10分钟上手MyBatis 3与Spring Boot集成：企业级开发避坑指南
项目地址: https://gitcode.com/gh_mirrors/my/mybatis-3 为什么选择MyBatis+Spring Boot架构组合
在现代Java企业开发中，持久层框架的选择直接影响项目的开发效率与运行性能。MyBatis作为一款轻量级ORM（对象关系映射）框架，通过XML或注解方式将SQL语句与Java方法绑定，既保留了SQL编写的灵活性，又避免了传统JDBC的繁琐代码。Spring Boot则提供了自动配置、依赖注入等特性，两者结合可显著降低企业级应用的配置复杂度。
MyBatis核心功能模块位于src/main/java/org/apache/ibatis/目录，主要包含：
- 注解驱动：通过@Select、@Mapper等注解实现SQL映射
- 映射接口：如ImmutableBlogMapper所示的接口定义模式
- 会话管理：SqlSession负责数据库连接与事务控制
快速集成步骤（5步式配置）
1. 添加Maven依赖
在Spring Boot项目的pom.xml中添加以下依赖：
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>3.0.3</version>
</dependency>
<dependency>
<groupId>com.mysql</groupId>
<artifactId>mysql-connector-j</artifactId>
<scope>runtime</scope>
</dependency>
注意：MyBatis-Spring-Boot-Starter已包含MyBatis核心库，无需重复引入mybatis-x.x.x.jar
2. 配置数据源
在application.properties中配置数据库连接信息：
spring.datasource.url=jdbc:mysql://localhost:3306/blog_db?useSSL=false&serverTimezone=UTC
spring.datasource.username=root
spring.datasource.password=password
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
# MyBatis配置
mybatis.mapper-locations=classpath:mapper/**/*.xml
mybatis.type-aliases-package=com.example.demo.domain
3. 创建实体类
定义与数据库表对应的JavaBean：
public class Blog {
private Integer id;
private String title;
private String content;
private LocalDateTime createTime;
// 全参构造器、getter/setter省略
}
4. 编写Mapper接口
创建数据访问接口并添加MyBatis注解：
@Mapper
public interface BlogMapper {
@Select("SELECT * FROM blog WHERE id = #{id}")
Blog selectById(Integer id);
@Insert("INSERT INTO blog(title, content, create_time) VALUES(#{title}, #{content}, #{createTime})")
@Options(useGeneratedKeys = true, keyProperty = "id")
int insert(Blog blog);
}
接口定义规范可参考ImmutableBlogMapper的方法命名模式
5. Service层调用
在业务逻辑层注入Mapper接口并使用：
@Service
public class BlogService {
private final BlogMapper blogMapper;
@Autowired
public BlogService(BlogMapper blogMapper) {
this.blogMapper = blogMapper;
}
public Blog getBlog(Integer id) {
return blogMapper.selectById(id);
}
}
核心注解使用指南
基础CRUD注解
MyBatis提供了完整的CRUD注解支持，位于src/main/java/org/apache/ibatis/annotations/目录：
| 注解 | 用途 | 示例 |
|---|---|---|
| @Select | 查询操作 | @Select("SELECT * FROM blog WHERE id = #{id}") |
| @Insert | 插入操作 | @Insert("INSERT INTO blog VALUES(#{id}, #{title})") |
| @Update | 更新操作 | @Update("UPDATE blog SET title = #{title} WHERE id = #{id}") |
| @Delete | 删除操作 | @Delete("DELETE FROM blog WHERE id = #{id}") |
高级映射技巧
1. 结果集映射
当数据库列名与实体类属性名不一致时，使用@Results注解：
@Select("SELECT id, blog_title, create_time FROM blog WHERE id = #{id}")
@Results({
@Result(column = "id", property = "id"),
@Result(column = "blog_title", property = "title"),
@Result(column = "create_time", property = "createTime")
})
Blog selectById(Integer id);
2. 动态SQL构建
使用脚本标签实现条件查询：
@Select({
"<script>",
"SELECT * FROM blog",
"<where>",
" <if test='title != null'>AND title LIKE CONCAT('%', #{title}, '%')</if>",
" <if test='createTime != null'>AND create_time >= #{createTime}</if>",
"</where>",
"</script>"
})
List<Blog> selectByCondition(BlogCondition condition);
动态SQL语法详见dynamic-sql.md
事务管理最佳实践
Spring Boot与MyBatis集成后，可通过@Transactional注解实现声明式事务管理：
@Service
public class BlogServiceImpl implements BlogService {
private final BlogMapper blogMapper;
@Autowired
public BlogServiceImpl(BlogMapper blogMapper) {
this.blogMapper = blogMapper;
}
@Transactional(isolation = Isolation.READ_COMMITTED, propagation = Propagation.REQUIRED)
public void createBlog(Blog blog) {
blogMapper.insert(blog);
// 业务逻辑处理...
}
}
事务配置需注意：
- 事务方法必须是public
- 避免在事务方法内捕获异常（会导致事务无法回滚）
- 合理设置传播行为与隔离级别
性能优化策略
1. 延迟加载配置
在application.properties中开启延迟加载：
mybatis.configuration.lazy-loading-enabled=true
mybatis.configuration.aggressive-lazy-loading=false
2. 一级缓存与二级缓存
MyBatis默认开启一级缓存（SqlSession级别），二级缓存需手动开启：
@CacheNamespace
public interface BlogMapper {
// 方法定义...
}
缓存实现原理参见CacheBuilder
3. 批量操作优化
使用SqlSession的批量执行器：
@Service
public class BatchService {
private final SqlSessionFactory sqlSessionFactory;
@Autowired
public BatchService(SqlSessionFactory sqlSessionFactory) {
this.sqlSessionFactory = sqlSessionFactory;
}
public void batchInsert(List<Blog> blogs) {
try (SqlSession session = sqlSessionFactory.openSession(ExecutorType.BATCH)) {
BlogMapper mapper = session.getMapper(BlogMapper.class);
for (Blog blog : blogs) {
mapper.insert(blog);
}
session.commit();
}
}
}
ExecutorType定义在src/main/java/org/apache/ibatis/session/ExecutorType.java
常见问题解决方案
1. Mapper接口无法注入
问题表现：Field blogMapper in com.example.service.BlogService required a bean of type 'com.example.mapper.BlogMapper' that could not be found
解决方法：
- 确保Mapper接口添加了
@Mapper注解 - 在Spring Boot启动类添加
@MapperScan("com.example.mapper")
2. 参数绑定异常
问题表现：There is no getter for property named 'title' in 'class java.lang.String'
解决方法：
- 单参数时使用
@Param注解：
@Select("SELECT * FROM blog WHERE title = #{title}")
Blog selectByTitle(@Param("title") String title);
3. 动态SQL中特殊字符处理
使用<![CDATA[ ]]>包裹特殊字符：
@Select({
"<script>",
"SELECT * FROM blog WHERE create_time <![CDATA[ <= ]]> #{endTime}",
"</script>"
})
List<Blog> selectBeforeTime(@Param("endTime") LocalDateTime endTime);
总结与进阶学习
通过本文介绍的5步集成法，你已掌握MyBatis 3与Spring Boot的基础整合技巧。要深入学习可参考以下资源：
- 官方文档：src/site/markdown/目录下的markdown文档
- 配置详解：configuration.md
- Java API：java-api.md
- 测试用例：src/test/java/org/apache/ibatis/目录下的示例代码
MyBatis作为一款灵活的ORM框架，既可以通过简单注解快速实现CRUD操作，也能通过XML配置处理复杂的业务场景。建议在实际项目中根据团队习惯和业务复杂度，选择合适的映射方式，充分发挥其"半自动化"ORM的优势。
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
