Maven项目使用mybatis generator + tk.mybatis + Lombok自动化生成Mybatis相关代码（二）

一、pom.xml配置

1、新增lombok + tk.myBatis的依赖包

 <dependency>
            <groupId>org.mybatis.generatorgroupId>
            <artifactId>mybatis-generator-coreartifactId>
            <version>${generator.version}version>
        dependency>

        <dependency>
            <groupId>mysqlgroupId>
            <artifactId>mysql-connector-javaartifactId>
            <version>${mysql.version}version>
        dependency>

        <dependency>
            <groupId>org.projectlombokgroupId>
            <artifactId>lombokartifactId>
            <optional>trueoptional>
        dependency>

        <dependency>
            <groupId>tk.mybatisgroupId>
            <artifactId>mapper-spring-boot-starterartifactId>
            <version>2.0.4version>
        dependency>

2、下载并安装lombok自动化生成代码的插件

• mybatis-generator-lombok-plugin插件源码地址
• 安装步骤：使用Idea打开该工程，找到maven projects；找到Lifecycle，然后先clean再install；最后这个插件就会打包并安装到本地的maven仓库中。
  

3、pom.xml中配置plugins插件内容

<build>
        <plugins>
            <plugin>
                <groupId>org.springframework.bootgroupId>
                <artifactId>spring-boot-maven-pluginartifactId>
            plugin>
            <plugin>
                <groupId>org.mybatis.generatorgroupId>
                <artifactId>mybatis-generator-maven-pluginartifactId>
                <version>${generator.version}version>
                <configuration>
                    
                    <configurationFile>src/main/resources/generatorConfig.xmlconfigurationFile>
                    <verbose>trueverbose>
                    <overwrite>trueoverwrite>
                configuration>
                <dependencies>
                    <dependency>
                        <groupId>mysqlgroupId>
                        <artifactId>mysql-connector-javaartifactId>
                        <version>${mysql.version}version>
                    dependency>

                    <dependency>
                        <groupId>tk.mybatisgroupId>
                        <artifactId>mapperartifactId>
                        <version>${tk.mybatis.version}version>
                    dependency>

                    <dependency>
                        <groupId>com.chrmgroupId>
                        <artifactId>mybatis-generator-lombok-pluginartifactId>
                        <version>1.0-SNAPSHOTversion>
                    dependency>

                    <dependency>
                        <groupId>org.mybatis.generatorgroupId>
                        <artifactId>mybatis-generator-coreartifactId>
                        <version>${generator.version}version>
                    dependency>

                dependencies>
            plugin>
        plugins>
    build>

• 注意：引入了tk.mybatis的插件就不能引入mybatis的插件，否则会报错。

<dependency>
        <groupId>com.chrmgroupId>
        <artifactId>mybatis-generator-lombok-pluginartifactId>
        <version>1.0-SNAPSHOTversion>
  dependency>

• mybatis-generator-lombok-plugin插件就是我们第二步打包并安装到maven仓库中的jar包。

二、generatorConfig.xml配置

1、在context标签中新增下列配置

        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
        
        <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
            
            <property name="mappers" value="tk.mybatis.mapper.common.Mapper"/>
        plugin>
        
        <plugin type="com.chrm.mybatis.generator.plugins.LombokPlugin" >
            <property name="hasLombok" value="true"/>
        plugin>

• 上面新增的两个插件分别负责整合tk.mybatis和lombok，必须要配置这两项，否则无法生成预期效果的代码。

2、generatorConfig.xml完整的配置

<generatorConfiguration>
    <properties resource="application.properties"/>

    <context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">

        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
        
        <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
            
            <property name="mappers" value="tk.mybatis.mapper.common.Mapper"/>
        plugin>
        
        <plugin type="com.chrm.mybatis.generator.plugins.LombokPlugin" >
            <property name="hasLombok" value="true"/>
        plugin>

        <commentGenerator>
            <property name="suppressAllComments" value="true" />
            <property name="suppressDate" value="true"/>
            <property name="javaFileEncoding" value="UTF-8"/>
        commentGenerator>

        <jdbcConnection driverClass="${spring.datasource.driver-class-name}"
                        connectionURL="${spring.datasource.url}"
                        userId="${spring.datasource.username}"
                        password="${spring.datasource.password}">
        jdbcConnection>
        
        <javaModelGenerator targetPackage="com.chuan.demo.dao.entity" targetProject="src/main/java"/>
        
        <sqlMapGenerator targetPackage="mappers" targetProject="src/main/resources"/>
        
        <javaClientGenerator targetPackage="com.chuan.demo.dao.mapper" targetProject="src/main/java"
                             type="XMLMAPPER"/>
        

        <table tableName="order_detail" domainObjectName="OrderDetail">
            
            <generatedKey column="detail_id" sqlStatement="Mysql" identity="true"/>
            
            
        table>

        <table tableName="order_master" domainObjectName="OrderMaster">
            
            <generatedKey column="order_id" sqlStatement="Mysql" identity="true"/>
            
            
        table>

        <table tableName="product_category" domainObjectName="ProductCategory">
            
            <generatedKey column="category_id" sqlStatement="Mysql" identity="true"/>
            
            
        table>

        <table tableName="product_info" domainObjectName="ProductInfo">
            
            <generatedKey column="product_id" sqlStatement="Mysql" identity="true"/>
            
            
        table>

        <table tableName="seller_info" domainObjectName="SellerInfo">
            
            <generatedKey column="id" sqlStatement="Mysql" identity="true"/>
            
            
        table>


    context>
generatorConfiguration>

三、最后运行MBG插件

1、数据库实体类

@Table(name = "order_detail")
@Data
public class OrderDetail {
    @Id
    @Column(name = "detail_id")
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private String detailId;

    @Column(name = "order_id")
    private String orderId;

    @Column(name = "product_id")
    private String productId;

    /**
     * 商品名称
     */
    @Column(name = "product_name")
    private String productName;

    /**
     * 当前价格,单位分
     */
    @Column(name = "product_price")
    private BigDecimal productPrice;

    /**
     * 数量
     */
    @Column(name = "product_quantity")
    private Integer productQuantity;

    /**
     * 小图
     */
    @Column(name = "product_icon")
    private String productIcon;

    /**
     * 创建时间
     */
    @Column(name = "create_time")
    private Date createTime;

    /**
     * 修改时间
     */
    @Column(name = "update_time")
    private Date updateTime;
}

• 相对于上一个章节，实体类已经没有了Getter和Setter方法了，并且新增了一些数据库相关的标签进行数据库字段关系的映射。

2、mapper接口方法

package com.chuan.demo.dao.mapper;

import com.chuan.demo.dao.entity.OrderDetail;
import tk.mybatis.mapper.common.Mapper;

public interface OrderDetailMapper extends Mapper<OrderDetail> {
}

• 相对于上一节的mapper接口，现在的这个mapper接口继承了tk.mybatis.mapper.common.Mapper，没有了上一章节中的四个增删查改方法了；这个接口是tk.mybatis提供的一个数据库操作的接口，包含了很多的数据库操作方法，具体的使用方式我们以后再讨论。

3、XXXMapper.xml文件

<mapper namespace="com.chuan.demo.dao.mapper.OrderDetailMapper">
  <resultMap id="BaseResultMap" type="com.chuan.demo.dao.entity.OrderDetail">
    
    <id column="detail_id" jdbcType="VARCHAR" property="detailId" />
    <result column="order_id" jdbcType="VARCHAR" property="orderId" />
    <result column="product_id" jdbcType="VARCHAR" property="productId" />
    <result column="product_name" jdbcType="VARCHAR" property="productName" />
    <result column="product_price" jdbcType="DECIMAL" property="productPrice" />
    <result column="product_quantity" jdbcType="INTEGER" property="productQuantity" />
    <result column="product_icon" jdbcType="VARCHAR" property="productIcon" />
    <result column="create_time" jdbcType="TIMESTAMP" property="createTime" />
    <result column="update_time" jdbcType="TIMESTAMP" property="updateTime" />
  resultMap>
mapper>

• 这个相对于上一章来说也更加简洁，因为tk.mybatis.mapper.common.Mapper中默认实现了一些基本的数据库操作方法，所以xml文件中也就不会有基本增删查改的语句了；但是我们可以在xml文件中使用复杂的SQL查询语句，总之mybatis的常规使用功能均存在。

4、总结

相对于 mybatis generator + mybatis自动化生成的代码结构来说，本章的mybatis generator + tk.mybatis + Lombok更适合项目开发中的生产环境，可以大大节省开发时间，开发人员只需要关注业务的开发以及数据库表的设计就行了。

注意：当我们在springboot项目中使用tk.mybatis时，我们需要在springboot配置文件application.yml或者application.properties中配置XXXMapper.xml文件的位置，否则xml文件将无法使用。

mybatis:
  mapper-locations: classpath:mappers/*.xml