Mybatis generator代码生成

最新推荐文章于 2022-05-31 17:22:02 发布
最新推荐文章于 2022-05-31 17:22:02 发布
阅读量95 收藏
点赞数
文章标签： java 数据库 开发工具
原文链接：http://www.cnblogs.com/yejg1212/p/9592369.html
版权

背景

项目中使用Mybatis做持久层框架，但由于开发成员水平不一，写dao的时候，各有各的偏好，有时候还会写出带sql注入漏洞的代码。

出现sql注入漏洞，一般是#和$的区别没弄明白：
$ 直接把字符串原封不动的搬进sql，有sql注入的风险
# 是预留一个问号,作为参数插入的，即可通过预编译sql的方式避免sql注入

于是想使用Mybatis generator这个工具来统一生成代码（java bean，mapper，xml）

使用

Mybatis generator可以通过如下方式运行

  • 命令行
下载mybatis-generator-core.jar，然后配置generatorConfig.xml文件，执行如下命令
java -jar mybatis-generator-core-1.3.7.jar -configfile generatorConfig.xml -overwrite
  • IDE插件，run as
安装eclipse/idea插件
  • 通过main方法执行
public static void main(String[] args) throws Exception {
    List<String> warnings = new ArrayList<String>();
    boolean overwrite = true;
    ConfigurationParser cp = new ConfigurationParser(warnings);

    Configuration config = cp.parseConfiguration(MainGenerate.class.getClassLoader().getResourceAsStream("generatorConfig.xml"));

    DefaultShellCallback callback = new DefaultShellCallback(overwrite);
    MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
    myBatisGenerator.generate(null);
    System.out.println("----done----");
}

问题及解决方法

分页问题

默认生成的xml是没有分页查询的，可通过

<plugin type="org.mybatis.generator.plugins.RowBoundsPlugin">

来实现分页，不过...

  • 在低版本的generator插件里是不包含这个的。
  • 使用这个插件生成分页代码后，会多一个selectByExampleWithRowbounds(XxxExample example, RowBounds rowBounds) 的方法，但是XxxMapper.xml文件中的selectByExampleWithRowbounds元素，可以发现select语句并没有使用limit 或者 rownum。
    实际上RowBounds原理是通过ResultSet的游标来实现分页，容易出现性能问题
解决办法

可使用pagehelper来解决，See Github

除此之外，我们也可以通过自定义分页插件来解决

  • Oracle插件
package com.yejg.mybatis.generator.plugins;

// 省略import

public class OraclePaginationPlugin extends PluginAdapter {

    public boolean modelExampleClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
        PrimitiveTypeWrapper integerWrapper = FullyQualifiedJavaType.getIntInstance().getPrimitiveTypeWrapper();

        Field begin = new Field();
        begin.setName("begin");
        begin.setVisibility(JavaVisibility.PRIVATE);
        begin.setType(integerWrapper);
        topLevelClass.addField(begin);
        context.getCommentGenerator().addFieldComment(begin, introspectedTable);

        Method setBegin = new Method();
        setBegin.setVisibility(JavaVisibility.PUBLIC);
        setBegin.setName("setBegin");
        setBegin.addParameter(new Parameter(integerWrapper, "begin"));
        setBegin.addBodyLine("this.begin = begin;");
        topLevelClass.addMethod(setBegin);
        context.getCommentGenerator().addGeneralMethodComment(setBegin, introspectedTable);
        
        Method getBegin = new Method();
        getBegin.setVisibility(JavaVisibility.PUBLIC);
        getBegin.setReturnType(integerWrapper);
        getBegin.setName("getBegin");
        getBegin.addBodyLine("return begin;");
        topLevelClass.addMethod(getBegin);
        context.getCommentGenerator().addGeneralMethodComment(getBegin, introspectedTable);

        Field end = new Field();
        end.setName("end");
        end.setVisibility(JavaVisibility.PRIVATE);
        end.setType(integerWrapper);
        topLevelClass.addField(end);
        context.getCommentGenerator().addFieldComment(end, introspectedTable);

        Method setEnd = new Method();
        setEnd.setVisibility(JavaVisibility.PUBLIC);
        setEnd.setName("setEnd");
        setEnd.addParameter(new Parameter(integerWrapper, "end"));
        setEnd.addBodyLine("this.end = end;");
        topLevelClass.addMethod(setEnd);
        context.getCommentGenerator().addGeneralMethodComment(setEnd, introspectedTable);

        Method getEnd = new Method();
        getEnd.setVisibility(JavaVisibility.PUBLIC);
        getEnd.setReturnType(integerWrapper);
        getEnd.setName("getEnd");
        getEnd.addBodyLine("return end;");
        topLevelClass.addMethod(getEnd);
        context.getCommentGenerator().addGeneralMethodComment(getEnd, introspectedTable);

        return true;
    }

    @Override
    public boolean sqlMapDocumentGenerated(Document document, IntrospectedTable introspectedTable) {
        XmlElement parentElement = document.getRootElement();

        XmlElement paginationPrefixElement = new XmlElement("sql");
        paginationPrefixElement.addAttribute(new Attribute("id", "Oracle_Paging_Prefix"));
        XmlElement pageStart = new XmlElement("if");
        pageStart.addAttribute(new Attribute("test", "begin != null and end != null"));
        pageStart.addElement(new TextElement("select * from ( select row_.*, rownum rownum_ from ( "));
        context.getCommentGenerator().addComment(paginationPrefixElement);
        paginationPrefixElement.addElement(pageStart);
        parentElement.addElement(paginationPrefixElement);

        XmlElement paginationSuffixElement = new XmlElement("sql");
        paginationSuffixElement.addAttribute(new Attribute("id", "Oracle_Paging_Suffix"));
        XmlElement pageEnd = new XmlElement("if");
        pageEnd.addAttribute(new Attribute("test", "begin != null and end != null"));
        pageEnd.addElement(new TextElement("<![CDATA[ ) row_ ) where rownum_ > #{begin} and rownum_ <= #{end} ]]>"));
        context.getCommentGenerator().addComment(paginationSuffixElement);
        paginationSuffixElement.addElement(pageEnd);
        parentElement.addElement(paginationSuffixElement);

        return super.sqlMapDocumentGenerated(document, introspectedTable);
    }

    @Override
    public boolean sqlMapSelectByExampleWithoutBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable) {

        XmlElement pageStart = new XmlElement("include"); //$NON-NLS-1$
        pageStart.addAttribute(new Attribute("refid", "Oracle_Paging_Prefix"));
        // context.getCommentGenerator().addComment(pageStart);
        element.getElements().add(0, pageStart);

        XmlElement isNotNullElement = new XmlElement("include"); //$NON-NLS-1$
        isNotNullElement.addAttribute(new Attribute("refid", "Oracle_Paging_Suffix"));
        // context.getCommentGenerator().addComment(isNotNullElement);
        element.getElements().add(isNotNullElement);

        return super.sqlMapUpdateByExampleWithoutBLOBsElementGenerated(element, introspectedTable);
    }

    /**
     * This plugin is always valid - no properties are required
     */
    public boolean validate(List<String> warnings) {
        return true;
    }
}
  • MySQl插件
package com.yejg.mybatis.generator.plugins;

// 省略import

public class MySQLPaginationPlugin extends PluginAdapter {

    @Override
    public boolean validate(List<String> list) {
        return true;
    }

    /**
     * 为每个Example类添加limit和offset属性已经set、get方法
     */
    @Override
    public boolean modelExampleClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {

        PrimitiveTypeWrapper integerWrapper = FullyQualifiedJavaType.getIntInstance().getPrimitiveTypeWrapper();

        Field limit = new Field();
        limit.setName("limit");
        limit.setVisibility(JavaVisibility.PRIVATE);
        limit.setType(integerWrapper);
        topLevelClass.addField(limit);

        Method setLimit = new Method();
        setLimit.setVisibility(JavaVisibility.PUBLIC);
        setLimit.setName("setLimit");
        setLimit.addParameter(new Parameter(integerWrapper, "limit"));
        setLimit.addBodyLine("this.limit = limit;");
        topLevelClass.addMethod(setLimit);

        Method getLimit = new Method();
        getLimit.setVisibility(JavaVisibility.PUBLIC);
        getLimit.setReturnType(integerWrapper);
        getLimit.setName("getLimit");
        getLimit.addBodyLine("return limit;");
        topLevelClass.addMethod(getLimit);

        Field offset = new Field();
        offset.setName("offset");
        offset.setVisibility(JavaVisibility.PRIVATE);
        offset.setType(integerWrapper);
        topLevelClass.addField(offset);

        Method setOffset = new Method();
        setOffset.setVisibility(JavaVisibility.PUBLIC);
        setOffset.setName("setOffset");
        setOffset.addParameter(new Parameter(integerWrapper, "offset"));
        setOffset.addBodyLine("this.offset = offset;");
        topLevelClass.addMethod(setOffset);

        Method getOffset = new Method();
        getOffset.setVisibility(JavaVisibility.PUBLIC);
        getOffset.setReturnType(integerWrapper);
        getOffset.setName("getOffset");
        getOffset.addBodyLine("return offset;");
        topLevelClass.addMethod(getOffset);

        return true;
    }

