TWI728445B - Message redirecting method and application programming interface gateway - Google Patents

Abstract

The disclosure provides a message redirecting method and an application programming interface gateway instance, which is suitable a first instance deployed in a microservice system, wherein the first instance is an application programming interface gateway instance. The method includes: detecting whether a first message appears in a specific topic of a message queue in the microservice system, wherein the first message encapsulates a first message content and a first recipient identity; determining whether a first user corresponding to the first recipient identity has been registered on the first instance through a first browser; in response to determining that the first user has been registered on the first instance, redirecting the first message content to the first browser through a first Websocket connection between the first browser and the first instance.

Description

Message transfer method and application program interface gateway

The present invention relates to an operating method of a microservice system, and particularly relates to a message transduction method and an application programming interface (API) gateway instance in the microservice system.

Generally speaking, the WebSocket connection established by the browser and the web server is a one-to-one connection. However, under a microservice system architecture that supports high availability, multiple gateways (such as API gateway instances) will be set up. In this case, you may face the problem that each browser request is sent to a different API gateway instance. In addition, the messages that other microservices want to send to the browser may also be forwarded through different API gateway instances. At this time, they will face the synchronization problem of WebSocket messages.

In view of this, the present invention provides a message transduction method and API gateway, which can be used to solve the above technical problems.

The present invention provides a message transduction method suitable for deployment in a microservice system A first example in the system, where the first example is an application programming interface gateway example, including: detecting whether a first message appears in a specific topic in a message queue in a microservice system, where the first message Encapsulate a first message content and a first recipient identity; unpack the first message to obtain the first message content and first recipient identity; determine whether a first user corresponding to the first recipient identity has passed a The first browser is registered on the first instance; in response to the determination that the first user has been registered on the first instance, the content of the first message is transferred through a first Websocket connection between the first instance and the first browser Lead to the first browser.

The invention provides an application program interface gateway, which is deployed in a microservice system and includes a message queue module, a registration module and a Websocket module. The message queue module is configured to detect whether a first message appears in a specific subject of a message queue in the microservice system, wherein the first message encapsulates a first message content and a first recipient identity; Encapsulate the first message to obtain the content of the first message and the identity of the first recipient. The registration module determines whether a first user corresponding to the identity of the first recipient has been registered on the first instance through a first browser. After the registration module determines that the first user is registered on the first instance, the Websocket module forwards the content of the first message to the first browser through a first Websocket connection between the first instance and the first browser Device.

Based on the above, the API gateway example of the present invention can decapsulate a new encapsulated message in a specific subject after detecting the new encapsulated message to obtain the recipient's identity. Then, if an API gateway instance determines that the user of the recipient identity has been registered on itself, then this API gateway instance can use the established Websocket Connect to relay the content of the message.

In order to make the above-mentioned features and advantages of the present invention more comprehensible, the following specific embodiments are described in detail in conjunction with the accompanying drawings.

100: Microservice system

11~1N: API gateway example

111: request processing module

112: Message Queue Module

113: Registered Module

114: HTTP request transduction module

115: Websocket module

120: Message Queue

130: microservices

S210~S250: steps

Fig. 1 is a schematic diagram of a micro service system according to an embodiment of the present invention.

Fig. 2 is a message transduction method according to an embodiment of the present invention.

In summary, the present invention provides a system and method for implementing a high-availability application program interface gateway under a microservice architecture based on message queues, which solves the problem of messages when the browser and the application program interface gateway are connected via WebSocket Synchronization issues, cross-domain WebSocket connection bridging issues, and cross-domain Hypertext Transfer Protocol (HTTP) synchronization and asynchronous request transduction issues.

Please refer to FIG. 1, which is a schematic diagram of a micro service system according to an embodiment of the present invention. As shown in FIG. 1, the microservice system 100 includes one or more API gateway instances 11-1N, a message queue 120, and microservices deployed therein. In the embodiment of the present invention, one API gateway instance may correspond to one or more microservices. Taking API gateway instance 11 as an example, it may correspond to one or more microservices 130. In some embodiments, the API gateway instance 11 can be used to help redirect the message from the microservice 130 to a specific user, and the relevant details will be detailed later.

In the embodiment of the present invention, the structure of each API gateway instance is similar, so the following will temporarily take API gateway instance 11 as an example for description. As shown in FIG. 1, the API gateway instance 11 may include a request processing module 111, a message queue module 112, a registration module 113, an HTTP request transduction module 114, and a Websocket module 115. Generally speaking, the request processing module 111 is responsible for processing all the sending and receiving of HTTP requests, and the message queue module 112 can listen to the message queue 120 at all times, and is responsible for sending and receiving messages. The request processing module 111 and the message queue module 112 are a unified interface of the API gateway instance 11. Externally, system users can use a browser and access API gateway instance 11 through HTTP requests. Internally, other microservices under the same microservice system 100 framework can communicate with the API gateway instance 11 through the HTTP request and message queue 120.

