CN106598620A - 代码生成方法及代码生成器 - Google Patents

Abstract

本发明公开一种代码生成方法及代码生成器，其中，该代码生成方法包括步骤：根据项目基本构建，生成前置代码规划；结合Jetty插件及.ftl文件，配置各层次的代码规划及代码生成模板；将代码生成模板套用在MVC三层架构，生成目标代码。本发明技术方案为基于jetty开源插件和freemarker框架的代码生成，该代码生成方法可灵活配置各个环节所生成的代码模型，提高了代码生成的效率的同时还提升了代码的质量。

Description

代码生成方法及代码生成器

技术领域

本发明涉及计算机软件技术领域，特别涉及代码生成方法及代码生成器。

背景技术

在项目开发过程中，对业务逻辑开发总存在一些重复性代码编写工作，如开发ORM、POJO、数据库DDL操作等，处理起来繁杂，效率低下，容易出错；而采用web配置式代码生成工具协助项目开发，是解决此问题的有效方法。目前代码生成工具主要是用数据库模型来生成，代码生成技术较多应用在集成开发环境。但多数代码生成器生成的代码模板和种类都已预定义，难改变代码结构与风格，灵活性欠佳，不能满足软件开发的各种规范性开发，同时由于代码框架已预定义，生成的代码都是一套式，缺乏针对性的应对各个技术环节，进行既定式的代码生成。

发明内容

本发明的主要目的是提供一种代码生成方法，旨在提供一种可灵活配置各个环节所生成的代码模型的代码生成方法。

为实现上述目的，本发明提出的代码生成方法包括步骤：

根据项目基本构建，生成前置代码规划；

结合Jetty插件及.ftl文件，配置各层次的代码规划及代码生成模板；

将所述代码生成模板套用在MVC三层架构，生成目标代码。

优选地，结合Jetty插件及.ftl文件，配置各层次的代码规划及代码生成模板的步骤包括：

配置表设计或.hbm.xml文件，Jetty插件调用.ftl文件，将其转换为Java代码模型；

根据类型转换配置与业务表数据，结合实体类.ftl文件，生成get、set方法的数据层代码；

根据数据层代码与业务表，结合.hbm.xml模板文件，生成ORM映射文件；

根据配置的代码规范中的类，结合hbm.xml文件中的name属性及.ftl文件中的后缀命名，生成类名，根据配置代码规范中的方法命名前缀与.ftl文件中的方法后缀，生成方法名称；

根据配置代码规范中的方法命名前缀及配置的数据库脚本，生成所需的数据控制层逻辑。

优选地，将所述代码生成模板套用在MVC三层架构，生成目标代码的步骤包括：

根据页面配置或默认路径的目标代码保存的路径，将目标代码输出到指定的路径或工程中，生成包括MVC三个层次的目标代码；

将输出目录中生成的代码拷贝到实际运行环境中进行调试，做定制业务逻辑部分的开发。

优选地，将所述代码生成模板套用在MVC三层架构，生成目标代码的步骤包括：

根据页面配置或默认路径的目标代码保存的路径，将目标代码输出到指定的路径或工程中，生成包括MVC三个层次的目标代码；

输出的代码部署到工程目录下，由前台维护逻辑处理。

优选地，根据项目基本构建，生成前置代码规划的步骤包括：

数据层规划，根据项目基本构建，规划数据层架构；

数据控制层规划，根据项目基本构建，规划数据控制层架构；

业务逻辑层规划，根据项目基本构建，规划业务逻辑层架构。

本发明还提出一种代码生成器，包括：

规划模块，根据项目基本构建，生成前置代码规划；

配置模块，结合Jetty插件及.ftl文件，配置各层次的代码规划及代码生成模板；

代码生成模块，将所述代码生成模板套用在MVC三层架构，生成目标代码。

优选地，所述配置模块包括：

转换模块，配置表设计或.hbm.xml文件，Jetty插件调用.ftl文件，将其转换为Java代码模型；

数据层配置模块，根据类型转换配置与业务表数据，结合实体类.ftl文件，生成get、set方法的数据层代码；

映射文件模块，根据数据层代码与业务表，结合.hbm.xml模板文件，生成ORM映射文件；

命名模块，根据配置的代码规范中的类，结合hbm.xml文件中的name属性及.ftl文件中的后缀命名，生成类名，根据配置代码规范中的方法命名前缀与.ftl文件中的方法后缀，生成方法名称；

