Mybatis --- 通用 Mapper 专用代码生成器

超、凢脫俗 2021-10-15 00:45 613阅读 0赞

# MyBatis 通用 Mapper4  #

通用Mapper都可以极大的方便开发人员。可以随意的按照自己的需要选择通用方法，还可以很方便的开发自己的通用方法。

极其方便的使用MyBatis单表的增删改查。

支持单表操作，不支持通用的多表联合查询。

**通用 Mapper 支持 Mybatis-3.2.4 及以上版本。**

## [**快速入门 - MyBatis 为什么需要通用 Mapper ?**][- MyBatis _ Mapper] ##

简介: 在早期项目文档中有过类似主题的内容，但是最近我自己看文档的时候发现一个问题，文档虽然很详细，但是并不适合初次接触的人。为了方便第一次听说，第一次尝试的开发人员了解通用 Mapper，补充此文档。

强烈建议初学者阅读本文，先从整体上了解 通用 Mapper，然后再通过下面的文档更深入的了解。

[https://github.com/abel533/Mapper][https_github.com_abel533_Mapper]

与springboot 整合通用Mapper

[https://github.com/abel533/Mapper/wiki/1.3-spring-boot][https_github.com_abel533_Mapper_wiki_1.3-spring-boot]

第一步，加依赖

<dependency>
      <groupId>tk.mybatis</groupId>
      <artifactId>mapper-spring-boot-starter</artifactId>
      <version>版本号</version>
    </dependency>

使用了通用Mapper 以后mybatis 的依赖就可以不要 ，去除

第二步，写配置，没有配置

[https://github.com/abel533/Mapper/wiki/3.config][https_github.com_abel533_Mapper_wiki_3.config]

其中3.1指出

\->>>>>   4.0 之后，增加了一个 `@RegisterMapper` 注解，通用 Mapper 中提供的所有接口都有这个注解，有了该注解后，通用 Mapper 会自动解析所有的接口，如果父接口（递归向上找到的最顶层）存在标记该注解的接口，就会自动注册上。因此 4.0 后使用通用 Mapper 提供的方法时，不需要在配置这个参数。

第三步，加注解

`@MapperScan` 注解配置

注意是tk包里面的（@tk.mybatis.spring.annotation.MapperScan(basePackages = "扫描包")）

第四步，代码生成器

[专用代码生成器][Link 1]

使用maven 的方式使用

### 使用 Maven 执行MBG ###

<plugin>
        <groupId>org.mybatis.generator</groupId>
        <artifactId>mybatis-generator-maven-plugin</artifactId>
        <version>1.3.6</version>
        <configuration>
          <configurationFile>
            ${basedir}/src/main/resources/generator/generatorConfig.xml
          </configurationFile>
          <overwrite>true</overwrite>
          <verbose>true</verbose>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.29</version>
          </dependency>
          <dependency>
            <groupId>tk.mybatis</groupId>
            <artifactId>mapper</artifactId>
            <version>4.0.0</version>
          </dependency>
        </dependencies>
      </plugin>

其中 修改自己 MySQL的驱动版本

一、

<dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.16</version>
    </dependency>

二、

mapper 使用最新的4.1.5

<dependency>
        <groupId>tk.mybatis</groupId>
        <artifactId>mapper</artifactId>
        <version>4.1.5</version>
    </dependency>

接下来，创建文件

路径：

${basedir}/src/main/resources/generator/generatorConfig.xml

内容在 [https://github.com/abel533/Mapper/wiki/4.1.mappergenerator][Link 1] 中有 粘贴就行

其中

修改成：

<table tableName="${tableName}">
        <generatedKey column="id" sqlStatement="JDBC"/>
    </table>

接下来还有三个地方，还需要修改成自己的包路径

<javaModelGenerator targetPackage="com.xx.xx.domain.entity.${moduleName}"
                        targetProject="src/main/java"/>
    
    
    <sqlMapGenerator targetPackage="com.xx.xx.dao.${moduleName}"
                     targetProject="src/main/resources"/>
    
    
    <javaClientGenerator targetPackage="com.xx.xx.dao.${moduleName}"
                         targetProject="src/main/java"
                         type="XMLMAPPER"/>

上面的xx.xx 换成自己的包路径即可

接下来创建

config.properties

在这之前

修改

generatorConfig.xml 中的
    <properties resource="config.properties"/>
    
    为
    
    <properties resource="generator/config.properties"/>

并且把 config.properties 放在$\{basedir\}/src/main/resources/generator 下面。

这个文件的作用是为了配置generatorConfig.xml 中的占位符的参数

例如：

jdbc.driverClass=com.mysql.cj.jdbc.Driver
    jdbc.url=jdbc:mysql://yourIp（替换成自己的）:3306/demo?nullCatalogMeansCurrent=true
    jdbc.user=root
    jdbc.password=root
    
    # 模块名称
    moduleName=user（替换成自己的）
    # 表名
    tableName=user 替换成自己的）

完成上诉操作即代表配置好了通用mapper，接下来使用，验证一下是否配置正确

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hpbmJ1bWk_size_16_color_FFFFFF_t_70][]

点击其中的

mybatis-generator:generate 即可

其中

jdbc:mysql://xxx:3306/demo?nullCatalogMeansCurrent=true

nullCatalogMeansCurrent=true 是重点，

解释：

## 是因为MySQL8.0+的驱动默认返回的是用户具有权限的所有表的信息，如果只返回当先数据库的表信息，需要配置nullCatalogMeansCurrent 参数。 ##

在连接参数加上 nullCatalogMeansCurrent=true 即可

整合 lombok

添加一行，即可

[- MyBatis _ Mapper]: https://blog.csdn.net/isea533/article/details/83045335
[https_github.com_abel533_Mapper]: https://github.com/abel533/Mapper
[https_github.com_abel533_Mapper_wiki_1.3-spring-boot]: https://github.com/abel533/Mapper/wiki/1.3-spring-boot
[https_github.com_abel533_Mapper_wiki_3.config]: https://github.com/abel533/Mapper/wiki/3.config
[Link 1]: https://github.com/abel533/Mapper/wiki/4.1.mappergenerator
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hpbmJ1bWk_size_16_color_FFFFFF_t_70]: /images/20211015/98ba4ccef21c4170847a0bdbd0187f86.png