    /**
     * 为Mapper.xml的selectByExample添加limit
     */
    @Override
    public boolean sqlMapSelectByExampleWithoutBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable) {

        XmlElement ifLimitNotNullElement = new XmlElement("if");
        ifLimitNotNullElement.addAttribute(new Attribute("test", "limit != null"));

        XmlElement ifOffsetNotNullElement = new XmlElement("if");
        ifOffsetNotNullElement.addAttribute(new Attribute("test", "offset != null"));
        ifOffsetNotNullElement.addElement(new TextElement("limit ${offset}, ${limit}"));
        ifLimitNotNullElement.addElement(ifOffsetNotNullElement);

        XmlElement ifOffsetNullElement = new XmlElement("if");
        ifOffsetNullElement.addAttribute(new Attribute("test", "offset == null"));
        ifOffsetNullElement.addElement(new TextElement("limit ${limit}"));
        ifLimitNotNullElement.addElement(ifOffsetNullElement);

        element.addElement(ifLimitNotNullElement);

        return true;
    }
}
生成的xml不是覆盖旧文件，有时还有重复的段

问题原因在于：
在IntrospectedTableMyBatis3Impl.getGeneratedXmlFiles方法中，isMergeable值被写死为true了。

GeneratedXmlFile gxf = new GeneratedXmlFile(document,
        getMyBatis3XmlMapperFileName(), getMyBatis3XmlMapperPackage(),
        context.getSqlMapGeneratorConfiguration().getTargetProject(),
        true, context.getXmlFormatter());

而MyBatisGenerator.writeGeneratedXmlFile方法中使用到该属性了。代码如下：

if (targetFile.exists()) {
    if (gxf.isMergeable()) {
        source = XmlFileMergerJaxp.getMergedSource(gxf, targetFile);
    } else if (shellCallback.isOverwriteEnabled()) {
        source = gxf.getFormattedContent();
        warnings.add(getString("Warning.11", targetFile.getAbsolutePath()));
    } else {
        source = gxf.getFormattedContent();
        targetFile = getUniqueFileName(directory, gxf.getFileName());
        warnings.add(getString("Warning.2", targetFile.getAbsolutePath()));
    }
} else {
    source = gxf.getFormattedContent();
}
解决办法

方法一：可直接修改源码，把isMergeable写成false

方法二：拿到GeneratedXmlFile对象，通过反射把isMergeable改成false

// 可以在前面自定义的Plugin中，sqlMapGenerated方法中拿到GeneratedXmlFile对象
public boolean sqlMapGenerated(GeneratedXmlFile sqlMap, IntrospectedTable introspectedTable) {
    try {
        java.lang.reflect.Field field = sqlMap.getClass().getDeclaredField("isMergeable");
        field.setAccessible(true);
        field.setBoolean(sqlMap, false);
    } catch (Exception e) {
        
    }
    return true;
}
注释问题

默认的注释完全没什么用，不如自定义注释，把数据库表字段的注释作为bean字段的注释

解决办法
public class MyCommentGenerator implements CommentGenerator {

    private Properties systemPro;
    private boolean suppressAllComments;
    private SimpleDateFormat dateFormat;

    public MyCommentGenerator() {
        super();
        systemPro = System.getProperties();
        suppressAllComments = false;
        dateFormat = new SimpleDateFormat("yyyy-MM-dd");
    }

    /**
     * 生成java model的类头上的注释
     */
    @Override
    public void addModelClassComment(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
        if (suppressAllComments) {
            return;
        }

        topLevelClass.addJavaDocLine("/**");
        StringBuffer sb = new StringBuffer();
        sb.append(" * ");
        sb.append(introspectedTable.getRemarks());
        sb.append(" [");
        sb.append(introspectedTable.getFullyQualifiedTable().toString().toLowerCase());
        sb.append("]");
        topLevelClass.addJavaDocLine(sb.toString());
        topLevelClass.addJavaDocLine(" * @author " + systemPro.getProperty("user.name"));
        topLevelClass.addJavaDocLine(" */");
    }

