MyBatis整合Generator工具类

最新推荐文章于 2024-06-02 12:41:38 发布

geng2568

最新推荐文章于 2024-06-02 12:41:38 发布

阅读量493

点赞数

分类专栏： Generator工具类文章标签： MyBatisGenerator工具类

本文链接：https://blog.csdn.net/geng2568/article/details/88865253

版权

Generator工具类专栏收录该内容

1 篇文章 0 订阅

订阅专栏

每次在建数据库表的时候，有多少张表就得写几个实体类和几个mapper.xml，最重要的是每次在数据库中添加每个属性的注解信息后，在编写实体类时习惯在每一个字段上面加上注释，这样方便其他人再看自己写的的代码是更加清晰明了，所以写了一个MybatisGenerator工具类自动生成实体类和mapper.xml文件，方便了很多。希望可以帮助到哪些大伙！

首先引入相关的pom依赖：

     <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus</artifactId>
            <version>2.1.4</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatisplus-spring-boot-starter</artifactId>
            <version>1.0.5</version>
        </dependency>
        <!--定义注释生成依赖插件-->
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.2</version>
        </dependency>

其次编写这个Generator工具类配置文件的，内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
        PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
        "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
    <!-- 数据库驱动:选择你的本地硬盘上面的数据库驱动包-->
    <classPathEntry  location="D:\software\Maven\repository\mysql\mysql-connector-java\5.1.45\mysql-connector-java-5.1.45.jar"/>
    <context id="DB2Tables"  targetRuntime="MyBatis3">//注意使用的是MyBatis3或MyBatis3Simple
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
      
        <commentGenerator type="com.zte.comment.MyCommentGenerator">
            <!--<property name="suppressDate" value="true"/>
             &lt;!&ndash;&lt;!&ndash;是否去除自动生成的注释 true：是 ： false:否 &ndash;&gt;&ndash;&gt;
            -->
            <property name="suppressAllComments" value="true"/>
            <property name="javaFileEncoding" value="UTF-8"/>
        </commentGenerator>

        <!--数据库链接URL，用户名、密码 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://10.85.153.34/res_man" userId="root" password="ZTEzdh">
        </jdbcConnection>
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- 生成模型的包名和位置-->
        <javaModelGenerator targetPackage="com.zte.domain" targetProject="src/main/java">
            <property name="enableSubPackages" value="true"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        <!-- 生成映射文件的包名和位置-->
        <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
            <property name="enableSubPackages" value="true"/>
            </sqlMapGenerator>
        <!-- 生成DAO的包名和位置-->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.zte.mapper" targetProject="src/main/java">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>
        <!-- 要生成的表 tableName是数据库中的表名或视图名 domainObjectName是实体类名-->
        <table tableName="server_manager" domainObjectName="ServerManager" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false">
            <!-- 当表中的某一个字段类型为text或者Blob类型时，可以添加如下代码-->
            <!--<columnOverride column="detail" javaType="java.lang.String" jdbcType="VARCHAR" />-->
        </table>
    </context>
</generatorConfiguration>

然在编写一个读取这个配置文件的启动类，并重写几个方法，实现实体类中同步对应数据库字段的注解：

package com.zte.comment;


import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.api.dom.java.Field;
import org.mybatis.generator.api.dom.java.InnerClass;
import org.mybatis.generator.api.dom.java.Method;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.exception.InvalidConfigurationException;
import org.mybatis.generator.exception.XMLParserException;
import org.mybatis.generator.internal.DefaultCommentGenerator;
import org.mybatis.generator.internal.DefaultShellCallback;


import java.io.File;
import java.io.IOException;
import java.sql.SQLException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Properties;

/**
 * Created by 6092002943 on 2018/12/20.
 * mybatis generator 自定义comment生成器.
 * 基于MBG 1.3.2.
 */
public class MyCommentGenerator extends DefaultCommentGenerator {

    private Properties properties;
    private Properties systemPro;
    private boolean suppressDate;
    private boolean suppressAllComments;
    private String currentDateStr;

    public MyCommentGenerator() {
        super();
        properties = new Properties();
        systemPro = System.getProperties();
        suppressDate = false;
        suppressAllComments = false;
        currentDateStr = (new SimpleDateFormat("yyyy-MM-dd")).format(new Date());
    }
    public void addFieldComment(Field field, IntrospectedTable introspectedTable,
                                IntrospectedColumn introspectedColumn) {
        if (suppressAllComments) {
            return;
        }
        StringBuilder sb = new StringBuilder();
        field.addJavaDocLine("/**");
        sb.append(" * ");
        sb.append(introspectedColumn.getRemarks());
        field.addJavaDocLine(sb.toString().replace("\n", " "));
        field.addJavaDocLine(" */");
    }

    public void addFieldComment(Field field, IntrospectedTable introspectedTable) {
    }

    public void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable) {
    }

    public void addGetterComment(Method method, IntrospectedTable introspectedTable,
                                 IntrospectedColumn introspectedColumn) {
    }

    public void addSetterComment(Method method, IntrospectedTable introspectedTable,
                                 IntrospectedColumn introspectedColumn) {
    }

    public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable, boolean markAsDoNotDelete) {
    }

    public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable) {
    }

    public static void main(String[] args) {
            try {
                List<String> warnings = new ArrayList<String>();
                boolean overwrite = true;
                //这个写在的那个配置文件所在路径
                File configFile = new File("D:/Project/resource-manage/src/main/resources/generator/generatorConfig.xml");
                ConfigurationParser cp = new ConfigurationParser(warnings);
                Configuration config = cp.parseConfiguration(configFile);
                DefaultShellCallback callback = new DefaultShellCallback(overwrite);
                MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
                myBatisGenerator.generate(null);
            } catch (SQLException e) {
                e.printStackTrace();
            } catch (IOException e) {
                e.printStackTrace();
            } catch (InterruptedException e) {
                e.printStackTrace();
            } catch (InvalidConfigurationException e) {
                e.printStackTrace();
            } catch (XMLParserException e) {
                e.printStackTrace();
            }


    }



}

注意：在启动类中添加注释的地方修改成你自己的配置文件坐在地方，都调好了，运行main方法就可以了。结果如下：

总结：希望可以帮助你，欢迎留言！！谢谢大家。

在修改自定义自动生成的dao层或者mapper.xml文件名称是需要添加以下操作

<table tableName="sys_store" mapperName="StoreDao">

<generatedKey column="id" sqlStatement="Mysql"/>

</table>

本来默认情况下生成的 mapper 名字为StoreMapper，通过上面设置后，就会生成 StroreDao，对于一般情况的用法这就够了。

但是因为 tableName 属性支持通配符 %，在这种情况下就不能使用mapperName属性设置了。为了解决这种情况，提供了一个插件可以用于通配符情况下的配置。

注意必须使用 MBG 1.3.4 或以上版本。

插件的思路很简单，在 MBG 中，使用 mapperName 的地方如下：

if (stringHasValue(tableConfiguration.getMapperName())) {
sb.append(tableConfiguration.getMapperName());
} else {
sb.append(fullyQualifiedTable.getDomainObjectName());
sb.append("Mapper"); //$NON-NLS-1$
}

看 else 中可以发现，默认是用DomainObjectName和Mapper拼接到一起的，所以对于 mapperName 我们可以设置为{0}Dao，然后使用MessageFormat，以DomainObjectName作为一个参数去格式化 mapperName ，这样就能很简单的解决通配符情况下的问题。

mapperName 出现在org.mybatis.generator.api.IntrospectedTable类中的下面两个方法中：

//包含处理 Mapper 接口和 SqlProvider 的代码
protected void calculateJavaClientAttributes() {
//...
}

//包含处理 Mapper.xml 的代码
protected String calculateMyBatis3XmlMapperFileName() {
}

平时我们在<context>中设置targetRuntime属性时，使用的是MyBatis3或MyBatis3Simple，他们对应的两个类，都是继承自IntrospectedTable，所以我们修改的时候，要针对这两个继承的类去实现。

这里给出完整的代码：

package com.zte.st.dailybuild.common;

import org.mybatis.generator.codegen.mybatis3.IntrospectedTableMyBatis3Impl;

import java.text.MessageFormat;

import static org.mybatis.generator.internal.util.StringUtility.stringHasValue;

/**
 * Created by 6092002943 on 2020/3/26.
 */
public class TkMyBatis3Impl extends IntrospectedTableMyBatis3Impl  {

    @Override//设置Mapper.xml文件名称的
    protected String calculateMyBatis3XmlMapperFileName() {
        StringBuilder sb = new StringBuilder();
        if (stringHasValue(tableConfiguration.getMapperName())) {
//            String mapperName = tableConfiguration.getMapperName();
//            int ind = mapperName.lastIndexOf('.');
//            if (ind != -1) {
//                mapperName = mapperName.substring(ind + 1);
//            }
//            //支持mapperName = "{0}Dao" 等用法
//            sb.append(MessageFormat.format(mapperName, fullyQualifiedTable.getDomainObjectName()));
//            sb.append(".xml"); //$NON-NLS-1$
            sb.append(fullyQualifiedTable.getDomainObjectName());
            sb.append("Mapper.xml"); //$NON-NLS-1$  强行设置mapper.xml文件的名字为表名加Mapper.xml,上面注释的是文件名是表名加Dao.xml
        } else {
            sb.append(fullyQualifiedTable.getDomainObjectName());
            sb.append("Mapper.xml"); //$NON-NLS-1$
        }
        return sb.toString();
    }

    @Override
    protected void calculateJavaClientAttributes() {
        if (context.getJavaClientGeneratorConfiguration() == null) {
            return;
        }

        StringBuilder sb = new StringBuilder();
        sb.append(calculateJavaClientImplementationPackage());
        sb.append('.');
        sb.append(fullyQualifiedTable.getDomainObjectName());
        sb.append("DAOImpl"); //$NON-NLS-1$
        setDAOImplementationType(sb.toString());

        sb.setLength(0);
        sb.append(calculateJavaClientInterfacePackage());
        sb.append('.');
        sb.append(fullyQualifiedTable.getDomainObjectName());
        sb.append("DAO"); //$NON-NLS-1$
        setDAOInterfaceType(sb.toString());//设置Dao层文件的名字

        sb.setLength(0);
        sb.append(calculateJavaClientInterfacePackage());
        sb.append('.');
        if (stringHasValue(tableConfiguration.getMapperName())) {
            //支持mapperName = "{0}Dao" 等用法
            sb.append(MessageFormat.format(tableConfiguration.getMapperName(), fullyQualifiedTable.getDomainObjectName()));
        } else {
            sb.append(fullyQualifiedTable.getDomainObjectName());
            sb.append("Mapper"); //$NON-NLS-1$
        }
        setMyBatis3JavaMapperType(sb.toString());//设置Dao层文件的名字

        sb.setLength(0);
        sb.append(calculateJavaClientInterfacePackage());
        sb.append('.');
        if (stringHasValue(tableConfiguration.getSqlProviderName())) {
            //支持mapperName = "{0}SqlProvider" 等用法
            sb.append(MessageFormat.format(tableConfiguration.getSqlProviderName(), fullyQualifiedTable.getDomainObjectName()));
        } else {
            sb.append(fullyQualifiedTable.getDomainObjectName());
            sb.append("SqlProvider"); //$NON-NLS-1$
        }
        setMyBatis3SqlProviderType(sb.toString());
    }

}

另一个和上面代码一样，只是继承的类变了：

//MyBatis3Simple 的实现 public class TkMyBatis3Impl extends IntrospectedTableMyBatis3SimpleImpl {

//内容和上面的一样

}

如何使用？

写个插件很容易，但是如何用对很多人来说都是一个大问题。

先说如何配置，再说如何运行。

配置
配置方式，只是修改上面的generatorConfig.xml<context>的targetRuntime属性，如下：

这样一运行生成的接口Dao层是实体类＋Dao.xml,而生成的mapper.xml文件的名字是实体类名+mapper.xml,。

这样就按照自定义的文件名称生成相关的文件

geng2568

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
MyBatis整合Generator工具类

每次在建数据库表的时候，有多少张表就得写几个实体类和几个mapper.xml，最重要的是每次在数据库中添加每个属性的注解信息后，在编写实体类时习惯在每一个字段上面加上注释，这样方便其他人再看自己写的的代码是更加清晰明了，所以写了一个MybatisGenerator工具类自动生成实体类和mapper.xml文件，方便了很多。希望可以帮助到哪些大伙！首先引入相关的pom依赖： &lt...
复制链接

扫一扫