CN111930354B

CN111930354B - Framework component system for software development and construction method thereof

Info

Publication number: CN111930354B
Application number: CN202010806958.5A
Authority: CN
Inventors: 周正斌; 杨岗; 廖文绪
Original assignee: Creative Information Technology Co ltd
Current assignee: Creative Information Technology Co ltd
Priority date: 2020-08-12
Filing date: 2020-08-12
Publication date: 2021-07-13
Anticipated expiration: 2040-08-12
Also published as: CN111930354A

Abstract

The invention discloses a framework component for software development and a construction method thereof, which are applied to a web back-end development framework and comprise an interface configuration component for providing an interface tool for application, so that a developer configures an interface according to requirements without developing codes; the file uploading component provides a public API for uploading and downloading files for the application, and the API is directly used for completing file uploading or downloading requirement development; the workflow component independently provides flow service and visual management for a development framework, and coordinates data, business activities and developers; the timing task component deploys and manages timing tasks for applications, and realizes adjustment of the timing tasks in a non-stop state; the system management component provides a management interface for the web back-end development framework and can manage the authority, role, mechanism, user and the like of the system. According to the scheme, the framework component can be provided for the web back-end development framework, so that the framework can realize componentized development, and the software development efficiency of software developers is further improved.

Description

Framework component system for software development and construction method thereof

Technical Field

The invention relates to the technical field of software development, in particular to a framework component system for software development and a construction method thereof.

Background

The scale of the existing project becomes larger and larger along with the increase of the demand, the increase of the scale brings much trouble, various business errors are complicatedly interwoven together, codes are not constrained among each business module, the fuzziness of code boundaries is brought, code conflicts occur at any time, and a small problem of change can cause new problems. Therefore, the concept of modular development is proposed, wherein the modular development is a way for efficiently processing complex application systems and better defining the function of a functional module, and a single component comprises four parts, namely a template, a data structure, a program and a style, and expresses the function provided by the component and the parameters required by calling the function through an interface of the component. The components can be developed and tested independently, and multiple persons are allowed to cooperate, write, develop and research different functional modules simultaneously. In the process of developing by utilizing components, the existing development framework has poor project expansibility, the integration of a new development technology is very unfriendly, developers need to integrate related technologies by themselves, and the existing development framework cannot completely support cross-platform development and deployment.

Disclosure of Invention

The invention aims to overcome the defects of the prior art, provides a framework component system for software development and a construction method thereof, provides a framework component for a web back-end development framework, integrates a plurality of component functions, and encapsulates the components to form a framework component library, thereby greatly improving the development efficiency of developers and improving the development flexibility and comprehensiveness of the framework.

The purpose of the invention is realized by the following technical scheme:

a framework component system for software development is applied to a web back-end development framework and comprises an interface configuration component, a framework component and a framework component, wherein the interface configuration component is used for providing an interface tool for an application, so that a developer can configure an interface according to requirements without developing any code;

the file uploading component is used for providing a public API for uploading and downloading files for the application, so that developers can directly use the API to complete file uploading or downloading requirement development;

the workflow component is used for independently providing flow service and visual management for a development framework, and coordinating data, business activities and developers;

the timing task component is used for deploying and managing timing tasks for the application and adjusting the timing tasks in a non-stop state;

and the system management component is used for providing a management interface for the web back-end development framework, so that managers can operate and manage the authority, role, mechanism, user and the like of the system.

Specifically, the interface configuration component comprises a dynamic interface module and an interface configuration module; the dynamic interface module is used for inquiring the URL and request parameters of the interface and intercepting illegal URLs and requests; the interface configuration module is used for configuring, testing and releasing the interface on the UI interface.

Specifically, the file uploading component comprises a file storage module, a file uploading module and a file downloading module; the file storage module is used for storing all files of the frame in a file server mode; the file uploading module is used for recording metadata uploaded by the file through a database; the file downloading module is used for inquiring the storage path of the file from the database and then calling the API interface for downloading the file to download the file.

Specifically, the metadata includes a file name, a file type, a file batch number, and a file saving path, where the file saving path corresponds to a storage path of the file on the file server.

Specifically, the workflow component comprises a model management module, a process definition management module and a process task management module; the model management module is used for providing a visual management interface and a design interface for the workflow model table and realizing the import and export of the model and the deployment of the model; the flow definition management module is used for providing a visual management interface for flow definition and realizing the definition and deployment of the flow; the flow task management module is used for creating a flow and managing the scheduling execution condition of the flow task.