数据控制层配置模块，根据配置代码规范中的方法命名前缀及配置的数据库脚本，生成所需的数据控制层逻辑。

优选地，所述代码生成模块包括：

生成模块，根据页面配置或默认路径的目标代码保存的路径，将目标代码输出到指定的路径或工程中，生成包括MVC三个层次的目标代码；

拷贝模块，将输出目录中生成的代码拷贝到实际运行环境中进行调试，做定制业务逻辑部分的开发。

优选地，所述代码生成模块包括：

生成模块，根据页面配置或默认路径的目标代码保存的路径，将目标代码输出到指定的路径或工程中，生成包括MVC三个层次的目标代码；

部署模块，输出的代码部署到工程目录下，由前台维护逻辑处理。

优选地，所述代码规划模块包括：

数据层规划模块，根据项目基本构建，规划数据层架构；

数据控制层规划模块，根据项目基本构建，规划数据控制层架构；

业务逻辑层规划模块，根据项目基本构建，规划业务逻辑层架构。

本发明技术方案通过步骤：根据项目基本构建，生成前置代码规划；结合Jetty插件及.ftl文件，配置各层次的代码规划及代码生成模板；将所述代码生成模板套用在MVC三层架构，生成目标代码。本发明基于Jetty插件及freemarker框架来实现代码的生成，可灵活配置各个环节所生成的代码模型，提高了代码生成的效率的同时还提升了代码的质量，将代码自动生成与Jetty开源插件捆绑一起，提升了易用性与拓展性。

附图说明

为了更清楚地说明本发明实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本发明的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图示出的结构获得其他的附图。

图1为本发明代码生成方法一实施例的流程图；

图2为图1中步骤S20的流程图；

图3为图1中步骤S30的流程图；

图4为图1中步骤S30一实施方式的流程图；

图5为图1中步骤S10另一实施方式的流程图；

图6为本发明代码生成器一实施例的功能模块图；

图7为图6中配置模块的功能模块图；

图8为图6中代码生成模块以实施方式的功能模块图；

图9为图6中代码生成模块另一实施方式的功能模块图；

图10为图6中规划模块的功能模块图。

附图标号说明：

标号	名称	标号	名称
				10	规划模块	22	数据层配置模块
20	配置模块	23	映射文件模块
				30	代码生成模块	24	命名模块
11	数据层规划模块	25	数据控制层配置模块
				12	数据控制层规划模块	31	生成模块
13	业务逻辑层规划模块	32	拷贝模块
				21	转换模块	33	部署模块

本发明目的的实现、功能特点及优点将结合实施例，参照附图做进一步说明。

具体实施方式

下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本发明的一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有作出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。

需要说明，本发明实施例中所有方向性指示(诸如上、下、左、右、前、后……)仅用于解释在某一特定姿态(如附图所示)下各部件之间的相对位置关系、运动情况等，如果该特定姿态发生改变时，则该方向性指示也相应地随之改变。

另外，在本发明中涉及“第一”、“第二”等的描述仅用于描述目的，而不能理解为指示或暗示其相对重要性或者隐含指明所指示的技术特征的数量。由此，限定有“第一”、“第二”的特征可以明示或者隐含地包括至少一个该特征。另外，各个实施例之间的技术方案可以相互结合，但是必须是以本领域普通技术人员能够实现为基础，当技术方案的结合出现相互矛盾或无法实现时应当认为这种技术方案的结合不存在，也不在本发明要求的保护范围之内。

本发明提出一种代码生成方法。

参照图1，该代码生成方法包括步骤：

S10：根据项目基本构建，生成前置代码规划；

S20：结合Jetty插件及.ftl文件，配置各层次的代码规划及代码生成模板；

S30：将所述代码生成模板套用在MVC三层架构，生成目标代码。

需要说明的是，MVC全名是Model View Controller，是模型(model)、视图(view)、控制器(controller)的缩写，一种软件设计典范，用一种业务逻辑、数据、界面显示分离的方法组织代码，将业务逻辑聚集到一个部件里面，在改进和个性化定制界面及用户交互的同时，不需要重新编写业务逻辑。MVC被独特的发展起来用于映射传统的输入、处理和输出功能在一个逻辑的图形化用户界面的结构中。

进一步地，Jetty是一个开源的servlet容器，它为基于Java的web容器，例如JSP和servlet提供运行环境。Jetty是使用Java语言编写的，它的API以一组JAR包的形式发布。开发人员可以将Jetty容器实例化成一个对象，可以迅速为一些独立运行的Java应用提供网络和web连接。Jetty具有以下优点：

