SpringBoot第八篇：整合MyBatis-Generator

Love The Way You Lie 2021-09-19 16:52 304阅读 0赞

## MyBatis Generator简介 ##

MyBatis Generator 是 MyBatis 代码生成器。

MyBatis 是一个ORM 的半自动框架，需要手动维护大量的 mapper.xml 文件和 POJO 类。 MyBatis Generator 为了完善 MyBatis 的这个缺点而出现。自动生成 Java POJOs、map.xml、代理接口、以及常规的 CRUD 方法。

## 使用 ##

本项目是通过 maven 构建的 SpringBoot 项目。

首先，在pom.xml 文件中引入相关的插件：

<build>
        <plugins>
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.2</version>
                <executions>
                    <execution>
                        <id>Generate MyBatis Artifacts</id>
                        <phase>deploy</phase>
                        <goals>
                            <goal>generate</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    
                    <configurationFile>src/main/resources/mybatis-generator/generatorConfig.xml</configurationFile>
                    <verbose>true</verbose>
                    <overwrite>true</overwrite>
                </configuration>
                <dependencies>
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>5.1.34</version>
                    </dependency>
                    <dependency>
                        <groupId>org.mybatis.generator</groupId>
                        <artifactId>mybatis-generator-core</artifactId>
                        <version>1.3.2</version>
                    </dependency>
                </dependencies>
            </plugin>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <classifier>exec</classifier>
                </configuration>
            </plugin>
        </plugins>
    </build>

这个引入的插件基本上都能看懂。不过需要特别注意的一点是，mybatis generator 插件单独依赖 MySQL 驱动，所以在插件中必须单独引入 MySQL 驱动包。否则会报错。

其次，根据 pom.xml 文件中指定的 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>
        
        
        <properties resource="mybatis-generator/mybatisGeneratorinit.properties"/>
        
        
    
        
        
        <context id="MysqlTables" targetRuntime="MyBatis3Simple" defaultModelType="flat">
            
            <property name="autoDelimitKeywords" value="true" />
            
            <property name="javaFileEncoding" value="utf-8" />
            
            <property name="beginningDelimiter" value="`" />
            <property name="endingDelimiter" value="`" />
    
            
            <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
            
            <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
            <plugin type="org.mybatis.generator.plugins.SerializablePlugin" />
            <plugin type="org.mybatis.generator.plugins.ToStringPlugin" />
    
            
            <commentGenerator >
                <property name="suppressAllComments" value="false"/>
                <property name="suppressDate" value="true" /> 
            </commentGenerator>
    
            
            <jdbcConnection driverClass="${jdbc_driver}" connectionURL="${jdbc_url}" userId="${jdbc_user}" password="${jdbc_password}" />
            
            <javaTypeResolver>
                
                <property name="forceBigDecimals" value="false"/>
            </javaTypeResolver>
    
            
            <javaModelGenerator targetPackage="com.yanfei1819.mybatisgeneratordemo.db.dto" targetProject="${project}" >
                <property name="enableSubPackages" value="false"/>
                <property name="trimStrings" value="true"/>
            </javaModelGenerator>
            
            <sqlMapGenerator targetPackage="mappers" targetProject="${resources}" >
                <property name="enableSubPackages" value="false" />
            </sqlMapGenerator>
            
            <javaClientGenerator targetPackage="com.yanfei1819.mybatisgeneratordemo.db.dao" targetProject="${project}" type="XMLMAPPER" >
                <property name="enableSubPackages" value="false" />
            </javaClientGenerator>
            
            <table tableName="user" enableCountByExample="true" enableUpdateByExample="true" enableDeleteByExample="true" enableSelectByExample="true" selectByExampleQueryId="true">
                <property name="useActualColumnNames" value="false" />
                
                <generatedKey column="id" sqlStatement="Mysql" identity="true" />
            </table>
        </context>
    </generatorConfiguration>

该配置是 mybatis generator 的主要配置，代码生成的相关信息基本都在此配置文件中。配置文件中也有数据库的信息，此处将数据库信息提出来了，在同级文加下创建 mybatisGeneratorinit.properties 文件：

#dao类和实体类的位置
    project =src/main/java
    #mapper文件的位置
    resources=src/main/resources
    #根据数据库中的表生成对应的pojo类、dao、mapper
    jdbc_driver =com.mysql.jdbc.Driver
    jdbc_url=jdbc:mysql://192.168.1.88:3306/test
    jdbc_user=xxx
    jdbc_password=xxx

最后，在pom.xml文件所在的目录执行如下命令：

`mvn mybatis-generator:generate` 。

如果是在 IDEA 下的项目，代码生成更加方便：

![1183871-20190520151517336-2098416252.png][]

这跟 maven 的用法有关，感兴趣的可以深入了解。

我们看看生成的代码位置：

![1183871-20190520151528906-1359939745.png][]

文件中都有对应的方法：

UserMapper.java :

package com.yanfei1819.mybatisgeneratordemo.db.dao;
    import com.yanfei1819.mybatisgeneratordemo.db.dto.User;
    import java.util.List;
    
    public interface UserMapper {
        int deleteByPrimaryKey(Integer id);
        int insert(User record);
        User selectByPrimaryKey(Integer id);
        List<User> selectAll();
        int updateByPrimaryKey(User record);
    }

User.java :

package com.yanfei1819.mybatisgeneratordemo.db.dto;
    import java.io.Serializable;
    public class User implements Serializable {
        /**
         * This field was generated by MyBatis Generator.
         * This field corresponds to the database column user.id
         *
         * @mbggenerated
         */
        private Integer id;
        /**
         * This field was generated by MyBatis Generator.
         * This field corresponds to the database column user.age
         *
         * @mbggenerated
         */
        private Integer age;
        /**
         * This field was generated by MyBatis Generator.
         * This field corresponds to the database column user.name
         *
         * @mbggenerated
         */
        private String name;
        /**
         * This field was generated by MyBatis Generator.
         * This field corresponds to the database table user
         *
         * @mbggenerated
         */
        private static final long serialVersionUID = 1L;
        // set/get 省略
    }

UserMapper.xml :

<?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
    <mapper namespace="com.yanfei1819.mybatisgeneratordemo.db.dao.UserMapper" >
      <resultMap id="BaseResultMap" type="com.yanfei1819.mybatisgeneratordemo.db.dto.User" >
        
        <id column="id" property="id" jdbcType="INTEGER" />
        <result column="age" property="age" jdbcType="INTEGER" />
        <result column="name" property="name" jdbcType="VARCHAR" />
      </resultMap>
      <delete id="deleteByPrimaryKey" parameterType="java.lang.Integer" >
        
        delete from user
        where id = #{id,jdbcType=INTEGER}
      </delete>
      <insert id="insert" parameterType="com.yanfei1819.mybatisgeneratordemo.db.dto.User" >
        
        <selectKey resultType="java.lang.Integer" keyProperty="id" order="AFTER" >
          SELECT LAST_INSERT_ID()
        </selectKey>
        insert into user (age, `name`)
        values (#{age,jdbcType=INTEGER}, #{name,jdbcType=VARCHAR})
      </insert>
      <update id="updateByPrimaryKey" parameterType="com.yanfei1819.mybatisgeneratordemo.db.dto.User" >
        
        update user
        set age = #{age,jdbcType=INTEGER},
          `name` = #{name,jdbcType=VARCHAR}
        where id = #{id,jdbcType=INTEGER}
      </update>
      <select id="selectByPrimaryKey" resultMap="BaseResultMap" parameterType="java.lang.Integer" >
        
        select id, age, `name`
        from user
        where id = #{id,jdbcType=INTEGER}
      </select>
      <select id="selectAll" resultMap="BaseResultMap" >
        
        select id, age, `name`
        from user
      </select>
    </mapper>

## 总结 ##

该插件与 MyBatis Plus 生成器功能相近。不同的是，MyBatis Plus 代码生成器是用纯粹的代码生成，该插件含有大量的配置。各自有利有弊，喜好看个人。

如果你对编程感兴趣或者想往编程方向发展，可以关注微信公众号【筑梦编程】，大家一起交流讨论！小编也会每天定时更新既有趣又有用的编程知识！

[1183871-20190520151517336-2098416252.png]: /images/20210812/f3d95756c3294f868f134bd4d4274052.png
[1183871-20190520151528906-1359939745.png]: /images/20210812/aabce0117aad446798f2f58aad9f3748.png