Mybatis Generator逆向工程的使用

​​

一、MyBatis Generator简介

    MyBatis Generator（MBG）是MyBatis和iBATIS的代码生成器。它将为所有版本的MyBatis以及版本2.2.0之后的iBATIS版本生成代码。它将审查数据库表（或许多表），并将生成可用于访问表的构件。这减少了设置对象和配置文件以与数据库表交互的初始麻烦。MBG寻求对简单CRUD（创建，检索，更新，删除）的大部分数据库操作产生重大影响。您仍然需要为连接查询或存储过程手动编写SQL和对象代码。MyBatis Generator将生成：

• 与表结构匹配的Java POJO。这可能包括：

• 一个匹配表的主键的类（如果有主键）

• 一个匹配表的非主键字段的类（BLOB字段除外）

• 包含表的BLOB字段的类（如果表具有BLOB字段）

• 用于启用动态选择，更新和删除的类

    这些类之间存在适当的继承关系。请注意，生成器可以配置为生成不同类型的POJO层次结构 - 例如，如果您愿意，可以选择为每个表生成单个域对象。

• MyBatis/iBATIS兼容的SQL Map XML文件。MBG为配置中的每个表上的简单CRUD函数生成SQL。生成的SQL语句包括：

• insert 插入

• update by primary key  按主键更新

• update by example (using a dynamic where clause)  通过条件更新（使用动态where子句）

• delete by primary key  按主键删除

• delete by example (using a dynamic where clause)  按条件删除（使用动态where子句）

• select by primary key  按主键查询

• select by example (using a dynamic where clause)  按条件查询（使用动态where子句）

• count by example  按条件查询记录总数

    根据表结构的不同，这些语句有不同的变体（例如，如果表没有主键，则MBG不会通过主键功能生成更新）。

• 适当使用上述对象的Java客户端类。Java客户端类的生成是可选的。MBG将为MyBatis 3.x生成以下类型的Java客户端：

• 适用于MyBatis 3.x映射器基础结构的映射器接口

MBG将为iBATIS 2.x生成以下类型的Java客户端：

• 符合Spring框架的DAO

• 仅使用iBATIS SQL映射API的DAO。这些DAO可以生成两种：通过构造函数或setter注入提供SqlMapClient。

• 符合iBATIS DAO框架的DAO（iBATIS的可选部分，现在不推荐使用此框架，我们建议您使用Spring框架）

    MyBatis生成器设计为在迭代开发环境中运行良好，并且可以作为Ant任务或Maven插件包含在连续构建环境中。迭代运行MBG时需要注意的重要事项包括：

1. 如果存在与新生成的XML文件同名的现有文件，MBG将自动合并XML文件。MBG不会覆盖您对其生成的XML文件所做的任何自定义更改。您可以反复运行它，而不必担心会丢失对XML的自定义更改。MBG将替换先前运行中生成的任何XML元素。

2. MBG不会合并Java文件，它可以覆盖现有文件或使用不同的唯一名称保存新生成的文件。如果对生成的Java文件进行更改并以迭代方式运行MBG，则必须手动合并更改。当作为Eclipse插件运行时 ，MBG可以自动合并Java文件。

二、MyBatis Generator使用

1、新建MBG的配置文件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="generator.properties"></properties>
    <!--指定特定数据库的jdbc驱动jar包的位置-->
    <!--<classPathEntry location="${jdbc.driverLocation}"/>-->
 
    <context id="default" targetRuntime="MyBatis3">
 
        <!-- optional，旨在创建class时，对注释进行控制，false生成注释,true无注释 -->
        <commentGenerator>
            <property name="suppressDate" value="false"/>
            <property name="suppressAllComments" value="false"/>
        </commentGenerator>
 
        <!--jdbc的数据库连接 -->
        <jdbcConnection
                driverClass="${jdbc.driverClass}"
                connectionURL="${jdbc.connectionURL}"
                userId="${jdbc.userId}"
                password="${jdbc.password}">
        </jdbcConnection>
 
 
        <!--
         默认false，把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer，
         为 true时把JDBC DECIMAL 和 NUMERIC 类型解析为java.math.BigDecimal
        -->
        <!-- 非必需，类型处理器，在数据库类型和java类型之间的转换控制-->
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>
 
 
        <!-- Model模型生成器,用来生成含有主键key的类，记录类 以及查询Example类
            targetPackage     指定生成的model生成所在的包名
            targetProject     指定在该项目下所在的路径|指定生成到的工程名称
        -->
        <javaModelGenerator targetPackage="com.test.model"
                            targetProject=".srcmainjava">
            <!-- 是否允许子包，即targetPackage.schemaName.tableName -->
            <property name="enableSubPackages" value="false"/>
            <!-- 是否对model添加 构造函数 true添加，false不添加-->
            <property name="constructorBased" value="false"/>
            <!-- 是否对类CHAR类型的列的数据进行trim操作 -->
            <property name="trimStrings" value="true"/>
            <!-- 建立的Model对象是否 不可改变  即生成的Model对象不会有 setter方法，只有构造方法 -->
            <property name="immutable" value="false"/>
        </javaModelGenerator>
 
        <!--Mapper映射文件生成所在的目录 为每一个数据库的表生成对应的SqlMapper文件 -->
        <sqlMapGenerator targetPackage="com.test.mapper"
                         targetProject=".srcmainjava">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>
 
        <!-- 客户端代码，生成易于使用的针对Model对象和XML配置文件 的代码
                type="ANNOTATEDMAPPER",生成Java Model 和基于注解的Mapper对象
                type="MIXEDMAPPER",生成基于注解的Java Model 和相应的Mapper对象
                type="XMLMAPPER",生成SQLMapper XML文件和独立的Mapper接口
        -->
        <javaClientGenerator targetPackage="com.test.mapper"
                             targetProject=".srcmainjava" type="XMLMAPPER">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>
 
        <!--需要映射的数据库的表名-->
        <table tableName="t_userinfo" domainObjectName="UserInfo"
               enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false"
               selectByExampleQueryId="false">
        </table>
    </context>
</generatorConfiguration>

2、新建generator.properties文件

jdbc.driverLocation=C:\mysql-connector-java-5.1.43.jar
jdbc.driverClass=com.mysql.jdbc.Driver
jdbc.connectionURL=jdbc:mysql://localhost:3306/mybatis
jdbc.userId=root
jdbc.password=tiger

3、配置执行mybatis generator操作，这里有两种方式

第1种方式：如果使用maven项目就可以省去编写Java启动类，使用maven插件和配置文件pom.xml即可，插件启动maven-generator，在pom.xml中添加maven-generator插件

<plugins>
    <!--myBatis逆向工程插件-->
    <plugin>
        <groupId>org.mybatis.generator</groupId>
        <artifactId>mybatis-generator-maven-plugin</artifactId>
        <version>1.3.2</version>
        <configuration>
            <verbose>true</verbose>
            <overwrite>true</overwrite>
            <configurationFile>${project.basedir}/src/main/resources/generatorConfig.xml</configurationFile>
        </configuration>
        <dependencies>
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>5.1.35</version>
            </dependency>
        </dependencies>
    </plugin>
</plugins>

点击mybatis-generator:generate就能执行mybatis generator了

第2种方式：

1、如果不是maven项目添加该mybatis-generator-core-1.3.2.jar，编写main方法指向mybatis逆向工程，我给依赖粘贴到下面了

<!-- https://mvnrepository.com/artifact/org.mybatis.generator/mybatis-generator-core -->
<dependency>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-core</artifactId>
    <version>1.3.2</version>
</dependency>

2、修改generatorConfig.xml文件，放开注释的该配置

<classPathEntry location="${jdbc.driverLocation}"/>

3、然后编写测试类执行

/**
 * 如果不是maven项目可以这样生成
 */
public class MybatisGeneratorTest {
    public static void main(String[] args) throws InterruptedException, SQLException, IOException, InvalidConfigurationException, XMLParserException {
        List<String> warnings = new ArrayList<String>();
        //生成的java文件是否覆盖
        boolean overwrite = true;
        //指定逆向工程配置文件
        //File configFile = new File("E:\project\mybatis-generator\src\main\resources\generatorConfig.xml");
        InputStream resourceAsStream = MybatisGeneratorTest.class.getClassLoader().getResourceAsStream("generatorConfig.xml");
        ConfigurationParser cp = new ConfigurationParser(warnings);
        Configuration config = cp.parseConfiguration(resourceAsStream);
        DefaultShellCallback callback = new DefaultShellCallback(overwrite);
        MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config,callback, warnings);
        myBatisGenerator.generate(null);
    }
}

介绍完这两种方式，查看数据表：

​

查看生成的实体类：

​

TIP：可以看出如果实体类想要遵循驼峰命名规范，数据库表字段名设计需要用"_"来划分

查看生成的文件信息：

​

TIP1：必须在<plugin></plugin>标签里添加数据库驱动，在其他地方添加无效，如果不添加会报找不到驱动错误，如过不在该插件添加数据库依赖的话可以使用 <classPathEntry location="${jdbc.driverLocation}"/> 来指定数据库驱动位置。

TIP2：如果你在使用mybatis generator插件执行的时候报[ERROR] Failed to execute goal org.mybatis.generator:mybatis-generator-maven-plugin:1.3.2:generate (default-cli) on project mybatis-generator: <properties> resource generator.properties does not exist -> [Help 1]

​

尽管你的 <properties resource="generator.properties"></properties>配置的没有问题，但是还是找不到generator.properties，查看该配置，注释掉

​

该配置会改变generatorConfig.xml中读取generator.properties文件的默认路径

TIP3：Mybatis Generator反向工程默认不会覆盖生成的*.java文件。也可以设置覆盖生成的*.java文件，在反向工程插件mybatis-generator-maven-plugin添加该配置<overwrite>true</overwrite>则会覆盖生成的*.java文件，如图

​

    Mybatis Generator不会覆盖你的mapper.xml文件，MBG会合并追加到mapper.xml和你自定义的存在一起，但是如果你修改MBG第一次默认生成的SQL（MBG生成的CRUD），MBG会重新把自己生成的CRUD恢复默认，说白了，MBG只会覆盖他自己生成的SQL，不会覆盖你自定义的，你自定义的不变。。。如图，他不会动你的自定义SQL，只会覆盖Mybatis反向工程自己生成的SQL，前提MBG自动生成SQL语句的注释要存在。

​

在最常见的用例中，MyBatis Generator（MBG）由XML配置文件驱动。配置文件告诉MBG

• 如何连接到数据库

• 生成什么对象，以及如何生成它们

• 应使用哪些表生成对象

官方MBG配置文件详解地址：http://mybatis.org/generator/configreference/xmlconfig.html

附带一个MBG的中文配置文件详解：https://www.jianshu.com/p/e09d2370b796

 

更多Mybatis逆向工程的使用参考：http://www.mybatis.org/generator/index.html

​

● XStream学习手册

● 别在 Java 代码里乱打日志了，这才是正确的打日志姿势！

● 高可用Redis服务架构分析与搭建

● 8 种方案，帮你解决重复提交问题！请拿走

● IDEA 解决 Maven 依赖冲突的高能神器，这一篇够不够？

​