Specifically, the timed task component comprises a task storage module, a task management module and a task deployment module; the task storage module is used for storing metadata information and logs of the timing task; the task management module is used for providing a task management interface and managing a task state and a task database; the task deployment module is used for deploying the timing task on a single machine or a plurality of machines in a single deployment or distributed deployment mode to execute.

Specifically, the system management component comprises an organization management module, a user management module, a role management module, a menu management module, a post management module and a permission management module.

A method of building a framework component system for software development, the method comprising the steps of:

s1, designing a basic framework of the framework, building a basic function module of the framework according to the framework, and providing a dependence foundation for the framework assembly;

s2, designing a framework component architecture, and determining the component functions and the component service logic of the web back-end development framework according to the service requirements;

s3, selecting component development component functions corresponding to the component functions based on the basic function module, and designing a database table corresponding to the component functions;

and S4, testing the developed component functions, and packaging the components to form a component library of the frame after the tests are correct.

The invention has the beneficial effects that: according to the scheme, a plurality of important components in software development are integrated, corresponding design is achieved, the components are enabled to be more consistent with habits of developers in use while configuration is simplified, a framework component can be provided for a web back-end development framework, development efficiency of the developers is greatly improved, and development flexibility and comprehensiveness of the framework are improved.

Drawings

Fig. 1 is a frame assembly architecture diagram of the present invention.

FIG. 2 is a flow chart of a framework component construction method of the present invention.

Fig. 3 is a flow chart of the interface configuration of the present invention.

Detailed Description

In order to more clearly understand the technical features, objects, and effects of the present invention, embodiments of the present invention will now be described with reference to the accompanying drawings.

In this embodiment, as shown in fig. 1, a framework component system for software development is applied to a web backend development framework, and includes an interface configuration component, a file upload component, a timing task component, and a system management component, and also provides a function of a custom component for developers, and the developers can perform definition development of the components according to their own needs. The interface configuration component is used for providing an interface tool for the application, so that a developer can configure the interface according to requirements without developing any code. The file uploading component is used for providing a common API for uploading and downloading files for the application, so that developers can directly use the API to complete file uploading or downloading requirement development. The workflow component is used for independently providing flow service and visual management for the development framework, and coordinating data, business activities and developers. The timing task component is used for deploying and managing timing tasks for the application and adjusting the timing tasks in a non-stop state. The system management component is used for providing a management interface for the web back-end development framework, so that management personnel can operate and manage the authority, role, mechanism, user and the like of the system.

Specifically, the timing task component comprises a task storage module, a task management module and a task deployment module; the task storage module is used for storing metadata information and logs of the timing task; the task management module is used for providing a task management interface and managing a task state and a task database; the task deployment module is used for deploying the timing task on a single machine or a plurality of machines in a single deployment or distributed deployment mode to execute.

In this embodiment, as shown in fig. 2, a method for constructing a framework component system for software development is further provided, where the method includes the following steps:

step 1, designing a basic framework of the framework, building a basic function module of the framework according to the framework, and providing a dependence foundation for the framework assembly.

And 2, designing a framework component framework, and determining the component functions and the component service logic of the web back-end development framework according to the service requirements.

And 3, selecting component development component functions corresponding to the component functions based on the basic function module, and designing a database table corresponding to the component functions.

And 4, testing the developed component functions, and packaging the components to form a component library of the frame after the tests are correct.

In this embodiment, before component development, a web backend is required to develop and build a corresponding basic function module, which mainly includes a dynamic data source module, a Druid connection pool module, a cache module, a log management module, an asynchronous processing module, a global exception handling module, an ID generator module, an automatic audit module, a paging plug-in module, a slow query tracking module, and the like. And designing a component functional module architecture and specifically realizing corresponding functional service logic on the basis of the basic functional module. The components in the component functional modules are independent of each other, but all depend on common-core implementation of common packets in the base functional module. The currently implemented components include an interface configuration component, a file upload component, a workflow component, a timed task component, and a system management component.

The interface configuration component aims at providing an interface configuration tool for the application, so that a user can configure an interface meeting the requirement without developing any code, and the design and construction process is as follows:

dynamic interface: and a universal url is intercepted in an interceptor mode. This url will prefix all interfaces configured by the interface configuration tool. All the interfaces are stored in the database after being configured. The database designs two tables: interface _ info and interface _ release. interface _ info records the configuration information of the interface, and interface _ release records the information of the sql script of the interface. When the interface request is carried out, the interceptor is firstly moved, and then the url of the interface and the request parameter are inquired whether to be legal or not through the interface _ info. If the received configuration information is legal, the interface _ release is used for acquiring the SQL script and returning the configuration information, and corresponding processing is performed after execution and then the configuration information is returned.

Interface configuration: the whole interface configuration, test and release are completed in one-stop mode through the UI. As shown in fig. 3, an interface configuration flow of the interface configuration component is that interface creation is performed on a page, and url and an access mode of interface access to be formulated are POST or GET; in the parameter definition area, configuring request parameters of a test interface, wherein the parameters only support a JSON format; configuring SQL sentences for accessing the database in the main working area; configuring an entity returned by the interface in the main working area; testing whether the return interface is expected through the test button; and finally, issuing an interface through an issuing button.

The file upload component is intended to provide a common API for file upload and download for applications. When a developer has file uploading or downloading requirements, the developer can directly use the API to complete development, and the main design and construction process is as follows:

file storage: all files are stored by means of a file server, and the file server provides an sftp protocol for communication.

Uploading a file: the database is used to record metadata of file uploads, including file name, file category, file batch number, file save path, etc. Wherein the file saving path corresponds to a storage path of the file on the file server.

Downloading a file: and inquiring the storage path of the file from the database, and calling an API (application programming interface) for downloading the file to download.

In the embodiment, in order to improve the productivity of Web developers to the maximum extent, the invention discloses a set of base workflow components which are not directly embedded into a business system but are independently deployed into services, an interface is exposed for the calling of the business system, and the coupling with the business system is reduced. The main design and construction process is as follows:

model management design: mainly, the method includes the following steps of CURD operation on a workflow MODEL table (ACT _ RE _ MODEL) and some extended functions, such as: and model import and export, model deployment and the like. The model is the beginning of the process, and the design of the process is the design process of the model; the definition file of the process, namely bpmn file, can be exported through the model, and can be used for the deployment of the process. The model management function provides a visual management interface and a design interface.

Flow definition management design: the flow must be defined before the workflow is used, which defines that the flow is also to be deployed. To deploy a process, they have to be packaged in a business document. One business document is a unit of workflow engine deployment. A service document corresponds to a compressed file that contains BPMN2.0 procedures, task forms, rules and any other type of file. In general, a business document is a container that contains named resources. When a business document is deployed, it will automatically scan BPMN files with either.bpmn 20.xml or.bpmn as an extension. Each file will be parsed and may contain multiple process definitions. The process definition provides a visual management interface, and the process model is deployed in the workflow component after being designed and is not deployed in the business system.

Starting a flow design: with the flow definition, a flow instance can be created. A new process instance is started, using the id defined in the process definition (corresponding to the process element in the XML file). Note that the ID here should be called a Key for the workflow (note: ID is generally used in the flow model, and Key is used in the workflow, such as task ID, etc.). A flow instance is created, first entering a start event. After the start event, it will follow all outgoing links to the first task. The workflow component will save a task to the database. At this point, the user or group assigned to the task is parsed and saved to the database. It should be noted that the workflow engine will continue to execute the flow unless a wait state is encountered, such as a user task. In the wait state, the state of the current process instance is saved to the database. This state cannot be changed until the user decides to complete the task. At this point, the engine may continue execution until the next wait state is encountered, or the process ends. If the intermediate engine restarts or crashes, the process state is also safely saved in the database. After the task is created, the startprocessInstantByKey will not return until the wait state of the user task is reached. The task is now assigned to a group, which means that this group is a candidate group for performing this task. The starting process does not provide a management interface, and only exposes the interface for the service application to call.

Designing a task list to be handled: the workflow engine is used in the process, one very important function is to obtain the to-do list, and the to-do list can be inquired in the workflow through the relevant APIs of the task service, although the APIs are designed elegantly, the APIs are often inconvenient in actual use and lack flexibility, and the requirements of technical solutions cannot be met. After analyzing the above disadvantages and requirements, the present invention considers that there are various defects when querying in API mode, so the design target is put on the database, and the problem is solved by defining the view mode, thus thoroughly solving the problems of convenience, flexibility and universality of query. The workflow component does not provide interface management of the task list to be handled, only provides flow data for the service system to use, and the data display is realized by the service system.

Designing a signing task: when a task is sent to a plurality of persons for processing at the same time and the task does not need to be signed, the task must be signed first to be processed. The current registrant claims this task. As will be appreciated, the user becomes the performer of the task and the task disappears from the task list of the other members. The task may move to the user's personal task list that signed in for the task. The current login person will also see that the performer of the task has become the current logged-in user. The function does not provide an operation interface, and only provides interface calling.

Task handling design: after the current login person finishes the task signing, the task can be directly processed in the task list to be handled. For the workflow engine, an external message is needed to let the process instance continue execution. The task will remove itself from the runtime. The flow may follow a single outbound connection moving to a second task. The same mechanism as the first task is used for the second task, except that the task is assigned to another group or person. The function does not provide interface operations, but only interface calls.

And (3) designing an already-processed task list: an already tasked task is a historical component that can capture information that occurs during the execution of a process and store it permanently, unlike runtime data, which exists in a database when a process instance is run through. There are 5 historical entity objects, historian processinstances, which contain information on current and completed process instances, historian variable instances, which contain the latest process variables or task variables, historian reactive instances, which contain execution information on an activity (node on the process), historian task instances, which contain information on current and past (completed or deleted) task instances, historian details, which contain various information on historical process instances, activity instances, task instances. Because the database stores historical information and information about the running process instances, it is necessary to consider how to run as few pairs as possible.

And (3) flow tracking design: after the process is started, a unique process instance is provided, and the execution condition of the process can be tracked through the process instance. The tracking of the flow includes a history list of flow pictures and flows.

Designing a sub-process: a sub-flow is an activity that contains other activities, gateways, events, etc. The implementation of the sub-process comprises two implementations based on the sub-process. One is embedded sub-flow: the sub-process elements are embedded in the main process element, the sub-process can only be used in the process, and the outside cannot be accessed. Such sub-processes are typically handled as local general logic or because of specific business needs, making the design of a more complex single main process clear and intuitive. The other is to call a sub-flow: firstly, one process is realized, the process can be called in another process, and some general processes can be generally defined as the calling sub-processes for the definition and the multiplexing of other processes. The sub-process uses elements to call and is indirectly embedded into the main process, so that the sub-process is convenient to use.

And (3) design of a tag: in process business management, tasks are usually processed by one person, and a plurality of persons process one task at the same time, and the task is called as a countersigning task. The flow assembly does not provide the interface operation of the function, only provides the interface to acquire data, and the interface is realized by the service system.

Retraction/retraction design: in the process business management, incomplete information or misoperation often occurs to send the process to a next-step handler, and the task can be recovered and reprocessed before the next-step handler does not process, namely, the recovery or the withdrawal of the process.

The timed task component requires what is a common demand scene to do at a certain characteristic time point in real production. This time a timing task is needed. Existing Spring provides a way to implement timed tasks by annotating methods with @ Schedule annotation. However, this approach has the biggest problem of having to modify the program source code if it comes to the task that needs to be adjusted. If the project is already online, modifying the source code means that a shutdown is required, which can hardly be allowed. Thus, the present invention develops a timed task component that can adjust tasks without downtime. The main design and construction process is as follows:

task management: metadata information for the tasks is stored by the database. The metadata includes task ID, task name, task grouping, task status, cron expression, etc. And then providing an interface for increasing, deleting, modifying and checking the tasks, and performing increasing, deleting, modifying and checking on the task database.

Task state management: and providing a task state management interface to manage the task state. The task states are as follows: started, suspended, stopped. The modification of the task involves changes in two places. One is a state change in memory and one is a state change of data in the database.

Task deployment: the tasks can be deployed in a distributed mode or in a single mode. For the distributed deployment approach, distributed locks are used to avoid repeated execution of tasks on multiple machines. The distributed lock defaults to using a database to realize lightweight, and can also use redis or zookeeper and the like in a customized manner.

Task logging: a log of tasks is stored by the database.

And a system management component, which is an essential module for the web system. The main design idea is as follows:

and (3) organization management: and providing an organization management interface to perform operations such as addition, deletion, modification, check and the like on the organization. Wherein, the mechanism is designed with the concept of a parent-child mechanism.

User management: and providing a user management interface to perform operations such as addition, deletion, modification, check and the like on the user. The user is associated with the institution and, in addition, an interface is provided for modifying the password and resetting the password.

And (3) role management: and providing a role management interface to perform operations such as adding, deleting, modifying, checking and the like on roles.

And (3) menu management: and providing a menu management interface to perform operations such as adding, deleting, modifying, checking and the like on the menu. In order to avoid using recursion to query when querying the menu, a relationship field is set for the menu. Relationship records a chain structure of current menu id and all parent menu ids, for example: 1-5-7 represents that the current menu id is 7, the father menu id is 5 and the father menu id of the father menu is 1. The current menu is at level 3. Therefore, through the relationship field, when the menu is queried, the menu can be queried through the like, and the menu and the role are associated.

And (4) post management: and providing a post management interface to perform operations such as increasing, deleting, modifying, checking and the like on the posts. The post is designed with the concept of parent-child post. In addition, the post and the mechanism, the post and the role, and the post and the user have an association relationship.

And (3) authority management: and providing an authority management interface to perform operations such as addition, deletion, modification, check and the like on the authority. The authority actually modifies the association between the post and the user.

In the embodiment, all the framework components are constructed and respectively tested, and after all the components are tested without problems, the components are packaged to form the component library and are released to the web back-end development framework for developers to use, so that the development efficiency of software application can be improved.

The foregoing shows and describes the general principles and broad features of the present invention and advantages thereof. It will be understood by those skilled in the art that the present invention is not limited to the embodiments described above, which are described in the specification and illustrated only to illustrate the principle of the present invention, but that various changes and modifications may be made therein without departing from the spirit and scope of the present invention, which fall within the scope of the invention as claimed. The scope of the invention is defined by the appended claims and equivalents thereof.

Claims

1. A framework component system for software development, which is applied to a web back-end development framework, is characterized by comprising

The interface configuration component is used for providing an interface tool for the application, so that a developer can configure the interface according to the requirement without developing any code;

the system management component is used for providing a management interface for the web back-end development framework, so that managers can operate and manage the authority, role, mechanism and user of the system;

the interface configuration component comprises a dynamic interface module and an interface configuration module; the dynamic interface module is used for inquiring the URL and request parameters of the interface and intercepting illegal URLs and requests; when the dynamic interface module carries out an interface request, the dynamic interface module firstly walks away the interceptor and then inquires whether the url of the interface and the request parameter are legal or not through interface _ info; if the SQL script is legal, then using interface _ release to obtain the SQL script and return configuration information, and performing corresponding processing after execution and returning;

the interface configuration module is used for configuring, testing and releasing the interface on the UI interface; the interface configuration process of the interface configuration module comprises the following steps: firstly, interface creation is carried out on a page, and url and access mode needing to be formulated for interface access are POST or GET; in the parameter definition area, configuring request parameters of a test interface, wherein the parameters only support a JSON format; configuring SQL sentences for accessing the database in the main working area; configuring an entity returned by the interface in the main working area; testing whether the return interface is expected through the test button; finally, issuing an interface through an issuing button;

the file uploading component comprises a file storage module, a file uploading module and a file downloading module; the file storage module is used for storing all files of the frame in a file server mode; the file uploading module is used for recording metadata uploaded by the file through a database; the file downloading module is used for inquiring the storage path of the file from the database and then calling an API (application program interface) for downloading the file;

the workflow component comprises a model management module, a process definition management module and a process task management module; the model management module is used for providing a visual management interface and a design interface for the workflow model table and realizing the import and export of the model and the deployment of the model; the flow definition management module is used for providing a visual management interface for flow definition and realizing the definition and deployment of the flow; the flow task management module is used for creating a flow and managing the scheduling execution condition of the flow task;

the timing task component comprises a task storage module, a task management module and a task deployment module; the task storage module is used for storing metadata information and logs of the timing task; the task management module is used for providing a task management interface and managing a task state and a task database; the task deployment module is used for deploying the timing task on a single machine or a plurality of machines in a single deployment or distributed deployment mode to execute.

2. The framework component system for software development as claimed in claim 1, wherein the metadata comprises file name, file category, file batch number, file saving path, wherein the file saving path corresponds to the storage path of the file on the file server.

3. A framework component system for software development according to claim 1, wherein said system management components include an institution management module, a user management module, a role management module, a menu management, a post management and a rights management module.

4. A method of building a framework component system for software development according to claim 1, the method comprising the steps of: