CN106648587A - 一种基于注解的Web应用代码生成方法 - Google Patents

Abstract

本发明涉及一种基于注解的Web应用代码生成方法，包括如下步骤：S1:运行Ant，并启动代码生成技术；S2：分析类的注解读取方法；S3：读取相关分析类的注解内容；S4：返回给本业务模块的分析类；S5：返回给代码生成技术；S6：代码生成技术将从注解中获得的业务描述信息发送给Freemarker模板引擎；S7：Freemarker模板引擎生成源代码；S8：Ant启动目标代码编译任务；S9：源代码进行编译、复制、生成jar包或war包；S10：Ant启动Jetty任务，发布Web应用。所述的一种基于注解的Web应用代码生成方法，能大幅度缩减编码过程及与之相关的详细设计及单元测试时间。

Description

一种基于注解的Web应用代码生成方法

技术领域

本发明属于软件工程计算机算法技术领域，具体涉及一种基于注解的Web应用代码生成方法。

背景技术

现有技术的方案主要从以下几个方面阐述：

一般的，软件开发过程包括：需求分析、概要设计、系统详细设计、编码、单元测试、集成测试等步骤。其中数据库表设计是系统概要设计的一部分工作。

现有技术的通常代码生成器，通常着眼于替代程序员“编码”的工具。“编码”仅仅是软件开发过程的一个组成部分，并且编码工作必须依赖于前期需求分析、概要设计、系统详细设计的工作成果。现有的技术方案，《Web应用代码生成系统的设计与实现》文献1，需要分别对控制器、视图、模型层进行配置，可以认为是基于模块的“详细设计”进行的。另外《基于J2EE的Web应用开发平台代码生成器设计与实现》的文献2，则是基于“数据库表设计”进行的。

《Web应用代码生成系统的设计与实现》文献1的技术方案，使用XML文件分别对所要生成的源代码各个层次进行配置。如图1(从文档中截图)所示，“栏目”的模块分别对模型层、控制层、视图层等的代码进行配置。由于需要分别对各个层次的代码进行配置，实际上必须在《详细设计》文档完成后，根据详细设计才能进行。这种方法的主要缺点有：(1)对于单个业务模块来说，需要分为控制层、视图层、模型层分别配置，每个层都需要配置其特定信息，例如控制层需要配置其视图的链接、执行的SQL操作等；模型层则需要配置属性的名称、类型；视图层也需要对JSP文件的名称、类型等进行配置，非常繁杂。(2)由于其配置的思想是基于单个模块进行分层次的XML配置，各层次的配置均无法指向其他的业务模块。而实际上，任何一个Web应用的模块都与其他业务对象之间存在关联，例如，某系统的员工管理模块，新增、删除、修改员工时，必然需要指定该员工的所属部门，可能采用下拉框或树型结构等方式供用户选择。《Web应用代码生成系统的设计与实现》文献1中所指的XML方式中，就无法生成与部门下拉框等相关的代码(因为无法正确引用到另外一个业务模块“部门管理”的相关内容)。

目前《基于J2EE的Web应用开发平台代码生成器设计与实现》文献2的技术方案，使用9张数据库表分别对所要生成的业务模块对应的数据实体进行配置，从图2可以看出，9张配置表围绕着业务模块对应的数据库表实体进行配置，所利用的是数据库设计输出的表结构(包括主外键关系)、系统编码等信息。数据库设计属于系统概要设计的数据模型部分，比较能够真实反映源代码中偏底层的部分(尤其是DAO层代码)。但数据库设计毕竟不能替代系统的整体设计，基于数据库设计的观念，所生成的代码将严重依赖于数据库的底层增删改查功能，而不具备对业务层、控制层的表述能力。《基于J2EE的Web应用开发平台代码生成器设计与实现》的文献所采用的数据库方式，其主要缺点为：(1)需要9张数据表用于配置，分别用于保存实体信息、实体项信息、实体外键信息、实体统计图、实体个性化信息、实体统计图个性化信息、系统编码、编码明细等9项配置。需要的配置信息繁杂，且非常琐碎，把原本整体的模块概念，分为9个不同的角度理解，并用数据库表描述其配置信息，人为增加了复杂度；(2)系统设计基于数据实体的层面，考虑的层级较低。我们知道，无论是结构化设计还是面向对象设计，都是自顶向下设计。即从用户需求出发，自顶向下设计。数据库表结构是系统分析设计的结果，以数据实体作为配置的基础，将使得系统只具备单个数据库表的增删改查功能，而不具备处理更为复杂的业务模块生成能力。例如，一个员工查询的页面，是否需要以该员工所属部门作为查询条件？这样的配置信息与数据库表结构无关，纯粹属于页面展现的配置，在现有所指的技术方案中就无法实现配置。

