一、MyBatis为什么需要通用Mapper?
通用 Mapper是一个可以实现任意 MyBatis 通用方法的框架,项目提供了常规的增删改查操作以及Example 相关的单表操作。通用 Mapper 是为了解决 MyBatis 使用中 90% 的基本操作,可以节省开发人员大量时间。开发人员可以随意的按照自己的需要选择通用方法,还可以很方便的开发自己的通用方法。 |
注意:
1、支持单表操作,不支持通用的多表联合查询。
2、通用 Mapper 支持 Mybatis-3.2.4及以上版本。
详情参考博客MyBatis 为什么需要通用 Mapper ?
二、Spring Boot集成通用Mapper
1、使用Spring Initializr快速创建Spring Boot项目
2、pom.xml
<!--通用mapper依赖-->
<dependency>
<groupId>tk.mybatis</groupId>
<artifactId>mapper-spring-boot-starter</artifactId>
<version>2.1.5</version>
</dependency>
3、主启动类添加@MapperScan注解
注意:这里需要导入的是 tk.mybatis.spring.annotation.MapperScan!
4、application.yml
spring:
datasource:
url: jdbc:mysql://localhost:3306/user_center?serverTimezone=UTC
hikari:
username: root
password: 123456
# >=6.x com.mysql.cj.jdbc.Driver
# <=5.x com.mysql.jdbc.Driver
driver-class-name: com.mysql.cj.jdbc.Driver
5、使用IDEA连接MySQL数据库
三、通用 Mapper 专用代码生成器
(1)、Maven 中的插件配置如下
<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>8.0.19</version>
</dependency>
<dependency>
<groupId>tk.mybatis</groupId>
<artifactId>mapper</artifactId>
<version>4.1.5</version>
</dependency>
</dependencies>
</plugin>
注意:这里有两个必须的依赖,一个是 JDBC 驱动,另一个是 Mapper 的插件。
(2)、src/main/resources新建generator包,在该包下新建generatorConfig.xml
<!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="generator/config.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"/>
<property name="caseSensitive" value="true"/>
</plugin>
<jdbcConnection driverClass="${jdbc.driverClass}"
connectionURL="${jdbc.url}"
userId="${jdbc.user}"
password="${jdbc.password}">
</jdbcConnection>
<!--实体-->
<javaModelGenerator targetPackage="com.uos.usercenter.domain.entity.${moduleName}"
targetProject="src/main/java"/>
<!--mapper.xml-->
<sqlMapGenerator targetPackage="com.uos.usercenter.dao.${moduleName}"
targetProject="src/main/resources"/>
<!--mapper接口-->
<javaClientGenerator targetPackage="com.uos.usercenter.dao.${moduleName}"
targetProject="src/main/java"
type="XMLMAPPER"/>
<!--为哪张表生成上述三个代码-->
<table tableName="${tableName}">
<generatedKey column="id" sqlStatement="JDBC"/>
</table>
</context>
</generatorConfiguration>
(3)、在generator包新建config.propertis
jdbc.driverClass=com.mysql.cj.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/user_center?serverTimezone=UTC
jdbc.user=root
jdbc.password=123456
# 模块名称
moduleName=user
# 表名
tableName=user
(4)、尝试运行
(5)、修改config.properties
nullCatalogMeansCurrent=true
(6)、再次运行,问题完美解决
(7)、编写controller测试类
@RestController
public class TestController {
@Autowired
private UserMapper userMapper;
@GetMapping("/test")
public User testInsert() {
User user = new User();
user.setAvatarUrl("XXX");
user.setBonus(10);
user.setCreateTime(new Date());
user.setUpdateTime(new Date());
userMapper.insertSelective(user);
return user;
}
}
(8)、浏览器访问(刷新)地址http://localhost:8080/test
(9)、generator 生成 lombok
添加lombok依赖
<!--lombok依赖-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.8</version>
<scope>provided</scope>
</dependency>
在generatorConfig.xml中添加
<property name="lombok" value="Getter,Setter,ToString"/>
双击mybatis-generator:generate
,生成代码
结果显示
如果自动生成的注解不是我们想要的,此时我们也可以手动添加Lombok的相关注解,例如: