CN105487864A - 代码自动生成的方法和装置 - Google Patents

Abstract

本发明提供一种代码自动生成的方法和装置，通过编写复杂的查询语言，突破现有技术中只能针对单表进行代码生成的限制，并可根据业务需求对项目的业务模块进行详细配置，使生成出来的代码最大化的符合业务需求。该方法包括：根据业务需求新增业务模块，并利用SQL查询语句配置所述业务模块；将所述业务模块的配置信息保存到数据库中；根据所述配置信息生成代码文件。

Description

代码自动生成的方法和装置

技术领域

本发明涉及计算机技术领域，尤其涉及一种代码自动生成的方法和装置。

背景技术

Web技术广泛的应用于各行各业，像电信、银行、政府、企业、电商等各行业的应用***均可通过Web技术开发实现。随着Web项目的规模越来越庞大，开发周期越来越长，开发成本越来越高，人们越来越青睐能够简单、快速、自动、智能的进行Web项目开发的自动开发平台。

目前已有的自动开发平台实现方式主要是通过个人编写的代码生成器进行代码的自动生成，即开发一个代码生成器，实现按照制定的逻辑自动生成代码。在进行业务模块开发时，首先选择一张业务主表，作为自动代码生成的基础；然后通过个人编写的代码生成器的已有逻辑对选择的业务主表进行自动代码生成，从而减少手工编写代码的工作量。

现有的自动开发平台能够解决项目开发中代码编写的问题，但是仍具有一定的局限性：

1.个人编写的代码生成器逻辑固定、死板，代码只有一种生成方式，无法应对变化多样的需求内容；

2.代码生成器生成的代码只是通过业务主表的字段硬性生成对应的代码内容，没有提供对每个字段进行详细设置的功能，生成后的代码还需要根据需求进行大量修改。

3.代码生成器只能对单表进行处理，对于多表联合查询的情况无法处理，很难适应所有的业务场景。

4.代码生成器大多结合Hibernate来实现数据的持久化操作，写法不够灵活，业务需求变更后，进行代码修改时异常复杂困难。

5.代码生成器生成的代码一般都进行了自定义的封装处理，使用时需要了解对应的封装逻辑，会产生二次学习成本。

发明内容

有鉴于此，本发明提供一种代码自动生成的方法和装置，通过编写复杂的查询语言，突破现有技术中只能针对单表进行代码生成的限制，并可根据业务需求对项目的业务模块进行详细配置，使生成出来的代码最大化的符合业务需求。

为实现上述目的，根据本发明的一个方面，提供了一种代码自动生成的方法。

本发明的代码自动生成的方法包括：根据业务需求新增业务模块，并利用SQL查询语句配置所述业务模块；将所述业务模块的配置信息保存到数据库中；根据所述配置信息生成代码文件。

可选地，利用SQL查询语句配置所述业务模块包括：根据SQL查询语句生成初始化配置信息，所述初始化配置信息包括：涉及的单表信息、Grid基本信息、Grid列信息、Form基本信息、Form列信息；根据业务需求对初始化配置信息进行修改。

可选地，将所述业务模块的配置信息保存到数据库中包括：利用Mybatis持久层框架将所述业务模块的所有配置信息以配置表的形式保存到数据库中。

可选地，根据所述配置信息生成代码文件包括：通过调用Velocity模板引擎获取代码模板，将所述代码模板与所述业务模块的配置信息结合生成前台代码文件和后台代码文件；通过调用MyBatisGenerator文件生成工具，生成MyBatis持久层框架所需的代码文件。

可选地，所述方法还包括：当业务需求变更时，根据业务需求变更的内容修改相应的配置信息并加以保存；根据修改后的配置信息选择需要重新生成的代码文件，进行代码重新生成。

可选地，所述方法还包括：当所述业务模块开发完成，不需要再进行代码生成和变更时，锁定所述业务模块。

为实现上述目的，根据本发明的一个方面，提供了一种代码自动生成的装置。

本发明的代码自动生成的装置包括：配置模块，用于根据业务需求新增业务模块，并利用SQL查询语句配置所述业务模块；保存模块，用于将所述业务模块的配置信息保存到数据库中；代码生成模块，用于根据所述配置信息生成代码文件。

可选地，所述配置模块还用于：根据SQL查询语句生成初始化配置信息，所述初始化配置信息包括：涉及的单表信息、Grid基本信息、Grid列信息、Form基本信息、Form列信息；根据业务需求对初始化配置信息进行修改。

可选地，所述保存模块还用于：利用Mybatis持久层框架将所述业务模块的所有配置信息以配置表的形式保存到数据库中。

可选地，所述代码生成模块还用于：通过调用Velocity模板引擎获取代码模板，将所述代码模板与所述业务模块的配置信息结合生成前台代码文件和后台代码文件；通过调用MyBatisGenerator文件生成工具，生成MyBatis持久层框架所需的代码文件。

可选地，所述装置还用于：当业务需求变更时，配置模块根据业务需求变更的内容修改相应的配置信息；保存模块保存修改后的配置信息；代码生成模块根据修改后的配置信息选择需要重新生成的代码文件，进行代码重新生成。

可选地，所述配置模块还用于：当所述业务模块开发完成，不需要再进行代码生成和变更时，锁定所述业务模块。

根据本发明的技术方案，在web项目开发的过程中，以业务模块为单位，通过配置SQL查询语句，突破现有技术中只能进行单表代码生成的限制，从而实现可以处理任何的业务逻辑；通过对业务模块各字段的详细配置，从而使生成出来的代码最大化的符合业务需求；通过利用Mybatis持久层框架对配置信息以配置表的形式进行持久化，从而使得可以处理的业务范围更宽广，可用性更高，而且生成的代码易读性好，修改难度低，方便项目的开发；通过调用Velocity模板引擎生成代码文件，实现代码生成样式的高度可自定义，从而可以适应不同类型的业务需求开发；通过利用MyBatisGenerator文件生成工具生成MyBatis持久层框架所需的代码文件，从而可以保证单表公共文件的规范统一和同MyBatis的结合，实现对数据的持久化操作；此外，由于使用了配置表的方式保存业务模块的配置信息，从而可以在进行代码修改的时候，直接选择相应的配置表进行修改，并重新生成对应的代码，实现代码生成的可控性；在某一业务模块开发完成后，通过锁定动作，可以实现对该业务模块的锁定，以防止生成的代码因被误操作而覆盖。

附图说明

附图用于更好地理解本发明，不构成对本发明的不当限定。其中：

图1是根据本发明实施例的代码自动生成的方法的主要步骤的示意图；

图2是根据本发明实施例的代码自动生成的装置的主要模块的示意图。

具体实施方式

以下结合附图对本发明的示范性实施例做出说明，其中包括本发明实施例的各种细节以助于理解，应当将它们认为仅仅是示范性的。因此，本领域普通技术人员应当认识到，可以对这里描述的实施例做出各种改变和修改，而不会背离本发明的范围和精神。同样，为了清楚和简明，以下的描述中省略了对公知功能和结构的描述。

图1是根据本发明实施例的代码自动生成的方法的主要步骤的示意图。

如图1所示，本发明实施例的代码自动生成的方法主要包括如下步骤：

步骤S11：根据业务需求新增业务模块，并利用SQL查询语句配置所述业务模块。

步骤S12：将所述业务模块的配置信息保存到数据库中。

本发明的技术方案中，利用开源技术搭建一web项目自动开发平台。其中，主要在MVC框架(MVC，即ModelViewController，是模型(model)－视图(view)－控制器(controller)的缩写，一种软件设计典范，用一种业务逻辑、数据、界面显示分离的方法组织代码，将业务逻辑聚集到一个部件里面，在改进和个性化定制界面及用户交互的同时，不需要重新编写业务逻辑)内进行项目的开发。本发明中主要利用springMVC框架。SpringMVC框架属于SpringFrameWork的后续产品，提供了构建Web应用程序的全功能MVC模块。SpringMVC分离了控制器、模型对象、分派器以及处理程序对象的角色。

本发明中，根据业务需求对业务模块的新增与配置主要是在SpringMVC框架的展示层进行。SpringMVC展示层(即视图view)的展示技术可以是基于Jquery语言和JqueryEasyUI展示控件库的技术支持。通过JqueryEasyUI提供的组件进行页面布局，通过Jquery提供的前台JavaScript操作方法实现业务逻辑。例如，在开发一个学生管理***的过程中，学生业务模块的学生信息表里可能涉及到性别字段，此时，可以通过Jquery提供的前台JavaScript方法获取对应的性别数据，再通过JqueryEasyUI的下拉框组件在前台页面中显示性别选项。

在本发明的实施例中，web项目的开发以模块为单位进行，根据业务需求新增业务模块，并对业务模块进行详细配置。即首先是根据业务需求新增一个业务模块；其次配置SQL查询语句，根据配置的SQL查询语句初始化配置信息，将业务模块所涉及到的单表和字段等的信息获取出来，此时获取的信息是业务模块初始化的默认配置信息，包括涉及的单表信息、Grid基本信息、Grid列信息、Form基本信息、Form列信息；最后对生成的初始化配置信息根据业务需求进行修改。

其中对生成的初始化配置信息根据业务需求进行修改包括：配置SQL查询语句后生成初始化的涉及的单表信息、Grid基本信息、Grid列信息、Form基本信息、Form列信息；根据业务需求对初始化的涉及的单表信息、Grid基本信息、Grid列信息、Form基本信息、Form列信息进行详细配置。

业务模块配置的过程中，需要将业务模块的所有配置信息保存到数据库中。本发明中，利用Mybatis持久层框架将业务模块的所有配置信息以配置表的形式保存到数据库中。Mybatis持久层框架是一个基于Java的持久层框架，支持直接编写sql语句，将sql语句保存在xml配置文件中，程序直接读取即可，可以实现任何复杂的业务逻辑处理。而现有技术是将字段的配置信息写入代码中，修改起来不灵活，本发明中利用Mybatis持久层框架进行配置信息的保存，使得业务模块可处理的业务范围更宽广，可用性更高，而且生成的代码易读性好，在代码生成后可以根据业务需求对代码进行修改，并且直接选择相应的配置表对应的配置信息进行修改即可，修改难度较利用Hibernate处理复杂的业务的难度降低。

业务模块的具体配置过程如下所述：

根据业务需求新增一个模块。录入模块名称、模块代码、开发人员、后台文件生成后所在的包路径、前台文件生成后所在的文件夹路径等业务模块基本配置信息。根据录入的模块代码自动生成前台文件和后台文件的文件名称，并将业务模块基本配置信息保存到数据库的业务模块配置主表中。

新增业务模块后如果需要对模块信息进行修改，可以选择对应的模块信息记录，通过修改模块界面进行模块配置信息的修改。

新增业务模块完成后，对业务模块进行详细配置。包括SQL查询语句配置、涉及表信息配置、Grid基本信息配置、Grid列信息配置、Form基本信息配置、Form列信息配置。

根据模块的业务需求整理出查询语句，并将查询语句内容对应录入到展示层中配置业务模块界面的select语句部分、from语句部分、where语句部分、groupby语句部分和orderby语句部分等，录入完成后进行保存。保存过程中开发平台对查询语句进行校验，校验查询语句是否能够正确执行，如不能正确执行，则提示进行修改，如能正确执行，则利用Mybatis将查询语句保存到数据库中的业务模块配置主表中的查询SQL字段中。

查询语句保存成功后，对业务模块进行初始化，生成如下初始化配置信息：

i.根据配置的业务模块查询语句获取出其中所涉及的单表信息，如表名、表别名，并生成单表对应的实体类名、实体文件存放的包路径、SqlMap文件存放的包路径和Mapper文件存放的包路径，同时默认设置单表的是否参与持久化字段的值，最后利用Mybatis将每个单表相关信息作为一条记录保存到数据库中的模块涉及表配置表中；

ii.在数据库的Grid配置主表中生成一条记录，默认设置列表名称、Grid高度、Grid宽度、每页行数、是否单选、是否可编辑等字段信息；

iii.根据查询语句中所查询的所有字段信息，在数据库的Grid列配置信息表中为每个字段生成一条记录信息，生成时自动获取字段对应的字段名称、字段别名、字段注释、字段所属表，自动识别字段是否为主键，根据识别结果回写是否显示和是否可编辑对应值，自动判断字段的类型，根据字段类型回写显示类型、列编辑器参数、下拉框转码类型等内容；

iv.在数据库的Form配置主表中生成三条记录，对应三种Form类型，分别为查询Form、新增Form、修改Form，默认设置每条记录的每行列数、是否显示、是否生成等字段信息；

v.根据查询语句中所查询的所有字段信息，在数据库的Form配置详细表中为查询Form、新增Form、修改Form三类Form分别生成对应的记录信息。生成时自动获取字段对应的字段名称、字段别名、字段注释、字段所属表，自动识别字段是否为主键，根据识别结果智能回写是否显示和是否可编辑对应值，自动判断字段的类型，根据字段类型自动回写显示类型、前台校验规则、前台校验提示信息、查询类型、下拉框转码类型等内容。

初始化处理完成后，将初始化信息返回到展示层的操作界面的对应列表中，此时可以结合业务需求对初始化信息进行进一步修改，如修改某些单表不进行持久化操作、Grid的高度和宽度、Grid是否可编辑、Grid中的列是否显示、Grid中的列是否为下拉框和对应的转码类型、查询Form中那些字段需要显示、查询Form中查询字段的查询类型，以及新增Form和修改Form中字段校验规则和校验提示信息等。并利用Mybatis持久层框架将修改后的配置信息保存到数据库中。本发明中用到的数据库例如可以是MySQL(关系型数据库管理***)数据库。

在将业务模块配置完成，并将配置信息保存到数据库后，从步骤S13开始处理。

步骤S13：根据所述配置信息生成代码文件。

代码的生成主要在SpringMVC框架的控制层(控制器controller)中进行。根据保存在数据库中的配置信息生成代码文件，包括：通过调用Velocity模板引擎获取代码模板，将所述代码模板与业务模块的配置信息结合生成前台代码文件和后台代码文件；通过调用MyBatisGenerator文件生成工具，生成MyBatis持久层框架所需的代码文件。

其中，Velocity模板引擎是一个基于java的模板引擎(templateengine)。它允许任何人仅仅使用简单的模板语言(templatelanguage)来引用由java代码定义的对象。在本发明中，使用Velocity模板引擎，实现对预先定义的代码模板进行自定义。对预先定义的代码模板进行自定义可以是：通过对已有的模板进行修改，实现修改后的代码模板更加符合开发的业务需求；此外，还可以复制已有模板，在其基础上重新建立自己的模板。

开发平台调用Velocity模板引擎，获取代码模板，然后将业务模块的配置信息传入代码模板中，以替换对应的属性，从而实现将配置数据与代码模板相结合，从而生成前台代码文件和后台代码文件。这些文件包括以下内容：前台主界面Main.jsp、前台主界面Main.js、前台新增界面Add.jsp、前台新增界面Add.js、前台修改界面Update.jsp、前台修改界面Update.js、后台Controller.java、后台Service接口IService.java、后台Service实现类ServiceImpl.java、后台DAO接口IDAO.java、后台DAO实现类DAOImpl.java、后台业务实体BusiEntity.java、后台业务sqlmap文件sqlmap.xml。

MyBatisGenerator是文件生成工具，使用MyBatisGenerator文件生成工具生成MyBatis持久层框架所需的文件内容，包括查询SQL中涉及到的单表对应的映射文件和实体文件。

开发平台调用MyBatisGenerator文件生成工具，结合MyBatisGeneratorConfig.xml配置文件中的配置信息，自动生成所有单表对应的MyBatis持久层框架所需的代码文件，包括以下内容：后台业务sqlmap文件sqlmap.xml、后台单表公共文件Entity.java和Mapper.xml。

经过该步骤的代码生成，可以实现根据业务模块的详细配置信息生成出高度符合业务需求的前台代码文件、后台代码文件和单表公共持久化文件，开发人员基本不需要再进行代码修改，即可实现自己的业务需求。

本发明实施例的代码自动生成的方法还可以包括：当业务需求变更时，根据业务需求修改业务模块相应的配置信息并保存；根据修改后的配置信息选择需要重新生成的代码文件，进行代码重新生成。