    /**
     * 添加字段注释
     */
    @Override
    public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
        if (suppressAllComments) {
            return;
        }
        StringBuilder sb = new StringBuilder();
        sb.append("/** ").append(introspectedColumn.getRemarks().replace("\n", " ")).append(" */");
        field.addJavaDocLine(sb.toString());
    }

    // 省略了其他方法
}

不过在使用的时候发现通过
introspectedColumn.getRemarks()
获取到的注释为null，此问题可通过修改xml配置文件来处理

<jdbcConnection driverClass="oracle.jdbc.driver.OracleDriver" connectionURL="jdbc:oracle:thin:@127.0.0.1:1521:YEJG" userId="XXX" password="XXX">
      <!-- 针对oracle数据库 -->
      <property name="remarksReporting" value="true" />
      
      <!-- 针对mysql数据库 -->
      <!-- <property name="useInformationSchema" value="true" /> -->
</jdbcConnection>
序列问题

其实这算不算什么问题，xml配置一下就可以了

<table tableName="users">
    <property name="useActualColumnNames" value="true" />
    <generatedKey type="pre" column="SERIAL_NO" sqlStatement="select users_seq.nextval from dual"></generatedKey>
</table>

这里需要注意下，generatedKey不要写在property前面了，mybatis generator对顺序有要求的。

字段命名方式问题

数据库表字段是USER_ID形式，生成的bean的字段变成userId形式

解决办法

可在generatorConfig.xml中添加如下配置

<property name="useActualColumnNames" value="true" />

不过这么一来，bean中的字段就都变成大写的了，期望生成user_id的形式，可通过修改源码来解决

// DatabaseIntrospector#getColumns，把column_name先toLowerCase处理一下
introspectedColumn.setActualColumnName(rs.getString("COLUMN_NAME").toLowerCase());

关于代码

以上代码已上传到Github

转载于:https://www.cnblogs.com/yejg1212/p/9592369.html

