CN115268897A - Component library document access method, device, equipment and medium - Google Patents

Abstract

Embodiments of the present application provide a component library document access method, apparatus, device, and medium, which implements access to different types of component documents through a set of document library generation systems. The method includes: receiving an access instruction of a component library document, where the access instruction includes the component type of the target component document and the document identifier of the target component document; according to the component type, retrieve the target access path corresponding to the component type from the main application, and according to the component type The target access path enters the sub-application corresponding to the component type; based on the document identifier, the target component document is obtained from the sub-application, and displayed on the display interface according to the preset format.

Description

A component library document access method, device, equipment and medium

technical field

The present application relates to the technical field of Internet micro-frontends, and in particular to a component library document access method, device, device and medium.

Background technique

At present, component libraries are often developed in daily development, such as creating new components in the component library. In order to facilitate the calling of components, the component library documentation is particularly important.

Since the current document library generation system does not support users to access different types of component library documents through one system, that is, it is not compatible with the mainstream Vue and React frameworks at the same time, so it is necessary to build multiple single document libraries for different types of component libraries Generating systems, each single document library generating system generates a type of component library documentation.

When users use this single document library generation system to access component library documents, because they often use different types of component library documents, they need to switch systems frequently during use, which is not conducive to the isomorphism of component libraries and increases maintenance cost.

Contents of the invention

The invention provides a method, device, device and medium for accessing component library documents, and realizes accessing different types of component documents through a document library generation system.

According to the first aspect of the embodiments of the present application, a method for accessing component library documents is provided, including:

Receive an access instruction of the component library document, where the access instruction includes the component type of the target component document and the document identifier of the target component document;

According to the component type, retrieve the target access path corresponding to the component type from the main application, and enter the sub-application corresponding to the component type according to the target access path;

Based on the document identifier, the target component document is obtained from the sub-application, and displayed on the display interface according to a preset format.

The above method, when receiving an access instruction, enters the corresponding subsystem to obtain component documents according to the access paths corresponding to different component types stored in the main application in advance, and realizes by storing the access paths of different component types in the main application. In order to access multiple sub-applications corresponding to different component types through the same main application, that is, to access different types of component documents through a document library generation system.

An optional implementation manner is that the method also includes:

If component documents of multiple component types are displayed on the display interface in an overlay manner, after receiving the switching instruction, the component document currently displayed on the display interface is overwritten with the component document corresponding to the switching identifier included in the switching instruction.

In the above method, after the first acquisition, various types of component documents are displayed on the display page by overlaying, and component documents are switched by modifying the overlay order, so as to avoid frequent acquisition of the same component document from sub-applications.

An optional implementation manner is, before receiving the access instruction of the component library document, further include:

For any component type, generate a sub-application corresponding to any component type according to a configuration file related to any component type;

Obtain the comment information of each component based on the storage path corresponding to each component of any component type through the document generator in the sub-application;

Through the document generator in the sub-application, the corresponding component document is generated according to the annotation information of each component, and stored in the corresponding sub-application.

In the above method, a component library document containing various component types is generated through the above method, so that subsequent users can access different types of component documents through the component document.

An optional implementation manner is that the configuration files related to any component type include a public configuration file shared by each component type and a private configuration file corresponding to any component type;

Generate sub-applications corresponding to any component type according to configuration files related to any component type, including:

Generate a sub-application corresponding to any component type according to the public configuration file and the private configuration file corresponding to any component type.

The above method simplifies the complexity of configuration files through public configuration, and also avoids waste of resources caused by repeated storage of the same configuration file.

An optional implementation manner is that the document generator generates in the following manner:

According to the configuration item corresponding to the document generator in the configuration file corresponding to any component type, generate the document generator in the sub-application corresponding to any component type;

Among them, the configuration item is generated by using the new configuration item to override the default configuration item after the configuration format is adjusted.

In the above method, the generation of configuration items corresponding to the document generator is realized by adjusting the configuration format, that is, using new configuration items to overwrite default configuration items.

An optional implementation manner is, before generating a sub-application corresponding to any component type according to a configuration file related to any component type, further include:

The configuration file related to any component type is received through the access entry of the main application, and the configuration file related to any component type is stored in a preset storage area.

In the above method, the access entry of the above main application facilitates the reception of the configuration file, and also reserves an entry for the expansion of the new sub-application in the future, that is, the configuration file corresponding to the new sub-application can be created through the access entry. new sub-application.

The second aspect of the embodiments of the present application provides a device for accessing component library documents, including:

The receiving module is configured to receive an access instruction of the component library document, where the access instruction includes the component type of the target component document and the document identifier of the target component document;

An access module, configured to retrieve a target access path corresponding to the component type from the main application according to the component type, and enter a sub-application corresponding to the component type according to the target access path;

The obtaining module is configured to obtain the target component document from the sub-application based on the document identification, and display it on the display interface according to a preset format.

An optional implementation manner is that the above-mentioned device also includes:

The switching module is used to cover the component documents currently displayed on the above-mentioned display interface with the component documents corresponding to the switching identifier contained in the above-mentioned switching instruction after receiving the switching instruction if the component documents of multiple component types are displayed in an overlay mode on the above-mentioned display interface. Component documentation.

An optional implementation manner is that the above-mentioned device further includes a document generation module, and before the above-mentioned receiving module is used to receive the access instruction of the component library document, the document generation module is used to:

For any component type, generate a sub-application corresponding to any of the above component types according to the configuration file related to any of the above component types;

Obtain the comment information of each of the above components based on the storage path corresponding to each component of any of the above component types through the document generator in the above sub-application;

Through the document generator in the above sub-application, the corresponding component document is generated according to the above-mentioned annotation information of each of the above-mentioned components, and stored in the corresponding sub-application.

An optional implementation manner is that the above-mentioned configuration files related to any of the above-mentioned component types include a public configuration file shared by each component type and a private configuration file corresponding to any of the above-mentioned component types;

The above-mentioned document generating module is used to generate a sub-application corresponding to any of the above-mentioned component types according to a configuration file related to any of the above-mentioned component types, including:

A sub-application corresponding to any of the above component types is generated according to the above public configuration file and the private configuration file corresponding to any of the above component types.

An optional implementation manner is that the above-mentioned document generator is generated in the following manner:

According to the configuration item corresponding to the document generator in the configuration file corresponding to any of the above component types, generate the document generator in the sub-application corresponding to any of the above component types;

Wherein, the above-mentioned configuration items are generated by using new configuration items to overwrite default configuration items after the configuration format is adjusted.

An optional implementation manner is that before the above-mentioned document generation module is used to generate the sub-application corresponding to any of the above-mentioned component types according to the configuration file related to any of the above-mentioned component types, it further includes:

The configuration file related to any one of the above component types is received through the access portal of the main application, and the configuration file related to any one of the above component types is stored in a preset storage area.

According to a third aspect of the embodiments of the present application, a device for accessing component library documents is provided, including:

processor;

memory for storing processor-executable instructions;

Wherein, the processor is configured to execute instructions, so as to realize the steps of any one of the methods for accessing the above-mentioned component library documents.

The fourth aspect of the embodiments of the present application provides a computer-readable storage medium, including computer-readable instructions. When the computer reads and executes the computer-readable instructions, the computer executes any one of the above methods for accessing component library documents A step of.

According to a fifth aspect of the embodiments of the present application, a computer program product is provided, including a computer program, and the computer program is stored in a computer-readable storage medium;

When the processor of the component library document accessing device reads the computer program from the computer-readable storage medium, the processor executes the computer program, so that the electronic device executes the steps of any one of the above component library document accessing methods.

Description of drawings

In order to more clearly illustrate the technical solutions in the embodiments of the present application, the drawings that need to be used in the description of the embodiments will be briefly introduced below. Obviously, the drawings in the following description are only some embodiments of the present invention. For Those of ordinary skill in the art can also obtain other drawings based on these drawings without any creative effort.

FIG. 1 is a schematic flowchart of a method for accessing component library documents provided by an embodiment of the present application;

FIG. 2 is a schematic diagram of a display interface provided by an embodiment of the present application;

FIG. 3 is a schematic diagram of a document switching interface provided by an embodiment of the present application;

FIG. 4 is a schematic flowchart of a method for generating a component library document provided in an embodiment of the present application;

FIG. 5 is a schematic diagram of a creation process of a component library document generation system provided by an embodiment of the present application;

FIG. 6 is a schematic diagram of a device for accessing component library documents provided by an embodiment of the present application;

FIG. 7 is a schematic diagram of a device for accessing component library documents provided by an embodiment of the present application.

Detailed ways

In order to make the purpose, technical solution and advantages of the present invention clearer, the present invention will be further described in detail below in conjunction with the accompanying drawings.

The application scenarios described in the embodiments of this application are to illustrate the technical solutions of the embodiments of the application more clearly, and do not constitute limitations on the technical solutions provided by the embodiments of the application. Those of ordinary skill in the art know that with the development of new application scenarios It appears that the technical solutions provided by the embodiments of the present application are also applicable to similar technical problems.

It should be noted that the terms "first" and "second" in the specification and claims of the present application and the above drawings are used to distinguish similar objects, but not necessarily to describe a specific order or sequence. The data so used are interchangeable under appropriate circumstances such that the embodiments of the invention described herein can be practiced in sequences other than those illustrated or described herein.

The implementations described in the following exemplary examples do not represent all implementations consistent with the present invention. Rather, they are merely examples of apparatuses and methods consistent with aspects of the present application as recited in the appended claims. Based on the embodiments in this application, all other embodiments obtained by persons of ordinary skill in the art without making creative efforts belong to the scope of protection of this application.

Currently, in the daily development of the component library, components are often modified and added. In order to facilitate the calling of developers, the writing of component library documents is particularly important. At present, there are two main ways to process the generation of component library documents:

One is to manually write the markdown document and upload it to the server. This method is inefficient and time-consuming, and the feasibility is low. In this method, the component library document is also generated for a single type of component. When accessing, developers need to Switch between different types of component library documents.

The second is to build a single component library document generation system. For example, use the react-styleguidist document generator to build a visual document system. This method is only for specific react or vue frameworks. It is not compatible with mainstream vue and react frameworks at the same time. Therefore, two systems need to be built, and developers need to constantly switch during development to realize access to different types of component library documents belonging to different frameworks. This method is not conducive to developers’ development and access to component library documents, and also increases maintenance cost.

In order to facilitate developers to access component library documents, the embodiment of the present application designs a component library document access method that can support developers to access different types of component documents through a document library generation system through micro-frontend transformation.

Fig. 1 is a schematic flow diagram of a method for accessing a component library document provided by an embodiment of the present application. As shown in Fig. 1, the present application provides a method for accessing a component library document, including the following steps:

Step 101: Receive an access instruction of the component library document, the access instruction includes the component type of the target component document and the document identifier of the target component document;

The component types of the above target component document in the embodiment of the present application include but not limited to vue component and react component.

Step 102, according to the component type, retrieve the target access path corresponding to the component type from the main application, and enter the sub-application corresponding to the component type according to the target access path;

In the embodiment of the present application, the above-mentioned main application pre-stores access paths corresponding to different component types, and according to the access paths, a relationship between the main application and sub-applications corresponding to different component types can be established.

In some embodiments, when creating a document library, the main application entry (index.html file) is first created, and then sub-applications corresponding to different component types are registered in the main application. Multiple sub-applications of different component types are registered in the application, and packaged and run by parcel-bundler (packaging tool), for example, sub-application 1 corresponding to the vue component and sub-application 2 corresponding to the react component are registered in the main application.

After the sub-applications are registered, the main application and each sub-application and the relationship between each sub-application are established by storing the access paths corresponding to the sub-applications in the main application.

Specifically, modify the file client.index.js through the newly added source code to establish the relationship between the main application and each sub-application and each sub-application. client.index.js is the entry file of the sub-application, which is used to integrate the The required webpack_public_path path assignment and the exposure of three life cycle functions, the above client.index.js can generate a patch file through patch-package, when the document generation system is created, the patch file is called to realize the main application and sub-applications and each sub-application Establishment of links between applications.

When an access request is received, according to the component type corresponding to the access request, the target access path corresponding to the component type is retrieved from the access paths corresponding to different component types pre-stored in the main application. After the target access path is retrieved, according to the The target access path enters the sub-application corresponding to the component type.

Step 103, based on the document identification, obtain the target component document from the sub-application, and display it on the display interface according to a preset format.

After entering the corresponding sub-application, search from the sub-application according to the document ID carried in the access instruction, and when the component document corresponding to the document ID is found, display the component document to the user through the display interface, as shown in Figure 2 Shown (the display interface of a component document corresponding to the vue component type).

Since the above-mentioned process of querying and identifying corresponding component documents from sub-applications is similar to the process of accessing component library documents based on a single document library generation system in the prior art, details are not repeated here.

The above method, when receiving an access instruction, enters the corresponding subsystem to obtain component documents according to the access paths corresponding to different component types stored in the main application in advance, and realizes by storing the access paths of different component types in the main application. In order to access multiple sub-applications corresponding to different component types through the same main application, that is, to access different types of component documents through a document library generation system.

In the embodiment of this application, each component document needs to be obtained from the sub-application according to the above method only when it is accessed for the first time, and stored in a designated area after the acquisition, and the user directly displays the component document by overwriting the original display content when accessing it again , for example, after receiving the user's access instruction for the first time, obtain the first component document corresponding to the user's access instruction according to the above method, and display it on the display interface; After accessing the command, obtain the second component document corresponding to the command according to the above method, and display it on the display interface by covering the first component document when displaying on the display interface, that is, when displaying another component document, the previously displayed The component document of is not closed, so that it can be called directly when the user visits again.

When the component documents of multiple component types are displayed on the display interface in an overlay mode, after receiving the switching instruction and determining that the component document corresponding to the switching identifier in the switching instruction has been displayed on the display interface, use the component corresponding to the switching identifier The document overwrites the component document currently displayed on the display interface.

