CN113791763A - 一种代码生成方法和装置 - Google Patents

具体实施方式

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

图1是根据本发明第一实施例的代码生成方法的主要流程的示意图，如图1所示，所述代码生成方法包括：

步骤S101，接收待开发程序的代码生成请求，建立java工程，进而调用预设的导入模型，获取所述java工程相对应的jar包并导入。

在一些实施例中，调用预设的导入模型，获取所述java工程相对应的jar包并导入，具体的实施过程包括：调用预设的导入模型，获取所述java工程相对应的jar包，在项目对象模型里添加jar包的依赖信息；或者存入java工程的lib文件夹，以通过开发工具将jar包进行导入。可以看出，本发明可以根据导入模型采用不同的jar包的导入，即在项目对象模型里添加jar的依赖或者，下载相应的jar包并放入java工程的库文件夹(即lib文件夹，lib是一种文件名后缀，代表的是静态数据连接库。)，通过开发工具将jar包进行导入。其中，所述的jar包可以包括freemarker.jar、ojdbc14.jar、mysql-connector-java-5.1.32.jar等等。

另外，Java是一门面向对象编程语言，具有简单性、面向对象、分布式、健壮性、安全性、平台独立与可移植性、多线程、动态性等特点。POM是项目对象模型(Project ObjectModel)的简称，为Maven项目中的文件，使用XML表示，名称叫做pom.xml。

步骤S102，在所述java工程中创建类包，以基于所述类包建立预设类型的配置类，进而根据所述配置类创建代码生成的执行类，以在所述执行类中创建相应的执行方法。

在一些实施例中，在基于所述类包建立预设类型的配置类时，可以根据模板引擎(即FreeMarker)中的模板工具，定义java类模板、统一注释模板文件java_imports.include以及统一公共函数模板文件macro.include(例如断言，分页参数、日志等)。以及建立数据数据库文件(即db)包目录、数据库表结构映射(即Table包目录)以及java包目录。其中，FreeMarker是一款模板引擎：即一种基于模板和要改变的数据，并用来生成输出文本(HTML网页、电子邮件、配置文件、源代码等)的通用工具。db全称是DataBase，为数据库文件。数据库表结构映射(即Table包目录)是数据库表与javaBean之间类型映射转换的一种关系定义，如字段类型、字段长度的断言等。

值得说明的是，定义java类模板包括javaBean模板、Mapping模板、Dao模板、BaseManager模板、Service模板、ServiceTest模板以及Controller模板。较佳的，可以通过前缀${className}字段来实现对各个模板的一一对应。如图2所示，为BaseManager与Service直接的层级关系流程示意图。

进一步地实施例，建立数据库文件包目录，具体的实施过程包括：编辑Sql工厂类(即SqlFactory类)，以基于Sql语法分析方法(例如：SqlFactory.parseSql()方法)生成自定义Sql对象对应数据库的Sql语句。其中，Sql工厂为根据SQL语句生成sql对象，用于代码生成器的生成。Sql语法分析方式支持多种语法。也就是说，Sql对象用于代码生成器的生成。SQL参数同时支持以下几种语法：

hibernate::username,ibatis2:#username#,$usename$,mybatis(oribatis3):#{username},${username}

SQL对象创建示例：

Sql sql＝new SqlFactory().parseSql("select*from user_info whereusername＝#username#and password＝#password#")

另外，建立数据库表结构映射，包括：根据数据库表中每列建立的属性对象，建立数据库表的结构映射对象(即Table对象)；定义数据库表工厂类(即TableFactory类)，调用getTable()方法，将数据库表的元数据(metadata)导入至相应的结构映射对象(即Table对象)getTable(sqlName)。也就是说，可以搜索数据库的所有表,并得到table对象列表创建代码getAllTable()。其中，Sql是Mysql的简称，为关系型数据库管理系统。数据库表工厂类可以根据数据库表的元数据(metadata)创建Table对象。getTable()方法可以根据数据库表名得到Table对象。

还有，本发明建立java包目录时可以定义JavaClass类、规范类名、最后一个包名、首字母大写、构造函数、共有的方法等。定义JavaField类，约束与field相关的Class类型。定义JavaMethod类，约束与method相关联的类。定义JavaProperty类。以及定义MethodParameter类，封装方法参数说明的帮助类，即一个已声明的泛型类型的参数索引，用作传递的规范对象。

