使用mybatis-generator插件结合tk.mybatis自动生成mapper二三事

曾经终败给现在 2021-12-24 07:11 438阅读 0赞

本篇文章将介绍使用spring boot框架，引入mybatis-generator插件，结合tk.mybatis自动生成Mapper和Entity的一整套流程，其中包括最重要的踩坑与填坑。

#  **一、基建**  #

*  # 演示用数据库 #

![1156797-20190621121953229-452807276.png][]

*  # 初始spring boot项目 #

[使用IDEA创建一个springboot项目][IDEA_springboot]

![1156797-20190621155535255-522512344.png][]

# **二、主角登场** #

1.在pom.xml中引入mybatis-generator插件。注意，这里我使用的是**tk.mybatis.所以需要引入相应的依赖。并添加mapper接口**

1 <dependency>
 2 <groupId>tk.mybatis</groupId>
 3 <artifactId>mapper-spring-boot-starter</artifactId>
 4 <version>2.0.2</version>
 5 </dependency>

1 package com.tk;
 2 
 3 import tk.mybatis.mapper.common.Mapper;
 4 import tk.mybatis.mapper.common.MySqlMapper;
 5 
 6 public interface MyMapper<T> extends Mapper<T>, MySqlMapper<T> {
 7 }

configurationFile节点配置了生成mapper、entity所需的配置文件，所以我们需要在相应的位置添加gengeatorConfig.xml配置文件。

1 
 2 <plugin>
 3 <groupId>org.mybatis.generator</groupId>
 4 <artifactId>mybatis-generator-maven-plugin</artifactId>
 5 <version>1.3.5</version>
 6 <configuration>
 7 <configurationFile>${basedir}/src/main/resources/generatorConfig.xml</configurationFile>
 8 <overwrite>true</overwrite>
 9 <verbose>true</verbose>
 10 </configuration>
 11 <dependencies>
 12 <dependency>
 13 <groupId>mysql</groupId>
 14 <artifactId>mysql-connector-java</artifactId>
 15 <version>${mysql.version}</version>
 16 </dependency>
 17 <dependency>
 18 <groupId>tk.mybatis</groupId>
 19 <artifactId>mapper</artifactId>
 20 <version>3.4.4</version>
 21 </dependency>
 22 </dependencies>
 23 </plugin>

2.添加generatorConfig.xml文件。文件位置要与pom.xml中配置的路径一致。关于该配置文件各个配置节点的含义和用途，文章末尾有详细解释。

配置文件一开始引入了**jdbc.properties**数据库连接配置文件，所以需要在resources文件夹下添加该配置文件。

1 <?xml version="1.0" encoding="UTF-8"?>
 2 <!DOCTYPE generatorConfiguration
 3 PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
 4 "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
 5 
 6 <generatorConfiguration>
 7 
 8 <properties resource="jdbc.properties"/>
 9 
 10 <context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">
 11 <property name="beginningDelimiter" value="`"/>
 12 <property name="endingDelimiter" value="`"/>
 13 
 14 
 15 <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
 16 <property name="mappers" value="com.tk.MyMapper"/>
 17 </plugin>
 18 
 19 
 20 <jdbcConnection
 21 driverClass="${jdbc.driverClass}"
 22 connectionURL="${jdbc.connectionURL}"
 23 userId="${jdbc.username}"
 24 password="${jdbc.password}">
 25 </jdbcConnection>
 26 
 27 
 28 <javaModelGenerator targetPackage="com.senda.hello.spring.boot.entity" targetProject="src/main/java"/>
 29 
 30 
 31 <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources"/>
 32 
 33 
 34 <javaClientGenerator
 35 targetPackage="com.senda.hello.spring.boot.mapper"
 36 targetProject="src/main/java"
 37 type="XMLMAPPER"/>
 38 
 39 
 40 <table catalog="dbtest" tableName="%">
 41 
 42 <generatedKey column="id" sqlStatement="Mysql" identity="true"/>
 43 </table>
 44 </context>
 45 </generatorConfiguration>

3.添加jdbc.properties数据库连接配置文件。***需要注意的是mysql8.0之后，driverClass的包名有变化。***

1 jdbc.driverClass=com.mysql.jdbc.Driver
    2 #8.0之后：jdbc.driverClass=com.mysql.cj.jdbc.Driver
    3 jdbc.connectionURL=jdbc:mysql://127.0.0.1:3306/dbtest?useUnicode=true&characterEncoding=utf-8&useSSL=false
    4 jdbc.username=root
    5 jdbc.password=root

4.经过上述步骤后，工程结构如下图所示。

![1156797-20190622121540984-88575773.png][]

5.万事俱备，自动构建，启动。双击mybatis-generator插件下的mybatis-generator:generate指令，开始自动构建。构建完成后，项目中就多了entity、dao、mapper，美滋滋啊！

![1156797-20190622121415562-1405294332.png][] ![1156797-20190622121904927-426384630.png][] ![1156797-20190622122012793-1167531568.png][]

6.现在简单查一查数据库，看这玩意儿好不好使。这里我使用的是阿里巴巴的的druid，所以需要引入相关依赖。

1 <dependency>
 2 <groupId>com.alibaba</groupId>
 3 <artifactId>druid-spring-boot-starter</artifactId>
 4 <version>1.1.10</version>
 5 </dependency>
 6 <dependency>
 7 <groupId>mysql</groupId>
 8 <artifactId>mysql-connector-java</artifactId>
 9 </dependency>

并在application.yml配置文件中添加相关的配置，包括druid和mybatis。