The above switching instruction can be generated by the user clicking on the switching button of the display interface. The switching button is as shown in Figure 3. The user can click on different component types to trigger the switching of the component document. It can be set anywhere on the display interface, such as the upper right corner.

In the embodiment of the present application, before receiving the access instruction of the component library document, the component library document needs to be generated, and its specific generation process is shown in Figure 4, (this process is a method for creating a component document of any component type , after the component documents corresponding to the components of various component types in the component library are generated according to the above method, they can be assembled to form a component library document), which specifically includes the following steps:

Step 401, generating a sub-application corresponding to any component type according to a configuration file related to any component type;

Wherein, the above-mentioned configuration files include a public configuration file shared by each component type and a private configuration file corresponding to any one of the above-mentioned component types.

The above-mentioned public configuration file (styleguide.config) includes configuration items such as version number, component download volume, style, and title. The above-mentioned private configuration file (such as the private configuration file styleguide.config.vue corresponding to the vue component type, and the corresponding to the react component type The private configuration file styleguide.config.react, etc.) includes configuration items such as webpack configuration after adapting the micro frontend, component path, startup port, etc.

After obtaining the above configuration file, generate a sub-application corresponding to any component type according to the public configuration file and the private configuration file corresponding to any component type.

The above sub-applications include but are not limited to sub-application 1 corresponding to the vue component type and sub-application 2 corresponding to the react component type.

Step 402, through the document generator in the sub-application, based on the storage path corresponding to each component of any component type, obtain the annotation information of each component;

The above annotation information includes the property annotation and method annotation of the component. The above attribute annotation includes the basic properties of the component itself, such as the number of fields, etc. The above method annotation includes the methods that the component can call. content.

In some embodiments, the document generator used by sub-application 1 is vue-styleguidist, and the vue-docgen-api plug-in in the document generator is used to extract the comment information of the component of the vue component type, specifically, extract the comment information of the vue component type Annotation information of props, slots, methods, and events in the code corresponding to the component.

The document generator used by sub-application 2 is react-styleguidist. The react-docgen plug-in in the document generator is used to extract the comment information of the components of the react component type, specifically, the description, Annotation information for displayName field, props and methods.

In some embodiments, after the user adds a new component (such as a vue component or a react component) in the component library by adding a code file in /src/components, the corresponding information of the component will be automatically stored in all component folders , the component library document generation system reads package.json in all component folders of src/components by calling the fs module of nodejs, obtains the component type of each component, and the path array (storage path) of each component, and according to the component type Differently configure each storage path in the corresponding sub-application, that is, store the storage path corresponding to the component type of vue in the styleguide.config.vue (sub-application 1) file, and store the corresponding storage path of the component type of react The path is stored in the styleguide.config.react (sub-application two) file.

When generating the component library document, the component library document generation system obtains the storage path of each component of the corresponding component type from the corresponding sub-application, and obtains the annotation information of each component according to the storage path.

In step 403, the document generator in the sub-application generates the corresponding component document according to the annotation information of each component, and stores it in the corresponding sub-application.

In some embodiments, after obtaining the comment information of each component, generate the json data format of the component document according to the comment information, then generate the corresponding Markdown for the component document in the json data format through the remark plug-in, and finally generate the component document of each component type, and stored in the corresponding sub-applications.

The documentation generator in the above sub-app is generated by:

According to the configuration item corresponding to the document generator in the configuration file corresponding to any component type, generate the document generator in the sub-application corresponding to any component type;

Among them, the configuration item is generated by using the new configuration item to override the default configuration item after the configuration format is adjusted.

In the specific implementation, the above configuration format defaults to use the default configuration item to cover the new configuration item (that is, the input configuration item). By modifying the scripts.make-webpack-config.js file, the configuration format is adjusted, and the original configuration format Modify to use the new configuration item to override the default configuration item. After modifying the scripts.make-webpack-config.js file, generate a patch file through patch-package. In the actual application process, call the patch file to adjust the configuration format.

During the creation of the component library document generation system, the document generator installed during project initialization is the document generator with the default configuration. During the sub-application generation process, the configuration items in the document generator are modified by calling the above patch file Make modifications to generate a new document generator corresponding to the sub-application.

Through the above method, the problem of overwriting the private webpack configuration of the source code is fixed, and the problem of modifying the packaging configuration of the micro-frontend is solved.

Before the sub-application corresponding to any component type is generated according to the configuration file related to any component type in the above step 401, the configuration file related to any component type is also received through the access entry of the main application, and any Configuration files related to component types are stored in the preset storage area.

In some embodiments, the user can input the configuration file related to any component type into the component library document generation system through the access portal of the main application, and the system will store the received configuration file in the corresponding location. When the system runs for the first time , generate the corresponding sub-application according to the configuration file.

Since the component library document generation system is configured with the main application access entry, when it is necessary to create a sub-application corresponding to a new component type, it is only necessary to configure the configuration file of the sub-application in the component library document generation system through this access entry , and add a document generator of the corresponding technology, you can add a new sub-application in the main application, that is, the component library document generation system provided by the embodiment of this application supports adding a new configuration file and a new document generator , to achieve compatibility with new front-end component technologies.

Fig. 5 is a schematic diagram of the creation process of a component library document generation system provided by the embodiment of the present application. As shown in Fig. 5, the above-mentioned component library document generation system creation process specifically includes the following five steps:

Step 501, perform project initialization.

Specifically, install document generators through npm, such as react-styleguidist and vue-styleguidlist (corresponding to react component types and vue component types, respectively), packaging tools such as webpack, and micro front-end plug-ins such as qiankun.

Step 502, create the main application entry index.html file, and register the sub-application in the main application.

Specifically, sub-applications corresponding to different component types are registered in the main application through the registerMicroApps method, and are packaged and run through parcel-bundler (package file).

Step 503 , performing micro-frontend modification.

Specifically, add two source code modification files, the two source code modification files are client.index.js and scripts.make-webpack-config.js, and generate two patch files through patch-package (package file).

Among them, client.index.js is the entry file of the sub-application. By assigning the webpack_public_path path required by the micro-front sub-application and exposing three lifecycle functions, the relationship between the main application and the sub-applications, and between the sub-applications is established. .

By modifying the scripts.make-webpack-config.js file, adjusting the configuration format, modifying the original configuration format to use the new configuration items to override the default configuration items, and repairing the problem that the source code private webpack configuration is overwritten.

Step 504, creating a public configuration and a private configuration.

Create a public configuration styleguide.config in the root directory, and create private configurations for sub-applications (such as styleguide.config.vue and styleguide.config.react) corresponding to each component type.

Different sub-applications correspond to different document generation processes. For example, if the component type is vue, configure and execute the document generation process corresponding to the vue component type through styleguide.config.vue; if the component type is a react component, use styleguide.config.react Configure and execute the document generation process corresponding to the react component type.

During the creation of the configuration file, the package file in step 503 above is used to modify the configuration format during the creation of the configuration item corresponding to the document generator.

Step 505 , the document generator corresponding to each component type extracts comment information from the component code, generates a component library document according to the comment information, and displays it through a visual interface.

The micro-frontend structure of the document generator provided by the embodiment of this application enables the unified generation of component library documents based on the main application entry and public configuration management files, realizing the unified management of configuration, and through the micro-frontend transformation of the existing document generator , generate a patch file, solve the problem of the document generation system adapting to the micro-front end, and realize real-time switching between sub-applications.

Based on the same disclosed concept, the embodiment of the present application also provides a device for accessing component library documents. Since the device is the device in the method in the embodiment of the present application, and the problem-solving principle of the device is similar to the method, the For the implementation of the device, reference may be made to the implementation of the method, and repeated descriptions will not be repeated.

Fig. 6 is a schematic diagram of a device for accessing component library documents provided by an embodiment of the present application. Please refer to Fig. 6. An embodiment of the present application provides a device for accessing component library documents, which includes:

The receiving module 601 is configured to receive an access instruction of the component library document, where the access instruction includes the component type of the target component document and the document identifier of the target component document;

The access module 602 is configured to retrieve a target access path corresponding to the above-mentioned component type from the main application according to the above-mentioned component type, and enter a sub-application corresponding to the above-mentioned component type according to the above-mentioned target access path;

The obtaining module 603 is configured to obtain the above-mentioned target component document from the above-mentioned sub-application based on the above-mentioned document identification, and display it on a display interface according to a preset format.

Optionally, the above-mentioned device also includes:

The switching module is used to cover the component documents currently displayed on the above-mentioned display interface with the component documents corresponding to the switching identifier contained in the above-mentioned switching instruction after receiving the switching instruction if the component documents of multiple component types are displayed in an overlay mode on the above-mentioned display interface. Component documentation.

Optionally, the above-mentioned device further includes a document generation module, and before the above-mentioned receiving module 601 is used to receive the access instruction of the component library document, the document generation module is used to:

For any component type, generate a sub-application corresponding to any of the above component types according to the configuration file related to any of the above component types;

Obtain the comment information of each of the above components based on the storage path corresponding to each component of any of the above component types through the document generator in the above sub-application;

Through the document generator in the above sub-application, the corresponding component document is generated according to the above-mentioned annotation information of each of the above-mentioned components, and stored in the corresponding sub-application.

Optionally, the above-mentioned configuration files related to any of the above-mentioned component types include public configuration files shared by each component type and private configuration files corresponding to any of the above-mentioned component types;

The above-mentioned document generating module is used to generate a sub-application corresponding to any of the above-mentioned component types according to a configuration file related to any of the above-mentioned component types, including:

A sub-application corresponding to any of the above component types is generated according to the above public configuration file and the private configuration file corresponding to any of the above component types.

Optionally, the above document generator is generated by:

According to the configuration item corresponding to the document generator in the configuration file corresponding to any of the above component types, generate the document generator in the sub-application corresponding to any of the above component types;

Wherein, the above-mentioned configuration items are generated by using new configuration items to overwrite default configuration items after the configuration format is adjusted.

Optionally, before the above-mentioned document generation module is used to generate the sub-application corresponding to any of the above-mentioned component types according to the configuration file related to any of the above-mentioned component types, it also includes:

The configuration file related to any one of the above component types is received through the access portal of the main application, and the configuration file related to any one of the above component types is stored in a preset storage area.

Based on the same disclosed concept, the embodiment of the present application also provides a component library document interrogation device, since this device is the device in the method in the embodiment of the present application, and the problem-solving principle of the device is similar to the method, Therefore, the implementation of the device can refer to the implementation of the method, and the repetition will not be repeated.

Those skilled in the art can understand that various aspects of the present application can be implemented as a system, method or program product. Therefore, various aspects of the present application can be specifically implemented in the following forms, that is: a complete hardware implementation, a complete software implementation (including firmware, microcode, etc.), or a combination of hardware and software implementations, which can be collectively referred to herein as "circuit", "module" or "system".

In some possible implementation manners, the device according to the present application may at least include at least one processor and at least one memory. Wherein, the memory stores program codes, and when the program codes are executed by the processor, the processor is made to execute the steps in the method for accessing the component library document described above in this specification according to various exemplary embodiments of the present application.

A device 700 according to this embodiment of the present application is described below with reference to FIG. 7 . The device 700 shown in FIG. 7 is only an example, and should not limit the functions and scope of use of this embodiment of the present application.

As shown in FIG. 7, device 700 is represented as a general-purpose device. Components of the device 700 may include, but are not limited to: the above-mentioned at least one processor 701, the above-mentioned at least one memory 702, and a bus 703 connecting different system components (including the memory 702 and the processor 701), wherein the memory stores program codes, when the program When the code is executed by the processor, it causes the processor to perform the following steps:

Receive an access instruction of the component library document, where the above access instruction includes the component type of the target component document and the document identifier of the above target component document;

According to the above-mentioned component type, retrieve the target access path corresponding to the above-mentioned component type from the main application, and enter the sub-application corresponding to the above-mentioned component type according to the above-mentioned target access path;

Based on the above-mentioned document identification, the above-mentioned target component document is obtained from the above-mentioned sub-application, and displayed on a display interface according to a preset format.

Bus 703 represents one or more of several types of bus structures, including a memory bus or memory controller, a peripheral bus, a processor, or a local bus using any of a variety of bus structures.

The memory 702 may include a readable medium in the form of a volatile memory, such as a random access memory (RAM) 7021 and/or a cache memory 7022 , and may further include a read only memory (ROM) 7023 .

Memory 702 may also include programs/utilities 7025 having a set (at least one) of program modules 7024 including, but not limited to, an operating system, one or more application programs, other program modules, and program data, which Each or some combination of the examples may include the implementation of a network environment.

Device 700 may also communicate with one or more external devices 704 (e.g., keyboards, pointing devices, etc.), and may also communicate with one or more devices that enable a user to interact with device 700, and/or communicate with Any device (eg, router, modem, etc.) that communicates with one or more other devices. Such communication may occur through input/output (I/O) interface 705 . Also, device 700 can communicate with one or more networks (eg, local area network (LAN), wide area network (WAN), and/or public networks, such as the Internet) via network adapter 706 . As shown, network adapter 706 communicates with other modules for device 700 over bus 703 . It should be understood that although not shown, other hardware and/or software modules may be used in conjunction with device 700, including but not limited to: microcode, device drivers, redundant processors, external disk drive arrays, RAID systems, tape drives, and Data backup storage system, etc.

Optionally, the above processor is also used for:

If component documents of multiple component types are displayed on the display interface in an overlay manner, after receiving the switching instruction, use the component document corresponding to the switching identifier included in the switching instruction to overwrite the component document currently displayed on the display interface.

Optionally, before receiving the access instruction of the component library document, the above processor is also used to:

For any component type, generate a sub-application corresponding to any of the above component types according to the configuration file related to any of the above component types;

Obtain the comment information of each of the above components based on the storage path corresponding to each component of any of the above component types through the document generator in the above sub-application;

Through the document generator in the above sub-application, the corresponding component document is generated according to the above-mentioned annotation information of each of the above-mentioned components, and stored in the corresponding sub-application.

Optionally, the above-mentioned configuration files related to any of the above-mentioned component types include public configuration files shared by each component type and private configuration files corresponding to any of the above-mentioned component types;

The above-mentioned processor is used to generate a sub-application corresponding to any of the above-mentioned component types according to a configuration file related to any of the above-mentioned component types, including:

A sub-application corresponding to any of the above component types is generated according to the above public configuration file and the private configuration file corresponding to any of the above component types.

Optionally, the above document generator is generated by:

According to the configuration item corresponding to the document generator in the configuration file corresponding to any of the above component types, generate the document generator in the sub-application corresponding to any of the above component types;

Wherein, the above-mentioned configuration items are generated by using new configuration items to overwrite default configuration items after the configuration format is adjusted.

Optionally, before generating the sub-application corresponding to any of the above component types according to the configuration file related to any of the above component types, the processor is further used to:

The configuration file related to any one of the above component types is received through the access portal of the main application, and the configuration file related to any one of the above component types is stored in a preset storage area.

In some possible implementations, various aspects of a method for accessing component library documents provided in this application can also be implemented in the form of a program product, which includes program codes. When the program product runs on a computer device, the program code It is used for causing a computer device to execute the steps in a method for accessing a component library document according to various exemplary embodiments of the present application described above in this specification.

A program product may take the form of any combination of one or more readable media. The readable medium may be a readable signal medium or a readable storage medium. A readable storage medium may be, for example, but not limited to, an electrical, magnetic, optical, electromagnetic, infrared, or semiconductor system, device, or device, or any combination thereof. More specific examples (non-exhaustive list) of readable storage media include: electrical connection with one or more conductors, portable disk, hard disk, random access memory (RAM), read only memory (ROM), erasable programmable read-only memory (EPROM or flash memory), optical fiber, portable compact disk read-only memory (CD-ROM), optical storage devices, magnetic storage devices, or any suitable combination of the foregoing.

The program product for monitoring according to the embodiment of the present application may adopt a portable compact disc read-only memory (CD-ROM) and include program codes, and may run on the device. However, the program product of the present application is not limited thereto. In this document, a readable storage medium may be any tangible medium containing or storing a program, and the program may be used by or in combination with an instruction execution system, device, or device.

A readable signal medium may include a data signal carrying readable program code in baseband or as part of a carrier wave. Such propagated data signals may take many forms, including but not limited to electromagnetic signals, optical signals, or any suitable combination of the foregoing. A readable signal medium may also be any readable medium other than a readable storage medium that can transmit, propagate, or transport a program for use by or in conjunction with an instruction execution system, apparatus, or device.

Program code embodied on a readable medium may be transmitted using any appropriate medium, including but not limited to wireless, wireline, optical fiber cable, RF, etc., or any suitable combination of the foregoing.

Program codes for performing the operations of the present application can be written in any combination of one or more programming languages, including object-oriented programming languages—such as Java, C++, etc., as well as conventional procedural programming Language - such as "C" or similar programming language. The program code can be executed entirely on the user equipment, partially on the user equipment, as an independent software package, partially on the user equipment and partially on the remote equipment, or entirely on the remote equipment or the server. In cases involving a remote device, the remote device may be connected to the user device through any kind of network, including a local area network (LAN) or a wide area network (WAN), or may be connected to an external device (such as through an Internet Service Provider). Internet connection).

It should be noted that although several units or subunits of the apparatus are mentioned in the above detailed description, this division is only exemplary and not mandatory. Actually, according to the embodiment of the present application, the features and functions of two or more units described above may be embodied in one unit. Conversely, the features and functions of one unit described above may be further divided to be embodied by a plurality of units.

In addition, while operations of the methods of the present application are depicted in the figures in a particular order, there is no requirement or implication that these operations must be performed in that particular order, or that all illustrated operations must be performed to achieve desirable results. Additionally or alternatively, certain steps may be omitted, multiple steps may be combined into one step for execution, and/or one step may be decomposed into multiple steps for execution.

Those skilled in the art should understand that the embodiments of the present application may be provided as methods, systems, or computer program products. Accordingly, the present application may take the form of an entirely hardware embodiment, an entirely software embodiment, or an embodiment combining software and hardware aspects. Furthermore, the present application may take the form of a computer program product embodied on one or more computer-usable storage media (including but not limited to disk storage, CD-ROM, optical storage, etc.) having computer-usable program code embodied therein.

The present application is described with reference to flowchart illustrations and block diagrams of methods, apparatus (systems), and computer program products according to embodiments of the present application. It should be understood that each procedure and/or block in the flowchart and block diagrams, and combinations of procedures and blocks in the flowchart and block diagrams, can be implemented by computer program instructions. These computer program instructions may be provided to a general purpose computer, special purpose computer, embedded processor, or processor of other programmable data processing equipment to produce a machine such that the instructions executed by the processor of the computer or other programmable data processing equipment produce a An apparatus for realizing the functions specified in one or more procedures of the flowchart and one or more blocks of the block diagram.

These computer program instructions may also be stored in a computer-readable memory capable of directing a computer or other programmable data processing apparatus to operate in a specific manner, such that the instructions stored in the computer-readable memory produce an article of manufacture comprising instruction means, the instructions The device realizes the function specified in one or more procedures of the flowchart and one or more blocks of the block diagram.

These computer program instructions can also be loaded onto a computer or other programmable data processing device, causing a series of operational steps to be performed on the computer or other programmable device to produce a computer-implemented process, thereby The instructions provide steps for implementing the functions specified in the flow diagram flow or flow and block diagram flow or block.

While preferred embodiments of the present application have been described, additional changes and modifications to these embodiments can be made by those skilled in the art once the basic inventive concept is appreciated. Therefore, the appended claims are intended to be construed to cover the preferred embodiment and all changes and modifications which fall within the scope of the application.

Obviously, those skilled in the art can make various changes and modifications to the application without departing from the spirit and scope of the application. In this way, if these modifications and variations of the present application fall within the scope of the claims of the present application and their equivalent technologies, the present application is also intended to include these modifications and variations.

Claims (10)

1. A component library document access method, characterized in that, comprising: receiving an access instruction of the component library document, wherein the access instruction includes the component type of the target component document and the document identifier of the target component document; Retrieving a target access path corresponding to the component type from the main application according to the component type, and entering a sub-application corresponding to the component type according to the target access path; Based on the document identifier, the target component document is obtained from the sub-application, and displayed on a display interface according to a preset format. 2. The method according to claim 1, characterized in that the method further comprises: If multiple component types of component documents are displayed on the display interface in an overlay manner, after receiving the switching instruction, use the component document corresponding to the switching identifier included in the switching instruction to overwrite the component document currently displayed on the display interface . 3. The method according to claim 1 or 2, wherein, before receiving the access instruction of the component library document, further comprising: For any component type, generating a sub-application corresponding to any component type according to a configuration file related to the any component type; Acquiring annotation information of each component based on a storage path corresponding to each component of any component type through the document generator in the sub-application; Through the document generator in the sub-application, the corresponding component document is generated according to the annotation information of each of the components, and stored in the corresponding sub-application. 4. The method according to claim 3, wherein the configuration files related to any component type include a public configuration file shared by each component type and a private configuration file corresponding to any component type ; Generating a sub-application corresponding to any component type according to a configuration file related to any component type, including: A sub-application corresponding to any component type is generated according to the public configuration file and the private configuration file corresponding to the any component type. 5. The method according to claim 3, wherein the document generator is generated in the following manner: generating the document generator in the sub-application corresponding to the any component type according to the configuration item corresponding to the document generator in the configuration file corresponding to the any component type; Wherein, the configuration items are generated by using new configuration items to overwrite default configuration items after the configuration format is adjusted. 6. The method according to claim 3, further comprising: The configuration file related to any component type is received through the access entry of the main application, and the configuration file related to the any component type is stored in a preset storage area. 7. A component library document access device, characterized in that it comprises: A receiving module, configured to receive an access instruction of the component library document, wherein the access instruction includes the component type of the target component document and the document identifier of the target component document; An access module, configured to retrieve a target access path corresponding to the component type from the main application according to the component type, and enter a sub-application corresponding to the component type according to the target access path; An acquisition module, configured to acquire the target component document from the sub-application based on the document identifier, and display it on a display interface in a preset format. 8. A component library document access device, characterized in that the device comprises: processor; memory for storing said processor-executable instructions; Wherein, the processor is configured to execute the instructions, so as to realize the steps of the method according to any one of claims 1-6. 9. A computer-readable storage medium, characterized in that it includes computer-readable instructions, and when the computer reads and executes the computer-readable instructions, the computer executes the method according to any one of claims 1 to 6 step. 10. A computer program product, characterized in that it comprises a computer program, and the computer program is stored in a computer-readable storage medium; When the processor of the component library document access device reads the computer program from the computer-readable storage medium, the processor executes the computer program, so that the electronic device executes any one of claims 1 to 6. steps of the method described above.

Images