CN110795135A - A method and apparatus for realizing annotated configuration - Google Patents

Abstract

The invention discloses a method and a device for realizing annotated configuration, and relates to the technical field of computers. A specific implementation of the method includes: reading a configuration file to implement environment settings; creating a component factory class, and adding component definitions; executing a container post-processor, and then synchronizing configuration information; and creating a component object. This embodiment can solve the problem that the conversion from the string to the program type is wrong, and the logic of acquiring the remote configuration information is highly intrusive to the business.

Description

A method and apparatus for realizing annotated configuration

technical field

The present invention relates to the field of computer technology, and in particular, to a method and apparatus for implementing annotated configuration.

Background technique

At present, most application systems require some configuration information. For example, the setting of the business logic threshold (allowing a single user to place orders in one day), and the setting of some switches (whether to follow the risk control logic). This kind of information is usually stored in zookeeper (distributed, open source distributed application coordination service) or self-implemented configuration service center, and passive notification or active polling is used to obtain remote values (both are strings). form), and then converted to the data type required by the program (Integer, Boolean, Date, etc.) and then cached locally (for example: a static variable in the JVM).

In the process of realizing the present invention, the inventor found that there are at least the following problems in the prior art:

The conversion from "string" to "program type" and cached locally, this processing process is scattered in various places where the application needs configuration information, which is intrusive to the application's business logic, and if it is not synchronized with the remote, It will also affect normal business logic execution.

SUMMARY OF THE INVENTION

In view of this, the embodiments of the present invention provide a method and apparatus for implementing annotated configuration, which can solve the problems of conversion errors from strings to program types and the high intrusiveness of business logic for obtaining remote configuration information.

In order to achieve the above object, according to an aspect of the embodiments of the present invention, a method for implementing annotated configuration is provided, including reading a configuration file to implement environment settings; creating a component factory class, and adding component definitions; performing container post-processing , then synchronize the configuration information; create a component object.

Optionally, execute the container post-processor, and then synchronize configuration information, including:

Parse @ConfigPath and @ConfigKey to obtain the Key value and Value value corresponding to @ConfigPath and @ConfigKey respectively;

Connect to the remote configuration center to determine whether there are Key values and Value values corresponding to @ConfigPath and @ConfigKey respectively;

If it exists, obtain the Key value and Value value of @ConfigPath of the remote configuration center, and the Key value and Value value of @ConfigKey to update it locally;

If it does not exist, add the parsed Key value and Value value of @ConfigPath, and the Key value and Value value of @ConfigKey in the remote configuration center.

Optionally, add annotations to the Key value and Value value of the parsed @ConfigPath, and the Key value and Value value of the parsed @ConfigKey.

Optionally, before obtaining the Key value and Value value of @ConfigPath of the remote configuration center, and the Key value and Value value of @ConfigKey, include:

The string form of the configuration information is converted into the value of the data type corresponding to the Key through the PropertyEditor of the Spring framework; the configuration information is the Key value and Value value of @ConfigPath of the remote configuration center, and the Key value and Value value of @ConfigKey.

In addition, according to an aspect of the embodiments of the present invention, an apparatus for implementing annotated configuration is provided, including a setting module for reading a configuration file to implement environment setting; creating a component factory class, and loading a component definition; a configuration module , which is used to execute the container post-processor, then synchronize the configuration information, and then create the component object.

Optionally, the configuration module executes the container post-processor, and then synchronizes configuration information, including:

Parse @ConfigPath and @ConfigKey to obtain the Key value and Value value corresponding to @ConfigPath and @ConfigKey respectively;

Connect to the remote configuration center to determine whether there are Key values and Value values corresponding to @ConfigPath and @ConfigKey respectively;

If it exists, obtain the Key value and Value value of @ConfigPath of the remote configuration center, and the Key value and Value value of @ConfigKey to update it locally;

If it does not exist, add the parsed Key value and Value value of @ConfigPath, and the Key value and Value value of @ConfigKey in the remote configuration center.

Optionally, the configuration module is also used for:

