mybatis学习(2) - MyBatis Generate的使用

上一篇中我们介绍了mybatis的简单用法，这篇文章，我们在那基础之上学习一下她的另外一个实用插件，MyBatis Generate的使用。

MBG是啥？

MyBatis Generate一般我们简称为MBG，数据库逆向工程插件，其实就是将数据库里的表结构读出，然后分析，最后生成实体对象类的过程。其它编程语言其实也类似，之前开发php的时候，我也手撸过类似的插件，同样一般插件也具备差不多的功能，原理主要是通过sql语句中的三种方法获取(此处我们以mysql为例)：

• show create [table]
• desc [table]
• select * from infomation_schema.COLUMNS

详细的可以参考：点击查看。

获取到结构之后，再分析每张表字段的类型，然后通过映射的关系，生成代码字符串，最后格式化代码，生成对应的实体类。

而MBG的出现，大大提升了我们在写单一表映射文件及实体类花费的时间，能提升效率的轮子都是好轮子，接下来我们就开始学习使用她吧。

MBG的安装

老规矩，先上下官网的地址：http://mybatis.org/generator/index.html。之前有人翻译的中文版本，貌似在线的几个网站都打不开，不要紧，官网的描述英文还是很简单的，照着抄总是没问题的。

打开idea工具，新建maven项目添加依赖如下：

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0modelVersion>

    <groupId>io.hxjstudygroupId>
    <artifactId>java-mybatis2-mbg-tinyartifactId>
    <version>1.0-SNAPSHOTversion>

    <properties>
        <maven.compiler.source>14maven.compiler.source>
        <maven.compiler.target>14maven.compiler.target>
    properties>

    <dependencies>
        <dependency>
            <groupId>org.mybatisgroupId>
            <artifactId>mybatisartifactId>
            <version>3.5.11version>
        dependency>
        <dependency>
            <groupId>mysqlgroupId>
            <artifactId>mysql-connector-javaartifactId>
            <version>8.0.30version>
        dependency>
        <dependency>
            <groupId>log4jgroupId>
            <artifactId>log4jartifactId>
            <version>1.2.17version>
        dependency>
        <dependency>
            <groupId>junitgroupId>
            <artifactId>junitartifactId>
            <version>4.13.2version>
            <scope>testscope>
        dependency>
    dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.mybatis.generatorgroupId>
                <artifactId>mybatis-generator-maven-pluginartifactId>
                <version>1.4.1version>
                <configuration>
                    <verbose>trueverbose>
                    <overwrite>trueoverwrite>
                configuration>
            plugin>
        plugins>
    build>
project>

MBG相关配置

在资源文件下添加数据库配置文件，application.properties：

jdbc.driverClass=com.mysql.cj.jdbc.Driver
jdbc.connectionURL=jdbc:mysql://localhost:3388/db_ddyx?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
jdbc.userId=root
jdbc.password=root

之后编写生成配置文件，generatorConfig.xml，内容如下：

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="/Users/hunkxia/.m2/repository/mysql/mysql-connector-java/8.0.30/mysql-connector-java-8.0.30.jar"/>

    
    <context id="MyDbContext" targetRuntime="MyBatis3">
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
        <property name="javaFileEncoding" value="UTF-8"/>


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

        

        
        <jdbcConnection
            driverClass="${jdbc.driverClass}"
            connectionURL="${jdbc.connectionURL}"
            userId="${jdbc.userId}"
            password="${jdbc.password}">
        jdbcConnection>

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

        
        <javaModelGenerator targetPackage="tiny.mybatis2.mbg.model" targetProject="./src/main/java">
            <property name="enableSubPackages" value="true"/>
            <property name="trimStrings" value="true"/>
        javaModelGenerator>

        
        <sqlMapGenerator targetPackage="tiny.mybatis2.mbg.xml" targetProject="./src/main/resources">
            <property name="enableSubPackages" value="true"/>
        sqlMapGenerator>

        
        <javaClientGenerator type="XMLMAPPER" targetPackage="tiny.mybatis2.mbg.xml" targetProject="./src/main/java">
            <property name="enableSubPackages" value="true"/>
        javaClientGenerator>

        
        <table schema="db_ddyx" tableName="g2_user" domainObjectName="UserInfo">
        table>
    context>
