《Mybatis入门到精通》——6.代码生成器

Day_07

Mybatis代码生成器；

通过配置，根据数据库表结构自动生成表实体类DAO、接口IDAO、对应的mapper.xml、Example；（会用即可，主要是3步：配置pom.xml；配置generator.xml；运行生成代码；）

(1) 新建Maven工程，在resource下新建一个generator的配置文件；

包括：

1. 本地JDBC驱动位置；
2. 生成的方式（Mybatis3 Mybatis3Simple）；
3. JDBC数据库的配置；
4. 生成的实体类DAO、接口IDAO、对应的mapper.xml的位置；
5. 选择数据库的哪些表；（可以选择所有表）

如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" >
<!-- @author Akira -->
<generatorConfiguration>
    <!--数据库配置文件-->
    <properties resource="jdbcConfig.properties"/>

    <!-- 本地数据库驱动程序jar包的全路径 -->
    <classPathEntry
            location="C:\Users\\A\\.m2\repository\\mysql\\mysql-connector-java\\5.1.6\\mysql-connector-java-5.1.6.jar"/>
    <!--targetRuntime= MyBatis3Simple 不生成Example相关的代码和方法, MyBatis3则生成Example-->
    <context id="context" targetRuntime="MyBatis3Simple">
        <commentGenerator>
            <property name="suppressAllComments" value="false"/>
            <property name="suppressDate" value="true"/>
        </commentGenerator>

        <!-- 数据库的相关配置 -->
        <jdbcConnection driverClass="${jdbc.driver}"
                        connectionURL="${jdbc.url}"
                        userId="${jdbc.username}"
                        password="${jdbc.password}">
        </jdbcConnection>

        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- 实体类生成的位置 -->
        <javaModelGenerator
                targetPackage="com.ming.mybatis.domain"
                targetProject=".\src\main\java">
            <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false -->
            <property name="enableSubPackages" value="false"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <!-- *Mapper.xml 文件的位置  sqlMapGenerator targetPackage根目录位置自动在resource下-->
        <sqlMapGenerator
                targetPackage="mybatis/mapper"
                targetProject=".\src\main\resources">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>

        <!-- Mapper 接口文件的位置 -->
        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="com.ming.mybatis.dao"
                             targetProject=".\src\main\java">
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>

        <!-- 相关表的配置 -->
        <!--<table tableName="blog"/>-->
        <!-- 使用通配符"%"匹配数据库中所有的表，其中所有表都有主键自增的 id 字段， sqlStatement 针对当前数据库配置 MySQL 。-->
        <table tableName="%">
            <generatedKey column="id" sqlStatement="Mysql" identity="true"/>
        </table>
    </context>
</generatorConfiguration>

(2) 配置pom.xml

包括：

之前导入的依赖jar包；

新增的<build>标签内的配置；

<!--在原基础上添加 这些就好了-->
<build>
    <finalName>mybatis-generator</finalName>
    <plugins>
        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.7</version>
            <configuration>
                <!--此处需要注意， 文件与上面的文件匹配-->
                <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
                <verbose>true</verbose>
                <overwrite>true</overwrite>
            </configuration>
            <executions>
                <execution>
                    <id>Generate MyBatis Artifacts</id>
                    <goals>
                        <goal>generate</goal>
                    </goals>
                </execution>
            </executions>
            <dependencies>
                <dependency>
                    <groupId>org.mybatis.generator</groupId>
                    <artifactId>mybatis-generator-core</artifactId>
                    <version>1.3.7</version>
                </dependency>
            </dependencies>
        </plugin>
    </plugins>
</build>
<!--到此结束-->

(3) 测试

打开 Maven Projects 视图

View | Tools | Windwos | Maven Projects

(4) 运行

Maven Projects 中双击 mybatis-generator

关于XML的配置

XML 配置详解

仅仅是上面那么简单的使用还不够爽。 那么我们就可以通过更改 generator.xml 配置文件的方式进行生成的配置。

推荐查阅：Mybatis-Generator之最完美配置详解 

【项目管理】Mybatis-Generator之最完美配置详解_张思全的博客-CSDN博客

1. 优先推荐查看官方的文档。

2. 官网没有的内容

2.1 property标签

该标签在官网中只是说用来指定元素的属性， 至于怎么用没有详细的讲解。

*2.1.1 分隔符相关

<property name="autoDelimitKeywords" value="true"/>
<property name="beginningDelimiter" value="`"/>
<property name="endingDelimiter" value="`"/>

以上的配置对应的是 mysql， 当数据库中的字段和数据库的关键字一样时， 就会使用分隔符。
比如我们的数据列是 delete, 按以上的配置后， 在它出现的地方， 就变成 delete。

2.1.2 编码

默认是使用当前的系统环境的编码， 可以配置为 GBK 或 UTF-8。

<property name="javaFileEncoding" value="UTF-8"/>

我想项目为 UTF-8， 如果指定生成 GBK， 则自动生成的中文就是乱码。

2.1.3 格式化

<!--格式化生成的 Java 代码-->
<property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
<!--格式化生成的 XML-->
<property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>

这些显然都是可以自定义实现的的。

2.2 plugins 标签

plugins 标签用来扩展或修改代码生成器生成的代码。
在生成的 XML 中， 是没有 <cache> 这个标签的。 该标签是配置缓存的。
如果我们想生成这个标签， 那么可以 plugins 中进行配置。

<plugin type="org.mybatis.generator.plugins.CachePlugin" >
            <property name="cache_eviction" value="LRU"/>
</plugin>

比如你想生成的 JavaBean 中自行实现 Serializable 接口。

<plugin type="org.mybatis.generator.plugins.SerializablePlugin" />

序列化接口实现

这些插件都蛮有用的， 感觉后续可以专门开一篇文章来讲解。

2.3 commentGenerator 标签

看名称， 就知道是用来生成注释用的。

默认配置：

<commentGenerator >
        <property name="suppressAllComments" value="false"/>
        <property name="suppressDate" value="false"/>
        <property name="addRemarkComments" value="false"/>
</commentGenerator>

suppressAllComments： 阻止生成注释， 默认值是false。
suppressDate: 阻止生成的注释包含时间戳， 默认为false。
addRemarkComments: 注释中添加数据库的注释， 默认为 false。

还有一个就是我们可以通过 type 属性指定我们自定义的注解实现类， 生成我们自己想要的注解。 自定义的实现类需要实现 org.mybatis.generator.api.CommentGenerator。

附上一个自己常用的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">
<!-- @author Akira -->
<generatorConfiguration>
    <!--替换成本地仓库的mysql驱动jar包-->
    <classPathEntry location="D:\.m2\repository\mysql\mysql-connector-java\5.1.47\mysql-connector-java-5.1.47.jar"/>
    <context id="DB2Tables" targetRuntime="MyBatis3">

        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
        <!--抑制生成代码注释-->
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <!--JDBC数据库连接-->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://mysql.XX.local:3306/smember?useUnicode=true&amp;characterEncoding=UTF-8"
                        userId="root"
                        password="root">
        </jdbcConnection>

        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!--
        targetPackage     指定生成的model生成所在的包名
        targetProject     指定在该项目下所在的路径
        -->
        <!-- entity生成的位置 -->
        <javaModelGenerator targetPackage="com.vivo.internet.supermembermng.dao.entity"
                            targetProject="src/main/java">
            <property name="enableSubPackages" value="false"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        <!-- *Mapper.xml 文件的位置  sqlMapGenerator targetPackage根目录位置自动在resource下-->
        <sqlMapGenerator targetPackage="META-INF/mybatis/mapper/normal" targetProject="src/main/resources">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>
        <!-- Mapper 接口文件的位置 -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.vivo.internet.supermembermng.dao.normal"
                             targetProject="src/main/java">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>

        <!--指定表、实体类名、DAO接口名-->
        <table tableName="award_template"
               domainObjectName="AwardTemplateDO" mapperName="AwardTemplateDAO" enableSelectByExample="false"
               enableDeleteByExample="false" enableCountByExample="false" enableUpdateByExample="false"
               delimitAllColumns="true">
        </table>

    </context>
</generatorConfiguration>

本章参考：mybatis 代码生成器（IDEA, Maven)及配置详解（部分配置你应该不知道） - 阿进的写字台 - 博客园