Add annotations to the Key value and Value value of the parsed @ConfigPath, and the Key value and Value value of the parsed @ConfigKey.

Optionally, before the configuration module obtains the Key value and Value value of @ConfigPath of the remote configuration center, and the Key value and Value value of @ConfigKey, it includes:

The string form of the configuration information is converted into the value of the data type corresponding to the Key through the PropertyEditor of the Spring framework; the configuration information is the Key value and Value value of @ConfigPath of the remote configuration center, and the Key value and Value value of @ConfigKey.

According to another aspect of the embodiments of the present invention, an electronic device is also provided, including:

one or more processors;

storage means for storing one or more programs,

When the one or more programs are executed by the one or more processors, the one or more processors cause the one or more processors to implement the method described in any of the foregoing embodiments for implementing annotated configuration.

According to another aspect of the embodiments of the present invention, a computer-readable medium is also provided, on which a computer program is stored, and when the program is executed by a processor, implements any of the foregoing embodiments based on implementing annotated configuration. method.

An embodiment of the above invention has the following advantages or beneficial effects: the present invention combines Spring (an open source design level framework, which solves the problem of loose coupling between the business logic layer and other layers) characteristics through annotation configuration, and realizes the A configuration information synchronization client with low business intrusion, so as to achieve automatic conversion of configuration information and types, and at the same time unify the processing logic of configuration information, and it is transparent and low intrusion to applications.

Further effects of the above non-conventional alternatives will be described below in conjunction with specific embodiments.

Description of drawings

The accompanying drawings are used for better understanding of the present invention and do not constitute an improper limitation of the present invention. in:

1 is a schematic diagram of a main flow of a method for implementing annotated configuration according to an embodiment of the present invention;

2 is a schematic diagram of the main flow of a method for implementing annotated configuration according to a referenced embodiment of the present invention;

3 is a schematic diagram of main modules of an apparatus for implementing annotated configuration according to an embodiment of the present invention;

4 is an exemplary system architecture diagram to which an embodiment of the present invention may be applied;

FIG. 5 is a schematic structural diagram of a computer system suitable for implementing a terminal device or a server according to an embodiment of the present invention.

Detailed ways

Exemplary embodiments of the present invention are described below with reference to the accompanying drawings, which include various details of the embodiments of the present invention to facilitate understanding and should be considered as exemplary only. Accordingly, those of ordinary skill in the art will recognize that various changes and modifications of the embodiments described herein can be made without departing from the scope and spirit of the invention. Also, descriptions of well-known functions and constructions are omitted from the following description for clarity and conciseness.

FIG. 1 is a schematic diagram of a main process of a method for implementing annotated configuration according to an embodiment of the present invention. The method for implementing annotated configuration may include:

Step S101, read the configuration file to realize environment setting.

In step S102, a component factory class is created, and a component definition is loaded.

Preferably, the component used in the present invention is Bean, and the component factory class is BeanFactory. Further, BeanFactory can be created, and bean definitions can be loaded.

Step S103: Execute the container post-processor, then synchronize the configuration information, and then create a component object.

Preferably, if the adopted component is a Bean, the container post-processor is executed, and then the configuration information is synchronized to create the Bean object.

In a further embodiment, when the container post-processor is executed and then the configuration information is synchronized, the following process may be used:

Parse @ConfigPath and @ConfigKey to obtain the Key value and Value value corresponding to @ConfigPath and @ConfigKey respectively.

Connect to the remote configuration center to determine whether there are Key and Value values corresponding to @ConfigPath and @ConfigKey respectively.

According to the judgment result, if it exists, obtain the Key value and Value value of @ConfigPath of the remote configuration center, and the Key value and Value value of @ConfigKey to update it locally. If it does not exist, add the parsed Key value and Value value of @ConfigPath, and the Key value and Value value of @ConfigKey in the remote configuration center.

In a further embodiment, annotations may be added to the parsed Key value and Value value of @ConfigPath, and the parsed Key value and Value value of @ConfigKey.