generatorConfiguration>

上面只列出了部分配置选项，更详细的配置选项可以查看官方说明：http://mybatis.org/generator/configreference/xmlconfig.html，大部分情况之下常见的配置已满足我们，如果有需要特殊处理的，可以详细查看配置文件。

执行操作

这时候可以在maven任务栏中查看到对应执行任务，如下图:

点击右键，run mybatis-generator:generate执行创建任务：

[INFO] Scanning for projects...
[INFO] 
[INFO] -----------------< io.hxjstudy:java-mybatis2-mbg-tiny >-----------------
[INFO] Building java-mybatis2-mbg-tiny 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO] 
[INFO] --- mybatis-generator-maven-plugin:1.4.1:generate (default-cli) @ java-mybatis2-mbg-tiny ---
[INFO] Connecting to the Database
[INFO] Introspecting table db_ddyx.g2_user
[INFO] Generating Example class for table g2_user
[INFO] Generating Record class for table g2_user
[INFO] Generating Mapper Interface for table g2_user
[INFO] Generating SQL Map for table g2_user
[INFO] Saving file UserInfoMapper.xml
[INFO] Saving file UserInfoExample.java
[INFO] Saving file UserInfo.java
[INFO] Saving file UserInfoMapper.java
[WARNING] Existing file /Users/jackma/Projects/2022/tech-doc/sources/java-mybatis2-mbg-tiny/./src/main/java/tiny/mybatis2/mbg/model/UserInfoExample.java was overwritten
[WARNING] Existing file /Users/jackma/Projects/2022/tech-doc/sources/java-mybatis2-mbg-tiny/./src/main/java/tiny/mybatis2/mbg/model/UserInfo.java was overwritten
[WARNING] Existing file /Users/jackma/Projects/2022/tech-doc/sources/java-mybatis2-mbg-tiny/./src/main/java/tiny/mybatis2/mbg/xml/UserInfoMapper.java was overwritten
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  1.747 s
[INFO] Finished at: 2022-11-04T09:54:57+08:00
[INFO] ------------------------------------------------------------------------

Process finished with exit code 0

然后可以看到生成的实体类及xml文件，结构如下：

至此，我们完成了简单使用MBG生成对应实体类及映射文件。

当然除了此种方法来生成文件外，还能直接通过jar文件的方式单独生成对应文件：

java -jar /Users/jackma/.m2/repository/org/mybatis/generator/mybatis-generator-core/1.4.1/mybatis-generator-core-1.4.1.jar -configfile ./src/main/resources/generatorConfigJar.xml -overwrite

注意先进入项目根目录中，然后才执行此命令，另外jar执行方式出现了如下错误：

<properties> resource application.properties does not exist

应该是路径问题导致的，暂时没有去处理，简单粗暴的把数据库配置文件直接写进generatorConfigJar.xml了。

执行java命名后，与上方生成的文件一样，此处不再赘述。

其它知识点

基于MBG的逆向工程大致的操作就如上所述了，下面再简单的了解下其它相关的一些知识点：

支持哪些方式整合

• 直接命令行
• 使用ant
• 使用maven
• 纯java代码执行
• 使用Eclipse插件

关于运行时(Runtime)

在配置文件的Context可以指定生成的目标Runtime，文档中描述了4种：

类型	描述
MyBatis3DynamicSql	默认的运行方式，针对新的java项目推荐使用
MyBatis3Kotlin	针对Kotlin项目推荐的运行方式
MyBatis3 or MyBatis3Simple	这种是早期使用MyBatis Generator的运行方式，这种模式我们只维护了，但不再进行增强

更详细的可以参考：https://blog.csdn.net/seek_of/article/details/105911997

通过上面的方式，很明显官方是非常推荐使用MyBatis3DynamicSql这种模式来生成对应文件。而对应的Mybatis帮助文档中有此语法的说明：https://mybatis.org/mybatis-dynamic-sql/docs/introduction.html，使用哪种方式，个人觉得纯粹还是基于自己编码习惯。

本文内容结束，相应的源代码地址如下：传送门