记配置mybatis-generator

最近计划做一个以Java为后台的项目，用的springboot + mybatis。建完表后，第一件事就是建对应的实体类了，建了几个表，几十个字段，不想一个个手写字段和get、set方法。所以试试mybatis的generator自动生成。

第一件事先搜一下别人对generator的使用，了解一下generator的配置。

https://www.cnblogs.com/maanshancss/p/6027999.html

https://www.cnblogs.com/zzllx/p/5994228.html

https://www.jianshu.com/p/310c299846fc

感谢3位作者的启迪，看完大概知道配置方法了，自己动手试试看。

1、添加maven依赖和插件

<dependency>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-core</artifactId>
    <version>1.3.6</version>
</dependency>

　　

<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.3.6</version>
    <configuration>
        <verbose>true</verbose>
        <overwrite>true</overwrite>
    </configuration>
</plugin>    

　　

2、新建\src\main\resources\generatorConfig.xml 文件

 

generatorConfig.xml

<?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>
    <!-- 配置文件路径 -->
    <properties resource="application.properties" />
    <!-- 数据库驱动:选择你的本地硬盘上面的数据库驱动包-->
    <classPathEntry location="C:\Users\Administrator\.m2\repository\mysql\mysql-connector-java\8.0.13\mysql-connector-java-8.0.13.jar"/>
    <context id="DB2Tables" targetRuntime="MyBatis3">
        <commentGenerator>
            <property name="suppressDate" value="true"/>
            <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <!--数据库链接URL，用户名、密码 -->
        <jdbcConnection driverClass="${jdbc.driver}" connectionURL="${jdbc.url}" userId="${jdbc.username}" password="${jdbc.password}">
        </jdbcConnection>

        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>
        <!-- 生成模型的包名和位置-->
        <javaModelGenerator targetPackage="cn.lzp.performance.entity" 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="cn.lzp.performance.dao" targetProject="src/main/java">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>
        <!-- 要生成的表 tableName是数据库中的表名或视图名 domainObjectName是实体类名 下面不需要的方法，设置成false就可以了
            5, enableInsert（默认true）：指定是否生成insert语句；
            6，enableSelectByPrimaryKey（默认true）：指定是否生成按照主键查询对象的语句（就是getById或get）；
            7，enableSelectByExample（默认true）：MyBatis3Simple为false，指定是否生成动态查询语句；
            8，enableUpdateByPrimaryKey（默认true）：指定是否生成按照主键修改对象的语句（即update)；
            9，enableDeleteByPrimaryKey（默认true）：指定是否生成按照主键删除对象的语句（即delete）；
            10，enableDeleteByExample（默认true）：MyBatis3Simple为false，指定是否生成动态删除语句；
            11，enableCountByExample（默认true）：MyBatis3Simple为false，指定是否生成动态查询总条数语句（用于分页的总条数查询）；
            12，enableUpdateByExample（默认true）：MyBatis3Simple为false，指定是否生成动态修改语句（只修改对象中不为空的属性）；
        -->
        <table tableName="tb_user" domainObjectName="User" mapperName="UserDao"
               enableInsert="false"
               enableSelectByPrimaryKey="false"
               enableSelectByExample="false"
               enableCountByExample="false"
               enableUpdateByExample="false"
               enableDeleteByExample="false"
               selectByExampleQueryId="false">
        </table>
    </context>
</generatorConfiguration>

上面3个注意点：

1、jdbcConnection我写在application.properties文件里面了，properties标签设置路径。

2、classPathEntry的路径是mysql jar包的位置，我设置的是本地仓库的绝对路径，这个文件生成就在本地执行的，所以这个用了本地的文件也无所谓。

3、mapperName用来配置自动生成后的文件名，也可以设置路径。

默认不设置，则生成的文件名为UserMapper和UserMapper.xml，习惯用Dao后缀，所以这里我修改了一下。

修改前：

修改后：

上面说可以设置路径怎么回事呢，简单试了一下。

<table tableName="tb_user" domainObjectName="User" mapperName="User.UserDao"
    enableInsert="false"
    enableSelectByPrimaryKey="false"
    enableSelectByExample="false"
    enableCountByExample="false"
    enableUpdateByExample="false"
    enableDeleteByExample="false"
    selectByExampleQueryId="false">
</table>

mapperName设置为“User.UserDao”，生成的文件路径结构是这样的

 

 

配置完成了，执行即可。

我用的是idea，右上角Edit Configurations,新增Maven架构，名字为：generator，Command line为：mybatis-generator:generate -e。

 然后运行这个架构就生成了对应的文件了，一个数据库表对应xml设置中的一个table标签，几十个字段一下子生成好对应的文件了，方便快捷。第一次折腾花了点时间，以后使用就省很多时间了。