CN113296763A - Application capability management method and system - Google Patents
Application capability management method and system Download PDFInfo
- Publication number
- CN113296763A CN113296763A CN202110565492.9A CN202110565492A CN113296763A CN 113296763 A CN113296763 A CN 113296763A CN 202110565492 A CN202110565492 A CN 202110565492A CN 113296763 A CN113296763 A CN 113296763A
- Authority
- CN
- China
- Prior art keywords
- information
- design document
- application capability
- class
- design
- Prior art date
- Legal status (The legal status is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the status listed.)
- Granted
Links
Images
Classifications
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F8/00—Arrangements for software engineering
- G06F8/30—Creation or generation of source code
- G06F8/35—Creation or generation of source code model driven
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F40/00—Handling natural language data
- G06F40/10—Text processing
- G06F40/166—Editing, e.g. inserting or deleting
- G06F40/186—Templates
-
- Y—GENERAL TAGGING OF NEW TECHNOLOGICAL DEVELOPMENTS; GENERAL TAGGING OF CROSS-SECTIONAL TECHNOLOGIES SPANNING OVER SEVERAL SECTIONS OF THE IPC; TECHNICAL SUBJECTS COVERED BY FORMER USPC CROSS-REFERENCE ART COLLECTIONS [XRACs] AND DIGESTS
- Y02—TECHNOLOGIES OR APPLICATIONS FOR MITIGATION OR ADAPTATION AGAINST CLIMATE CHANGE
- Y02P—CLIMATE CHANGE MITIGATION TECHNOLOGIES IN THE PRODUCTION OR PROCESSING OF GOODS
- Y02P90/00—Enabling technologies with a potential contribution to greenhouse gas [GHG] emissions mitigation
- Y02P90/30—Computing systems specially adapted for manufacturing
Abstract
The invention provides an application capability management method and system, which relate to the technical field of software development and comprise the following steps: defining a detailed design document template; a designer writes a design document according to the design document template; automatically generating a service code according to the design document; analyzing the service code to obtain application capability information; and displaying the acquired application capability information and assisting designers to further write design documents. The invention has the beneficial effects that: designing a document template, and acquiring key information of the service to the maximum extent by limiting the format of the design document; after the designer fills in the design document template, the service code can be automatically generated according to the service key information recorded in the template, so that the repetitive work of the developer is greatly reduced, and low-level errors such as key content omission are avoided; meanwhile, the codes are directly analyzed to obtain the relevant capability information of the codes, so that designers can know the overall situation, the rationality of the current design can be judged, and more reasonable design documents can be written.
Description
Technical Field
The invention relates to the technical field of software development, in particular to an application capability management method and system.
Background
In the daily development process, on one hand, the code capability information needs manual maintenance, so that the code capability information is repetitive work, the technical content is low, and the error is easy to make for developers. For example: (1) the process of translating the service definition part in the design document into the service code generally needs to translate the contents of service name, interface name, class name, access and reference entity class, public annotation, reference package, calling of existing capability and the like; (2) extracting a service interface document from the latest service code, and deriving an Excel form, wherein the process needs to extract detailed information including a service name, an attribution application, a Chinese remark, a developer name, a mobile phone number, access and reference information and the like; on the other hand, when designing documents, designers cannot judge the rationality of the current design according to the overall situation of the existing capabilities, such as the need to know the existing capabilities, the capability utilization rate, the capability of identifying too low a utilization rate, the number and the difference of the same type of capabilities; call relationships between capabilities.
Disclosure of Invention
Aiming at the problems, the invention provides an application capability management method and system, which can automatically manage the original code capability information manually maintained, reduce the repetitive work of developers, improve the development quality, and automatically analyze the existing codes to obtain the code capability information, thereby being convenient for guiding the designers to evaluate the rationality of the current design.
In order to achieve the above object, the present invention discloses an application capability management method, which comprises:
defining a detailed design document template;
a designer writes a design document according to the design document template;
automatically generating a service code according to the design document;
analyzing the service code to obtain application capability information;
and displaying the acquired application capability information, and assisting designers to further write design documents.
As a further improvement of the invention, the design document template comprises logic description, task class, request input, request output, logic, data access layer information and class description information.
As a further improvement of the present invention, when the designer writes the design document according to the design document template, if there is no new component, the data access layer information and the class description information do not need to be filled in.
As a further improvement of the present invention, the automatically generating service code according to the design document; the method comprises the following steps:
dividing the content in the design document into a static part and a dynamic part;
generating service code information and component code information according to logic description, task class, request input, request output, data access layer and class description information in the design document aiming at the static part;
and aiming at the dynamic part, generating a calling code for the existing service and component according to the logic information in the design document.
As a further improvement of the present invention, for the static part, it includes:
generating a package, a class, an interface, a reference class, a function annotation, a function access parameter and an access parameter class, an attribute and an attribute annotation of a service code according to the logic description, the task class, the request input and the response output information in the design document;
and generating a package, a class, an interface, a function, a comment, a metadata class and a data access class of the component according to the data access layer and the class description information in the design document.
As a further improvement of the present invention, the analyzing the service code obtains application capability information; the method comprises the following steps:
analyzing the service code to obtain a related information record database;
analyzing the component codes to obtain a related information record database;
and analyzing the data access layer and the metadata codes to obtain a related information record database.
As a further improvement of the invention, the api document information is generated by using the service as an entrance according to the analyzed service code.
As a further improvement of the present invention, the displaying of the obtained application capability information assists designers to further compile design documents; the method comprises the following steps:
and generating an application capability list, and displaying basic information of the application capability, including application capability names, descriptions, application ranges and access reference lists.
As a further improvement of the invention, the scope of use includes the call chain of capabilities and by which applications they are called.
The invention also discloses an application capability management system, which comprises: the system comprises a template definition module, a document compiling module, a code generating module, a capability information acquiring module and a capability information displaying module;
the template definition module is configured to:
defining a detailed design document template;
the document writing module is configured to:
a designer writes a design document according to the design document template;
the code generation module is configured to:
automatically generating a service code according to the design document;
the capability information obtaining module is configured to:
analyzing the service code to obtain application capability information;
the capability information display module is used for:
and displaying the acquired application capability information, and assisting designers to further write design documents.
Compared with the prior art, the invention has the beneficial effects that:
according to the method, the core thought of a designer is fully mastered by designing a document template, the format of a design document is limited, and the key information of the service is acquired to the maximum extent; after the designer fills in the design document template, the service code can be automatically generated according to the service key information recorded in the template, so that the repetitive work of the developer is greatly reduced, and key content omission and low-level errors caused by corresponding manual writing of the service code are avoided; meanwhile, the invention can directly analyze the code to obtain the relevant capability information of the code for the query of designers, so that the designers can know the overall situation, judge the rationality of the current design and write more reasonable design documents.
Compared with the prior art that the related capability information is obtained according to the design document, the method can avoid obtaining wrong capability information when the design document and the code are deviated, and meanwhile, the timeliness and the integrity of the information can be guaranteed.
After the service code is generated, the api document is automatically generated by analyzing the service code, so that the api document can be kept synchronous with the code all the time, and developers do not need to spend energy on modifying the api document.
Drawings
FIG. 1 is a flowchart of an application capability management method according to an embodiment of the present invention;
FIG. 2 is a diagram of an application capability management system according to an embodiment of the present invention;
FIG. 3 is a schematic diagram of a closed loop effect of development and design implemented by the application capability management method according to an embodiment of the present invention;
fig. 4 is a timing diagram illustrating an application capability management method according to an embodiment of the present invention.
Detailed Description
In order to make the objects, technical solutions and advantages of the embodiments of the present invention clearer, the technical solutions in the embodiments of the present invention will be clearly and completely described below with reference to the drawings in the embodiments of the present invention, and it is obvious that the described embodiments are some, but not all, embodiments of the present invention. All other embodiments, which can be obtained by a person skilled in the art without any inventive step based on the embodiments of the present invention, are within the scope of the present invention.
The invention is described in further detail below with reference to the attached drawing figures:
as shown in fig. 1, the application capability management method provided by the present invention includes:
s1, defining a detailed design document template;
wherein, the template content comprises:
(1) a logical description, comprising: service name, service description;
(2) a task class comprising: interface, implementation class, function;
(3) request input, example:
| name of parent element | Element name | Constraining | Type (B) | Length of | Description of the invention | Description of values |
| BUSI_INFO | CONTRACT_NO | 1 | Long | 20 | Account id | Account id |
(4) request output, example:
(5) logic, comprising: existing capabilities invoked and other steps;
(6) a data access layer comprising: newly adding data access and newly adding sql, and if no newly added component exists, filling the part;
(7) class descriptions, including: interface name, class name, related description, access reference information and logic of the newly added component;
s2, the designer writes the design document according to the design document template;
wherein the content of the first and second substances,
logic description, task class, request input, request output, and logic are mandatory items;
regarding the data access layer, if no new component is added, filling is not needed; regarding class descriptions, if only the existing component is called, no new component is added and filling is not needed.
And S3, automatically generating service codes according to the design document, and reducing the low-technology content and repetitive work of developers.
Wherein the content of the first and second substances,
dividing the content in the design document into a static part and a dynamic part;
for the static part:
generating a package, a class, an interface, a reference class, a function annotation, a function access and access-reference class, an attribute annotation and the like of the service code according to (1) logic description, (2) task class, (3) request input and (4) response output in the design document;
generating a package, a class, an interface, a function, an annotation, a metadata class and a data access class of the component according to the (6) data access layer and the (7) class description in the design document;
for the dynamic part:
according to the logic (5) in the template, the logic realization of the function is obtained, the calling codes of the existing service and assembly are generated, and the entry parameters of the function are spliced automatically;
and finally, splicing the dynamic and static partial codes to obtain a complete service code.
S4, analyzing the service code to obtain application capability information;
wherein, include:
(1) automatically analyzing the service code, acquiring related information including service name, class name, function name, annotation, access parameter information and the like, and recording the information into a database;
(2) automatically analyzing the component code, acquiring related information including class name, function name, annotation, access parameter information, etc., and recording the information into database
(3) Analyzing a data access layer and metadata codes, wherein the data access layer and the metadata codes comprise class names, function names, comments, access parameter information and sql information, and recording the information into a database;
furthermore, extracting by taking the service as an entrance according to the information in the database, generating an api document, and writing the api document into Excel.
And S5, displaying the acquired application capability information and assisting designers to further write design documents.
Wherein the content of the first and second substances,
processing according to the acquired capability information to generate a capability list, wherein the list comprises the use range of each capability, and the method specifically comprises the following steps: a chain of calls for that capability, by which other capabilities are called;
basic information of the capability is then presented, including the capability name, description, and access list.
As shown in fig. 2, the application capability management system provided by the present invention includes: the system comprises a template definition module, a document compiling module, a code generating module, a capability information acquiring module and a capability information displaying module;
a template definition module to:
defining a detailed design document template;
a document writing module to:
a designer writes a design document according to the design document template;
a code generation module to:
automatically generating a service code according to the design document;
a capability information acquisition module to:
analyzing the service code to obtain application capability information;
a capability information presentation module for:
and displaying the acquired application capability information and assisting designers to further write design documents.
As shown in fig. 3 and 4, the present invention implements a closed loop for programming and development, including:
in the development mode, the first and second development modes,
automatically generating a service code by designing a document, and storing the service code in a database;
in the design mode, the first and second electrodes are,
and acquiring the application capability through codes stored in the database, and providing guidance for program design.
The invention has the advantages that:
according to the method, the core thought of a designer is fully mastered by designing a document template, the format of a design document is limited, and the key information of the service is acquired to the maximum extent; after the designer fills in the design document template, the service code can be automatically generated according to the service key information recorded in the template, so that the repetitive work of the developer is greatly reduced, and key content omission and low-level errors caused by corresponding manual writing of the service code are avoided; meanwhile, the invention can directly analyze the code to obtain the relevant capability information of the code for the query of designers, so that the designers can know the overall situation, judge the rationality of the current design and write more reasonable design documents.
Compared with the prior art that the related capability information is obtained according to the design document, the method can avoid obtaining wrong capability information when the design document and the code are deviated, and meanwhile, the timeliness and the integrity of the information can be guaranteed.
After the service code is generated, the api document is automatically generated by analyzing the service code, so that the api document can be kept synchronous with the code all the time, developers do not need to spend energy on modifying the api document, and omission and errors caused by manual modification are avoided.
The designer can inquire related capability information through keywords, wherein the related capability information comprises capability calling information, data of similar capabilities and differences, so that a more reasonable design document can be compiled, and the operation and maintenance personnel can easily know the general view of the project.
The above is only a preferred embodiment of the present invention, and is not intended to limit the present invention, and various modifications and changes will occur to those skilled in the art. Any modification, equivalent replacement, or improvement made within the spirit and principle of the present invention should be included in the protection scope of the present invention.
Claims (10)
1. An application capability management method, comprising:
defining a detailed design document template;
a designer writes a design document according to the design document template;
automatically generating a service code according to the design document;
analyzing the service code to obtain application capability information;
and displaying the acquired application capability information, and assisting designers to further write design documents.
2. The application capability management method according to claim 1, wherein the design document template includes logic description, task class, request input, request output, logic, data access layer information, and class specification information.
3. The application capability management method according to claim 2, wherein when the designer writes a design document based on the design document template, if no new component is added, the data access layer information and the class description information do not need to be filled in.
4. The application capability management method according to claim 1, characterized in that: automatically generating a service code according to the design document; the method comprises the following steps:
dividing the content in the design document into a static part and a dynamic part;
generating service code information and component code information according to logic description, task class, request input, request output, data access layer and class description information in the design document aiming at the static part;
and aiming at the dynamic part, generating a calling code for the existing service and component according to the logic information in the design document.
5. The application capability management method according to claim 4, comprising, for the static part:
generating a package, a class, an interface, a reference class, a function annotation, a function access parameter and an access parameter class, an attribute and an attribute annotation of a service code according to the logic description, the task class, the request input and the response output information in the design document;
and generating a package, a class, an interface, a function, a comment, a metadata class and a data access class of the component according to the data access layer and the class description information in the design document.
6. The application capability management method according to claim 1, wherein the parsing the service code obtains application capability information; the method comprises the following steps:
analyzing the service code to obtain a related information record database;
analyzing the component codes to obtain a related information record database;
and analyzing the data access layer and the metadata codes to obtain a related information record database.
7. The application capability management method according to claim 6, characterized in that: and generating the api document information by taking the service as an entrance according to the analyzed service code.
8. The application capability management method according to claim 1, wherein the displaying the obtained application capability information assists designers to further write design documents; the method comprises the following steps:
and generating an application capability list, and displaying basic information of the application capability, including application capability names, descriptions, application ranges and access reference lists.
9. The application capability management method of claim 8, wherein the usage scope comprises a call chain of capabilities and which applications are called.
10. A system for implementing the application capability management method according to any one of claims 1 to 9, comprising: the system comprises a template definition module, a document compiling module, a code generating module, a capability information acquiring module and a capability information displaying module;
the template definition module is configured to:
defining a detailed design document template;
the document writing module is configured to:
a designer writes a design document according to the design document template;
the code generation module is configured to:
automatically generating a service code according to the design document;
the capability information obtaining module is configured to:
analyzing the service code to obtain application capability information;
the capability information display module is used for:
and displaying the acquired application capability information, and assisting designers to further write design documents.
Priority Applications (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN202110565492.9A CN113296763B (en) | 2021-05-24 | 2021-05-24 | Application capability management method and system |
Applications Claiming Priority (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN202110565492.9A CN113296763B (en) | 2021-05-24 | 2021-05-24 | Application capability management method and system |
Publications (2)
| Publication Number | Publication Date |
|---|---|
| CN113296763A true CN113296763A (en) | 2021-08-24 |
| CN113296763B CN113296763B (en) | 2023-07-04 |
Family
ID=77324261
Family Applications (1)
| Application Number | Title | Priority Date | Filing Date |
|---|---|---|---|
| CN202110565492.9A Active CN113296763B (en) | 2021-05-24 | 2021-05-24 | Application capability management method and system |
Country Status (1)
| Country | Link |
|---|---|
| CN (1) | CN113296763B (en) |
Citations (8)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN101030229A (en) * | 2002-07-19 | 2007-09-05 | Jgr阿奎西申公司 | Method for changing document semanteme coded and sent by source semanteme edition |
| US20090063493A1 (en) * | 2007-09-04 | 2009-03-05 | Kyocera Mila Corporation | Information Processing Apparatus |
| US20130339841A1 (en) * | 2012-06-14 | 2013-12-19 | Open Text S.A. | Systems and methods of a script generation engine |
| CN104484216A (en) * | 2014-12-29 | 2015-04-01 | 广州唯品会网络技术有限公司 | Method and device for generating service interface document and on-line test tool |
| CN106886406A (en) * | 2017-01-19 | 2017-06-23 | 阿里巴巴集团控股有限公司 | The generation method and device of exploitation code or document |
| CN107885499A (en) * | 2017-10-19 | 2018-04-06 | 平安壹钱包电子商务有限公司 | A kind of interface document generation method and terminal device |
| US20180349103A1 (en) * | 2017-06-03 | 2018-12-06 | Apple Inc. | Integration of learning models into a software development system |
| CN110806863A (en) * | 2019-11-05 | 2020-02-18 | 泰康保险集团股份有限公司 | Interface document generation method and device, electronic equipment and storage medium |
-
2021
- 2021-05-24 CN CN202110565492.9A patent/CN113296763B/en active Active
Patent Citations (8)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN101030229A (en) * | 2002-07-19 | 2007-09-05 | Jgr阿奎西申公司 | Method for changing document semanteme coded and sent by source semanteme edition |
| US20090063493A1 (en) * | 2007-09-04 | 2009-03-05 | Kyocera Mila Corporation | Information Processing Apparatus |
| US20130339841A1 (en) * | 2012-06-14 | 2013-12-19 | Open Text S.A. | Systems and methods of a script generation engine |
| CN104484216A (en) * | 2014-12-29 | 2015-04-01 | 广州唯品会网络技术有限公司 | Method and device for generating service interface document and on-line test tool |
| CN106886406A (en) * | 2017-01-19 | 2017-06-23 | 阿里巴巴集团控股有限公司 | The generation method and device of exploitation code or document |
| US20180349103A1 (en) * | 2017-06-03 | 2018-12-06 | Apple Inc. | Integration of learning models into a software development system |
| CN107885499A (en) * | 2017-10-19 | 2018-04-06 | 平安壹钱包电子商务有限公司 | A kind of interface document generation method and terminal device |
| CN110806863A (en) * | 2019-11-05 | 2020-02-18 | 泰康保险集团股份有限公司 | Interface document generation method and device, electronic equipment and storage medium |
Non-Patent Citations (2)
| Title |
|---|
| S. CHOUDHARY 等: "SPEC2REST: An Approach for Eliciting Web API Resources from Existing Applications", 《2017 IEEE INTERNATIONAL CONFERENCE ON WEB SERVICES (ICWS)》, pages 910 - 913 * |
| 翁丹玉 等: "开放数据平台的接口服务研究及应用探讨", 《数据分析与知识发现》, vol. 01, no. 08, pages 92 - 99 * |
Also Published As
| Publication number | Publication date |
|---|---|
| CN113296763B (en) | 2023-07-04 |
Similar Documents
| Publication | Publication Date | Title |
|---|---|---|
| US8392873B2 (en) | Methods and apparatus for implementing model-based software solution development and integrated change management | |
| US11526656B2 (en) | Logical, recursive definition of data transformations | |
| CN103412853B (en) | A kind of automatic example generation method for file convertor | |
| CN107220274B (en) | Visual data interface market realization method | |
| CN108762743B (en) | Data table operation code generation method and device | |
| CN106951231B (en) | Computer software development method and device | |
| CN104881275A (en) | Electronic spreadsheet generating method and device | |
| CN114153459A (en) | Interface document generation method and device | |
| CN114281342A (en) | Automatic code generation method | |
| CN112799718A (en) | Enumerated document generation method and device, electronic equipment and storage medium | |
| US8131776B2 (en) | Automated migration of translation maps for use in exchanging documents between entities | |
| CN113655996B (en) | Enterprise-level system generation method based on demand model | |
| CN109542418B (en) | Service code generation method and computer terminal | |
| US8607201B2 (en) | Augmenting visualization of a call stack | |
| CN112114810A (en) | Compiling processing method and device | |
| CN111881660A (en) | Report generation method and device, computer equipment and storage medium | |
| US9383972B2 (en) | Methods and arrangements for processing and presentation of information | |
| CN113296763A (en) | Application capability management method and system | |
| Elkashef et al. | Mapping UML sequence diagram into the web ontology language OWL | |
| US10606728B2 (en) | Framework for detecting source code anomalies | |
| Laleau et al. | Using formal metamodels to check consistency of functional views in information systems specification | |
| CN113254455A (en) | Dynamic configuration method and device of database, computer equipment and storage medium | |
| CN111325007A (en) | Comment analyzing method and terminal for PPTX file | |
| CN101126983A (en) | Structural model merge method and system | |
| US20240086163A1 (en) | Iterative and interactive method for code conversion |
Legal Events
| Date | Code | Title | Description |
|---|---|---|---|
| PB01 | Publication | ||
| PB01 | Publication | ||
| SE01 | Entry into force of request for substantive examination | ||
| SE01 | Entry into force of request for substantive examination | ||
| GR01 | Patent grant | ||
| GR01 | Patent grant |