CN111930354A - 一种用于软件开发的框架组件及其构建方法 - Google Patents

Abstract

本发明公开了一种用于软件开发的框架组件及其构建方法，应用于web后端开发框架，包括接口配置组件为应用提供接口工具，使得开发人员根据需求配置接口且无需开发代码；文件上传组件为应用提供文件上传和下载的公用API，直接使用API来完成文件上传或下载需求开发；工作流组件为开发框架单独提供流程服务和可视化的管理，协调数据、业务活动和开发人员；定时任务组件为应用部署和管理定时任务，且实现在不停机状态下对定时任务进行调整；***管理组件为web后端开发框架提供管理接口，能对***的权限、角色、机构和用户等进行管理。通过本方案能为web后端开发框架提供框架组件，使得框架能够实现组件化开发，进一步提高软件开发人员的软件开发效率。

Description

一种用于软件开发的框架组件及其构建方法

技术领域

本发明涉及软件开发技术领域，尤其涉及一种用于软件开发的框架组件及其构建方法。

背景技术

现在的项目随着需求的增加规模变得越来越大，规模的增大带来了很多烦恼，各种业务错中复杂的交织在一起，每个业务模块之间，代码没有约束，带来了代码边界的模糊，代码冲突时有发生，更改一个小问题可能引起一些新的问题。因此人们提出了组件化开发的概念，组件化是一种高效的处理复杂应用***，可以更好的明确功能模块作用的方式，采用模块式开发方式，单个组件包括模板，数据结构，程序，样式四部份，通过组件的接口表达由该组件提供的功能和调用它时所需要的参数。组件是可以单独开发、测试，允许多人同时协作，编写及开发、研究不同的功能模块。现有的开发框架在利用组件开发的过程中，项目的扩展性较差，新的开发技术集成非常不友好，需要开发人员自己来集成相关技术，且不能完全支持跨平台开发和部署。

发明内容

本发明的目的在于克服现有技术的不足，提供一种用于软件开发的框架组件及其构建方法，为web后端开发框架提供框架组件，集成多个组件功能，并将组件进行封装形成框架组件库，大大提高了开发人员的开发效率，提高了框架的开发灵活性和全面性。

本发明的目的是通过以下技术方案来实现的：

一种用于软件开发的框架组件，应用于web后端开发框架，包括接口配置组件，用于为应用提供接口工具，使得开发人员能根据需求配置接口且无需开发任何代码；

文件上传组件，用于为应用提供一个文件上传和下载的公用API，使得开发人员可以直接使用API来完成文件上传或下载需求开发；

工作流组件，用于为开发框架单独提供流程服务和可视化的管理，协调数据、业务活动和开发人员；

定时任务组件，用于为应用部署和管理定时任务，且实现在不停机状态下对定时任务进行调整；

***管理组件，用于为web后端开发框架提供管理接口，使得管理人员能对***的权限、角色、机构和用户等进行操作管理。

具体的，所述接口配置组件包括动态接口模块和接口配置模块；动态接口模块用于查询接口的URL和请求参数，拦截非法的URL和请求；接口配置模块用于在UI界面对接口进行配置、测试和发布。

具体的，所述文件上传组件包括文件存储模块、文件上传模块和文件下载模块；文件存储模块用于通过文件服务器的方式对框架所有的文件进行存储；文件上传模块用于通过数据库来记录文件上传的元数据；文件下载模块用于从数据库里查询文件的保存路径，然后调用文件下载的API接口进行文件下载。

具体的，所述元数据包括文件名、文件类别、文件批次号、文件保存路径，其中文件保存路径对应文件在文件服务器上的存储路径。

具体的，所述工作流组件包括模型管理模块、流程定义管理模块和流程任务管理模块；模型管理模块用于对工作流模型表提供可视化管理界面和设计界面，实现模型的导入导出和模型部署；流程定义管理模块用于对流程定义提供可视化的管理界面，实现流程的定义和部署；流程任务管理模块用于创建流程和管理流程任务的调度执行情况。

具体的，所述定时任务组件包括任务存储模块、任务管理模块和任务部署模块；任务存储模块用于存储定时任务的元数据信息和日志；任务管理模块用于提供任务管理接口，对任务状态和任务数据库进行管理；任务部署模块用于以单台部署或分布式部署的方式将定时任务部署在单台或多台机器上执行。

具体的，所述***管理组件包括机构管理模块、用户管理模块、角色管理模块、菜单管理、岗位管理和权限管理模块。

一种用于软件开发的框架组件构建方法，方法包括以下步骤：

S1，设计框架的基础架构，并根据架构搭建框架的基础功能模块，为框架组件提供依赖基础；

S2，设计框架组件架构，根据业务需求确定web后端开发框架的组件功能和组件业务逻辑；

S3，基于基础功能模块，选取组件功能对应的构件开发组件功能，并设计与组件功能对应的数据库表；

S4，将开发完成的组件功能进行测试，测试完成无误后，将组件进行封装，形成框架的组件库。

本发明的有益效果：通过本方案集成了多个软件开发中的重要组件，并进行相应的设计，简化配置的同时使得组件在使用上更加符合开发人员的习惯，可以为web后端开发框架提供框架组件，大大提高了开发人员的开发效率，提高了框架的开发灵活性和全面性。

附图说明

图1是本发明的框架组件架构图。

图2是本发明的框架组件构建方法流程图。

图3是本发明的接口配置流程图。

具体实施方式

为了对本发明的技术特征、目的和效果有更加清楚的理解，现对照附图说明本发明的具体实施方式。

本实施例中，如图1所示，一种用于软件开发的框架组件，应用于web后端开发框架，包括接口配置组件、文件上传组件、定时任务组件和***管理组件，同时还为开发人员提供自定义组件的功能，开发人员可根据自身需求进行组件的定义开发。其中，接口配置组件用于为应用提供接口工具，使得开发人员能根据需求配置接口且无需开发任何代码。文件上传组件用于为应用提供一个文件上传和下载的公用API，使得开发人员可以直接使用API来完成文件上传或下载需求开发。工作流组件用于为开发框架单独提供流程服务和可视化的管理，协调数据、业务活动和开发人员。定时任务组件用于为应用部署和管理定时任务，且实现在不停机状态下对定时任务进行调整。***管理组件用于为web后端开发框架提供管理接口，使得管理人员能对***的权限、角色、机构和用户等进行操作管理。

具体的，接口配置组件包括动态接口模块和接口配置模块；动态接口模块用于查询接口的URL和请求参数，拦截非法的URL和请求；接口配置模块用于在UI界面对接口进行配置、测试和发布。

具体的，文件上传组件包括文件存储模块、文件上传模块和文件下载模块；文件存储模块用于通过文件服务器的方式对框架所有的文件进行存储；文件上传模块用于通过数据库来记录文件上传的元数据；文件下载模块用于从数据库里查询文件的保存路径，然后调用文件下载的API接口进行文件下载。

具体的，元数据包括文件名、文件类别、文件批次号、文件保存路径，其中文件保存路径对应文件在文件服务器上的存储路径。

具体的，工作流组件包括模型管理模块、流程定义管理模块和流程任务管理模块；模型管理模块用于对工作流模型表提供可视化管理界面和设计界面，实现模型的导入导出和模型部署；流程定义管理模块用于对流程定义提供可视化的管理界面，实现流程的定义和部署；流程任务管理模块用于创建流程和管理流程任务的调度执行情况。

具体的，定时任务组件包括任务存储模块、任务管理模块和任务部署模块；任务存储模块用于存储定时任务的元数据信息和日志；任务管理模块用于提供任务管理接口，对任务状态和任务数据库进行管理；任务部署模块用于以单台部署或分布式部署的方式将定时任务部署在单台或多台机器上执行。

具体的，***管理组件包括机构管理模块、用户管理模块、角色管理模块、菜单管理、岗位管理和权限管理模块。

本实施例中，如图2所示，还提供一种用于软件开发的框架组件构建方法，方法包括以下步骤：

步骤1，设计框架的基础架构，并根据架构搭建框架的基础功能模块，为框架组件提供依赖基础。

步骤2，设计框架组件架构，根据业务需求确定web后端开发框架的组件功能和组件业务逻辑。

步骤3，基于基础功能模块，选取组件功能对应的构件开发组件功能，并设计与组件功能对应的数据库表。

步骤4，将开发完成的组件功能进行测试，测试完成无误后，将组件进行封装，形成框架的组件库。

本实施例中，在进行组件的开发之前，需要web后端开发搭建相应的基础功能模块，主要包括动态数据源模块、Druid连接池模块、缓存模块、日志管理模块、异步处理模块、全局异常处理模块、ID生成器模块、自动审计模块、分页插件模块和慢查询追踪模块等。在基础功能模块的基础上进行组件功能模块架构设计和相应功能业务逻辑的具体实现。组件功能模块中的各个组件互相独立，但是都依赖于基础功能模块中common包的common-core实现。目前已实现的组件有接口配置组件、文件上传组件、工作流组件、定时任务组件和***管理组件。

其中，接口配置组件旨在为应用提供的一个接口配置工具，使得使用者无需开发任何代码就配置一个满足需求的接口，其设计构建过程如下：

动态接口：通过***的方式，实现对一个通用的url的拦截。这个url会做为所有通过接口配置工具配置的接口的前缀。所有的接口，配置后保存在数据库中。数据库设计两张表：interface_info和interface_release。interface_info记录接口的配置信息，interface_release记录接口的sql脚本等信息。进行接口请求的时候，首先会走***，然后通过interface_info查询接口的url和请求参数否合法。如果合法，再使用interface_release获取SQL脚本和返回配置信息，执行后做相应的处理后返回。

接口配置：整个接口配置、测试、发布，一站式都通过UI 界面完成。接口配置组件的接口配置流程如图3所示，首先在页面上进行接口创建，将需要制定接口访问的url和访问方式为POST或GET；在参数定义区，配置测试接口的请求参数，参数只支持JSON格式；在主工作区配置访问数据库的SQL语句；在主工作区配置接口返回的实体；通过测试按钮测试是否是预期的返回接口；最后通过发布按钮发布接口。

文件上传组件旨在为应用提供一个文件上传和下载的公用API。使得开发者在有文件上传或下载需求的时候，可以直接使用API来完成开发，其主要的设计构建过程如下：

文件存储：所有文件通过文件服务器的方式进行存储，文件服务器提供sftp协议进行通信。

文件上传：使用数据库来记录文件上传的元数据，元数据包括文件名、文件类别、文件批次号、文件保存路径等。其中文件保存路径对应文件在文件服务器上的存储路径。

文件下载：从数据库里查询文件的保存路径，然后调用文件下载的API接口进行下载。

本实施例中，为了最大限度的提高Web开发人员的生产力，本发明封门了一套基工作流组件，该组件没有直接嵌入业务***，而是单独部署成了服务，暴露接口供业务***调用，减少与业务***的耦合。其主要的设计构建过程如下：

模型管理设计：主要是对工作流模型表(ACT_RE_MODEL)的CURD操作以及一些扩展功能，如：模型导入导出，模型部署等功能。模型是流程的开端，流程的设计就是模型的设计过程；通过模型可以导出流程的定义文件*.bpmn 文件，可用于流程的部署。模型管理功能提供可视化的管理界面和设计界面。

流程定义管理设计：在使用工作流之前必须对流程进行定义，流程定义了还要对流程进行部署。为了部署流程，它们不得不包装在一个业务文档中。一个业务文档是工作流引擎部署的单元。一个业务文档相当于一个压缩文件，它包含BPMN2.0流程，任务表单，规则和其他任意类型的文件。大体上，业务文档是包含命名资源的容器。当一个业务文档被部署，它将会自动扫描以.bpmn20.xml 或者.bpmn 作为扩展名的BPMN文件。每个文件都将会被解析并且可能会包含多个流程定义。流程定义提供可视化的管理界面，流程模型设计后在工作流组件中部署，不在业务***中部署。

启动流程设计：有了流程定义，就可以创建流程实例了。启动一个新流程实例，使用定义在流程定义里的id（对应XML文件中的process元素）。注意这里的id对于工作流来说，应该叫做key（注：一般在流程模型中使用的ID，在工作流中都是Key，比如任务ID等）。创建一个流程实例，首先进入开始事件。开始事件之后，它会沿着所有的外出连线执行，到达第一个任务。工作流组件会把一个任务保存到数据库里。这时分配到这个任务的用户或群组会被解析，也会保存到数据库里。需要注意，工作流引擎会继续执行流程的环节，除非遇到一个等待状态，比如用户任务。在等待状态下，当前的流程实例的状态会保存到数据库中。直到用户决定完成任务才能改变这个状态。这时，引擎会继续执行，直到遇到下一个等待状态，或流程结束。如果中间引擎重启或崩溃，流程状态也会安全的保存在数据库里。任务创建之后，startProcessInstanceByKey 会在到达用户任务这个等待状态之后才会返回。这时任务分配给了一个组，这意味着这个组是执行这个任务的候选组。启动流程不提供管理界面，只暴露接口供业务应用调用。

待办任务列表设计：此过程使用工作流引擎，一个非常重要的功能就是获取待办事项列表，在工作流中可以通过TaskService的相关API进行查询，虽然这些API设计优雅，但是实际使用中往往不够方便，也缺乏灵活性，达不到技术解决方案的要求。分析上述缺点和需求后，本发明认为通过API方式进行查询的话，总是有各种缺陷，因此把设计的目标放在数据库上，通过定义视图的方式解决问题，彻底解决查询的方便性、灵活性、通用性问题。工作流组件不提供待办任务列表的界面管理，只提供流程数据给业务***使用，数据的展现由业务***实现。

签收任务设计：当一个任务同时发送给多个人处理，且该任务不需要会签时，必须先签收才能办理任务。当前登录人认领这个任务。认领以后，这个用户就会成为任务的执行人，任务会从其他成员的任务列表中消失。任务会移动到签收任务的用户个人任务列表。当前登录人也会看到任务的执行人已经变成当前登陆的用户。该功能不提供操作界面，只提供接口调用。

任务办理设计：当前登录人签收完任务后，可以直接在待办任务列表里处理任务。对于工作流引擎，需要一个外部信息来让流程实例继续执行。任务会把自己从运行库中删除。流程会沿着单独一个外出连线执行，移动到第二个任务。与第一个任务相同的机制会使用到第二个任务上，不同的是任务是分配给其他的组或者人员。该功能不提供界面操作，只提供接口调用。

已办任务列表设计：已办任务是一个历史组件，它可以捕获发生在进程执行中的信息并永久的保存，与运行时数据不同的是，当流程实例运行完成之后它还会存在于数据库中。有5个历史实体对象: HistoricProcessInstances 包含当前和已经结束的流程实例信息、HistoricVariableInstances 包含最新的流程变量或任务变量、HistoricActivityInstances 包含一个活动(流程上的节点)的执行信息、HistoricTaskInstances 包含关于当前和过去的（已完成或已删除）任务实例信息、HistoricDetails 包含历史流程实例、活动实例、任务实例的各种信息。由于数据库中保存着历史信息以及正在运行的流程实例信息，就要考虑怎样尽量少的对运行。

流程追踪设计：流程启动后都有一个唯一的流程实例，通过流程实例可以追踪流程的执行情况。流程的追踪包含流程图片以及流转的历史列表。

子流程设计：子流程是包含其他的活动、网关、事件等的活动。子流程的实现，包括两种基于子流程的实现。一种是内嵌子流程：子流程元素内嵌在主流程元素之内，只能在该流程中使用该子流程，外部是无法访问到的。这种子流程一般作为局部通用逻辑处理，或者因为特定业务需要，使得比较复杂的单个主流程设计清晰直观。另一种是调用子流程：首先实现一个流程，在另一个流程中可以调用该流程，通常可以定义一些通用的流程作为这种调用子流程，供其他多个流程定义复用。这种子流程使用元素来进行调用，间接地嵌入到主流程中，用起来比较方便。

会签设计：在流程业务管理中，任务是通常都是由一个人去处理的，而多个人同时处理一个任务，这种任务我们称之为会签任务。流程组件不提供该功能的界面操作，只提供接口获取数据，界面由业务***实现。

收回/退回设计：在流程业务管理中，经常出现信息不完整或者误操作将流程发送到一下步处理人，在下一步处理人未处理前可以将任务收回重新处理，这就是流程的收回或者撤销。

定时任务组件，在现实生产中，要求在某个特点的时间点做点什么是常见的需求场景。这时候就需要用到定时任务。现有的Spring提供了通过使用@Schedule注解来标注方法实现定时任务的方式。但是此方式有个最大的问题，那就是如果涉及到需要对任务进行调整的时候，就不得不修改程序源代码。如果项目已经上线了，要修改源代码那就意味着需要停机，这几乎是不能被允许的。因此，本发明开发了一个不停机就能对任务进行调整的定时任务组件。其主要设计构建过程如下：

任务管理：通过数据库来存储任务的元数据信息。元数据包括任务ID、任务名称、任务分组、任务状态、cron表达式等。然后提供任务增删改查的接口，对任务数据库进行增删改查。

任务状态管理：提供任务状态管理接口对任务状态进行管理。任务状态有：已启动、暂停、停止。任务的修改，涉及到两个地方的改变。一个是内存中状态改变，一个是数据库中的数据的状态改变。

任务部署：任务可以分布式部署，也可以单台部署。对于分布式部署的方式，使用了分布式锁来避免多台机器上的任务重复执行。分布式锁默认使用数据库来做轻量级的实现，也可以自定义使用redis或zookeeper等。

任务日志：通过数据库来存储任务的日志。

***管理组件，对于web***来说，***管理是必不可少的模块。其主要设计思路如下：

机构管理：提供机构管理接口对机构进行增删改查等操作。其中，机构设计有父子机构的概念。

用户管理：提供用户管理接口对用户进行增删改查等操作。用户和机构进行关联，另外，还提供修改密码和密码重置的接口。

角色管理：提供角色管理接口对角色进行增删改查等操作。

菜单管理：提供菜单管理接口对菜单进行增删改查等操作。为了避免查询菜单的时候使用递归进行查询，给菜单设置了一个relationship字段。Relationship记录的是当前菜单id和所有父菜单id的链式结构，例如：1-5-7代表当前菜单id为7，父菜单id为5，父菜单的父菜单id为1。当前菜单处于第3层级。所以，通过relationship字段，查询菜单的时候可以通过like进行查询，并将菜单和角色进行关联。

岗位管理：提供岗位管理接口对岗位进行增删改查等操作。岗位设计有父子岗位的概念。此外，岗位和机构，岗位和角色，岗位和用户都有关联关系。

权限管理：提供权限管理接口对权限进行增删改查等操作。权限实际修改的是岗位和用户的关联关系。

本实施例中，在所有框架组件构建完成，分别进行测试，在所有组件测试没有问题后，将组件进行封装形成组件库，并发布到web后端开发框架中，供开发人员使用，可以提高软件应用的开发效率。

以上显示和描述了本发明的基本原理和主要特征和本发明的优点。本行业的技术人员应该了解，本发明不受上述实施例的限制，上述实施例和说明书中描述的只是说明本发明的原理，在不脱离本发明精神和范围的前提下，本发明还会有各种变化和改进，这些变化和改进都落入要求保护的本发明范围内。本发明要求保护的范围由所附的权利要求书及其等效物界定。

Claims (8)

1.一种用于软件开发的框架组件，应用于web后端开发框架，其特征在于，包括

接口配置组件，用于为应用提供接口工具，使得开发人员能根据需求配置接口且无需开发任何代码；

文件上传组件，用于为应用提供一个文件上传和下载的公用API，使得开发人员可以直接使用API来完成文件上传或下载需求开发；

工作流组件，用于为开发框架单独提供流程服务和可视化的管理，协调数据、业务活动和开发人员；

定时任务组件，用于为应用部署和管理定时任务，且实现在不停机状态下对定时任务进行调整；

***管理组件，用于为web后端开发框架提供管理接口，使得管理人员能对***的权限、角色、机构和用户等进行操作管理。

2.根据权利要求1所述的一种用于软件开发的框架组件，其特征在于，所述接口配置组件包括动态接口模块和接口配置模块；动态接口模块用于查询接口的URL和请求参数，拦截非法的URL和请求；接口配置模块用于在UI界面对接口进行配置、测试和发布。

3.根据权利要求1所述的一种用于软件开发的框架组件，其特征在于，所述文件上传组件包括文件存储模块、文件上传模块和文件下载模块；文件存储模块用于通过文件服务器的方式对框架所有的文件进行存储；文件上传模块用于通过数据库来记录文件上传的元数据；文件下载模块用于从数据库里查询文件的保存路径，然后调用文件下载的API接口进行文件下载。

4.根据权利要求3所述的一种用于软件开发的框架组件，其特征在于，所述元数据包括文件名、文件类别、文件批次号、文件保存路径，其中文件保存路径对应文件在文件服务器上的存储路径。

5.根据权利要求1所述的一种用于软件开发的框架组件，其特征在于，所述工作流组件包括模型管理模块、流程定义管理模块和流程任务管理模块；模型管理模块用于对工作流模型表提供可视化管理界面和设计界面，实现模型的导入导出和模型部署；流程定义管理模块用于对流程定义提供可视化的管理界面，实现流程的定义和部署；流程任务管理模块用于创建流程和管理流程任务的调度执行情况。

6.根据权利要求1所述的一种用于软件开发的框架组件，其特征在于，所述定时任务组件包括任务存储模块、任务管理模块和任务部署模块；任务存储模块用于存储定时任务的元数据信息和日志；任务管理模块用于提供任务管理接口，对任务状态和任务数据库进行管理；任务部署模块用于以单台部署或分布式部署的方式将定时任务部署在单台或多台机器上执行。

7.根据权利要求1所述的一种用于软件开发的框架组件，其特征在于，所述***管理组件包括机构管理模块、用户管理模块、角色管理模块、菜单管理、岗位管理和权限管理模块。

8.一种用于软件开发的框架组件构建方法，其特征在于，方法包括以下步骤：

S1，设计框架的基础架构，并根据架构搭建框架的基础功能模块，为框架组件提供依赖基础；

S2，设计框架组件架构，根据业务需求确定web后端开发框架的组件功能和组件业务逻辑；

S3，基于基础功能模块，选取组件功能对应的构件开发组件功能，并设计与组件功能对应的数据库表；

S4，将开发完成的组件功能进行测试，测试完成无误后，将组件进行封装，形成框架的组件库。

Images