易用性，易用性是Jetty设计的基本原则，通过XML或者API来对Jetty进行配置；默认配置可以满足大部分的需求；将Jetty嵌入到应用程序当中只需要非常少的代码；

可扩展性，在使用了Ajax的Web 2.0的应用程序中，每个连接需要保持更长的时间，这样线程和内存的消耗量会急剧的增加。这就使得我们担心整个程序会因为单个组件陷入瓶颈而影响整个程序的性能。但是有了Jetty，即使在有大量服务请求的情况下，***的性能也能保持在一个可以接受的状态。利用Continuation机制来处理大量的用户请求以及时间比较长的连接。Jetty设计了非常良好的接口，因此在Jetty的某种实现无法满足用户的需要时，用户可以非常方便地对Jetty的某些实现进行修改，使得Jetty适用于特殊的应用程序的需求。

易嵌入性，Jetty设计之初就是作为一个优秀的组件来设计的，这也就意味着Jetty可以非常容易的嵌入到应用程序当中而不需要程序为了使用Jetty做修改。从某种程度上，你也可以把Jetty理解为一个嵌入式的Web服务器。Jetty可以作为嵌入式服务器使用，Jetty的运行速度较快，而且是轻量级的，可以在Java中可以从test case中控制其运行。从而可以使自动化测试不再依赖外部环境，顺利实现自动化测试。

进一步地，FreeMarker是一款模板引擎，即一种基于模板和要改变的数据，并用来生成输出文本(HTML网页、电子邮件、配置文件、源代码等)的通用工具。它是一个Java类库，是一款程序员可以嵌入他们所开发产品的组件。

本发明实施例中，根据项目基本构建，生成前置代码规划的步骤S10包括了规范定义、存放路径、方法名、类名等的前置规划。

步骤S20具体为，通过获取配置信息设计结合Jetty封装代码模型器结合调用代码模型文件*.ftl，生成配置信息模型，然后通过Java模型生成器转换生成具体代码到指定路径。

本发明技术方案通过步骤：根据项目基本构建，生成前置代码规划；结合Jetty插件及.ftl文件，配置各层次的代码规划及代码生成模板；将所述代码生成模板套用在MVC三层架构，生成目标代码。本发明基于Jetty插件及freemarker框架来实现代码的生成，可灵活配置各个环节所生成的代码模型，提高了代码生成的效率的同时还提升了代码的质量，将代码自动生成与Jetty开源插件捆绑一起，提升了易用性与拓展性。

参照图2，具体地，结合Jetty插件及.ftl文件，配置各层次的代码规划及代码生成模板的步骤S20包括：

S21：配置表设计或.hbm.xml文件，Jetty插件调用.ftl文件，将其转换为Java代码模型；

S22：根据类型转换配置与业务表数据，结合实体类.ftl文件，生成get、set方法的数据层代码；

S23：根据数据层代码与业务表，结合.hbm.xml模板文件，生成ORM映射文件；

S24：根据配置的代码规范中的类，结合hbm.xml文件中的name属性及.ftl文件中的后缀命名，生成类名，根据配置代码规范中的方法命名前缀与.ftl文件中的方法后缀，生成方法名称；

S25：根据配置代码规范中的方法命名前缀及配置的数据库脚本，生成所述的数据控制层逻辑。

参照图3，具体地，将所述代码生成模板套用在MVC三层架构，生成目标代码的步骤S30包括：

S31：根据页面配置或默认路径的目标代码保存的路径，将目标代码输出到指定的路径或工程中，生成包括MVC三个层次的目标代码；

S32：将输出目录中生成的代码拷贝到实际运行环境中进行调试，做定制业务逻辑部分的开发。

参照图4，具体地，将所述代码生成模板套用在MVC三层架构，生成目标代码的步骤S30包括：

S31：根据页面配置或默认路径的目标代码保存的路径，将目标代码输出到指定的路径或工程中，生成包括MVC三个层次的目标代码；

S33：输出的代码部署到工程目录下，由前台维护逻辑处理。

需要说明的是，通过输出目录中生成的代码拷贝到实际运行环境中做定制业务逻辑部分的开发，或输出的代码部署到工程目录下由前台维护逻辑处理，可增强页面的可视化，即以“所见即所得”的编程思想为原则，随时可以看到结果，代码与结果的同步调整。

参照图5，具体地，根据项目基本构建，生成前置代码规划的步骤S10包括：

S11：数据层规划，根据项目基本构建，规划数据层架构；