基于上述1和2文献的描述中，《Web应用代码生成系统的设计与实现》文献1的技术方案是基于单个业务对象(例如员工)的XML配置生成多个层次(控制器、视图、模型等)的代码；《基于J2EE的Web应用开发平台代码生成器设计与实现》文献2的技术方案是基于单个实体的9个配置表配置进行生成。而实际的业务场景远比此复杂(例如员工的增删改查必然涉及到该员工所属部门的表结构和界面展现)。因此，上述两种方案所生成的代码不具备立即编译执行的可能性，而需要人工添加各业务对象或各实体之间的关系代码，并在大量添加代码后，再进行编译调试。事实上，在大量添加各业务对象关系代码的同时，将引入很多错误，生成器对于软件工程过程所起到的效用有限。

发明内容

本发明要解决的技术问题是：为了克服上述中存在的问题，提供了一种基于注解的Web应用代码生成方法，该方法以面向对象分析设计(OOAD)技术为基础，基于面向对象分析的工作成果“分析类”，并以注解方式描述分析类及分析类之间的关联关系，并将面向对象分析(OOA)所建立的分析类模型，转化为Web应用的源代码(例如Java及JSP代码)，并自动编译通过、发布执行。

本发明解决其技术问题所采用的技术方案是：一种基于注解的Web应用代码生成方法，其特征是,包括如下步骤：

S1:运行Ant，并启动代码生成技术；

S2：代码生成技术调用本业务对应的分析类的注解读取方法；

S3：在读取本业务的分析类属性的注解时，需要读取相关分析类的注解内容，比如在一个对象模型中，一个分析类总是与其他分析类存在相互关联，例如在一个房屋管理系统中，分析类房屋(House)的一个属性“所属楼栋”就会关联到分析类楼栋(Building)；

S4：相关的分析类将注解内容转化为Map<String,Object>格式的数据对象，返回给本业务模块的分析类；

S5：本业务模块的分析类将所有注解描述的内容转化为Map<String,Object>格式的数据对象，并返回给代码生成技术；

S6：代码生成技术将从注解中获得的业务描述信息发送给Freemarker模板引擎；

S7：Freemarker模板引擎依次调用各个源代码模板，与输入的数据生成源代码，源代码包括Java、JSP、sql脚本等；

S8：Ant启动目标代码编译任务；

S9：代码编译任务对上述生成的源代码进行编译、复制、生成jar包或war包；

S10：Ant启动Jetty任务，发布Web应用。

所述的Ant是一个将软件编译、测试、部署等步骤联系在一起加以自动化的一个工具，大多用于Java环境中的软件开发。由Apache软件基金会所提供。Ant与linux系统下的make功能相似，且具有跨平台、操作简便、扩展方便等优点。Ant可以便利地执行编译、启动Java程序(例如Jetty)、文件管理等固有任务，也可以通过Java语言开发自定义任意以实现特定的功能。

所述的代码生成技术是将已有软件的各种有关知识用于建立新的软件，以缩减软件开发和维护的花费的一种技术，在web应用开发领域，编码和与编码密切相关的详细设计、单元测试环节占据了大部分工期和工时。代码生成技术将本企业在web应用开发领域的相关技术、经验、知识，以“代码生成器”模板的方式进行固化，并配合适当的“配置信息”生成代码，达到软件复用的目标。常用的配置信息表达方式主要由：XML、JSON。代码生成技术是软件复用方法的一个特例，软件复用对于提高软件生产力和质量非常重要。在web应用开发领域，复用本公司以往的类似产品的部分模块，已经成为一种比较常见的做法。但是，由于业务领域的巨大差异，即使在一个企业的范围之内，往往也只能对组织结构管理、用户管理、角色权限管理等少数公共功能模块进行复用。而更大范围内大量业务模块就不具备复用价值。

所述的注解是现代编程语言在代码级别的说明，声明在类、属性、方法、局部变量、方法参数等的前面，用来对这些元素进行说明。注解(Annotation)的特点在于保存在编译后的类文件(.class)中，程序运行时使用反射(Reflect)机制获取注解(Annotation)，以得到指定的类、属性、方法、参数、局部变量、方法参数等的额外信息。

所述的分析类是采用面向对象分析所获得的类模型。

所述的面向对象分析是在比较明确的用户需求基础上，通过对问题空间的分析，把问题分解为一些对象与类，并找出这些对象的属性与服务，以及对象之间的关系，并以此建立以对象为单元的信息系统逻辑模型。

所述的Freemarker模板引擎是一种基于模板和要改变的数据，并用来生成输出文本格式的各类文件等的通用工具。由于Web应用软件的源代码Java、JSP、JavaScript等均为文本格式，因此可用Freemarker模板引擎结合适当的自定义模板创建。

本发明的有益效果是：所述的一种基于注解的Web应用代码生成方法，该方法基于软件工程过程初级阶段(OOA)的成果，抽象级别较高；生成的目标代码已经包含分析类之间的关系；且能够编译通过并已经能正常运行，因此能大幅度缩减编码过程及与之相关的详细设计及单元测试时间，以达到大幅度提升软件工程生产率和产品质量的目标，具体优点如下：

1、基于面向对象分析(OOA)的工作成果分析类，在项目早期即可进行代码生成；

2、采用基于注解描述作为配置的方式，比XML与数据库表配置更便利；

3、基于上述步骤，生成的代码可自动编译通过，并可启动运行，在项目早期可反复调整原型，并重新生成；

4、采用bootstrap等通用第三方组件技术，界面代码标准美观、便于修改。

附图说明

下面结合附图和实施例对本发明进一步说明。

图1是《Web应用代码生成系统的设计与实现》文献1中摘抄的编程代码；

图2是《基于J2EE的Web应用开发平台代码生成器设计与实现》文献2中所描述的图；

图3是本发明的一种基于注解的Web应用代码生成方法的实施例时序图；

图4是本发明的一种基于注解的Web应用代码生成方法的实施例实际代码生成结果图；

图5是本发明的一种基于注解的Web应用代码生成方法的实施例实际代码生成另一结果图；

具体实施方式

现在结合附图对本发明作进一步详细的说明。这些附图均为简化的示意图，仅以示意方式说明本发明的基本结构，因此其仅显示与本发明有关的构成。

如图3所示的一种基于注解的Web应用代码生成方法，包括如下步骤：

S1:运行Ant，并启动代码生成技术，Ant是一个将软件编译、测试、部署等步骤联系在一起加以自动化的一个工具，大多用于Java环境中的软件开发；

S2：代码生成技术调用本业务对应的分析类的注解读取方法，代码生成技术是将已有软件的各种有关知识用于建立新的软件，以缩减软件开发和维护的花费的一种技术；

S3：在读取本业务的分析类属性的注解时，需要读取相关分析类的注解内容，注解是现代编程语言在代码级别的说明；

S4：相关的分析类将注解内容转化为Map<String,Object>格式的数据对象，返回给本业务模块的分析类，分析类是采用面向对象分析所获得的类模型，面向对象分析是在比较明确的用户需求基础上，通过对问题空间的分析，把问题分解为一些对象与类，并找出这些对象的属性与服务，以及对象之间的关系，并以此建立以对象为单元的信息系统逻辑模型；

S5：本业务模块的分析类将所有注解描述的内容转化为Map<String,Object>格式的数据对象，并返回给代码生成技术；

S6：代码生成技术将从注解中获得的业务描述信息发送给Freemarker模板引擎，Freemarker模板引擎是一种基于模板和要改变的数据，并用来生成输出文本格式的各类文件等的通用工具；

S7：Freemarker模板引擎依次调用各个源代码模板，与输入的数据生成源代码；

S8：Ant启动目标代码编译任务；

S9：代码编译任务对上述生成的源代码进行编译、复制、生成jar包或war包；

S10：Ant启动Jetty任务，发布Web应用。

经过以上S1-S10的步骤，完成了从代码生成、编译、启动Web服务器(Jetty)等一系列工作。

