CN111831318A - 一种自动生成代码的微服务管理系统及代码生成方法 - Google Patents

Abstract

本公开提供了一种自动生成代码的微服务管理系统及代码生成方法，包括系统划分单位管理模块、基本信息管理模块、代码生成模块和代码传输模块，代码生成模块用于根据所述微服务应用的基本信息和微服务应用模板代码生成微服务应用代码，根据微服务接口基本信息和微服务应用代码生成微服务接口代码；代码传输模块用于发送微服务应用模板代码到代码生成模块，上传微服务应用和微服务接口代码到代码存储模块；本公开有效降低了微服务架构下系统开发的难度，同时提高了代码可用性，降低了出错率，为微服务系统研发、软件完善性维护、软件快速迭代以及需求快速落地提供了极大的便利。

Description

一种自动生成代码的微服务管理系统及代码生成方法

技术领域

本公开涉及微服务技术领域，特别涉及一种自动生成代码的微服务管理系统及代码生成方法。

背景技术

本部分的陈述仅仅是提供了与本公开相关的背景技术，并不必然构成现有技术。

微服务架构是近年来产生的一种新型软件架构，在国内外得到广泛的关注与应用，微服务架构突破了传统架构模式带来的技术瓶颈，为软件开发带来新的活力，但是在微服务架构下软件被拆分为大量体积较小的应用，如何在微服务架构下迅速开展工作，且保证代码质量，是开发人员要应对的难题。

本公开发明人发现，微服务架构下，应用程序由独立部署运行的微服务应用组成，每个微服务应用独立开发。传统软件开发由开发人员在本地编辑器或者软件框架官方提供的代码生成器新建应用，在新建应用过程中，不同的开发人员如果在配置工程类型、框架版本、开发语言版本、打包类型、工程依赖等方面操作内容不同就会导致一个系统中的微服务应用工程结构不统一，这会对系统的可靠性和代码质量造成威胁。

微服务接口依附于微服务应用存在，用于发送或者接收请求，它是保证微服务系统内外部通信的核心，然而，当下微服务架构尚处于推广状态，大多数开发人员没有接触过微服务接口的开发，因此，在开发工作开始前需要花费大量时间进行人员培训，那么开发工作的进度就会受到影响，即便开发人员掌握了微服务接口的开发方法，在一个微服务系统中微服务接口的数量众多，每个接口对于参数的要求不同，校验过程繁琐，采用人工开发的方式效率低下，严重影响软件生命周期迭代速度，尤其是在开发人员接触微服务架构的初期，这使得微服务架构方便敏捷开发的优势无从显现。

发明内容

为了解决现有技术的不足，本公开提供了一种自动生成代码的微服务管理系统及代码生成方法，有效降低了微服务架构下系统开发的难度，同时提高了代码可用性，降低了出错率，为微服务系统研发、软件完善性维护、软件快速迭代以及需求快速落地提供了极大的便利。

为了实现上述目的，本公开采用如下技术方案：

本公开第一方面提供了一种自动生成代码的微服务管理系统。

一种自动生成代码的微服务管理系统，包括：

系统划分单位管理模块，至少被配置为：根据业务背景自定义划分功能模块的基本单位；

基本信息管理模块，至少被配置为：管理微服务应用和微服务接口的基本信息；

代码生成模块，至少被配置为：用于根据所述微服务应用的基本信息和微服务应用模板代码生成微服务应用代码，根据微服务接口基本信息和微服务应用代码生成微服务接口代码。

作为可能的一些实现方式，所述系统还包括代码传输模块，至少被配置为：发送微服务应用模板代码到代码生成模块，上传微服务应用和微服务接口代码到代码存储模块。

作为可能的一些实现方式，所述基本信息管理模块，至少包括微服务应用基本信息管理模块，用于创建、编辑和存储微服务应用的基本信息。

作为进一步的限定，微服务应用的基本信息至少包括微服务应用编号、微服务应用名称、负责人编号、负责人名称、代码库类型、所属系统划分基本单位、代码库路径、代码库用户名、代码库密码和微服务接口服务提供者所在包路径。

作为可能的一些实现方式，所述基本信息管理模块，至少包括微服务接口基本信息管理模块，用于创建、编辑和存储微服务接口的基本信息。

作为进一步的限定，微服务接口包括服务提供者和服务消费者，服务提供者的基本信息至少包括接口类型、接口中文名、接口方法名、接口类名、接口入参和接口出参；

所述服务消费者的基本信息包括接口类名、接口类路径、接口中文名、服务提供者所属微服务应用名称和服务提供者接口方法名。

作为可能的一些实现方式，所述代码生成模块，至少包括微服务应用代码生成模块，用于根据微服务应用模板代码和微服务应用的基本信息生成微服务应用代码。

作为可能的一些实现方式，所述代码生成模块，至少包括微服务接口代码生成模块，对于服务提供者代码，生成代码至少包括接口重定向类文件和接口参数检查类文件；对于服务消费者代码，生成代码至少包括发送请求类文件和接口参数检查类文件。

本公开第二方面提供了一种微服务应用代码生成管理方法。

一种微服务应用代码生成管理方法，包括以下步骤：

根据业务需求设计系统划分单位；

在某一个系统划分单位的基础上，维护所述微服务应用的基本信息，至少包括微服务应用编号、微服务应用名称、负责人编号、负责人名称、代码库类型、所属系统划分基本单位和代码库路径；

根据微服务应用类型，从代码库获取微服务应用模板代码；

根据微服务应用基本信息和微服务应用模板代码生成微服务应用代码；

根据微服务应用基本信息中代码库地址、代码库用户名和代码库密码，将微服务应用生成代码上传至代码库。

本公开第三方面提供了一种微服务接口代码生成管理方法。

一种微服务接口代码生成管理方法，应用于服务提供者，包括以下步骤：

获取微服务接口的基本信息，至少包括接口类型、接口中文名、接口方法名、接口类名、接口入参和接口出参；

下载服务提供者代码到本地，至少包括当前微服务应用提供的所有微服务接口，根据微服务接口的基本信息，生成微服务接口重定向类文件，将微服务请求分发至相应处理类，同时生成接口参数检查类文件；

完成接口相应处理类编写后，提交相应处理类文件，并在系统中上传重定向类文件和接口参数检查类文件至代码库。

本公开第四方面提供了一种微服务接口代码生成管理方法。

一种微服务接口代码生成管理方法，应用于服务消费者，包括以下步骤：

选择服务提供者，设置当前服务消费者类文件路径和服务消费者名称；

在服务提供者接口列表中选择所述服务消费者需要调用的接口；

填写代码库用户名和密码，将当前服务消费者类文件上传至代码库。

与现有技术相比，本公开的有益效果是：

1、本公开所述的系统及方法，针对软件系统微服务化后应用增多、微服务接口开发任务繁重的问题，提出了微服务应用和微服务接口代码自动生成方式，为微服务应用和微服务接口建立模板仓库，统一微服务系统内微服务应用的工程结构，从而统一管控代码质量和升级过程，同时，降低由于开发人员不适应软件架构变更而为开发工作带来的损失；

2、本公开所述的系统及方法，通过为开发人员提供微服务应用和微服务接口代码自动生成系统和方法，有效降低了微服务架构下系统开发的难度，大幅提高软件生产率，同时提高代码可用性、降低出错率，为微服务系统研发、软件完善性维护、软件快速迭代以及需求快速落地提供了极大的便利。

附图说明

图1为本公开实施例1提供的微服务开发管理系统结构示意图。

图2为本公开实施例2提供的微服务应用开发管理方法示意图。

图3为本公开实施例3提供的服务提供者开发管理方法示意图。

图4为本公开实施例4提供的服务消费者开发管理方法示意图。

具体实施方式

应该指出，以下详细说明都是示例性的，旨在对本公开提供进一步的说明。除非另有指明，本文使用的所有技术和科学术语具有与本公开所属技术领域的普通技术人员通常理解的相同含义。

需要注意的是，这里所使用的术语仅是为了描述具体实施方式，而非意图限制根据本公开的示例性实施方式。如在这里所使用的，除非上下文另外明确指出，否则单数形式也意图包括复数形式，此外，还应当理解的是，当在本说明书中使用术语“包含”和/或“包括”时，其指明存在特征、步骤、操作、器件、组件和/或它们的组合。

在不冲突的情况下，本申请中的实施例及实施例中的特征可以相互组合。

实施例1：

如图1所示，本公开实施例1提供了一种微服务开发管理系统，包括：

系统划分单位管理模块101，用于管理微服务系统中所述划分功能模块的最基本单位，可根据业务背景自定义划分功能模块的基本单位，所述微服务应用从属于一个且仅属于一个所述微服务系统基本划分单位。

基本信息管理模块102，用于管理所述微服务应用和所述微服务接口的基本信息。

代码生成模块103，用于根据所述微服务应用的基本信息生成微服务应用代码，根据所述微服务接口基本信息生成微服务接口代码。

代码传输模块104，用于下载微服务应用模板代码、上传所述微服务应用和所述微服务接口代码。

代码存储模块105，用于存放所述微服务应用、所述微服务接口以及微服务应用模板代码，其特征在于，所述代码存储模块为SVN、Git等代码库。

所述基本信息管理模块102，进一步包括：

微服务应用基本信息管理模块1021，用于创建、编辑和存储所述微服务应用的基本信息，所述基本信息包括微服务应用编号、微服务应用名称、负责人编号、负责人名称、代码库类型、所属系统划分基本单位、代码库路径、代码库用户名、代码库密码、微服务接口服务提供者所在包路径等。

微服务接口基本信息管理模块1022，用于创建、编辑和存储微服务接口的基本信息，所述微服务接口包括服务提供者和服务消费者，所述服务提供者的基本信息包括接口类型、接口中文名、接口方法名、接口类名、接口入参和接口出参；

所述服务消费者的基本信息包括接口类名、接口类路径、接口中文名、服务提供者所属微服务应用名称和服务提供者接口方法名。

所述代码生成模块103，进一步包括：

微服务应用代码生成模块1031，用于根据所述微服务应用基本信息管理模块获取所述微服务应用的基本信息生成微服务应用代码；

所述微服务应用代码在微服务应用代码模板基础上生成，所述微服务应用框架基于Spring Boot框架，涉及到的文件有pom.xml、application.properties、starter.java、servlet.xml、框架配置文件以及业务所需自定义配置文件。

微服务接口代码生成模块1032，用于根据所述微服务接口基本信息管理模块获取所述微服务接口的基本信息生成微服务接口代码；

对于服务提供者代码，生成代码包括接口重定向类文件和接口参数检查类文件；对于服务消费者代码，生成代码包括发送请求类文件和接口参数检查类文件。

微服务应用代码生成过程，具体为：

系统划分管理模块101中，创建、编辑和存储微服务系统中业务划分基本单位信息；

当需要创建新的微服务应用时，通过系统划分管理模块101查询获取相关划分基本单位信息；

开发人员通过微服务应用基本信息管理模块1021录入微服务应用基本信息，包括微服务应用编号、代码库类型、代码库路径等；

微服务应用代码生成模块1031通过微服务应用基本信息管理模块1021查询获取微服务应用编号、配置文件模板、微服务应用类型等信息，并以此为依据自动生成微服务应用代码；

此处需要说明的是，微服务应用类型包括但不限于纯后台业务逻辑处理型和包含前台页面型；

代码传输模块104通过微服务应用基本信息管理模块1021查询获取代码库类型、微服务应用代码库路径、代码库用户名和代码库密码等信息，校验代码库路径和代码库用户名密码后，将微服务应用代码生成模块1031生成的微服务应用代码上传至代码存储模块105；

代码存储模块105接收并存储微服务应用代码，同时，微服务应用模板代码也存放于此模块中，并由系统管理人员对应用模板进行近期更新，从而保证应用代码的可靠性和先进性。

服务提供者代码生成过程，具体为：

开发人员通过微服务接口基本信息管理模块1022创建、编辑和存储微服务接口基本信息，包括接口类型、接口中文名、接口方法名、接口类名、接口入参和接口出参；

此处需要说明的是，微服务接口依附于微服务应用存在，在创建微服务接口时，通过微服务应用基本信息管理模块1021获取微服务应用编号、代码库路径、代码库用户名、代码库密码等基本信息并存储于微服务接口基本信息管理模块1022；

微服务接口代码生成模块1032通过微服务接口基本信息管理模块1022获取微服务接口的接口类型、接口方法名、接口类名、接口入参和出参等信息，从而生成接口重定向类文件和接口参数检查类文件；

微服务接口发布时，代码传输模块104通过微服务接口基本信息管理模块1022查询获取代码上传路径、代码库用户名和代码库密码，校验代码上传路径是否可用以及代码库用户名和代码库密码是否正确，检查完毕将微服务接口代码上传至代码存储模块105。

实施例2：

如图2所示，本公开实施例2提供了一种微服务应用开发管理方法，包括以下步骤：

步骤201，根据业务需求设计系统划分单位；

步骤202，在某一个系统划分单位的基础上，维护所述微服务应用的基本信息，包括微服务应用编号、微服务应用名称、负责人编号、负责人名称、代码库类型、所属系统划分基本单位、代码库路径等；

步骤203，根据微服务应用类型，从代码库获取微服务应用模板代码；

步骤204，根据微服务应用基本信息和微服务应用模板代码生成微服务应用代码；

步骤205，根据微服务应用基本信息中代码库地址、代码库用户名和代码库密码，将微服务应用生成代码上传至代码库。

实施例3：

如图3所示，本公开实施例3提供了一种服务提供者开发管理方法，包括以下步骤：

步骤301，设计微服务接口的基本信息，包括设计接口类型、接口中文名、接口方法名、接口类名、接口入参和接口出参，完成微服务接口设计；

步骤302，下载服务提供者代码到本地，其特征在于，包括当前微服务应用提供的所有微服务接口，根据已设计微服务接口的接口信息，生成微服务接口重定向类文件用于将微服务请求分发至相应处理类，同时生成接口参数检查类文件；

步骤303，发布服务提供者，完成接口相应处理类编写后，开发人员在本地编辑器提交相应处理类文件，并在系统中上传重定向类文件和接口参数检查类文件至代码库，完成服务提供者一次开发过程。

实施例4：

本公开实施例4提供了一种服务消费者开发管理方法，包括以下步骤：

步骤401，选择服务提供者，设置当前服务消费者类文件路径和服务消费者名称；

步骤402，在服务提供者接口列表中选择所述服务消费者需要调用的接口；

步骤403，填写代码库用户名和密码，将当前服务消费者类文件上传至代码库。

本领域内的技术人员应明白，本公开的实施例可提供为方法、系统、或计算机程序产品。因此，本公开可采用硬件实施例、软件实施例、或结合软件和硬件方面的实施例的形式。而且，本公开可采用在一个或多个其中包含有计算机可用程序代码的计算机可用存储介质(包括但不限于磁盘存储器和光学存储器等)上实施的计算机程序产品的形式。

本公开是参照根据本公开实施例的方法、设备(系统)、和计算机程序产品的流程图和/或方框图来描述的。应理解可由计算机程序指令实现流程图和/或方框图中的每一流程和/或方框、以及流程图和/或方框图中的流程和/或方框的结合。可提供这些计算机程序指令到通用计算机、专用计算机、嵌入式处理机或其他可编程数据处理设备的处理器以产生一个机器，使得通过计算机或其他可编程数据处理设备的处理器执行的指令产生用于实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能的装置。

这些计算机程序指令也可存储在能引导计算机或其他可编程数据处理设备以特定方式工作的计算机可读存储器中，使得存储在该计算机可读存储器中的指令产生包括指令装置的制造品，该指令装置实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能。

这些计算机程序指令也可装载到计算机或其他可编程数据处理设备上，使得在计算机或其他可编程设备上执行一系列操作步骤以产生计算机实现的处理，从而在计算机或其他可编程设备上执行的指令提供用于实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能的步骤。

本领域普通技术人员可以理解实现上述实施例方法中的全部或部分流程，是可以通过计算机程序来指令相关的硬件来完成，所述的程序可存储于一计算机可读取存储介质中，该程序在执行时，可包括如上述各方法的实施例的流程。其中，所述的存储介质可为磁碟、光盘、只读存储记忆体(Read-Only Memory，ROM)或随机存储记忆体(RandomAccessMemory，RAM)等。