It is also worth noting that, before updating the configuration information of the remote configuration center (that is, the Key value and Value value of @ConfigPath of the remote configuration center, and the Key value and Value value of @ConfigKey.) The PropertyEditor converts the string form of the configuration information into the value of the data type corresponding to the Key.

As another referenced embodiment of the present invention, as shown in FIG. 2 , this embodiment implements annotated configuration based on characteristics of Spring, and the method for implementing annotated configuration may include:

Step S201, parse property sources and profiles to complete environment setting.

Among them, the configuration file can be read by parsing property sources and profiles.

Step S202, creating a component factory class to build a container.

For example, an IOC (Inversion of Control) container can be obtained by creating a BeanFactory (Bean Factory Class). Among them, the IOC (Inversion of Control) is inversion of control, which is a law to reduce program coupling.

Step S203, load the component definition.

Among them, the component definition, such as: Bean definition (ie BeanDefinition) is used to describe an instance of a Bean, including: attributes, constructors, parameters and other Bean-related information.

In step S204, the container post-processor is executed to synchronize the configuration information, so that the configuration information of the local and remote configuration centers is consistent.

In the embodiment, the synchronization of the configuration information is performed after the container post-processor is executed, which can ensure that the configuration information is in the latest state when executing the business logic, which perfectly decouples the synchronization of the configuration information from the business logic, while ensuring that Synchronize with the configuration information of the remote configuration center. Its specific implementation process includes:

Step 1: Parse @ConfigPath and @ConfigKey to obtain the Key value and Value value of @ConfigPath, and the Key value and Value value of @ConfigKey.

Step 2: Connect to the remote configuration center to determine whether there are the parsed Key value and Value value of @ConfigPath and the parsed @ConfigKey Key value and Value value. If so, go to Step 3, otherwise go to Step 4.

Step 3: Obtain the Key value and Value value of @ConfigPath in the remote configuration center, and the Key value and Value value of @ConfigKey to update it locally.

Preferably, after obtaining the configuration information of the remote configuration center, the characters of the configuration information can be converted to the Character Editor of the Spring framework (which is an open-source design-level framework) (used to complete the conversion between data types and strings). The string form is converted to the value of the corresponding data type of Key. The configuration information is the Key value and Value value of @ConfigPath of the remote configuration center, and the Key value and Value value of @ConfigKey.

Step 4: Add the parsed Key value and Value value of @ConfigPath, and the Key value and Value value of @ConfigKey in the remote configuration center.

It is worth noting that no matter after step 3 or step 4 is performed, the remote configuration center can be monitored to monitor the Key value and Value value of @ConfigPath, and monitor the Key value and Value value of @ConfigKey.

Step S205, create a component object, which is a singleton by default.

For example, when the component is a Bean, the constructor of the Bean can be called to create a Bean instance to create a Bean object.

It should be noted that in the present invention, because the configuration information is static, when the configuration information needs to be referenced, it can be used directly (that is, it can be accessed):

classname.propertyname

As a further embodiment of the present invention, annotations are added to the Key value and Value value of @ConfigPath, and the Key value and Value value of @ConfigKey, so as to achieve less intrusiveness to the business, that is, to synchronize with traditional configuration information. In contrast, the purpose of decoupling from business logic is achieved by encapsulating the logic of configuration information synchronization into annotations and container post-processing.

Among them, @ConfigPath can indicate that this class is a configuration class, corresponding to a path in the remote configuration center, for example: value="/yanglikun", that is, the configuration Path. In addition, @ConfigPath has corresponding read and write permission values, and supports spring placeholders to load secret keys in different operating environments according to profiles. For example: readToken="${ucc.yanglikun.readToken}", that is, the read key. writeToken="${ucc.yanglikun.writeToken}", that is, write the secret key.

Among them, @ConfigKey can represent specific configuration information (Key, Value), the default field name is the Key of the remote configuration center, of course, it can also be customized, for example: @ConfigKey("custom_key_name"), that is, the specified field value, the default field name .

FIG. 3 is an apparatus for implementing annotated configuration according to an embodiment of the present invention. As shown in FIG. 3 , the apparatus 300 for implementing annotated configuration includes a setting module 301 and a configuration module 302 . Among them, the setting module 301 reads the configuration file to realize the environment setting, creates the component factory class, and loads the component definition. After that, the configuration module 302 executes the container post-processor, then synchronizes the configuration information, and then creates a component object.

As a further embodiment, the configuration module 302 executes the container post-processor, and then the specific implementation process of synchronizing the configuration information includes:

Parse @ConfigPath and @ConfigKey to obtain the Key value and Value value corresponding to @ConfigPath and @ConfigKey respectively.

Connect to the remote configuration center to determine whether there are Key and Value values corresponding to @ConfigPath and @ConfigKey respectively. According to the judgment result, if it exists, obtain the Key value and Value value of @ConfigPath of the remote configuration center, and the Key value and Value value of @ConfigKey to update it locally. If it does not exist, add the parsed Key value and Value value of @ConfigPath, and the Key value and Value value of @ConfigKey in the remote configuration center.

In a preferred embodiment, annotations are added to the parsed Key value and Value value of @ConfigPath, and the parsed Key value and Value value of @ConfigKey.

It is also worth noting that, before obtaining the Key value and Value value of @ConfigPath of the remote configuration center, and the Key value and Value value of @ConfigKey, the String form of the configuration information is converted into the data type corresponding to the Key through the PropertyEditor of the Spring framework. value of . The configuration information is the Key value and Value value of @ConfigPath of the remote configuration center, and the Key value and Value value of @ConfigKey.

It should be noted that, the specific implementation content of the apparatus for implementing annotated configuration according to the present invention has been described in detail in the method for implementing annotated configuration described above, so the repeated content will not be described here.

FIG. 4 shows an exemplary system architecture 400 to which a method for implementing annotated configuration or an apparatus for implementing annotated configuration according to an embodiment of the present invention may be applied.

As shown in FIG. 4 , the system architecture 400 may include terminal devices 401 , 402 , and 403 , a network 404 and a server 405 . The network 404 is a medium used to provide a communication link between the terminal devices 401 , 402 , 403 and the server 405 . The network 404 may include various connection types, such as wired, wireless communication links, or fiber optic cables, among others.

The user can use the terminal devices 401, 402, 403 to interact with the server 405 through the network 404 to receive or send messages and the like. Various communication client applications may be installed on the terminal devices 401 , 402 and 403 , such as shopping applications, web browser applications, search applications, instant messaging tools, email clients, social platform software, etc. (only examples).

The terminal devices 401, 402, 403 may be various electronic devices having a display screen and supporting web browsing, including but not limited to smart phones, tablet computers, laptop computers, desktop computers, and the like.

The server 405 may be a server that provides various services, for example, a background management server that provides support for shopping websites browsed by the terminal devices 401 , 402 , and 403 (just an example). The background management server can analyze and process the received product information query request and other data, and feed back the processing results (such as target push information, product information—just an example) to the terminal device.

It should be noted that the method for implementing annotated configuration provided by the embodiment of the present invention is generally performed by the server 405 , and accordingly, the apparatus for implementing the annotated configuration is generally set in the server 405 .

It should be understood that the numbers of terminal devices, networks and servers in FIG. 4 are merely illustrative. There can be any number of terminal devices, networks and servers according to implementation needs.

Referring to FIG. 5 below, it shows a schematic structural diagram of a computer system 500 suitable for implementing a terminal device according to an embodiment of the present invention. The terminal device shown in FIG. 5 is only an example, and should not impose any limitations on the functions and scope of use of the embodiments of the present invention.

As shown in FIG. 5, a computer system 500 includes a central processing unit (CPU) 501 which can be loaded into a random access memory (RAM) 503 according to a program stored in a read only memory (ROM) 502 or a program from a storage section 508 Instead, various appropriate actions and processes are performed. In the RAM 503, various programs and data necessary for the operation of the system 500 are also stored. The CPU 501 , the ROM 502 and the RAM 503 are connected to each other through a bus 504 . An input/output (I/O) interface 505 is also connected to bus 504 .

The following components are connected to the I/O interface 505: an input section 506 including a keyboard, a mouse, etc.; an output section 507 including a cathode ray tube (CRT), a liquid crystal display (LCD), etc., and a speaker, etc.; a storage section 508 including a hard disk, etc. ; and a communication section 509 including a network interface card such as a LAN card, a modem, and the like. The communication section 509 performs communication processing via a network such as the Internet. A drive 510 is also connected to the I/O interface 505 as needed. A removable medium 511, such as a magnetic disk, an optical disk, a magneto-optical disk, a semiconductor memory, etc., is mounted on the drive 510 as needed so that a computer program read therefrom is installed into the storage section 508 as needed.

In particular, the processes described above with reference to the flowcharts may be implemented as computer software programs in accordance with the disclosed embodiments of the present invention. For example, embodiments disclosed herein include a computer program product comprising a computer program carried on a computer-readable medium, the computer program containing program code for performing the method illustrated in the flowchart. In such an embodiment, the computer program may be downloaded and installed from the network via the communication portion 509 and/or installed from the removable medium 511 . When the computer program is executed by the central processing unit (CPU) 501, the above-described functions defined in the system of the present invention are performed.

It should be noted that the computer-readable medium shown in the present invention may be a computer-readable signal medium or a computer-readable storage medium, or any combination of the above two. The computer-readable storage medium can be, for example, but not limited to, an electrical, magnetic, optical, electromagnetic, infrared, or semiconductor system, apparatus or device, or a combination of any of the above. More specific examples of computer readable storage media may include, but are not limited to, electrical connections with one or more wires, portable computer disks, hard disks, random access memory (RAM), read only memory (ROM), erasable Programmable read only memory (EPROM or flash memory), fiber optics, portable compact disk read only memory (CD-ROM), optical storage devices, magnetic storage devices, or any suitable combination of the foregoing. In the present invention, a computer-readable storage medium may be any tangible medium that contains or stores a program that can be used by or in conjunction with an instruction execution system, apparatus, or device. In the present invention, however, a computer-readable signal medium may include a data signal propagated in baseband or as part of a carrier wave, carrying computer-readable program code therein. Such propagated data signals may take a variety of forms, including but not limited to electromagnetic signals, optical signals, or any suitable combination of the foregoing. A computer-readable signal medium can also be any computer-readable medium other than a computer-readable storage medium that can transmit, propagate, or transport the program for use by or in connection with the instruction execution system, apparatus, or device . Program code embodied on a computer readable medium may be transmitted using any suitable medium including, but not limited to, wireless, wireline, optical fiber cable, RF, etc., or any suitable combination of the foregoing.

The flowchart and block diagrams in the Figures illustrate the architecture, functionality, and operation of possible implementations of systems, methods and computer program products according to various embodiments of the present invention. In this regard, each block in the flowchart or block diagrams may represent a module, segment, or portion of code that contains one or more logical functions for implementing the specified functions executable instructions. It should also be noted that, in some alternative implementations, the functions noted in the blocks may occur out of the order noted in the figures. For example, two blocks shown in succession may, in fact, be executed substantially concurrently, or the blocks may sometimes be executed in the reverse order, depending upon the functionality involved. It is also noted that each block of the block diagrams or flowchart illustrations, and combinations of blocks in the block diagrams or flowchart illustrations, can be implemented in special purpose hardware-based systems that perform the specified functions or operations, or can be implemented using A combination of dedicated hardware and computer instructions is implemented.

The modules involved in the embodiments of the present invention may be implemented in a software manner, and may also be implemented in a hardware manner. The described modules can also be provided in the processor, for example, it can be described as: a processor includes a setting module and a configuration module. Among them, the names of these modules do not constitute a limitation on the module itself under certain circumstances.