In some embodiments, after the user connects to the microservice system 100 that deploys a high-availability API gateway with a microservice architecture through the browser they are using, each browser request will be randomly assigned to the microservice system 100 Any API gateway instance connection. For ease of explanation, the following assumes that the user's browser is connected to API gateway instance 11. In this case, the request processing module 111 first receives the HTTP connection request from the user's browser, and then establishes a Websocket connection with the user's browser accordingly. At the same time, the request processing module 111 can also call the registration module 113 according to the HTTP connection request. Correspondingly, the registration module 113 composes registration information according to the user ID (userId) field in the HTTP connection request, and temporarily stores it in the memory of the API gateway instance 11 to complete a connection registration action . In one embodiment, the memory of the API gateway instance 11 may store the registration information used to record each user registered on the API gateway instance 11 (for example, including user identification). Don't code), but the present invention is not limited to this.

After that, if there is a microservice in the microservice system 11 that needs to send a message to a specific user connected to the microservice system 100, the mechanism provided by the following first and second embodiments can be used to proceed.

In the first embodiment, assuming that the microservice 130 wants to send a message to a certain user, the microservice 130 can use the user ID of the user as the recipient identity, and then combine it with the related message content The HTTP request (hereinafter referred to as the first HTTP request) is sent to the API gateway instance 11 corresponding to the microservice 130.

After the request processing module 111 of the API gateway instance 11 receives the first HTTP request, the registration module 113 can confirm whether the API gateway instance 11 (memory) stores the corresponding user ID Registration information. In one embodiment, if the registration module 113 finds registration information matching the recipient's identity in the API gateway instance 11, it means that the user has registered with the API gateway instance 11, and the user’s There is already a Websocket connection between the browser and API gateway instance 11. Therefore, the Websocket module 115 can forward the relevant message content to the browser used by the user through the aforementioned Websocket connection.

In another embodiment, if the registration module 113 fails to find the registration information matching the recipient's identity in the API gateway instance 11, it means that the user is not registered in the API gateway instance 11 (ie , Websocket connection has not been established with API gateway instance 11). In this case, the message queue module 112 can encapsulate the related message content and recipient identity into a package message, and send it to the message queue 120 for storage.

In the embodiment of the present invention, the message queue 120 may include different themes, and each theme can be regarded as a sub-queue that can be used to store a specific type of message, but the present invention is not limited to this. In the first embodiment, the message queue 120 may include a "MessageSyncEvent" subject, which can be used to store the packaged message packaged by the API gateway instance, but the invention is not limited to this.

In the second embodiment, after the message queue module in each of the remaining API gateway instances detects that a new encapsulated message appears in the subject of "MessageSyncEvent", it can proceed through the message transduction method proposed by the present invention Follow-up processing. Similarly, if there are other API gateway instances that queue the encapsulated message to the "MessageSyncEvent" topic, the queue message module 112 can also detect the presence of a new encapsulated message in the "MessageSyncEvent" topic through The message transduction method proposed by the present invention performs subsequent processing, and the related details will be further described in conjunction with FIG. 2 later.

In addition, in the second embodiment, assuming that the microservice 130 wants to send a message to a certain user, the microservice 130 can encapsulate the related message content and the identity of the recipient of the message into an encapsulated message, and encapsulate the encapsulated message. The message is forwarded to the message queue 120. In the second embodiment, the message queue 120 can include an "ApiGwRequest" theme, which can be used to store the encapsulated message encapsulated by the microservice itself, but the invention is not limited to this.

Later, when the message queue module in each API gateway instance (for example, the message queue module 112) detects that a new package message appears in the "ApiGwRequest" subject, the message presented in Figure 2 of the present invention can also be used Transduction method for follow-up deal with.

Please refer to FIG. 2, which is a message transduction method according to an embodiment of the present invention. The method of this embodiment can be executed by the API gateway instance 11 in FIG. 1. The details of each step are described below in conjunction with the content of FIG. 1.

First, in step S210, the queue message module 112 can detect whether the first message appears in a specific topic of the message queue 120 in the microservice system 100. In this embodiment, the aforementioned specific theme may be the "MessageSyncEvent" theme in the first embodiment or the "ApiGwRequest" theme in the second embodiment, but the invention is not limited to this.