通过开发平台自动生成完代码后，如果业务人员提出了需求变更，只需要根据需求变更内容重新进行业务模块的配置，将对应的配置信息调整为符合需求变更后的内容，并将变更后的配置信息保存到数据库中，然后选择需要重新生成的代码文件进行代码重新生成。对于不涉及需求变更或已进行过修改的代码文件，可以不进行选择，这样可以实现代码生成的可控性，防止不需要变动的代码文件被覆盖掉。

代码重新生成时，根据重新配置的信息对选择需要重新生成的文件进行自动代码生成的过程如前所述，此处不再赘述。

本发明实施例的代码自动生成的方法还可以包括：当业务模块开发完成，不需要再进行代码生成和变更时，锁定业务模块。

如果一个业务模块已经全部开发完成，不需要再进行代码生成，则可以对该业务模块记录进行锁定，锁定后将不能再进行修改、配置、生成代码、删除操作，防止代码被误操作而被覆盖。

在进行模块锁定操作时，回写数据库的模块配置表中对应记录的是否锁定字段为“是”。再对该模块记录进行操作时，开发平台会根据是否锁定字段判断出该记录已处于锁定状态，直接提示不能在进行相关操作。

根据本发明实施例的代码自动生成的方法可以看出，在web项目开发的过程中，以业务模块为单位，通过配置SQL查询语句，突破现有技术中只能进行单表代码生成的限制，从而实现可以处理任何的业务逻辑；通过对业务模块各字段的详细配置，从而使生成出来的代码最大化的符合业务需求；通过利用Mybatis持久层框架对配置信息以配置表的形式进行持久化，从而使得可以处理的业务范围更宽广，可用性更高，而且生成的代码易读性好，修改难度低，方便项目的开发；通过调用Velocity模板引擎生成代码文件，实现代码生成样式的高度可自定义，从而可以适应不同类型的业务需求开发；通过利用MyBatisGenerator文件生成工具生成MyBatis持久层框架所需的代码文件，从而可以保证单表公共文件的规范统一和同MyBatis的结合，实现对数据的持久化操作；此外，由于使用了配置表的方式保存业务模块的配置信息，从而可以在进行代码修改的时候，直接选择相应的配置表进行修改，并重新生成对应的代码，实现代码生成的可控性；在某一业务模块开发完成后，通过锁定动作，可以实现对该业务模块的锁定，以防止生成的代码因被误操作而覆盖。

图2是根据本发明实施例的代码自动生成的装置的主要模块的示意图。

如图2所示，本发明实施例的代码自动生成的装置20主要包括如下模块：配置模块201、保存模块202、代码生成模块203。

配置模块201，用于根据业务需求新增业务模块，并利用SQL查询语句配置所述业务模块；保存模块202，用于将所述业务模块的配置信息保存到数据库中；代码生成模块203，用于根据所述配置信息生成代码文件。

配置模块201还用于：根据SQL查询语句生成初始化配置信息，所述初始化配置信息包括：涉及的单表信息、Grid基本信息、Grid列信息、Form基本信息、Form列信息；根据业务需求对初始化配置信息进行修改。

保存模块202还用于：利用Mybatis持久层框架将所述业务模块的所有配置信息以配置表的形式保存到数据库中。

代码生成模块203还用于：通过调用Velocity模板引擎获取代码模板，将所述代码模板与所述业务模块的配置信息结合生成前台代码文件和后台代码文件；通过调用MyBatisGenerator文件生成工具，生成MyBatis持久层框架所需的代码文件。

装置20还用于：当业务需求变更时，配置模块201根据业务需求变更的内容修改相应的配置信息；保存模块202保存修改后的配置信息；代码生成模块203根据修改后的配置信息选择需要重新生成的代码文件，进行代码重新生成。

配置模块201还用于：当所述业务模块开发完成，不需要再进行代码生成和变更时，锁定所述业务模块。