1 spring:
     2   datasource:
     3     druid:
     4       url: jdbc:mysql://127.0.0.1:3306/dbtest?useUnicode=true&characterEncoding=utf-8&useSSL=false
     5       username: root
     6       password: root
     7       initial-size: 1
     8       min-idle: 1
     9       max-active: 20
    10       test-on-borrow: true
    11       driver-class-name: com.mysql.jdbc.Driver
    12       #MySQL 8.x: driver-class-name: com.mysql.cj.jdbc.Driver
    13 
    14 mybatis:
    15   type-aliases-package: com.senda.hello.spring.boot.mybatis.entity
    16   mapper-locations: classpath:mapper/*.xml

还需要在启动类加上MapperScan注解，指明Dao的位置。注意这里引入的是**tk包下的MapperScan。**

1 package com.senda.hello.spring.boot.mybatis;
     2 
     3 import org.springframework.boot.SpringApplication;
     4 import org.springframework.boot.autoconfigure.SpringBootApplication;
     5 import tk.mybatis.spring.annotation.MapperScan;
     6 
     7 @SpringBootApplication
     8 @MapperScan(basePackages = "com.senda.hello.spring.boot.mapper")
     9 public class HelloSpringBootMybatisApplication {
    10 
    11     public static void main(String[] args) {
    12         SpringApplication.run(HelloSpringBootMybatisApplication.class, args);
    13     }
    14 
    15 }

写个测试方法，玩一玩吧！注意要在**SpringBootTest注解里注明测试类**，为了加载配置文件。

1 package com.senda.hello.spring.boot.mybatis;
 2 
 3 import com.senda.hello.spring.boot.mapper.TbUserMapper;
 4 import com.senda.hello.spring.boot.entity.TbUser;
 5 import org.junit.Test;
 6 import org.junit.runner.RunWith;
 7 import org.springframework.beans.factory.annotation.Autowired;
 8 import org.springframework.boot.test.context.SpringBootTest;
 9 import org.springframework.test.context.junit4.SpringRunner;
 10 
 11 import java.util.List;
 12 
 13 @RunWith(SpringRunner.class)
 14 @SpringBootTest(classes = HelloSpringBootMybatisApplication.class)
 15 public class HelloSpringBootMybatisApplicationTests {
 16 
 17 @Autowired
 18 private TbUserMapper userMapper;
 19 
 20 @Test
 21 public void testSelect() {
 22 List<TbUser> userList = userMapper.selectAll();
 23 for (TbUser user : userList)
 24 System.out.println(user.getLoginname());
 25 }
 26 
 27 }

运行测试类，Oops！报错了！！！发现SQL语句错了，数据库和表名字中间多了一个点。肿么肥四。搞了这么大半天，你跟我说用不了吗？

org.springframework.jdbc.BadSqlGrammarException: 
    ### Error querying database.  Cause: com.mysql.jdbc.exceptions.jdbc4.MySQLSyntaxErrorException: You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near '.tb_user' at line 1
    ### The error may exist in com/senda/hello/spring/boot/mapper/TbUserMapper.java (best guess)
    ### The error may involve defaultParameterMap
    ### The error occurred while setting parameters
    ### SQL: SELECT uid,loginname,loginpass,email,status,activationCode  FROM dbtest..tb_user
    ### Cause: com.mysql.jdbc.exceptions.jdbc4.MySQLSyntaxErrorException: You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near '.tb_user' at line 1
    ; bad SQL grammar []; nested exception is com.mysql.jdbc.exceptions.jdbc4.MySQLSyntaxErrorException: You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near '.tb_user' at line 1

遇到问题，要解决啊！！！打开生成的TbUser实体类，我们惊讶的发现，table的名字竟然多了一个点。赶紧删除，再运行测试方法。bingo，完美运行，问题解决了。

![1156797-20190622124733537-925419795.png][] ![1156797-20190622125011307-1986329856.png][]

#  三、分析问题 #

问题真的解决了么？真正的项目，动辄几十、几百张表的，难道要一个个删点么？人家这么成熟的插件，难道会烦这么低级的错误？因为Entity、Dao、mapper都是根据generatorConfig.xml文件来生成的。所以，只可能是这个配置文件那里配错了。那么到底是那里配错了呢？

1.首先，我们需要知道，database、schema、catalog三者的联系与区别。

按照SQL标准的解释，在SQL环境下Catalog和Schema都属于抽象概念，可以把它们理解为一个容器或者数据库对象命名空间中的一个层次，主要 用来解决命名冲突问题。从概念上说，一个数据库系统包含多个Catalog，每个Catalog又包含多个Schema，而每个Schema又包含多个数 据库对象（表、视图、字段等），反过来讲一个数据库对象必然属于一个Schema，而该Schema又必然属于一个Catalog，这样我们就可以得到该数据库对象的完全限定名称从而解决命名冲突的问题了；例如数据库对象表的完全限定名称就可以表示为：**Catalog名称.Schema名称.表名称**。这里 还有一点需要注意的是，SQL标准并不要求每个数据库对象的完全限定名称是唯一的，就象域名一样，如果喜欢的话，每个IP地址都可以拥有多个域名。

MySQL 5.5的官方文档是这么说的：

CREATE DATABASE creates a database with the given name.
    To use this statement, you need the CREATE privilege for the database.
    CREATE SCHEMA is a synonym for CREATE DATABASE.
    
    [译]
    CREATE DATABASE根据给定的名称创建数据库。
    你需要拥有数据库的CREATE权限来使用这个语句。
    CREATE SCHEMA是CREATE DATABASE的一个代名词。

也就是说，在MySQL中，schema和database是同一个玩意儿。而MySQL又不支持catalog，所以，我们平常看到的MySQL数据库对象表的完全限定名称是：**database.table.**

下面给出常用数据库对catalog、schema的支持情况：

<table style="margin-left:30px;"> 
 <tbody style="margin-left:30px;"> 
 <tr style="margin-left:30px;"> 
 <td style="margin-left:30px;"> 供应商 </td> 
 <td style="margin-left:30px;"> Catalog支持 </td> 
 <td style="margin-left:30px;"> Schema支持 </td> 
 </tr> 
 <tr style="margin-left:30px;"> 
 <td style="margin-left:30px;"> Oracle </td> 
 <td style="margin-left:30px;"> 不支持 </td> 
 <td style="margin-left:30px;"> Oracle User ID </td> 
 </tr> 
 <tr style="margin-left:30px;"> 
 <td style="margin-left:30px;"> MySQL </td> 
 <td style="margin-left:30px;"> 不支持 </td> 
 <td style="margin-left:30px;"> 数据库名 </td> 
 </tr> 
 <tr style="margin-left:30px;"> 
 <td style="margin-left:30px;"> MS SQL Server </td> 
 <td style="margin-left:30px;"> 数据库名 </td> 
 <td style="margin-left:30px;"> 对象属主名，2005版开始有变 </td> 
 </tr> 
 <tr style="margin-left:30px;"> 
 <td style="margin-left:30px;"> DB2 </td> 
 <td style="margin-left:30px;"> 指定数据库对象时，Catalog部分省略 </td> 
 <td style="margin-left:30px;"> Catalog属主名 </td> 
 </tr> 
 <tr style="margin-left:30px;"> 
 <td style="margin-left:30px;"> Sybase </td> 
 <td style="margin-left:30px;"> 数据库名 </td> 
 <td style="margin-left:30px;"> 数据库属主名 </td> 
 </tr> 
 <tr style="margin-left:30px;"> 
 <td style="margin-left:30px;"> Informix </td> 
 <td style="margin-left:30px;"> 不支持 </td> 
 <td style="margin-left:30px;"> 不需要 </td> 
 </tr> 
 <tr style="margin-left:30px;"> 
 <td style="margin-left:30px;"> PointBase </td> 
 <td style="margin-left:30px;"> 不支持 </td> 
 <td style="margin-left:30px;"> 数据库名 </td> 
 </tr> 
 </tbody> 
</table>

2.好了，回归我们的问题。有了上述背景知识，我们就可以快速定位generatorConfig.xml文件配置错误的地方了。在table节点，我们配置了catalog属性为database名称。现在一眼就知道配置错了，无中生有，删掉该属性。

![1156797-20190622132250284-808228460.png][] ![1156797-20190622132443423-1403432538.png][]

为了保险起见，我们还要在jdbcConnection节点中添加属性，申明当前数据库不支持catalog。

![1156797-20190622132828375-1514604103.png][]

3.现在让我们重新运行命令，生成Entity、Dao、mapper，生成成功后，看看TbUser的table注解，已经变成了表名字了。在运行下测试类，完美！！！还说啥，直接开花就完事儿。

![1156797-20190622133317917-1158309781.png][] ![1156797-20190622133353733-1738423013.png][]、

#  四、附录 #

完整的generatorConfig.xml配置及属性注解。

1 <xml version="1.0" encoding="UTF-8"?>
 2 <!DOCTYPE generatorConfiguration
 3 PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
 4 "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
 5 
 6 <generatorConfiguration>
 7 
 15 
 16 
 20 
 21 
 33 <context id="mysql" defaultModelType="hierarchical" targetRuntime="MyBatis3Simple" >
 34 
 35 
 38 <property name="autoDelimitKeywords" value="false"/>
 39 
 40 <property name="javaFileEncoding" value="UTF-8"/>
 41 
 42 <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
 43 
 44 <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
 45 
 46 
 47 <property name="beginningDelimiter" value="`"/>
 48 <property name="endingDelimiter" value="`"/>
 49 
 50 
 53 <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql:///pss" userId="root" password="admin">
 54 
 55 </jdbcConnection>
 56 
 57 
 61 <javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl">
 62 
 70 <property name="forceBigDecimals" value="false"/>
 71 </javaTypeResolver>
 72 
 73 
 74 
 79 <javaModelGenerator targetPackage="com._520it.mybatis.domain" targetProject="src/main/java">
 80 
 83 <property name="constructorBased" value="false"/>
 84 
 85 
 86 <property name="enableSubPackages" value="true"/>
 87 
 88 
 92 <property name="immutable" value="false"/>
 93 
 94 
 99 <property name="rootClass" value="com._520it.mybatis.domain.BaseDomain"/>
 100 
 101 
 102 <property name="trimStrings" value="true"/>
 103 </javaModelGenerator>
 104 
 105 
 106 
 111 <sqlMapGenerator targetPackage="com._520it.mybatis.mapper" targetProject="src/main/resources">
 112 
 113 <property name="enableSubPackages" value="true"/>
 114 </sqlMapGenerator>
 115 
 116 
 117 
 125 <javaClientGenerator targetPackage="com._520it.mybatis.mapper" type="ANNOTATEDMAPPER" targetProject="src/main/java">
 126 
 127 <property name="enableSubPackages" value="true"/>
 128 
 129 
 132 </javaClientGenerator>
 133 
 134 
 172 <table tableName="userinfo" >
 173 
 174 
 175 <property name="constructorBased" value="false"/>
 176 
 177 
 178 <property name="ignoreQualifiersAtRuntime" value="false"/>
 179 
 180 
 181 <property name="immutable" value="false"/>
 182 
 183 
 184 <property name="modelOnly" value="false"/>
 185 
 186 
 189 
 190 
 193 
 194 
 197 
 198 
 201 
 202 
 205 
 206 
 209 <property name="selectAllOrderByClause" value="age desc,username asc"/>
 210 
 211 
 212 <property name="useActualColumnNames" value="false"/>
 213 
 214 
 215 
 231 
 232 
 243 
 244 
 245 
 249 <columnOverride column="username">
 250 
 251 <property name="property" value="userName"/>
 252 
 253 
 256 
 257 
 260 
 261 
 266 
 267 
 270 </columnOverride>
 271 
 272 
 279 </table>
 280 
 281 </context>
 282 
 283 </generatorConfiguration>

\[完\]

转载于:https://www.cnblogs.com/little-rain/p/11063410.html

[1156797-20190621121953229-452807276.png]: /images/20211223/2558aefe8e9d44af9c5e0d17dfde934d.png
[IDEA_springboot]: https://www.cnblogs.com/little-rain/p/11063967.html
[1156797-20190621155535255-522512344.png]: /images/20211223/7682ecd1d0c44fb294391a2445ba3d62.png
[1156797-20190622121540984-88575773.png]: /images/20211223/001a1e2e86da4759b844b72b5fbb0b0e.png
[1156797-20190622121415562-1405294332.png]: https://img2018.cnblogs.com/blog/1156797/201906/1156797-20190622121415562-1405294332.png
[1156797-20190622121904927-426384630.png]: https://img2018.cnblogs.com/blog/1156797/201906/1156797-20190622121904927-426384630.png
[1156797-20190622122012793-1167531568.png]: /images/20211223/50b6dfccec384cc7a8e30f28b5c685df.png
[1156797-20190622124733537-925419795.png]: https://img2018.cnblogs.com/blog/1156797/201906/1156797-20190622124733537-925419795.png
[1156797-20190622125011307-1986329856.png]: /images/20211223/0f07a69104e74dacba7df58b37c487ac.png
[1156797-20190622132250284-808228460.png]: https://img2018.cnblogs.com/blog/1156797/201906/1156797-20190622132250284-808228460.png
[1156797-20190622132443423-1403432538.png]: /images/20211223/865d0c5207b049efbabbbc491e8b53ba.png
[1156797-20190622132828375-1514604103.png]: /images/20211223/b46f3ff47e484ffab09eb6e60b9ca14c.png
[1156797-20190622133317917-1158309781.png]: https://img2018.cnblogs.com/blog/1156797/201906/1156797-20190622133317917-1158309781.png
[1156797-20190622133353733-1738423013.png]: /images/20211223/9eba9b3d82124e3c8dfece1e1065a4a1.png