告别枯燥的CRUD，Java代码生成器的使用

代码生成器有很多，这里介绍的是rapid-generator 4.0.6，这个项目近几年已经没有更新，但是对于功能使用毫无影响，而且扩展性很强，可以生成满足各种需求的代码。 本文讲的是springboot+jpa组合，其他组合相信大家看了文章后可以自己去尝试。

准备工作

网上有源码下载，这里我主要下了两个东西，一个是rapid-generator（这个是主要源码，必须的），另一个是rapid-generator-template（里面有各种模版例子，方便使用），如果不需要修改源码也可以直接maven引入这个源码包。
rapid-generator Maven地址

    com.googlecode.rapid-framework
    rapid-generator
    4.0.6

rapid-generator-templater Maven地址

    com.googlecode.rapid-framework
    rapid-generator-template
    4.0.6

这个生成器用freemarker来进行生成文件，主要就是通过读取数据库的各种信息，包装成数据，填充到我们的模版中，这样就得到了我们需要的代码文件。

项目搭建与配置

在生成代码之前我们还需要来进行搭建项目以及相关配置，新建一个maven项目largh-codegen，将rapid-generator（这里不需要rapid-generator-template，这个稍后用到再讲）jar解压，源码拷贝到项目中，因为这个代码生成器使用freemarker，所以我们在pom.xml引入freemarker依赖

    org.freemarker
    freemarker
    2.3.23
  

我用的是mysql，因此再添加数据库驱动

     Mysql
     mysql-connector-java
     5.1.38
  

现在就来说下rapid-generator-template，将这个jar包解压，进入rapid-generator-template-4.0.6-sources\generator\template\rapid\share\basic这个目录，可以看到5个include文件，我们找个地方新建一个文件夹template（我直接在本项目resources下新建了template文件夹），把这五个文件放入其中，其实这几个文件就是定义了一些版权、注释等信息，可以自己修改成自己的。在我们新建的项目classpath下新建一个生成配置文件generator.xml，Maven项目就直接放在resources下面即可。

    
        代码生成器配置文件:
        1.会为所有的property生成property_dir属性,如pkg=com.company => pkg_dir=com/company
        2.可以引用环境变量: ${env.JAVA_HOME} or System.properties: ${user.home},property之间也可以相互引用
    

    com.largh

    
    pages

    D://generator-output

    
    upms_

    root
    root

    
    
    

    
    java.util.Date
    java.util.Date
    java.util.Date
    Integer
    Integer
    Long

    
    

    jdbc:mysql://localhost:3306/largh
    com.mysql.jdbc.Driver

    

    

    

    

    

    

    

    

    

这个配置文件需要配置你数据库信息、basepackage（基础包路径）、outRoot（输出目录）、tableRemovePrefixes（移除表的前缀）等，仔细看看应该没什么问题。到这里直接上一张项目图：

图一

PS：有些同学导入源码进去编译的时候可能会报错，原因是你的jdk版本是1.7或1.8，因为这个项目可能比较久了，作者写的时候用的是老一点版本，而高版本中有个类在1.7增加了一个方法。你只需要按照错误提示操作增加这个方法就行。

图二

建立骨架项目

编写一个项目骨架模版，这样生成的代码可以直接运行跑起来。下面是我的项目骨架结构：

图三

里面相关代码都是用代码生成器里面的变量来进行替换，更多变量需要查看源码里面几个model，根据这些就可以定制生成你的项目了。
新建一个生成代码的main方法，运行这个方法即可

    public static void main(String[] args) throws Exception {
        String templatePath = "E:\\IdeaProjects\\largh-codegen\\src\\main\\resources\\template";
        GeneratorFacade g = new GeneratorFacade();
        g.getGenerator().addTemplateRootDir(templatePath);
        //删除生成器的输出目录//
        g.deleteOutRootDir();
        g.generateByAllTable();
    }

templatePath就是你template的完整路径，你放在哪里，就填写哪个。运行完这个方法可以看到我输出目录里面多了一个largh-api-quickstart文件夹，这个就是生成的项目了，接下来把生成的代码导入idea下跑起来

图四

图五

图六

你想只生成实体类这些，都是可以的，有兴趣的同学可以研究下源码。到这里基本就完成了，再也不怕面对枯燥的CRUD了。
本文源码地址： largh-codegen