从以上描述可以看出，在web项目开发的过程中，以业务模块为单位，通过配置SQL查询语句，突破现有技术中只能进行单表代码生成的限制，从而实现可以处理任何的业务逻辑；通过对业务模块各字段的详细配置，从而使生成出来的代码最大化的符合业务需求；通过利用Mybatis持久层框架对配置信息以配置表的形式进行持久化，从而使得可以处理的业务范围更宽广，可用性更高，而且生成的代码易读性好，修改难度低，方便项目的开发；通过调用Velocity模板引擎生成代码文件，实现代码生成样式的高度可自定义，从而可以适应不同类型的业务需求开发；通过利用MyBatisGenerator文件生成工具生成MyBatis持久层框架所需的代码文件，从而可以保证单表公共文件的规范统一和同MyBatis的结合，实现对数据的持久化操作；此外，由于使用了配置表的方式保存业务模块的配置信息，从而可以在进行代码修改的时候，直接选择相应的配置表进行修改，并重新生成对应的代码，实现代码生成的可控性；在某一业务模块开发完成后，通过锁定动作，可以实现对该业务模块的锁定，以防止生成的代码因被误操作而覆盖。

上述具体实施方式，并不构成对本发明保护范围的限制。本领域技术人员应该明白的是，取决于设计要求和其他因素，可以发生各种各样的修改、组合、子组合和替代。任何在本发明的精神和原则之内所作的修改、等同替换和改进等，均应包含在本发明保护范围之内。

Claims (12)

1.一种代码自动生成的方法，其特征在于，包括：

根据业务需求新增业务模块，并利用SQL查询语句配置所述业务模块；

将所述业务模块的配置信息保存到数据库中；

根据所述配置信息生成代码文件。

2.根据权利要求1所述的方法，其特征在于，利用SQL查询语句配置所述业务模块包括：

根据SQL查询语句生成初始化配置信息，所述初始化配置信息包括：涉及的单表信息、Grid基本信息、Grid列信息、Form基本信息、Form列信息；

根据业务需求对初始化配置信息进行修改。

3.根据权利要求1所述的方法，其特征在于，将所述业务模块的配置信息保存到数据库中包括：利用Mybatis持久层框架将所述业务模块的所有配置信息以配置表的形式保存到数据库中。

4.根据权利要求1所述的方法，其特征在于，根据所述配置信息生成代码文件包括：

通过调用Velocity模板引擎获取代码模板，将所述代码模板与所述业务模块的配置信息结合生成前台代码文件和后台代码文件；

通过调用MyBatisGenerator文件生成工具，生成MyBatis持久层框架所需的代码文件。

5.根据权利要求1所述的方法，其特征在于，所述方法还包括：

当业务需求变更时，根据业务需求变更的内容修改相应的配置信息并加以保存；

根据修改后的配置信息选择需要重新生成的代码文件，进行代码重新生成。

6.根据权利要求1-5任一项所述的方法，其特征在于，所述方法还包括：

当所述业务模块开发完成，不需要再进行代码生成和变更时，锁定所述业务模块。

7.一种代码自动生成的装置，其特征在于，包括：

配置模块，用于根据业务需求新增业务模块，并利用SQL查询语句配置所述业务模块；

保存模块，用于将所述业务模块的配置信息保存到数据库中；

代码生成模块，用于根据所述配置信息生成代码文件。

8.根据权利要求7所述的装置，其特征在于，所述配置模块还用于：

根据SQL查询语句生成初始化配置信息，所述初始化配置信息包括：涉及的单表信息、Grid基本信息、Grid列信息、Form基本信息、Form列信息；

根据业务需求对初始化配置信息进行修改。

9.根据权利要求7所述的装置，其特征在于，所述保存模块还用于：利用Mybatis持久层框架将所述业务模块的所有配置信息以配置表的形式保存到数据库中。

10.根据权利要求7所述的装置，其特征在于，所述代码生成模块还用于：

通过调用Velocity模板引擎获取代码模板，将所述代码模板与所述业务模块的配置信息结合生成前台代码文件和后台代码文件；

通过调用MyBatisGenerator文件生成工具，生成MyBatis持久层框架所需的代码文件。

11.根据权利要求7所述的装置，其特征在于，所述装置还用于：

当业务需求变更时，配置模块根据业务需求变更的内容修改相应的配置信息；

保存模块保存修改后的配置信息；

代码生成模块根据修改后的配置信息选择需要重新生成的代码文件，进行代码重新生成。

12.根据权利要求7-11任一项所述的装置，其特征在于，所述配置模块还用于：

当所述业务模块开发完成，不需要再进行代码生成和变更时，锁定所述业务模块。