MyBatis Plus(简称MP)是MyBatis的增强工具,这个工具简化了MyBatis的开发工作提供了各种丰富的SQL执行操作,例如在MyBatis Plus中提供了自动生成SQL、分页查询、代码生成等功能操作,下面我们就来看看如何在Spring Boot中如何整合MyBatis Plus实现数据库ORM操作。
MyBatis Plus概述
MyBatis Plus是对MyBatis的增强,主要解决了MyBatis的常用操作需要编写大量重复代码的问题。通过使用MyBatis Plus,我们可以简化数据库操作,减少冗余代码。
在MyBatis Plus中包含了如下的一些操作特性。
- 自动生成SQL:MyBatis Plus提供了对常见数据库CRUD操作的基础方法支持。
- 分页查询:在MyBatis Plus中集成了现成的分页插件,并且支持了多种分页方式方式,不需要额外的引入其他的分页依赖框架。
- 代码生成:在MyBatis Plus中可以根据数据库表自动生成实体类、Mapper接口等代码。
- 性能优化:MyBatis Plus中还提供了性能分析、SQL执行优化等功能,方便开发者对SQL进行优化。
在Spring Boot中整合MyBatis Plus
首先,在pom.xml文件中添加MyBatis Plus相关的配置依赖,如下所示。
<dependencies>
<!-- Spring Boot Starter Web -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- Spring Boot Starter MyBatis -->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.2.0</version> <!-- 使用适合你项目的版本 -->
</dependency>
<!-- MyBatis Plus -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.5.0</version> <!-- 使用适合的版本 -->
</dependency>
<!-- MySQL连接驱动(如果使用MySQL数据库) -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!-- Spring Boot Starter JDBC(如果需要) -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
</dependencies>
配置数据源
配置完成之后,接下来就需要在Spring Boot的配置文件中添加上MyBatis和MySQL的相关链接配置,如下所示。
spring:
datasource:
url: jdbc:mysql://localhost:3306/test_db?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
username: root
password: your_password
driver-class-name: com.mysql.cj.jdbc.Driver
# MyBatis Plus配置
mybatis-plus:
mapper-locations: classpath:/mapper/*.xml
typeAliasesPackage: com.example.demo.model
配置MyBatis Plus
在Spring Boot中,MyBatis Plus会自动的扫描并且添加Mapper的接口配置以及XML的配置,如下所示,在SpringBoot启动的时候,我们可以通过@MapperScan注解来配置Mapper的扫描路径,或者是在配置类中添加相关的配置,保证SpringBoot框架能够扫描到对应的配置。
@SpringBootApplication
@MapperScan("com.example.demo.mapper") // 扫描Mapper接口所在包
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
使用MyBatis Plus
配置完成之后,接下来我们就来看看MyBatis Plus的相关功能的使用。首先,我们先来配置一个数据库的实体类对象配置。如下所示。
@Data
@TableName("user") // 指定表名
public class User {
@TableId
private Long id; // 主键字段
private String name;
private Integer age;
private String email;
}
接下来,我们继承BaseMapper接口,就可以使用MyBatis Plus中提供的CRUD操作来实现对数据库的基本操作。
public interface UserMapper extends BaseMapper<User> {
// 可以在这里添加自定义的方法
}
我们可以通过在Service层注入UserMapper来调用MyBatis Plus的基础操作。
@Service
public class UserService extends ServiceImpl<UserMapper, User> {
// 继承ServiceImpl后,可以直接使用BaseMapper提供的所有方法
}
在Controller层中调用Service中提供的方法来实现具体的业务操作逻辑,如下所示。
@RestController
@RequestMapping("/user")
public class UserController {
@Autowired
private UserService userService;
@PostMapping
public boolean save(@RequestBody User user) {
return userService.save(user); // 使用MyBatis Plus提供的save方法
}
@GetMapping("/{id}")
public User getById(@PathVariable Long id) {
return userService.getById(id); // 使用MyBatis Plus提供的getById方法
}
@GetMapping
public List<User> getAll() {
return userService.list(); // 使用MyBatis Plus提供的list方法
}
}
MyBatis Plus的常见功能
除了上面的基础功能实现之外,我们还可以通过MyBatis Plus来实现例如分页、代码生成等功能。如下所示,我们来演示一下如何通过MyBatis Plus实现分页操作。
自动分页
在MyBatis Plus中自动集成了分页插件操作,我们可以通过分页插件来实现自动分页操作,只需要在配置文件中开启对应的配置,然后通过Page类来实现分页操作即可。
mybatis-plus.configuration.mapper-locations=classpath:/mapper/*.xml
mybatis-plus.plugins=com.baomidou.mybatisplus.extension.plugins.pagination.Page
然后,在查询时使用分页
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
Page<User> page = new Page<>(1, 10); // 分页查询,1为页码,10为每页显示的条数
LambdaQueryWrapper<User> queryWrapper = new LambdaQueryWrapper<>();
queryWrapper.eq(User::getAge, 25); // 查询年龄为25的用户
IPage<User> userPage = userService.page(page, queryWrapper);
自动代码生成
MyBatis Plus中还提供了代码生成器,我们可以通过使用CodeGenerator类,自动生成实体类、Mapper接口、Service层和Controller层等代码详情,相关操作详情可以参考MyBatis Plus的官方文档。
总结
在Spring Boot整合MyBatis Plus可以简化MyBatis的操作,通过MyBatis Plus提供的各种强大功能,减少了开发过程中重复代码的开发,只需要添加对应的依赖就可以快速实现与Spring Boot项目的整合,通过各种基础功能的支持极大的提升了开发效率。