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

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

准备工作

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

<dependency>
    <groupId>com.googlecode.rapid-framework</groupId>
    <artifactId>rapid-generator</artifactId>
    <version>4.0.6</version>
</dependency>

rapid-generator-templater Maven地址

<dependency>
    <groupId>com.googlecode.rapid-framework</groupId>
    <artifactId>rapid-generator-template</artifactId>
    <version>4.0.6</version>
</dependency>

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

项目搭建与配置

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

<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.23</version>
</dependency>  

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

<dependency>
     <groupId>Mysql</groupId>
     <artifactId>mysql-connector-java</artifactId>
     <version>5.1.38</version>
</dependency>  

现在就来说下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下面即可。

<?xml version="1.0" encoding="GBK"?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
    <comment>
        代码生成器配置文件:
        1.会为所有的property生成property_dir属性,如pkg=com.company => pkg_dir=com/company
        2.可以引用环境变量: ${env.JAVA_HOME} or System.properties: ${user.home},property之间也可以相互引用
    </comment>

    <entry key="basepackage">com.largh</entry>

    <!-- jsp namespace: web/${namespace}/${className}/list.jsp -->
    <entry key="namespace">pages</entry>

    <entry key="outRoot">D://generator-output</entry>

    <!-- 需要移除的表名前缀,使用逗号进行分隔多个前缀,示例值: t_,v_ -->
    <entry key="tableRemovePrefixes">upms_</entry>

    <entry key="jdbc_username">root</entry>
    <entry key="jdbc_password">root</entry>

    <!-- oracle需要指定jdbc.schema,其它数据库忽略此项配置  -->
    <entry key="jdbc_schema"></entry>
    <entry key="jdbc_catalog"></entry>

    <!-- 数据库类型映射  -->
    <entry key="java_typemapping.java.sql.Timestamp">java.util.Date</entry>
    <entry key="java_typemapping.java.sql.Date">java.util.Date</entry>
    <entry key="java_typemapping.java.sql.Time">java.util.Date</entry>
    <entry key="java_typemapping.java.lang.Byte">Integer</entry>
    <entry key="java_typemapping.java.lang.Short">Integer</entry>
    <entry key="java_typemapping.java.math.BigDecimal">Long</entry>

    <!-- H2 -->
    <!-- <entry key="jdbc.url">jdbc:h2:tcp://localhost/test</entry>
    <entry key="jdbc.driver">org.h2.Driver</entry>
    -->

    <entry key="jdbc_url">jdbc:mysql://localhost:3306/largh</entry>
    <entry key="jdbc_driver">com.mysql.jdbc.Driver</entry>

    <!-- Oracle     jdbc:oracle:oci:@tnsname_devdb
    <entry key="jdbc.url">jdbc:oracle:thin:@192.168.0.177:1521:[sid]</entry>
    <entry key="jdbc.driver">oracle.jdbc.driver.OracleDriver</entry>
    -->

    <!-- SQLServer2000
    <entry key="jdbc.url">jdbc:microsoft:sqlserver://localhost:1433;DatabaseName=[database]</entry>
    <entry key="jdbc.driver">com.microsoft.jdbc.sqlserver.SQLServerDriver</entry>
    -->

    <!-- SQLServer2005
    <entry key="jdbc.url">jdbc:sqlserver://192.168.0.98:1433;DatabaseName=[database]</entry>
    <entry key="jdbc.driver">com.microsoft.sqlserver.jdbc.SQLServerDriver</entry>
    -->

    <!-- JTDs for SQLServer
    <entry key="jdbc.url">jdbc:jtds:sqlserver://192.168.0.102:1433/[database];tds=8.0;lastupdatecount=true</entry>
    <entry key="jdbc.driver">net.sourceforge.jtds.jdbc.Driver</entry>
    -->

    <!-- PostgreSql
   <entry key="jdbc.url">jdbc:postgresql://localhost/[database]</entry>
   <entry key="jdbc.driver">org.postgresql.Driver</entry>
    -->

    <!-- Sybase
   <entry key="jdbc.url">jdbc:sybase:Tds:localhost:5007/[database]</entry>
   <entry key="jdbc.driver">com.sybase.jdbc.SybDriver</entry>
    -->

    <!-- DB2
    <entry key="jdbc.url">jdbc:db2://localhost:5000/[database]</entry>
    <entry key="jdbc.driver">com.ibm.db2.jdbc.app.DB2Driver</entry>
    -->

    <!-- HsqlDB
    <entry key="jdbc.url">jdbc:hsqldb:mem:generatorDB</entry>
    <entry key="jdbc.driver">org.hsqldb.jdbcDriver</entry>
    -->

    <!-- Derby
    <entry key="jdbc.url">jdbc:derby://localhost/databaseName</entry>
    <entry key="jdbc.driver">org.apache.derby.jdbc.ClientDriver</entry>
    -->

</properties>

这个配置文件需要配置你数据库信息、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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,458评论 6 513
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 94,030评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,879评论 0 358
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,278评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,296评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 52,019评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,633评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,541评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,068评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,181评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,318评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,991评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,670评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,183评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,302评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,655评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,327评论 2 358

推荐阅读更多精彩内容