S12：数据控制层规划，根据项目基本构建，规划数据控制层架构；

S13：业务逻辑层规划，根据项目基本构建，规划业务逻辑层架构。

需要说明的是，本发明可以仅生成数据层、数据控制层或业务逻辑层之中的一个层次代码，适用于仅修改一个层次数据的情况，使得代码生成的过程更加灵活可控。

本发明在数据层的代码生成的过程为：

数据层配置，根据业务表与设计业务模型配置的对应关系，经过模型匹配生成对应的实体类代码信息。

实体类模型生成：将具体模型转换为代码，实现具体代码的生成。

实体类展示编辑：用于展示代码生成后的展示信息，同时能修正不满足的部分内容。

ORM映射文件生成：通过实体类配置信息，选取实体类映射文件模板，生成与实体类文件对应的ORM映射文件。

本发明生成数据控制层代码的过程为：

数据控制层配置：通过选取的实体类及配置信息，结合代码规划信息，进过模型匹配生成对应的数据控制层类代码信息。

数据控制层模型生成：结合配置信息与数据控制层模型，转换实想用户需要的具体数据控制层代码。

数据控制层模型展示编辑：用于展示代码生成后的展示信息，同时能修正不满足的部分内容。

本发明生成业务逻辑层代码的过程为：

业务逻辑层配置模块：通过选取的实体类及配置信息，结合代码规划信息，进过模型匹配生成对应的业务逻辑层代码信息。

业务逻辑层模型生成：结合配置信息与业务逻辑层模型，转换实想用户需要的业务逻辑层方法基础代码。

业务逻辑层模型展示编辑：用于展示代码生成后的展示信息，同时能修正不满足的部分内容。

参照图6，本发明还提出一种代码生成器，包括：

规划模块10，根据项目基本构建，生成前置代码规划；

配置模块20，结合Jetty插件及.ftl文件，配置各层次的代码规划及代码生成模板；

代码生成模块30，将所述代码生成模板套用在MVC三层架构，生成目标代码。

参照图7，具体地，所述配置模块20包括：

转换模块21，配置表设计或.hbm.xml文件，Jetty插件调用.ftl文件，将其转换为Java代码模型；

数据层配置模块22，根据类型转换配置与业务表数据，结合实体类.ftl文件，生成get、set方法的数据层代码；

映射文件模块23，根据数据层代码与业务表，结合.hbm.xml模板文件，生成ORM映射文件；

命名模块24，根据配置的代码规范中的类，结合hbm.xml文件中的name属性及.ftl文件中的后缀命名，生成类名，根据配置代码规范中的方法命名前缀与.ftl文件中的方法后缀，生成方法名称；

数据控制层配置模块25，根据配置代码规范中的方法命名前缀及配置的数据库脚本，生成所需的数据控制层逻辑。

参照图8，具体地，所述代码生成模块30包括：

生成模块31，根据页面配置或默认路径的目标代码保存的路径，将目标代码输出到指定的路径或工程中，生成包括MVC三个层次的目标代码；

拷贝模块32，将输出目录中生成的代码拷贝到实际运行环境中进行调试，做定制业务逻辑部分的开发。

参照图9，具体地，所述代码生成模块30包括：

生成模块31，根据页面配置或默认路径的目标代码保存的路径，将目标代码输出到指定的路径或工程中，生成包括MVC三个层次的目标代码；

部署模块33，输出的代码部署到工程目录下，由前台维护逻辑处理。

参照图10，具体地，所述代码规划模块10包括：

数据层规划模块11，根据项目基本构建，规划数据层架构；

数据控制层规划模块12，根据项目基本构建，规划数据控制层架构；

业务逻辑层规划模块13，根据项目基本构建，规划业务逻辑层架构。

本发明技术方案通过根据项目基本构建，生成前置代码规划；结合Jetty插件及.ftl文件，配置各层次的代码规划及代码生成模板；将所述代码生成模板套用在MVC三层架构，生成目标代码，三个步骤实现了一种代码生成方法。通过该方法可灵活配置各个环节所生成的代码模型，根据不同的代码模型生成其相对应模型的规范化代码，为产品化的二次开发提供便利；其灵活性及***化的处理方式，在提高了***开发效率的同时也兼顾各种版本的代码规范，提升代码质量；将代码自动生成与Jetty开源插件捆绑一起，提升了装置的易用性与拓展性。

