🧱 一、前言
在 Java 后端开发中,Spring Boot + MyBatis 是一个非常经典且流行的组合。Spring Boot 提供了快速开发的能力,而 MyBatis 则以其灵活的 SQL 控制和高效的数据库操作能力受到广泛欢迎。
本篇文章将带你从零开始,一步步完成 Spring Boot 整合 MyBatis 的全过程,并附带完整代码示例,帮助你快速上手!
✅ 二、准备工作
1. 开发环境要求
- JDK 1.8 或以上
- Maven 3.x
- IDE:IntelliJ IDEA / Eclipse
- 数据库:MySQL 5.7+
- Spring Boot 版本:2.7.x 或 3.x(本文以 2.7.16 为例)
2. 创建 Spring Boot 项目
你可以使用 Spring Initializr 快速生成基础项目结构,选择以下依赖:
- Spring Web
- MyBatis Framework
- MySQL Driver
或者手动添加如下依赖到 pom.xml
:
<dependencies>
<!-- Web模块 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- MyBatis Starter -->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.2.2</version>
</dependency>
<!-- MySQL驱动 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
</dependencies>
🛠️ 三、配置数据源与 MyBatis
1. 配置 application.yml
在 src/main/resources/application.yml
中添加如下内容:
spring:
datasource:
url: jdbc:mysql://localhost:3306/test_db?
username: root
password: 123456
driver-class-name: com.mysql.cj.jdbc.Driver
mybatis:
mapper-locations: classpath:mapper/*.xml
type-aliases-package: com.example.demo.model
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
说明:
-
mapper-locations: 指定 MyBatis Mapper XML 文件的位置。
-
type-aliases-package: 设置实体类所在的包,便于在 XML 中直接使用类名。
-
log-impl: 用于mybatis执行sql信息打印到控制台
📁 四、创建实体类 & Mapper 接口
1. 创建实体类 User.java
public class User {
private Long id;
private String name;
private Integer age;
// Getter 和 Setter 省略
}
2. 创建 Mapper 接口
@Mapper
public interface UserMapper {
List<User> findAll();
}
📄 五、编写 MyBatis XML 映射文件
在 resources/mapper/UserMapper.xml
中编写 SQL 映射:
<?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.example.demo.mapper.UserMapper">
<select id="findAll" resultType="User">
SELECT * FROM users
</select>
</mapper>
🧪 六、编写 Service 与 Controller 测试接口
1. UserService.java
@Service
public class UserService {
@Autowired
private UserMapper userMapper;
public List<User> getAllUsers() {
return userMapper.findAll();
}
}
2. UserController.java
@RestController
@RequestMapping("/users")
public class UserController {
@Autowired
private UserService userService;
@GetMapping
public List<User> getUsers() {
return userService.getAllUsers();
}
}
📈 七、启动项目并测试
运行 Spring Boot 项目后,访问接口:http://localhost:8080/users
如果成功返回 JSON 格式的用户列表,说明 Spring Boot 已经成功整合 MyBatis!
🔍 八、常见问题排查
问题描述 | 解决方案 |
---|---|
报错 Invalid bound statement (not found) | 检查 Mapper 接口是否加了 @Mapper 注解或在启动类上使用 @MapperScan |
数据库连接失败 | 检查数据库地址、用户名、密码是否正确 |
XML 文件未加载 | 确保 mapper-locations 路径正确,并放在 resources 下 |
实体类找不到 | 确保 type-aliases-package 设置正确 |
🧩 九、进阶建议
- 使用 PageHelper 分页插件实现分页查询
- 使用 MyBatis Generator 自动生成实体类和 Mapper
- 结合 Druid 监控 SQL 执行情况
- 使用 Logback 输出 SQL 日志调试
📝 十、结语
通过本文的学习,你应该已经掌握了如何在 Spring Boot 项目中整合 MyBatis,并能够进行基本的数据库操作。
如果你觉得这篇文章对你有帮助,欢迎点赞、收藏、转发给更多需要的朋友!我们下期再见 👋