As another aspect, the present invention also provides a computer-readable medium, which may be included in the device described in the above embodiments; or may exist alone without being assembled into the device. The above-mentioned computer-readable medium carries one or more programs, and when the above-mentioned one or more programs are executed by a device, the device includes: reading a configuration file to realize the environment setting; reading the configuration file to realize the environment Set up; create a component factory class, and add component definitions; execute the container post-processor, and then synchronize configuration information; create a component object.

According to the technical solutions of the embodiments of the present invention, it is possible to solve the problems of errors in converting from character strings to program types, and the high intrusiveness of the logic of acquiring remote configuration information to services.

The above-mentioned specific embodiments do not constitute a limitation on the protection scope of the present invention. It should be understood by those skilled in the art that various modifications, combinations, sub-combinations and substitutions may occur depending on design requirements and other factors. Any modifications, equivalent replacements and improvements made within the spirit and principle of the present invention shall be included within the protection scope of the present invention.

Claims (10)

1. a method for realizing annotated configuration, characterized in that, comprising: Read configuration files to implement environment settings; Create component factory classes and add component definitions; Execute the container post-processor, and then synchronize the configuration information; Create a component object. 2. The method according to claim 1, wherein the container post-processor is executed, and then the configuration information is synchronized, comprising: Parse @ConfigPath and @ConfigKey to obtain the Key value and Value value corresponding to @ConfigPath and @ConfigKey respectively; Connect to the remote configuration center to determine whether there are Key values and Value values corresponding to @ConfigPath and @ConfigKey respectively; If it exists, obtain the Key value and Value value of @ConfigPath of the remote configuration center, and the Key value and Value value of @ConfigKey to update it locally; If it does not exist, add the parsed Key value and Value value of @ConfigPath, and the Key value and Value value of @ConfigKey in the remote configuration center. 3. The method according to claim 2, wherein an annotation is added to the Key value and Value value of the parsed @ConfigPath, and the Key value and Value value of the parsed @ConfigKey. 4. method according to claim 2, is characterized in that, obtains the Key value, the Value value of the @ConfigPath of remote configuration center, and before the Key value and the Value value of @ConfigKey, comprising: The string form of the configuration information is converted into the value of the data type corresponding to the Key through the PropertyEditor of the Spring framework; the configuration information is the Key value and Value value of @ConfigPath of the remote configuration center, and the Key value and Value value of @ConfigKey. 5. A device for realizing annotated configuration, comprising: Settings module, used to read configuration files to implement environment settings; create component factory classes, and load component definitions; The configuration module is used to execute the container post-processor, then synchronize the configuration information, and then create the component object. 6. The apparatus according to claim 5, wherein the configuration module executes a container post-processor, and then synchronizes configuration information, comprising: Parse @ConfigPath and @ConfigKey to obtain the Key value and Value value corresponding to @ConfigPath and @ConfigKey respectively; Connect to the remote configuration center to determine whether there are Key values and Value values corresponding to @ConfigPath and @ConfigKey respectively; If it exists, obtain the Key value and Value value of @ConfigPath of the remote configuration center, and the Key value and Value value of @ConfigKey to update it locally; If it does not exist, add the parsed Key value and Value value of @ConfigPath, and the Key value and Value value of @ConfigKey in the remote configuration center. 7. The device according to claim 6, wherein the configuration module is further configured to: Add annotations to the Key value and Value value of the parsed @ConfigPath, and the Key value and Value value of the parsed @ConfigKey. 8. device according to claim 6, is characterized in that, before described configuration module obtains the Key value of the @ConfigPath of remote configuration center, Value value, and before the Key value and Value value of @ConfigKey, comprise: The string form of the configuration information is converted into the value of the data type corresponding to the Key through the PropertyEditor of the Spring framework; the configuration information is the Key value and Value value of @ConfigPath of the remote configuration center, and the Key value and Value value of @ConfigKey. 9. An electronic device, characterized in that, comprising: one or more processors; storage means for storing one or more programs, The one or more programs, when executed by the one or more processors, cause the one or more processors to implement the method of any one of claims 1-4. 10. A computer-readable medium on which a computer program is stored, characterized in that, when the program is executed by a processor, the method according to any one of claims 1-4 is implemented.

Images