需要说明的是，本发明基于所述类包建立预设类型的配置类的过程中，还可以编写generator.xml，进而能够配置数据库连接信息、包名路径、数据库类型映射、输出文件目录等等。以及编写GeneratorControl生成器模板控制器，用于模板中可以控制生成器执行相关控制操作，控制生成过程等的一些参数，例如文件是否覆盖、文件编码等等。另外，定义Generator主要提供两个方法供外部使用：第一个方法为generateBy()用于生成文件，第二个方法为deleteBy()用于删除生成的文件。

作为另一些实施例，在所述执行类中创建相应的执行方法，包括：根据代码生成器中的生成器属性配置文件(即GeneratorProperties配置文件)，读取TableFactory类和SqlFactory类，进而基于定义的模板文件生成generator.xml中配置的对应类的全路径和类名，以注入自定义的数据库属性，生成相应的java类。其中，GeneratorProperties配置文件为读取配置文件的类，可以包括数据库连接信息和一些基本的参数配置。

进一步地实施例，注入自定义的数据库属性，生成相应的java类，包括调用GeneratorConfigCLAP.generateByTable(表名)方法，基于定义的全局配置类注入自定义的数据库属性，生成相应的java类并存入所述java工程的相应目录中。即将生成的java类放入需要使用的项目相应目录里进行开发，实现了简单的一套增删改查，从Controller模板到Dao模板以及单元测试。优选地，在生成相应的java类时可以设置全局配置类中的生成文件输出目录、是否覆盖已有文件、是否打开输出目录等等信息。其中，GeneratorConfigCLAP.generateByTable(表名)方法为代码生成配置模板，为根据数据库表生成制定文件的方法。

较佳的，在生成java类时还可以结合数据源配置类中的是否驼峰字段、表前缀字段，包名配置类中的实体包名属性，全局配置类中的开发人员、实体类的命名方式、指定生成的主键id的类型生成相应的java实体类。

值得说明的是，在所述执行类中创建相应的执行方法的过程中，还可以在generator.xml中设置期望配置的数据源配置属性、项目包名路径、数据库类型映射、输出文件目录等等。

图3是根据本发明第二实施例的代码生成方法的主要流程的示意图，所述代码生成方法可以包括：

步骤S301，接收待开发程序的代码生成请求，建立java工程。

步骤S302，调用预设的导入模型，获取所述java工程相对应的jar包，在pom.xml里添加jar包的依赖信息；或者存入java工程的lib文件夹，以通过开发工具将jar包进行导入。

步骤S303，在所述java工程中创建类包。

步骤S304，根据FreeMarker模板工具，定义java类模板、统一注释模板文件以及统一公共函数模板文件；以及建立数据db包目录、Table包目录以及java包目录。

步骤S305，创建代码生成的执行类。

步骤S306，根据代码生成器中的GeneratorProperties配置文件，读取TableFactory类和SqlFactory类，进而基于定义的模板文件生成generator.xml中配置的对应类的全路径和类名。

步骤S307，调用GeneratorConfigCLAP.generateByTable()方法，基于定义的全局配置类注入自定义的数据库属性，生成相应的java类并存入所述java工程的相应目录中。

图4是根据本发明第三实施例的代码生成方法的主要流程的示意图，所述代码生成方法为基于FreeMarker生成java规范代码的工具类，可以包括代码工程模块、generator.xml配置链接信息和执行模块。其中，代码工程模块能够建立java工程，并通过预设的导入模型将所述java工程相对应的jar包进行导入。在所述java工程中创建类包，例如创建Template包则可以根据FreeMarker模板工具，定义java类模板、统一注释模板文件以及统一公共函数模板文件。建立数据db包目录，Table包目录，即定义Sql、Table对模板的实现。创建javamodel包，即对应java类的method与filed的规范约束。以及generator包，即生成相关策略。而执行模块包括了GeneratorConfigCLAPJAVA文件输出工具类型、GeneratorControl生成器模板控制器以及GeneratorProperties读取配置文件类。

图5是根据本发明实施例的代码生成装置的主要模块的示意图，如图5所示，所述代码生成装置500包括接收模块501和处理模块502。其中，接收模块501接收待开发程序的代码生成请求，建立java工程，进而调用预设的导入模型，获取所述java工程相对应的jar包并导入；处理模块502在所述java工程中创建类包，以基于所述类包建立预设类型的配置类，进而根据所述配置类创建代码生成的执行类，以在所述执行类中创建相应的执行方法。

在一些实施例中，接收模块501调用预设的导入模型，获取所述java工程相对应的jar包并导入，包括：

调用预设的导入模型，获取所述java工程相对应的jar包，在项目对象模型里添加jar包的依赖信息；或者存入java工程的库文件夹，以通过开发工具将jar包进行导入。

在一些实施例中，处理模块502基于所述类包建立预设类型的配置类，包括：

根据模板引擎中的模板工具，定义java类模板、统一注释模板文件以及统一公共函数模板文件；以及建立数据库文件包目录、数据库表结构映射以及java包目录。

在一些实施例中，处理模块502建立数据库文件包目录，包括：

编辑Sql工厂类，以基于Sql语法分析方法生成自定义Sql对象对应数据库的Sql语句。

在一些实施例中，处理模块502建立数据库表结构映射，包括：

根据数据库表中每列建立的属性对象，建立数据库表的结构映射对象；定义数据库表工厂类，调用getTable()方法，将数据库表的元数据导入至相应的结构映射对象。

在一些实施例中，处理模块502在所述执行类中创建相应的执行方法，包括：

根据代码生成器中的生成器属性配置文件，读取数据库表工厂类和Sql工厂类，进而基于定义的模板文件生成配置的对应类的全路径和类名，以注入自定义的数据库属性，生成相应的java类。

在一些实施例中，处理模块502注入自定义的数据库属性，生成相应的java类，包括：

调用代码生成配置模板，基于定义的全局配置类注入自定义的数据库属性，生成相应的java类并存入所述java工程的相应目录中。

需要说明的是，在本发明所述代码生成方法和所述代码生成装置在具体实施内容上具有相应关系，故重复内容不再说明。

图6示出了可以应用本发明实施例的代码生成方法或代码生成装置的示例性系统架构600。

如图6所示，系统架构600可以包括终端设备601、602、603，网络604和服务器605。网络604用以在终端设备601、602、603和服务器605之间提供通信链路的介质。网络604可以包括各种连接类型，例如有线、无线通信链路或者光纤电缆等等。

用户可以使用终端设备601、602、603通过网络604与服务器605交互，以接收或发送消息等。终端设备601、602、603上可以安装有各种通讯客户端应用。

终端设备601、602、603可以是具有代码生成屏并且支持网页浏览的各种电子设备，包括但不限于智能手机、平板电脑、膝上型便携计算机和台式计算机等等。

服务器605可以是提供各种服务的服务器，例如对用户利用终端设备601、602、603提供支持的后台管理服务器(仅为示例)。后台管理服务器可以对接收到的产品信息查询请求等数据进行分析等处理，并将处理结果(例如目标推送信息、产品信息--仅为示例)反馈给终端设备。

应该理解，图6中的终端设备、网络和服务器的数目仅仅是示意性的。根据实现需要，可以具有任意数目的终端设备、网络和服务器。

下面参考图7，其示出了适于用来实现本发明实施例的终端设备的计算机系统70的结构示意图。图7示出的终端设备仅仅是一个示例，不应对本发明实施例的功能和使用范围带来任何限制。

如图7所示，计算机系统70包括中央处理单元(CPU)701，其可以根据存储在只读存储器(ROM)702中的程序或者从存储部分708加载到随机访问存储器(RAM)703中的程序而执行各种适当的动作和处理。在RAM703中，还存储有计算机系统700操作所需的各种程序和数据。CPU701、ROM702以及RAM73通过总线704彼此相连。输入/输出(I/O)接口705也连接至总线704。

以下部件连接至I/O接口705：包括键盘、鼠标等的输入部分706；包括诸如阴极射线管(CRT)、液晶代码生成器(LCD)等以及扬声器等的输出部分707；包括硬盘等的存储部分708；以及包括诸如LAN卡、调制解调器等的网络接口卡的通信部分709。通信部分709经由诸如因特网的网络执行通信处理。驱动器706也根据需要连接至I/O接口705。可拆卸介质707，诸如磁盘、光盘、磁光盘、半导体存储器等等，根据需要安装在驱动器706上，以便于从其上读出的计算机程序根据需要被安装入存储部分708。

特别地，根据本发明公开的实施例，上文参考流程图描述的过程可以被实现为计算机软件程序。例如，本发明公开的实施例包括一种计算机程序产品，其包括承载在计算机可读介质上的计算机程序，该计算机程序包含用于执行流程图所示的方法的程序代码。在这样的实施例中，该计算机程序可以通过通信部分709从网络上被下载和安装，和/或从可拆卸介质707被安装。在该计算机程序被中央处理单元(CPU)701执行时，执行本发明的系统中限定的上述功能。

需要说明的是，本发明所示的计算机可读介质可以是计算机可读信号介质或者计算机可读存储介质或者是上述两者的任意组合。计算机可读存储介质例如可以是——但不限于——电、磁、光、电磁、红外线、或半导体的系统、装置或器件，或者任意以上的组合。计算机可读存储介质的更具体的例子可以包括但不限于：具有一个或多个导线的电连接、便携式计算机磁盘、硬盘、随机访问存储器(RAM)、只读存储器(ROM)、可擦式可编程只读存储器(EPROM或闪存)、光纤、便携式紧凑磁盘只读存储器(CD-ROM)、光存储器件、磁存储器件、或者上述的任意合适的组合。在本发明中，计算机可读存储介质可以是任何包含或存储程序的有形介质，该程序可以被指令执行系统、装置或者器件使用或者与其结合使用。而在本发明中，计算机可读的信号介质可以包括在基带中或者作为载波一部分传播的数据信号，其中承载了计算机可读的程序代码。这种传播的数据信号可以采用多种形式，包括但不限于电磁信号、光信号或上述的任意合适的组合。计算机可读的信号介质还可以是计算机可读存储介质以外的任何计算机可读介质，该计算机可读介质可以发送、传播或者传输用于由指令执行系统、装置或者器件使用或者与其结合使用的程序。计算机可读介质上包含的程序代码可以用任何适当的介质传输，包括但不限于：无线、电线、光缆、RF等等，或者上述的任意合适的组合。

附图中的流程图和框图，图示了按照本发明各种实施例的系统、方法和计算机程序产品的可能实现的体系架构、功能和操作。在这点上，流程图或框图中的每个方框可以代表一个模块、程序段、或代码的一部分，上述模块、程序段、或代码的一部分包含一个或多个用于实现规定的逻辑功能的可执行指令。也应当注意，在有些作为替换的实现中，方框中所标注的功能也可以以不同于附图中所标注的顺序发生。例如，两个接连地表示的方框实际上可以基本并行地执行，它们有时也可以按相反的顺序执行，这依所涉及的功能而定。也要注意的是，框图或流程图中的每个方框、以及框图或流程图中的方框的组合，可以用执行规定的功能或操作的专用的基于硬件的系统来实现，或者可以用专用硬件与计算机指令的组合来实现。

描述于本发明实施例中所涉及到的模块可以通过软件的方式实现，也可以通过硬件的方式来实现。所描述的模块也可以设置在处理器中，例如，可以描述为：一种处理器包括接收模块和处理模块。其中，这些模块的名称在某种情况下并不构成对该模块本身的限定。

作为另一方面，本发明还提供了一种计算机可读介质，该计算机可读介质可以是上述实施例中描述的设备中所包含的；也可以是单独存在，而未装配入该设备中。上述计算机可读介质承载有一个或者多个程序，当上述一个或者多个程序被一个该设备执行时，使得该设备包括接收待开发程序的代码生成请求，建立java工程，进而调用预设的导入模型，获取所述java工程相对应的jar包并导入；在所述java工程中创建类包，以基于所述类包建立预设类型的配置类，进而根据所述配置类创建代码生成的执行类，以在所述执行类中创建相应的执行方法。

根据本发明实施例的技术方案，能够解决现有项目开发中实体定义存在大量重复性工作的问题。

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