weixin_33972649
关注
使用Mybatis Generator自动生成Mybatis相关代码
qiuguo0205's blog
11-21 287
本文将简要介绍怎样利用Mybatis Generator自动生成Mybatis的相关代码：一、构建一个环境： 1. 首先创建一个表：   CREATE TABLE pet (name VARCHAR(20), owner VARCHAR(20), species VARCHAR(20), sex CHAR(1), birth DATE, death DATE);   2. 然后注入数...
mybatis generator 代码生成
aayygg1234的专栏
04-27 326
mybatis generator代码生成有五中方式，这里我们列出三种，重点说下其中两项常用的。 第一种:使用命令行创建 java -jar mybatis-generator-core-1.3.2.jar -config file generatorConfig.xml -overwrite 第二种:通过MybatisGenerator类和配置文件生成代码 package com.github.dao; import org.mybatis.generator.api.MyBatisGen.
mybatis generator
weixin_34107955的博客
10-28 90
2019独角兽企业重金招聘Python工程师标准>>> ...
mybatis自动生成代码(generator插件)
yx15156537218的博客
11-05 393
mybatis代码生成插件generator generator依赖 测试类生成器 配置文件 1、依赖 <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>1.3.0&
SpringBoot+Mybatis反向工程全过程
qq_42023080的博客
07-19 473
反向工程详细过程
MybatisGenerator代码生成器（可查询指定字段）
08-06
MybatisGenerator本身是没有提供查询指定字段的，例如数据库有5个字段，我想查询其中3个...经过研究MybatisGenerator实现原理，在保证原有功能的基础上，实现了生成查询指定字段的相关方法，下载即可使用。eclipse！
mybatis generator代码生成器
11-25
MyBatis Generator是一个可以用来生成Mybatis dao,entity,Mapper文件的一个工具,在项目的过程中可以省去很多重复的工作,我们只要在MyBatis Generator的配置文件中配置好要生成的表名与包名，然后运行一条命令就会...
Mybatis Generator代码生成
05-03
总结来说，Mybatis Generator是一款强大的代码生成工具，它简化了Mybatis框架的使用，降低了开发难度，提高了开发效率。通过合理配置和灵活运用，可以在保证代码质量的同时，大幅提升开发速度。对于熟悉Mybatis框架...
Mybatis Generator 代码生成工具
02-21
Mybatis Generator 是一款强大的自动化代码生成工具，它能够极大提高开发效率，特别是在处理与数据库交互的 CRUD（创建、读取、更新、删除）操作时。这个工具能够自动生成 Mybatis 的 XML 映射文件、实体类以及 ...
MyBatis Generator代码生成器视频教程
06-09
MyBatis Generator (MBG) 是一个Mybatis的代码生成器 MyBatis 和 iBATIS. 他可以生成Mybatis各个版本的代码，和iBATIS 2.2.0版本以后的代码。 他可以内省数据库的表（或多个表）然后生成可以用来访问（多个）表的...
Mybatis代码生成器Mybatis-Generator使用详解
m0_67698950的博客
05-31 3万+
前提 最近在做创业项目的时候因为有比较多的新需求，需要频繁基于DDL生成Mybatis适合的实体、Mapper接口和映射文件。其中，代码生成器是MyBatis Generator(MBG)，用到了Mybatis-Generator-Core相关依赖，这里通过一篇文章详细地分析这个代码生成器的使用方式。本文编写的时候使用的Mybatis-Generator版本为1.4.0，其他版本没有进行过调研。 引入插件 Mybatis-Generator的运行方式有很多种： 基于mybatis-generator
MyBatis Generator配置及运行
mameng1988的博客
04-13 5345
一、MyBatis Generator配置1、创建的maven项目如下：在上述Maven项目的pom.xml中引入：              &lt;dependency&gt; &lt;groupId&gt;org.mybatis&lt;/groupId&gt; &lt;artifactId&gt;mybatis&lt;/artifactId&gt; &lt;version&gt;...
MyBatis Generator生成代码的四种方式
Mervin的专栏
11-30 3万+
由于MyBatis属于一种半自动的ORM框架，所以主要的工作就是配置Mapping映射文件，但是由于手写映射文件很容易出错，所以可利用MyBatis生成器自动生成实体类、DAO接口和Mapper映射文件。这样可以省去一部分的功夫，将生成的代码copy到项目工程中即可。 参考文档http://mybatis.org/generator 中文译版 http://generator.sturgeo
MyBatis逆向工程代码的生成以及使用详解(持续更新)
热门推荐
qq_39056805的博客
06-07 14万+
啊
MyBatis Generator生成代码的几种方式
勿忘初心的博客
10-13 1万+
由于MyBatis属于一种半自动的ORM框架，所以主要的工作就是配置Mapping映射文件，但是由于手写映射文件很容易出错，所以可利用MyBatis生成器自动生成实体类、DAO接口和Mapper映射文件。这样可以省去一部分的功夫，下面将介绍几种生成方式:MyBatis Generator 参考文档:http://blog.csdn.net/isea533/article/details/42102...
MyBatis Generator 1.3.2 生成带注释的实体类
GaoShanBuZaiGao的博客
10-15 301
0.下载源码 地址：https://github.com/mybatis/generator/releases/tag/mybatis-generator-1.3.2 1.IDEA导入源码 2.修改Field.java a.添加属性remark，同时添加getter，setter方法 b.修改getFormattedContent方法 public String getFormattedContent(int indentLev
mybatis使用generator生成器生成entity，mapper，xml模版类及自己写sql情况处理
星坠竹空
03-19 880
在使用mybatis时总是要生成实体类，mapper以及常用的mapper.xml文件，手写既没有技术含量还浪费时间，所以使用generator生成器会很方便。 pom.xml配置： <dependency> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-ge...
使用mybatis-generator在自动生成Model类和Mapper文件
栗少的博客
10-27 847
使用mybatis-generator插件可以很轻松的实现mybatis的逆向工程,即,能通过表结构自动生成对应的java类及mapper文件,可以大大提高工作效率,并且它提供了很多自定义的设置可以应对不同的需求,最近做公司新开的一个项目就是使用到了它,简单粗暴. 　　下面介绍详细的使用步骤和注意事项,我的项目环境是idea+maven+ssm,但是我新建了一个空的maven项目专门用来生成java代码,然后再把它有选择的copy到自己的项目环境中. 　　1.新建一个空的webapp类型的maven项目
MyBatis代码生成器-Example讲解
勇往直前的专栏
12-10 3379
概述 在上篇博文 MyBatis代码生成器（逆向工程）MBG使用 中介绍了MBGZ的基本使用。我们知道在MBG的context中将targetRuntime配置为MyBatis3时，MBG会生成和Example相关的对象和方法。 本篇博文我们来介绍下与Example相关的用法。 示例 以country表相关的Example MBG 为例 generatorConfig-country.xm...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值