数据库逆向生成代码及Maven插件开发
博客专区 > 蛙牛 的博客 > 博客详情
数据库逆向生成代码及Maven插件开发
蛙牛 发表于2年前
数据库逆向生成代码及Maven插件开发
  • 发表于 2年前
  • 阅读 5364
  • 收藏 258
  • 点赞 17
  • 评论 25

腾讯云 技术升级10大核心产品年终让利>>>   

摘要: 之前使用mybatis,可以用mybatis generator逆向生成dao层代码。公司使用的是自己开发的服务,所以最近抽空写了一个逆向生成的工具,并做成了maven插件,以后就可以很方便的实现dao层的相关代码

        之前使用mybatis,可以用mybatis generator逆向生成dao层代码,详见博客《数据库逆向框架代码生成工具:MyBatis Generator的使用》。公司使用的是自己开发的服务,所以最近抽空写了一个逆向生成的工具,并做成了maven插件,以后就可以很方便的实现dao层的相关代码。

        在开发之前已经想好了思路,通过velocity模板,实现代码生成。上网搜了下velocity的代码生成工具。搜到了《一个基于velocity模板引擎的代码生成器》,下载了源码进行了部署以及学习,作者的代码写的非常规范,基于jquery easyui和mybatis做了一个mybatis的封装框架,并且考虑了多数据库的支持,自己从中也收获不少。另外也看了mybatis generator的源码,因为里面要兼容的东西多,所以代码量也是很大的。

        自己想做的比较简单,只用基于公司现有的底层实现,逆向生成出来Dao层的代码就可以。不需要支持其他数据库,不需要提供UI界面,只用简单的配置即可。所以实现的比较简单,正因为简单,修改起来也方便,学习成本也很低。下面进入正文。


1实现方式

        1通过配置连接库 2获得对应的表结构元数据 3进行相关类型转换 4然后通过velocity模板生成对应的文件。


需要注意:

        约定优于配置,命名一定要规范。比如数据库的字段命名规范,多个单词使用 _ 分割,这样可以方便转换为JavaBean的驼峰命名格式。数据库的user_name,JavaBean中对应userName。  

         另外如果想支持自己的项目,需要修改velocity模板,如果有特殊需求,可能需要改下源码。

2实现过程

        首先需要通过读取配置文件,连接数据库,我们可以使用各种方式,比如最原生的jdbc,或者mybatis,这里使用了Apache的DBCP以及DBUitls,另外配置文件使用properties,都是为了实现起来简单。


 配置文件配置有mysql的连接属性,需要逆向生成的数据库表名,生成的实体名,包名

       

2.把配置封装在一个对象中,便于上下文使用(也是为了maven插件使用,下文会说到)。

把数据库的连接,以及查询操作封装在DBHelper中。

然后获得对应表的元数据,进行类型转换,数据封装为velocity的模板数据,通过velocity生成代码。


3.代码细节

DBHelper中,通过配置初始化datasource,然后创建DBUtil的QueryRunner查询器。

通过QueryRunner的query方法,查询数据,这里用到MapListHandler解析器,可以把查询结果转换成List<Map<String, Object>>


接下来把查询到的元数据,转换为自定义对象,把数据库类型转换为java类型。这里有一个技术细节,DBUtils返回的Map对象里面的key是不区分大小写的。


生成代码,对应的velocity模板中的属性


然后就是渲染到模板了,需要什么属性,可以自己封装,模板也可以根据自己需要进行修改,这里是公司实体对应的模板

package ${package}.contract.entity;

import com.bj58.sfft.utility.dao.annotation.Column;
import com.bj58.sfft.utility.dao.annotation.Id;
import com.bj58.sfft.utility.dao.annotation.NotDBColumn;
import com.bj58.sfft.utility.dao.annotation.Table;
import com.bj58.spat.scf.serializer.component.annotation.SCFMember;
import com.bj58.spat.scf.serializer.component.annotation.SCFSerializable;

#set($hasDate=0)
#foreach($column in $columns)
#if($column.javaType=='Date' && $hasDate==0)
import java.util.Date;
#set($hasDate=1)
#end
#end

@Table(name="${table}")
@SCFSerializable
public class ${entity}{

    @NotDBColumn
    private static final long serialVersionUID = 1L;

#foreach($column in $columns)
    @SCFMember
#if(${column.isPk})
#if(!${column.isIdentityPk})
    @Id(insertable=true)
#end
#else
    @Column(name="${column.columnName}")
#end
    private ${column.javaType} ${column.javaFieldName};

#end

#foreach(${column} in ${columns})
    public void set${column.javaFieldNameUF}(${column.javaType} ${column.javaFieldName}){
        this.${column.javaFieldName} = ${column.javaFieldName};
    }

    public ${column.javaType} get${column.javaFieldNameUF}(){
        return this.${column.javaFieldName};
    }

#end}


这里需要生成整个Dao层代码,所以把方法写成了回调的形式


最后运行代码,会把代码生成在 项目的target/generator目录下


4封装成Maven插件

maven插件开发,也是自己第一次弄,官方文档Maven Plugin

上网搜了下maven插件开发,《开发自己的Maven插件之一:hello world》

实现过程也很简单,在pom中添加插件依赖,在代码中继承AbstractMojo类 ,实现execute方法

使用Intellij IDEA的话,可以选择maven模板




通过引用插件,就可以在项目中运行code-generator:generator命令,或者点击右侧插件运行


需要注意资源文件的加载方式

运行maven插件,项目是可以不编译的,因此要通过maven注入的basedir,获得项目的路径

如果在Java中运行,首先是需要编译项目的,通过java获得文件路径是在类编译的根目录下的

为了便于使用和测试,所以源码中,可以调用main包下的CodeGenerator类。

也可以把项目install本地,通过maven插件的方式,在其他项目中引用运行



5源码

源码使用了别人的一些代码进行了修改,类注释中都有原作者

最后强调,代码生成器不是万能的,要根据自己的需要进行一些修改,代码写的比较简单,见谅

源码:《code-generator》

共有 人打赏支持
蛙牛
粉丝 517
博文 45
码字总数 48937
作品 1
评论 (25)
蛙牛
@红薯 这都不推荐 以后没有写博客的动力了 1
lims
58同城哦
缓一缓
楼主还有 那个 velocity模板引擎代码生成器 的源码吗?博客链接里没找到代码下载位置3
菊花爆满山
加一个生成之后的截图
tuzibuluo
我也改造生成了dao和service,maven插件这个试试13
单行道
学习
fsh267
非常感谢,有空研究一下
蛙牛

引用来自“缓一缓”的评论

楼主还有 那个 velocity模板引擎代码生成器 的源码吗?博客链接里没找到代码下载位置3
在resources目录下~
蛙牛

引用来自“开源中国大Boss”的评论

加一个生成之后的截图
最后一张图片就是
蛙牛

引用来自“tuzibuluo”的评论

我也改造生成了dao和service,maven插件这个试试13
其实这篇主要也是想说maven插件的开发的
蛙牛

引用来自“fsh267”的评论

非常感谢,有空研究一下
iehyou

引用来自“fsh267”的评论

非常感谢,有空研究一下

引用来自“蛙牛”的评论

以后以为生成代码很高级,自己写过之后 发现就是写模板
baiyunfei
正好要弄个mybatis 的代码生成,试试
大漠真人
牛逼了,哈哈
傲气小舟舟
思路是错误的,持久层怎么能反推业务实体呢?
蛙牛

引用来自“傲气小舟舟”的评论

思路是错误的,持久层怎么能反推业务实体呢?
DB实体 业务实体 可以是不一样的~
缓一缓

引用来自“缓一缓”的评论

楼主还有 那个 velocity模板引擎代码生成器 的源码吗?博客链接里没找到代码下载位置3

引用来自“蛙牛”的评论

在resources目录下~
多谢
dmrs
up
最近改了下mybatis generator源码
可以自定义生成字段注释和表注释
看了楼主的代码
值得学习
sumyfly
向牛人学习!
墨-眉
mark,好东西,有时间好好研究
×
蛙牛
如果觉得我的文章对您有用,请随意打赏。您的支持将鼓励我继续创作!
* 金额(元)
¥1 ¥5 ¥10 ¥20 其他金额
打赏人
留言
* 支付类型
微信扫码支付
打赏金额:
已支付成功
打赏金额: