spring boot mybatis-generator 使用tk.mybatis.mapper通用mapper自动生成代码

前言

这次的项目，使用spring boot 多模块开发。其中，数据库集成了data Jpa 和 Mybatis。最先引入的data jpa，但是后面涉及到多表关联多条件查询的时候，就显得很麻烦。然后就把mybatis也引入了进来。
这里重点记录一下如何使用通用mapper逆向生成代码。提高我们的工作效率。

环境

开发工具：IntelliJ IDEA 2018
项目框架： 基于Spring Boot + mysql + mybatis + data jpa

最后的项目结构

简单说一下：因为后台管理系统cms和接口系统web都共用同一个mapper，所以提出来了。

Spring boot 引入Mybatis

这里如何引入mybtais,我就不记录了，网上教程很多~
application.yml

# mybatis
mybatis:
    mapper-locations: classpath*:com/flk/mapper/**/*.xml # mapper.xml文件所在位置
#    config-location: classpath:config/mybatis_config.xml
    type-aliases-package: com.flk.*         #对应实体类的包名
    configuration:
      map-underscore-to-camel-case: true  #配置驼峰命名转换 在进行sql查询和初始化实体时mybatis会为我们自动转化
#      log-impl: org.apache.ibatis.logging.stdout.StdOutImpl   #mybatis 控制台打印sql

mybatis自动生成dao,entity,mapper

1.传统的生成方式

参考这篇博客：springboot入门（三）-- springboot集成mybatis及mybatis generator工具使用

ps:这种方法生成的dao层，没有继承通用mapper。
用过的小伙伴应该都会发现，当你数据库某张表突然要加一个字段的时候，就会变得特别麻烦。首先你得去修改实体，然后修改mapper，mapper对应的xml里面自带的增删改查等方法都需要修改，很麻烦。如果需要修改的表字段比较多~~啧啧啧。反正我觉得不是很好用。

2.tk.mybatis.mapper方式生成（通用mapper）

2.1 pom.xml中添加引用

需要添加两个引用mapper-spring-boot-starter 和 tk.mybatis

 <dependencies>
 	   <dependency>
	        <groupId>com.flkgroupId>
	        <artifactId>flk-mapperartifactId>
	        <version>0.0.1-SNAPSHOTversion>
   	    dependency>
  dependencies>
  <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.bootgroupId>
                <artifactId>spring-boot-maven-pluginartifactId>
            plugin>
   			
            <plugin>
                <groupId>org.mybatis.generatorgroupId>
                <artifactId>mybatis-generator-maven-pluginartifactId>
                <version>1.3.5version>
                <dependencies>
                    <dependency>
                        <groupId> mysqlgroupId>
                        <artifactId> mysql-connector-javaartifactId>
                        <version>5.1.39version>
                    dependency>
                    <dependency>
                        <groupId>org.mybatis.generatorgroupId>
                        <artifactId>mybatis-generator-coreartifactId>
                        <version>1.3.5version>
                    dependency>
                    <dependency>
                        <groupId>tk.mybatisgroupId>
                        <artifactId>mapperartifactId>
                        <version>3.5.2version>
                    dependency>
                dependencies>
                <executions>
                    <execution>
                        <id>Generate MyBatis Artifactsid>
                        <phase>packagephase>
                        <goals>
                            <goal>generategoal>
                        goals>
                    execution>
                executions>
                <configuration>
                    
                    <verbose>trueverbose>
                    
                    <overwrite>trueoverwrite>
                    
                    <configurationFile>
                        src/main/resources/mybatis-generator.xmlconfigurationFile>
                configuration>
            plugin>
        plugins>
    build>

2.2 编写mybatis-generator.xml

这里，你需要修改配置文件中的数据库连接等配置
targetProject这个修改为你自己项目所在目录的绝对路径！

<generatorConfiguration>
    
    
            

    <context id="Tables" targetRuntime="MyBatis3">
        
        

        <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
            <property name="mappers" value="tk.mybatis.mapper.common.Mapper"/>
            
            <property name="caseSensitive" value="true"/>
        plugin>

        
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://127.0.0.1:3306/flk_qa" userId="root"
                        password="123456">
        jdbcConnection>
        
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false" />
        javaTypeResolver>

        
        <javaModelGenerator targetPackage="com.flk.mybatis.user"
                            targetProject="D:\work\git\flk\flk-entity\src\main\java">
            <property name="enableSubPackages" value="true" />
            <property name="trimStrings" value="true" />
        javaModelGenerator>
        
        <sqlMapGenerator targetPackage="com.flk.mapper.user"
                         targetProject="D:\work\git\flk\flk-mapper\src\main\java">
            <property name="enableSubPackages" value="false" />
        sqlMapGenerator>
        
        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="com.flk.mapper.user"
                             targetProject="D:\work\git\flk\flk-mapper\src\main\java">
            <property name="enableSubPackages" value="false" />
        javaClientGenerator>

        
        <table tableName="flk_user" domainObjectName="FlkUser" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false" />

    context>
generatorConfiguration>

2.3 生成代码

idea:找到项目下面的这个窗口，双击mybatis-generator，即可自动生成代码
eclipse:以application的方式运行就可以了

2.4 查看控制台打印

生成文件ok！
生成文件如下：
FlkNewsMapper.java：

import tk.mybatis.mapper.common.Mapper;
public interface FlkNewsMapper extends Mapper<FlkNews> {
}

FlkNewsMapper.xml

<mapper namespace="com.flk.mapper.news.FlkCoverMapper">
  <resultMap id="BaseResultMap" type="com.flk.mybatis.news.FlkCover">
    
    <id column="cover_id" jdbcType="INTEGER" property="coverId" />
    <result column="name" jdbcType="VARCHAR" property="name" />
    <result column="template" jdbcType="VARCHAR" property="template" />
    <result column="platform" jdbcType="VARCHAR" property="platform" />
    <result column="mark" jdbcType="VARCHAR" property="mark" />
    <result column="create_time" jdbcType="TIMESTAMP" property="createTime" />
    <result column="is_delete" jdbcType="INTEGER" property="isDelete" />
    <result column="update_time" jdbcType="TIMESTAMP" property="updateTime" />
  resultMap>
  <sql id="Base_Column_List">
    
    cover_id, name, template, platform, mark, create_time, is_delete, update_time
  sql>
mapper>

总结

1.使用tk.mybatis.mapper生成的mapper，在扫描的时候，需要用tk的这个实体tk.mybatis.spring.annotation.MapperScan来扫描，不然项目启动的时候，会报mapper找不到的错。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.domain.EntityScan;
import org.springframework.scheduling.annotation.EnableScheduling;
import tk.mybatis.spring.annotation.MapperScan;

@SpringBootApplication
@MapperScan("com.flk.mapper.*")
@EntityScan(basePackages = {"com.flk.jpa"})
@EnableScheduling
public class CmsApplication {

    public static void main(String[] args) {
        SpringApplication.run(CmsApplication.class, args);
    }

}

2.data jpa 和 mybatis共用问题
结果是可以共用，同时jpa的pageable分页和mybatis的pageHelper分页都是可以同时用的。我在配引入mybatis的时候，引入了一个mybatis的配置文件，里面配了一个pageHelper，导致在使用pageHelper分页的时候，报下面这个错。

系统中发现了多个分页插件？？？？？？？？
最开始我和同事都一直认为是因为我们同时集成了jpa和mybatis的原因，不能同时使用pageable和pageHelper两个分页插件。
后面得出的结果是可以同时使用这两个分页插件的。
这个错误是因为：
pom中引入pageHelper，如果你引入的依赖是spring boot 自己的starter – pagehelper-spring-boot-starter。
yml文件中不需要任何配置。直接使用就可以了。

 <dependency>
     <groupId>com.github.pagehelpergroupId>
     <artifactId>pagehelper-spring-boot-starterartifactId>
     <version>1.2.9version>
 dependency>

而我，引入的spring boot 自己的starter – pagehelper-spring-boot-starter。还在yml中自己有配置了一个pageHelper。当使用pageHelper进行分页的时候，就报了分页插件冲突这个错。我猜大概是存在两个分页拦截器，当你分页的时候，程序不知道去使用哪一个进行拦截并分页。去掉yml关于pageHelper的相关配置就好了。

所以，当你使用spring boot集成某个组件的时候，百度搜索，最好是带上spring boot这个关键字。不然就会出现这种奇奇怪怪的问题。改起来还很花时间。

相关博客

springboot集成pagehelper-spring-boot-starter