第一、分析类采用面向对象分析的工作成果，本方法基于软件工程过程初级阶段(OOA)的工作成果，这使得配置的基础具有较高的抽象性，这就确保了代码生成的配置在最大程度上拟合了目标系统。而现有技术通常是基于数据库表这样的低层次抽象，或者是对目标代码的各层次(控制器、模型、视图等)分别做抽象；

第二、基于“注解”(Annotation)描述风格，使用XML或数据库配置，都存在配置数据过多或过于分散的问题，且难以表示各个业务模块之间的相关性；

第三、生成的代码不但包含了本模块的特性，还能够正确引用相关的模块特性。例如，在生成的员工管理模块的新增员工功能中，生成的代码可以对该员工选择适当的所属部门。而其他现有方法通常只能对本业务模块、本业务实体进行描述，而难以关联到相关的业务模块。基于“注解”描述时，用注解的Java类描述“分析类”，不但可以描述本业务模块的特性，还可以通过属性引用到相关的“分析类”，这些被引用的分析类同样是注解描述风格的。

基于以上第三点，由于生成的代码已经能够正确本模块及相关联的业务模块属性，该代码质量很高，与最终程序员所需要的目标代码已经非常接近。一般的，只需要对生成的页面适当排版即可。

实施例：

本发明的一种基于注解的Web应用代码生成方法，进一步对生成的代码进行自动编译、发布执行；如果前期在模块关系中配置有误，在自动编译、发布的过程中将自动检查出来，例如图4所示，代码生成“楼栋管理”，“楼栋管理”页面已经完全可用，无需修改，自动编译部署后查询结果正确。如图5所示，“更改楼栋”页面同样也自动编译部署正确，并且相关的楼栋类型、省份、市、县等均能显示其名称。

以上述依据本发明的理想实施例为启示，通过上述的说明内容，相关工作人员完全可以在不偏离本项发明技术思想的范围内，进行多样的变更以及修改。本项发明的技术性范围并不局限于说明书上的内容，必须要根据权利要求范围来确定其技术性范围。

Claims (7)

1.一种基于注解的Web应用代码生成方法，其特征是,包括如下步骤：

S1:运行Ant，并启动代码生成技术；

S2：代码生成技术调用本业务对应的分析类的注解读取方法；

S3：在读取本业务的分析类属性的注解时，需要读取相关分析类的注解内容；

S4：相关的分析类将注解内容转化为Map<String,Object>格式的数据对象，返回给本业务模块的分析类；

S5：本业务模块的分析类将所有注解描述的内容转化为Map<String,Object>格式的数据对象，并返回给代码生成技术；

S6：代码生成技术将从注解中获得的业务描述信息发送给Freemarker模板引擎；

S7：Freemarker模板引擎依次调用各个源代码模板，与输入的数据生成源代码；

S8：Ant启动目标代码编译任务；

S9：代码编译任务对上述生成的源代码进行编译、复制、生成jar包或war包；

S10：Ant启动Jetty任务，发布Web应用。

2.根据权利要求1所述的一种基于注解的Web应用代码生成方法，其特征是:所述的Ant是一个将软件编译、测试、部署等步骤联系在一起加以自动化的一个工具，大多用于Java环境中的软件开发。

3.根据权利要求1所述的一种基于注解的Web应用代码生成方法，其特征是:所述的代码生成技术是将已有软件的各种有关知识用于建立新的软件，以缩减软件开发和维护的花费的一种技术。

4.根据权利要求1所述的一种基于注解的Web应用代码生成方法，其特征是:所述的注解是现代编程语言在代码级别的说明。

5.根据权利要求1所述的一种基于注解的Web应用代码生成方法，其特征是:所述的分析类是采用面向对象分析所获得的类模型。

6.根据权利要求5所述的一种基于注解的Web应用代码生成方法，其特征是:所述的面向对象分析是在比较明确的用户需求基础上，通过对问题空间的分析，把问题分解为一些对象与类，并找出这些对象的属性与服务，以及对象之间的关系，并以此建立以对象为单元的信息系统逻辑模型。

7.根据权利要求1所述的一种基于注解的Web应用代码生成方法，其特征是:所述的Freemarker模板引擎是一种基于模板和要改变的数据，并用来生成输出文本格式的各类文件等的通用工具。