一、Spring Boot 集成 MyBatis Plus
MyBatis Plus是一个MyBatis的增强框架,在MyBatis的基础上只做增强不做改变,为简化开发、提高效率而生。MyBatis Plus提供了通用的Mapper和Service,可以在不编写任何SQL语句的情况下,快速实现对单表的CRUD、批量操作、逻辑删除以及分页等操作。
使用idea创建spring-boot-mybatisplus,导入基本依赖
MyBatis Plus提供了Spring Boot启动器,可以直接导入MyBatis Plus的starter,然后再导入MyBatis Plus代码生成器依赖以及模板依赖
代码语言:javascript复制<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.5.1</version>
</dependency>
MyBatis Plus 自动配置原理 MyBatis Plus的自动配置类是com.baomidou.mybatisplus.autoconfigure包下的MybatisPlusAutoConfiguration
MybatisPlusAutoConfiguration自动配置类启用了MyBatisPlusProperties配置类
MyBatisPlusProperties配置类的前缀是mybatis-plus
mybatis-plus的相关配置都在MyBatisPlusProperties配置类中
二、MyBatis Plus 实现 CRUD
在application.yml中配置数据库连接信息,使用Spring Boot默认的数据源
代码语言:javascript复制spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
username: root
password: Abc*123456
url: jdbc:mysql://rm-uf67r962043910k193o.mysql.rds.aliyuncs.com:3306/test
增加MyBatis Plus的相关配置
代码语言:javascript复制mybatis-plus:
mapper-locations: classpath:mappers/*.xml
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
map-underscore-to-camel-case: true
auto-mapping-behavior: full
增加entity包,新增Tesla实体类
代码语言:javascript复制@Data
@TableName("t_tesla")
public class Tesla {
private Integer id;
private String name;
private Double price;
private String vehicleType;
private String factory;
}
新增mapper包,增加TeslaMapper接口,增加selectTeslaById方法
代码语言:javascript复制@Mapper
public interface TeslaMapper {
Tesla selectTeslaById(Integer id);
}
在resources目录下增加mpper文件夹,增加TeslaMapper对应的XML文件
代码语言:javascript复制<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.lilith.mapper.TeslaMapper">
<sql id="teslaAllColums">
id,name,price,vehicle_type,factory
</sql>
<select id="selectTeslaById" resultType="com.lilith.entity.Tesla">
SELECT
<include refid="teslaAllColums"></include>
FROM t_tesla where id = #{id}
</select>
</mapper>
增加TeslaMapperTest测试类,对selectTeslaById方法进行测试
代码语言:javascript复制@SpringBootTest
public class TeslaMapperTest {
@Resource
private TeslaMapper teslaMapper;
@Test
public void selectTeslaById(){
Tesla tesla = teslaMapper.selectTeslaById(2);
System.out.println("查询到的内容为:" tesla);
}
}
执行该方法
成功查询到数据,application.yml中MyBatis Plus的配置生效。
继承BaseMapper实现CRUD
TeslaMapper继承MyBatis Plus的BaseMapper接口即可拥有基本CRUD条件查询以及分页方法
代码语言:javascript复制@Mapper
public interface TeslaMapper extends BaseMapper<Tesla>{
Tesla selectTeslaById(Integer id);
}
在TeslaMapperTest中测试BaseMapper提供的查询方法
代码语言:javascript复制@Test
public void selectOneById(){
Tesla tesla = teslaMapper.selectById(2);
System.out.println("MyBatis Plus的SELECT方法查询到的数据:" tesla);
}
执行该方法
更多MyBatis Plus的CRUD方法以及注解和条件查询可以参考 Data Acces 之 MyBatis Plus(一)- BaseMapper CRUD(Part A) 和 Data Access 之 MyBatis Plus(二)- Wrapper 条件构造器
三、MyBatis Plus 插件使用
在SSM中配置MyBatis Plus插件需要在Spring 配置文件中配置分页插件,然后将分页插件的Bean注入到MybatisSqlSessionFactoryBean中。而在Spring Boot中可以使用配置类的方式,将分页插件的Bean注册到容器中
新建config包,增加MyBatisPlusConfig配置类,将MyBatis Plus用于分页的插件注入到容器中
代码语言:javascript复制@Configuration
public class MyBatisPlusConfig {
public PaginationInnerInterceptor innerInterceptor(){
PaginationInnerInterceptor interceptor = new PaginationInnerInterceptor();
interceptor.setDbType(DbType.MYSQL);
return interceptor;
}
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor(){
MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();
mybatisPlusInterceptor.setInterceptors(Arrays.asList(innerInterceptor()));
return mybatisPlusInterceptor;
}
}
在TeslaMapperTest中测试selectPage方法
代码语言:javascript复制@Test
public void selectPage(){
Page<Tesla> teslaPage = new Page<>(2,4);
Page<Tesla> page = teslaMapper.selectPage(teslaPage, null);
System.out.println("--------------------");
System.out.println("查询当前页面的数据:" page.getRecords());
System.out.println("--------------------");
}
执行selectPage方法
根据输出的SQL语句,成功执行了分页查询。
四、MyBatis Plus MPG 代码生成器
使用MyBatis Plus的代码生成器需要导入generator依赖和模板引擎依赖
代码语言:javascript复制<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.5.1</version>
</dependency>
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.31</version>
</dependency>
在MybatisplusApplicationTests测试类中添加代码生成器方法的代码
代码语言:javascript复制private static final String JDBC_URL = "jdbc:mysql://localhost/test?useUnicode=true&characterEncoding=utf8&autoReconnect=true&useSSL=false&serverTimezone=Asia/Shanghai&allowMultiQueries=true";
private static final String JDBC_USERNAME = "root";
private static final String JDBC_PASSWORD = "root";
// 代码生成器
@Test
public void generator(){
FastAutoGenerator.create(JDBC_URL, JDBC_USERNAME, JDBC_PASSWORD)
.globalConfig(builder -> {
builder.author("Jingnan") // 设置作者
//.enableSwagger() // 开启 swagger 模式
.fileOverride() // 覆盖已生成文件
.outputDir("src/main/java"); // 指定输出目录
})
.packageConfig(builder -> {
builder.parent("com") // 设置父包名
.moduleName("lilith") // 设置父包模块名
.pathInfo(Collections.singletonMap(OutputFile.mapperXml, "src/main/resources/mappers/")); // 设置mapperXml生成路径
})
.strategyConfig(builder -> {
builder.addInclude("porsche") // 设置需要生成的表名
.addTablePrefix("t_", "c_"); // 设置过滤表前缀
})
.templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板,默认的是Velocity引擎模板
.execute();
}
执行该方法就可以生成controller层、service层、mapper层以及mapper XML配置文件
测试Controller层代码
在PorscheController中增加代码
代码语言:javascript复制@Controller
@RequestMapping("/lilith/porsche")
public class PorscheController {
@Autowired
private IPorscheService porscheService;
@ResponseBody
@GetMapping("/list")
public List<Porsche> list(){
List<Porsche> list = porscheService.list();
return list;
}
}
将TeslaMapper类上的@Mapper注解删除,在MyBatisplusApplication启动类上添加@MapperScan注解
代码语言:javascript复制@MapperScan(basePackages = "com.lilith.mapper")
启动应用,浏览器输入 http://localhost:8080/lilith/porsche/list
关于MyBatis Plus的代码生成器以及Mapper层和Service层的测试也可以参考Data Access 之 MyBatis Plus(三)- MPG代码生成器