Spring Boot整合MyBatis实战：从配置到高级应用

1. Spring Boot与MyBatis集成概述

在现代Java企业级应用开发中，Spring Boot和MyBatis的组合已经成为主流技术栈之一。Spring Boot通过自动配置和约定优于配置的原则简化了Spring应用的初始搭建和开发过程，而MyBatis作为一款优秀的持久层框架，提供了灵活且强大的SQL映射能力。两者的结合能够充分发挥各自的优势，既保留了Spring Boot的便捷性，又可以利用MyBatis对SQL的精细控制。

这种集成方式特别适合需要复杂SQL查询但又希望保持开发效率的项目场景。通过Spring Boot Starter for MyBatis，开发者可以快速搭建起一个完整的数据库访问层，而无需关心繁琐的配置细节。

2. 环境准备与项目搭建

2.1 创建Spring Boot项目

首先需要创建一个基础的Spring Boot项目。可以通过以下方式之一实现：

1. 使用Spring Initializr（https://start.spring.io/）在线生成
2. 通过IDE（如IntelliJ IDEA）的Spring Boot项目向导
3. 手动创建Maven或Gradle项目并添加相应依赖

在创建项目时，需要选择以下核心依赖：

• Spring Web（如果项目需要Web功能）
• MyBatis Framework
• 对应数据库的JDBC驱动（如MySQL、PostgreSQL等）

2.2 添加必要依赖

对于Maven项目，pom.xml中需要包含以下关键依赖：

xml复制<dependencies>
    <!-- Spring Boot Starter -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>
    
    <!-- MyBatis Spring Boot Starter -->
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>2.2.0</version>
    </dependency>
    
    <!-- 数据库驱动 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <scope>runtime</scope>
    </dependency>
    
    <!-- 其他项目所需依赖 -->
</dependencies>

2.3 配置数据源

在application.properties或application.yml中配置数据库连接信息：

properties复制# 数据库配置
spring.datasource.url=jdbc:mysql://localhost:3306/your_database?useSSL=false&serverTimezone=UTC
spring.datasource.username=your_username
spring.datasource.password=your_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.model

3. MyBatis核心组件配置

3.1 实体类创建

首先创建与数据库表对应的实体类。例如，对于一个用户表：

java复制package com.example.demo.model;

public class User {
    private Long id;
    private String username;
    private String email;
    // 省略getter/setter
}

3.2 Mapper接口定义

创建Mapper接口，定义数据库操作方法：

java复制package com.example.demo.mapper;

import com.example.demo.model.User;
import org.apache.ibatis.annotations.*;

import java.util.List;

@Mapper
public interface UserMapper {
    @Select("SELECT * FROM users WHERE id = #{id}")
    User findById(Long id);

    @Insert("INSERT INTO users(username, email) VALUES(#{username}, #{email})")
    @Options(useGeneratedKeys = true, keyProperty = "id")
    void insert(User user);

    @Update("UPDATE users SET username=#{username}, email=#{email} WHERE id=#{id}")
    void update(User user);

    @Delete("DELETE FROM users WHERE id=#{id}")
    void delete(Long id);

    @Select("SELECT * FROM users")
    List<User> findAll();
}

3.3 XML映射文件配置

对于复杂的SQL操作，可以使用XML映射文件。在resources/mapper目录下创建UserMapper.xml：

xml复制<?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">
    <resultMap id="userResultMap" type="User">
        <id property="id" column="id"/>
        <result property="username" column="username"/>
        <result property="email" column="email"/>
    </resultMap>

    <select id="findByCondition" resultMap="userResultMap">
        SELECT * FROM users
        <where>
            <if test="username != null">
                AND username LIKE CONCAT('%', #{username}, '%')
            </if>
            <if test="email != null">
                AND email LIKE CONCAT('%', #{email}, '%')
            </if>
        </where>
    </select>
</mapper>

4. 高级特性与最佳实践

4.1 动态SQL应用

MyBatis提供了强大的动态SQL功能，可以在XML映射文件中使用：

xml复制<update id="updateSelective" parameterType="User">
    UPDATE users
    <set>
        <if test="username != null">username=#{username},</if>
        <if test="email != null">email=#{email},</if>
    </set>
    WHERE id=#{id}
</update>

4.2 分页查询实现

结合PageHelper实现分页查询：

1. 添加PageHelper依赖：

xml复制<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper-spring-boot-starter</artifactId>
    <version>1.4.1</version>
</dependency>

2. 在Service层使用：

java复制public PageInfo<User> findUsersByPage(int pageNum, int pageSize) {
    PageHelper.startPage(pageNum, pageSize);
    List<User> users = userMapper.findAll();
    return new PageInfo<>(users);
}

4.3 事务管理

Spring Boot与MyBatis集成后，可以使用Spring的事务管理：

java复制@Service
public class UserService {
    private final UserMapper userMapper;

    public UserService(UserMapper userMapper) {
        this.userMapper = userMapper;
    }

    @Transactional
    public void updateUser(User user) {
        userMapper.update(user);
        // 其他数据库操作
    }
}

5. 常见问题与解决方案

5.1 映射文件未加载问题

问题现象：Mapper接口调用时报错，提示"Invalid bound statement (not found)"

解决方案：

1. 检查application.properties中mybatis.mapper-locations配置是否正确
2. 确保XML文件位于正确目录下
3. 检查XML文件中的namespace是否与Mapper接口全限定名一致

5.2 自动注入失败问题

问题现象：启动时报错，提示"Field xxxMapper in xxx required a bean of type xxxMapper that could not be found"

解决方案：

1. 确保Mapper接口添加了@Mapper注解或在启动类上添加@MapperScan
2. 检查包扫描路径是否正确

5.3 数据库连接池配置

优化建议：

properties复制# 连接池配置
spring.datasource.hikari.maximum-pool-size=20
spring.datasource.hikari.minimum-idle=10
spring.datasource.hikari.idle-timeout=30000
spring.datasource.hikari.max-lifetime=2000000
spring.datasource.hikari.connection-timeout=30000

6. 性能优化技巧

6.1 二级缓存配置

在application.properties中启用MyBatis二级缓存：

properties复制mybatis.configuration.cache-enabled=true

在Mapper接口或XML映射文件中添加缓存配置：

xml复制<cache eviction="LRU" flushInterval="60000" size="512" readOnly="true"/>

6.2 SQL执行监控

集成p6spy监控SQL执行：

1. 添加依赖：

xml复制<dependency>
    <groupId>p6spy</groupId>
    <artifactId>p6spy</artifactId>
    <version>3.9.1</version>
</dependency>

2. 修改配置：

properties复制spring.datasource.driver-class-name=com.p6spy.engine.spy.P6SpyDriver
spring.datasource.url=jdbc:p6spy:mysql://localhost:3306/your_database

3. 添加spy.properties：

properties复制module.log=com.p6spy.engine.logging.P6LogFactory
appender=com.p6spy.engine.spy.appender.Slf4JLogger

7. 测试与验证

7.1 单元测试配置

创建测试类验证Mapper功能：

java复制@SpringBootTest
class UserMapperTest {
    @Autowired
    private UserMapper userMapper;

    @Test
    void testInsert() {
        User user = new User();
        user.setUsername("test");
        user.setEmail("test@example.com");
        userMapper.insert(user);
        assertNotNull(user.getId());
    }
}

7.2 集成测试建议

对于复杂业务逻辑，建议编写集成测试：

java复制@SpringBootTest
@Transactional
class UserServiceIntegrationTest {
    @Autowired
    private UserService userService;

    @Test
    void testUpdateUser() {
        // 测试数据准备
        User user = new User();
        user.setUsername("original");
        userService.createUser(user);
        
        // 测试执行
        user.setUsername("updated");
        userService.updateUser(user);
        
        // 验证结果
        User updated = userService.findById(user.getId());
        assertEquals("updated", updated.getUsername());
    }
}

8. 项目结构建议

一个良好的项目结构可以提高代码的可维护性：

code复制src/main/java
├── com.example.demo
│   ├── config          # 配置类
│   ├── controller      # 控制器
│   ├── service         # 服务层
│   ├── mapper          # MyBatis Mapper接口
│   ├── model           # 实体类
│   └── DemoApplication.java # 启动类
src/main/resources
├── application.yml     # 应用配置
├── mapper              # MyBatis XML映射文件
└── static/templates    # 静态资源/模板

9. 生产环境注意事项

9.1 SQL注入防护

虽然MyBatis使用预编译语句可以有效防止SQL注入，但仍需注意：

1. 避免直接拼接SQL语句
2. 使用#{}而非${}进行参数替换
3. 对用户输入进行严格验证

9.2 连接泄露检测

配置连接泄露检测：

properties复制spring.datasource.hikari.leak-detection-threshold=60000

9.3 监控与健康检查

启用Spring Boot Actuator监控数据源状态：

properties复制management.endpoint.health.show-details=always
management.endpoints.web.exposure.include=health,info

10. 扩展与进阶

10.1 多数据源配置

对于需要连接多个数据库的场景：

1. 配置多个数据源：

java复制@Configuration
public class DataSourceConfig {
    @Bean
    @ConfigurationProperties("app.datasource.primary")
    public DataSource primaryDataSource() {
        return DataSourceBuilder.create().build();
    }

    @Bean
    @ConfigurationProperties("app.datasource.secondary")
    public DataSource secondaryDataSource() {
        return DataSourceBuilder.create().build();
    }
}

2. 为每个数据源配置独立的SqlSessionFactory和事务管理器

10.2 MyBatis Generator集成

使用MyBatis Generator自动生成基础代码：

1. 添加插件配置：

xml复制<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.4.1</version>
    <configuration>
        <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
        <overwrite>true</overwrite>
    </configuration>
</plugin>

2. 创建generatorConfig.xml配置文件

10.3 与Spring Data JPA混合使用

在某些场景下，可以同时使用MyBatis和JPA：

java复制@Entity
@Table(name = "users")
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String username;
    // JPA注解与MyBatis可以共存
}

@Repository
public interface UserRepository extends JpaRepository<User, Long> {
    // JPA查询方法
}

@Mapper
public interface UserMapper {
    // MyBatis查询方法
}

在实际项目中，可以根据业务需求灵活选择使用MyBatis还是JPA，或者两者结合使用。对于简单的CRUD操作可以使用JPA提高开发效率，对于复杂查询则可以使用MyBatis进行精细控制。