MyBatis框架是目前比较流线的Java持久层框架,通过简单的注解或者是通过XML配置文件的方式将Java对象与SQL语句进行关联映射,从而达到化简数据库操作的目的,与传统的JPA技术或者是JDBC技术相比,提供给开发者多种的灵活性。下面我们就来详细介绍一下如何在Spring Boot3 中整合Mybatis框架。
创建项目并导入依赖
??首先来讲,我们需要创建一个SpringBoot3的项目,然后在POM文件中引入Mybatis相关的依赖配置,如下所示。
org.springframework.boot
spring-boot-starter-web
org.mybatis.spring.boot
mybatis-spring-boot-starter
3.0.0
com.mysql
mysql-connector-java
org.springframework.boot
spring-boot-devtools
runtime
??这里需要注意依赖版本问题,由于Spring Boot3 已经升级到Java17+了,所以需要保证Spring Boot版本与MyBatis的版本的依赖关系。
配置连接
??添加完依赖之后,接下来就需要在配置文件中添加数据库的连接以及MyBatis的相关配置内容,如下所示。
spring:
datasource:
url: jdbc:mysql://localhost:3306/your_database?useSSL=false&serverTimezone=UTC
username: root
password: password
driver-class-name: com.mysql.cj.jdbc.Driver
mybatis:
mapper-locations: classpath:/mappers/**/*.xml # 配置 MyBatis XML 映射文件的位置
type-aliases-package: com.example.demo.model # 配置实体类包路径,便于 MyBatis 扫描
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl # 打印 SQL 日志,开发时使用
??在Spring Boot3中默认继承了 HikariCP 连接池,所以一般不需要手动进行配置,如果需要自定义连接池配置,可以在配置文件中添加如下的参数。
spring:
datasource:
hikari:
maximum-pool-size: 10
minimum-idle: 5
idle-timeout: 30000
connection-timeout: 30000
具体使用步骤
??配置完成之后,接下来我们就来看看具体如何整合Java对象以及Mybatis映射文件之间的关系。
创建实体类
??首先我们先来创建POJO实体类对象,例如创建一个User用户表的映射对象,如下所示。
package com.example.demo.model;
public class User {
private Long id;
private String name;
private String email;
// Getters and Setters
}
创建Mapper接口
??Mybatis的核心就是这个Mapper接口的创建,通过定义接口来定义操作数据库的方法,并且与SQL语句通过XML或者是注解的方式进行映射,如下所示。
package com.example.demo.mapper;
import com.example.demo.model.User;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;
import java.util.List;
@Mapper
public interface UserMapper {
@Select("SELECT * FROM user")
List getAllUsers();
// 其他 CRUD 操作可以使用注解,也可以在 XML 文件中编写 SQL 语句
}
创建XML文件
??上面这种方式是通过注解的方式来与SQL语句进行的映射,当然为了统一方便,我们也可以通过如下的方式来在src/main/resources/mappers/ 目录下创建对应的 XML 映射文件,来配置SQL语句映射关系,如下所示。
创建 Service 和 Controller 层
Service层
??创建好映射关系之后,接下来就可以在Service层的对象中使用这个Mapper接口来进行数据的获取操作了,如下所示。
package com.example.demo.service;
import com.example.demo.mapper.UserMapper;
import com.example.demo.model.User;
import org.springframework.stereotype.Service;
import java.util.List;
@Service
public class UserService {
private final UserMapper userMapper;
public UserService(UserMapper userMapper) {
this.userMapper = userMapper;
}
public List getAllUsers() {
return userMapper.getAllUsers();
}
}
??接下来就是在Controller层中调用业务逻辑Service层的方法来提供RESTFul接口给前端或者是其他服务进行使用了。
package com.example.demo.controller;
import com.example.demo.model.User;
import com.example.demo.service.UserService;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
@RestController
public class UserController {
private final UserService userService;
public UserController(UserService userService) {
this.userService = userService;
}
@GetMapping("/users")
public List getAllUsers() {
return userService.getAllUsers();
}
}
总结
??到这里,整个的整合流程就算是结束了,在实际使用场景中可能会遇到事务管理、日志处理、插件分页、MyBatis缓存等各种问题。而这些细节都需要开发者自己去注意进行处理。MyBatis是一个非常灵活强大的框架,在灵活性与简洁性之间做到了很好的平衡,是JDBC与JPA之间的一个非常好的ORM框架选择。