以上所述仅为本公开的优选实施例而已，并不用于限制本公开，对于本领域的技术人员来说，本公开可以有各种更改和变化。凡在本公开的精神和原则之内，所作的任何修改、等同替换、改进等，均应包含在本公开的保护范围之内。

Claims (10)

1.一种自动生成代码的微服务管理系统，其特征在于，包括：

系统划分单位管理模块，至少被配置为：根据业务背景自定义划分功能模块的基本单位；

基本信息管理模块，至少被配置为：管理微服务应用和微服务接口的基本信息；

代码生成模块，至少被配置为：用于根据所述微服务应用的基本信息和微服务应用模板代码生成微服务应用代码，根据微服务接口基本信息和微服务应用代码生成微服务接口代码。

2.如权利要求1所述的自动生成代码的微服务管理系统，其特征在于，所述基本信息管理模块，至少包括微服务应用基本信息管理模块，用于创建、编辑和存储微服务应用的基本信息。

3.如权利要求2所述的自动生成代码的微服务管理系统，其特征在于，微服务应用的基本信息至少包括微服务应用编号、微服务应用名称、负责人编号、负责人名称、代码库类型、所属系统划分基本单位、代码库路径、代码库用户名、代码库密码和微服务接口服务提供者所在包路径。

4.如权利要求1所述的自动生成代码的微服务管理系统，其特征在于，所述基本信息管理模块，至少包括微服务接口基本信息管理模块，用于创建、编辑和存储微服务接口的基本信息。

5.如权利要求4所述的自动生成代码的微服务管理系统，其特征在于，微服务接口包括服务提供者和服务消费者，服务提供者的基本信息至少包括接口类型、接口中文名、接口方法名、接口类名、接口入参和接口出参；

所述服务消费者的基本信息包括接口类名、接口类路径、接口中文名、服务提供者所属微服务应用名称和服务提供者接口方法名。

6.如权利要求1所述的自动生成代码的微服务管理系统，其特征在于，所述代码生成模块，至少包括微服务应用代码生成模块，用于根据微服务应用模板代码和微服务应用的基本信息生成微服务应用代码；

或者，所述系统还包括代码传输模块，至少被配置为：发送微服务应用模板代码到代码生成模块，上传微服务应用和微服务接口代码到代码存储模块。

7.如权利要求1所述的自动生成代码的微服务管理系统，其特征在于，所述代码生成模块，至少包括微服务接口代码生成模块，对于服务提供者代码，生成代码至少包括接口重定向类文件和接口参数检查类文件；对于服务消费者代码，生成代码至少包括发送请求类文件和接口参数检查类文件。

8.一种微服务应用代码生成管理方法，其特征在于，包括以下步骤：

根据业务需求设计系统划分单位；

在某一个系统划分单位的基础上，维护所述微服务应用的基本信息，至少包括微服务应用编号、微服务应用名称、负责人编号、负责人名称、代码库类型、所属系统划分基本单位和代码库路径；

根据微服务应用类型，从代码库获取微服务应用模板代码；

根据微服务应用基本信息和微服务应用模板代码生成微服务应用代码；

根据微服务应用基本信息中代码库地址、代码库用户名和代码库密码，将微服务应用生成代码上传至代码库。

9.一种微服务接口代码生成管理方法，其特征在于，应用于服务提供者，包括以下步骤：

获取微服务接口的基本信息，至少包括接口类型、接口中文名、接口方法名、接口类名、接口入参和接口出参；

下载服务提供者代码到本地，至少包括当前微服务应用提供的所有微服务接口，根据微服务接口的基本信息，生成微服务接口重定向类文件，将微服务请求分发至相应处理类，同时生成接口参数检查类文件；

完成接口相应处理类编写后，提交相应处理类文件，并在系统中上传重定向类文件和接口参数检查类文件至代码库。

10.一种微服务接口代码生成管理方法，其特征在于，应用于服务消费者，包括以下步骤：

选择服务提供者，设置当前服务消费者类文件路径和服务消费者名称；

在服务提供者接口列表中选择所述服务消费者需要调用的接口；

填写代码库用户名和密码，将当前服务消费者类文件上传至代码库。

Images