以上所述仅为本发明的优选实施例，并非因此限制本发明的专利范围，凡是在本发明的发明构思下，利用本发明说明书及附图内容所作的等效结构变换，或直接/间接运用在其他相关的技术领域均包括在本发明的专利保护范围内。

Claims (10)

1.一种代码生成方法，其特征在于，包括步骤：

根据项目基本构建，生成前置代码规划；

结合Jetty插件及.ftl文件，配置各层次的代码规划及代码生成模板；

将所述代码生成模板套用在MVC三层架构，生成目标代码。

2.如权利要求1所述的代码生成方法，其特征在于，结合Jetty插件及.ftl文件，配置各层次的代码规划及代码生成模板的步骤包括：

配置表设计或.hbm.xml文件，Jetty插件调用.ftl文件，将其转换为Java代码模型；

根据类型转换配置与业务表数据，结合实体类.ftl文件，生成get、set方法的数据层代码；

根据数据层代码与业务表，结合.hbm.xml模板文件，生成ORM映射文件；

根据配置的代码规范中的类，结合hbm.xml文件中的name属性及.ftl文件中的后缀命名，生成类名，根据配置代码规范中的方法命名前缀与.ftl文件中的方法后缀，生成方法名称；

根据配置代码规范中的方法命名前缀及配置的数据库脚本，生成所需的数据控制层逻辑。

3.如权利要求2所述的代码生成方法，其特征在于，将所述代码生成模板套用在MVC三层架构，生成目标代码的步骤包括：

根据页面配置或默认路径的目标代码保存的路径，将目标代码输出到指定的路径或工程中，生成包括MVC三个层次的目标代码；

将输出目录中生成的代码拷贝到实际运行环境中进行调试，做定制业务逻辑部分的开发。

4.如权利要求2所述的代码生成方法，其特征在于，将所述代码生成模板套用在MVC三层架构，生成目标代码的步骤包括：

根据页面配置或默认路径的目标代码保存的路径，将目标代码输出到指定的路径或工程中，生成包括MVC三个层次的目标代码；

输出的代码部署到工程目录下，由前台维护逻辑处理。

5.如权利要求1至4任意一项所述的代码生成方法，其特征在于，根据项目基本构建，生成前置代码规划的步骤包括：

数据层规划，根据项目基本构建，规划数据层架构；

数据控制层规划，根据项目基本构建，规划数据控制层架构；

业务逻辑层规划，根据项目基本构建，规划业务逻辑层架构。

6.一种代码生成器，其特征在于，包括：

规划模块，根据项目基本构建，生成前置代码规划；

配置模块，结合Jetty插件及.ftl文件，配置各层次的代码规划及代码生成模板；

代码生成模块，将所述代码生成模板套用在MVC三层架构，生成目标代码。

7.如权利要求6所述的代码生成器，其特征在于，所述配置模块包括：

转换模块，配置表设计或.hbm.xml文件，Jetty插件调用.ftl文件，将其转换为Java代码模型；

数据层配置模块，根据类型转换配置与业务表数据，结合实体类.ftl文件，生成get、set方法的数据层代码；

映射文件模块，根据数据层代码与业务表，结合.hbm.xml模板文件，生成ORM映射文件；

命名模块，根据配置的代码规范中的类，结合hbm.xml文件中的name属性及.ftl文件中的后缀命名，生成类名，根据配置代码规范中的方法命名前缀与.ftl文件中的方法后缀，生成方法名称；

数据控制层配置模块，根据配置代码规范中的方法命名前缀及配置的数据库脚本，生成所需的数据控制层逻辑。

8.如权利要求7所述的代码生成器，其特征在于，所述代码生成模块包括：

生成模块，根据页面配置或默认路径的目标代码保存的路径，将目标代码输出到指定的路径或工程中，生成包括MVC三个层次的目标代码；

拷贝模块，将输出目录中生成的代码拷贝到实际运行环境中进行调试，做定制业务逻辑部分的开发。

9.如权利要求7所述的代码生成器，其特征在于，所述代码生成模块包括：

生成模块，根据页面配置或默认路径的目标代码保存的路径，将目标代码输出到指定的路径或工程中，生成包括MVC三个层次的目标代码；

部署模块，输出的代码部署到工程目录下，由前台维护逻辑处理。

10.如权利要求6至9任意一项所述的代码生成器，其特征在于，所述代码规划模块包括：

数据层规划模块，根据项目基本构建，规划数据层架构；

数据控制层规划模块，根据项目基本构建，规划数据控制层架构；

业务逻辑层规划模块，根据项目基本构建，规划业务逻辑层架构。