Assuming that the specific theme is the "MessageSyncEvent" theme in the first embodiment, the first message under consideration can be an encapsulated message generated by other API gateway instances for the corresponding microservice, which can encapsulate the first message content And the identity of the first recipient. On the other hand, if the above-mentioned specific theme is the "ApiGwRequest" theme in the second embodiment, the considered first message can be obtained by encapsulating the content of the first message and the identity of the first recipient by a certain microservice.

Afterwards, in step S220, the queue message module 112 can decapsulate the first message to obtain the first message content and the first recipient identity. Then, in step S220, the registration module 113 can determine whether the first user corresponding to the first recipient identity has been registered on the API gateway instance 11 through the first browser. For example, the registration module 113 can confirm whether the user ID corresponding to the identity of the first recipient is stored in the API gateway instance 11 (in the memory). If yes, it means that the first user has registered with API gateway instance 11, and the browser of the first user (hereinafter referred to as the first browser) There is already a Websocket connection (hereinafter referred to as the first Websocket connection) between the API gateway instance 11 and the browser. Therefore, the Websocket module 115 can then forward the first message content to the first browser through the first Websocket channel between the API gateway instance 11 and the first browser in step S240.

Conversely, if the first user corresponding to the identity of the first recipient is not registered on API gateway instance 11 through the first browser, it means that the first user is not registered on API gateway instance 11 (ie , Websocket connection has not been established with API gateway instance 11). Therefore, the Websocket module 115 may perform step S250 to ignore the first message.

It can be seen from the above that, in the embodiment of the present invention, when a microservice wants to send a message to a specific user, but the user is not registered in the API gateway instance corresponding to the microservice, the corresponding API gateway can be used The example encapsulates the related message content and recipient identity as an encapsulated message (that is, the method of the first embodiment), or the microservice itself encapsulates the related message content and recipient identity as an encapsulated message (that is, the second embodiment) Example of practice). Afterwards, the above-mentioned encapsulated message can be stored in the corresponding specific topic in the message queue, and each API gateway instance can decapsulate it after detecting a new encapsulated message in the specific topic to obtain the content The identity of the recipient. Then, if an API gateway instance determines that the user of the receiver identity is registered on itself, the API gateway instance can relay the message content through the established Websocket connection, otherwise it can be ignored .

In addition, in other embodiments, the present invention further proposes a synchronous/asynchronous transduction mechanism between browsers. Specifically, in one embodiment, it is assumed that a second user The user has registered in the API gateway instance 11 through the second browser, and the API gateway instance 11 has established a second Websocket connection with the second browser accordingly. In this case, the second browser can send a second HTTP request to the request processing module 111, where the HTTP request can include a header field, and the header field can carry the destination address and the authentication token (token).

In the asynchronous transduction mechanism, after receiving the aforementioned second HTTP request from the second browser, the request processing module 111 can parse the aforementioned destination address from the header field, which can be generated by the HTTP request transduction module 114 The corresponding unique universal identification code (UUID). After that, the HTTP request transduction module 114 can return the above-mentioned unique universal identification code to the second browser through the second Websocket connection. Then, the HTTP request transduction module 114 can call the corresponding destination through a thread based on the destination address. And, in response to receiving a response from the destination, the thread can encapsulate the response and the above-mentioned unique universal identification code as an encapsulated message, and the Websocket module 115 sends it back to the second browser through the second Websocket connection.

In one embodiment, if the second browser intends to call multiple destinations through the second HTTP request, the HTTP request transduction module 114 can assign a dedicated thread to each destination, and each thread can be used for calling A destination. Moreover, after each thread receives the response from the respective destination, it can independently encapsulate the response and the above-mentioned unique universal identification code into an encapsulated message, which is sent back to the second browser by the Websocket module 115 through the second Websocket connection.

In addition, in the synchronous transduction mechanism, after receiving the above-mentioned second HTTP request from the second browser, the request processing module 111 can parse the above-mentioned destination address from the header field. After that, the HTTP request transduction module 114 can synchronously call multiple specific microservices located at the destination address based on the destination address. Afterwards, in response to receiving a specific response corresponding to the above-mentioned second HTTP request from each specific microservice, the HTTP request transduction module 114 may merge the specific response of each specific microservice into a JSON format, and reply the JSON format I'm a second browser.

In summary, the present invention can provide a method for supporting a browser to connect to multiple WebSocket servers at the same time and a mechanism for HTTP request transduction that supports synchronous and asynchronous under a high-availability microservice architecture.

Through the RabbitMQ message queue, the communication mechanism between multiple application interface gateways is implemented, and the registration module is included to support user identification. The user logs in with an account in the browser and communicates with any one of the high-availability micro-service architectures. After the application program interface gateway is connected, the gateway will generate a user ID based on the user account and store it in the memory. As long as the user logs in with the same account, the message can be received at the same time even in different browsers. It can also be used for message transduction. After setting, use the application program interface gateway as the entrance to subscribe to multiple WebSocket servers located in different domains at the same time.

In addition, the present invention also supports the browser's synchronization and asynchronous request transduction. The request can be directed to the domain based on the destination domain contained in the Header field in the HTTP request sent by the caller, and the synchronization request is directly synchronized. If the call is an asynchronous request, it will be sent back to the browser in the form of WebSocket. This technical feature can be used when a large-scale system has multiple internal subsystems, and the external application gateway performs request transduction to prevent the subsystems from being exposed to the Internet environment and causing information security vulnerabilities. When the microservice architecture deploys multiple application gateway instances, due to the call The instance of each call is different. The present invention supports user identification and automatic message synchronization, so it can correctly synchronize the message to the instance of the application gateway that has established a connection with the user’s browser, and then forward it back User browser.

When a large-scale system has only one external interface, the present invention provides a synchronous and asynchronous transduction mechanism for HTTP requests, and unified application gateways open to the outside world forward the requests to the internal subsystem, and asynchronous requests are returned by WebSocket messages. Pass it to users to avoid system exposure and information security loopholes.

Although the present invention has been disclosed in the above embodiments, it is not intended to limit the present invention. Anyone with ordinary knowledge in the relevant technical field can make some changes and modifications without departing from the spirit and scope of the present invention. The protection scope of the present invention shall be subject to those defined by the attached patent application scope.

S210~S250: steps

Claims (7)

A message transduction method is suitable for deploying in a first instance of a microservice system, wherein the first instance is an application programming interface gateway instance, including: detecting a message queue in the microservice system Whether a first message appears in a specific topic, where the first message is generated by a microservice in the microservice system encapsulating a first message content and a first recipient identity and forwarded to the message queue The specific subject; unpack the first message to obtain the content of the first message and the identity of the first recipient; determine whether a first user corresponding to the identity of the first recipient has been registered with a first browser On the first instance; in response to determining that the first user has been registered on the first instance, the content of the first message is transferred to the first instance through a first Websocket connection with the first browser A browser. For example, the method described in item 1 of the scope of patent application further includes: ignoring the first message in response to determining that the first user is not registered on the first instance. For example, the method described in claim 1 further includes: responding to a second user connecting to the microservice system through a second browser, receiving a browser request from the second browser, and according to Establishing a second Websocket connection with the second browser, wherein the browser request includes a user identification of the second user; Based on the user identification of the second user, a piece of registration information is formed and stored in the first instance. The method according to claim 3, wherein the first instance corresponds to a microservice, and at least one user is registered on the first instance, and the method further includes: receiving a second instance from the microservice A hypertext transfer protocol request, wherein the first hypertext transfer protocol request includes a second message content and a second recipient identity; determining whether the second recipient identity matches one of the at least one user; Responding to the registration information of the second user whose identity of the second recipient matches the at least one user, forwarding the content of the second message to the second browser through the second Websocket connection; When the second recipient identity does not match any of the at least one user, encapsulate the content of the second message and the second recipient identity into a second message, and forward the second message to the message The specific topic in the queue. The method described in item 3 of the scope of patent application further includes: receiving a second hypertext transfer protocol request from the second browser, wherein the second hypertext transfer protocol request includes a header field with a The destination address and an authentication token; the destination address is parsed from the header field, and a corresponding unique universal identification code is generated; Return the unique universal identification code to the second browser through the second Websocket connection; call a corresponding destination through a thread based on the destination address; respond to receiving a response from the destination, send The response and the unique universal identification code are encapsulated as an encapsulated message and sent back to the second browser through the second Websocket connection. For example, the method described in claim 1 further includes: in response to receiving a second hypertext transfer protocol request from a second browser, parsing from a header field of the second hypertext transfer protocol message A destination address; based on the destination address to synchronously call a plurality of specific microservices located at the destination address; in response to receiving a specific response from each of the specific microservices corresponding to the second hypertext transfer protocol request, the The specific response of each specific microservice is merged into a JSON format, and the JSON format is returned to the second browser. An application programming interface gateway, which is deployed in a microservice system, includes: a message queue module, which is configured to: detect whether a specific subject of a message queue in the microservice system appears A first message, where the first message is generated by a microservice in the microservice system encapsulating a first message content and a first recipient identity and forwarded to the specific topic of the message queue; Decapsulate the first message to obtain the content of the first message and the identity of the first recipient; a registration module that determines whether a first user corresponding to the identity of the first recipient has passed through a first browser Registered on the first instance; a Websocket module, which after the registration module determines that the first user has been registered on the first instance, through a first Websocket connection with the first browser The line forwards the content of the first message to the first browser.

Images