MyBatis与Spring整合：注解与XML配置实战指南

1. MyBatis与Spring整合的核心价值

在企业级Java开发中，持久层框架的选择直接影响着系统的可维护性和开发效率。MyBatis作为半自动化的ORM框架，通过SQL与对象映射的灵活设计，在复杂查询场景中展现出独特优势。而Spring框架的IoC容器和声明式事务管理，则为MyBatis提供了完美的运行环境。两者的整合实现了以下核心价值：

• SQL可控性：开发者可以精确控制SQL语句，针对不同数据库特性进行优化
• 对象映射自动化：自动将ResultSet转换为Java对象，减少样板代码
• 事务管理统一化：通过Spring的@Transactional注解实现声明式事务
• 配置灵活性：支持XML和注解两种方式，适应不同团队偏好

实际项目中最常见的组合是：Spring Boot + MyBatis + 注解驱动开发。但XML配置方式在复杂SQL场景仍不可替代

2. 基于注解的整合方案

2.1 基础环境搭建

首先确保项目中包含必要依赖（以Maven为例）：

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>

2.2 核心注解详解

@MapperScan

在启动类上标注，自动扫描指定包下的Mapper接口：

java复制@SpringBootApplication
@MapperScan("com.example.mapper")
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

@Mapper

在接口上使用，声明为MyBatis映射器：

java复制@Mapper
public interface UserMapper {
    @Select("SELECT * FROM users WHERE id = #{id}")
    User selectById(@Param("id") Long id);
    
    @Insert("INSERT INTO users(name,email) VALUES(#{name},#{email})")
    @Options(useGeneratedKeys = true, keyProperty = "id")
    int insert(User user);
}

动态SQL注解

使用@SelectProvider等实现动态SQL：

java复制@SelectProvider(type = UserSqlProvider.class, method = "getUserList")
List<User> getUserList(Map<String, Object> params);

// SQL提供类
class UserSqlProvider {
    public String getUserList(Map<String, Object> params) {
        return new SQL() {{
            SELECT("*");
            FROM("users");
            if (params.get("name") != null) {
                WHERE("name like #{name} || '%'");
            }
            ORDER_BY("id DESC");
        }}.toString();
    }
}

2.3 事务控制

通过Spring的@Transactional实现声明式事务：

java复制@Service
public class UserService {
    private final UserMapper userMapper;
    
    @Transactional
    public void createUser(User user) {
        userMapper.insert(user);
        // 其他数据库操作...
    }
}

3. XML配置方式详解

3.1 基础配置

在application.yml中指定XML映射文件位置：

yaml复制mybatis:
  mapper-locations: classpath:mapper/*.xml
  type-aliases-package: com.example.entity

3.2 XML映射文件结构

典型的Mapper 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.mapper.UserMapper">
    
    <resultMap id="userResultMap" type="User">
        <id property="id" column="id"/>
        <result property="name" column="name"/>
        <result property="email" column="email"/>
    </resultMap>
    
    <select id="selectById" resultMap="userResultMap">
        SELECT * FROM users WHERE id = #{id}
    </select>
    
    <insert id="insert" useGeneratedKeys="true" keyProperty="id">
        INSERT INTO users(name,email) 
        VALUES(#{name},#{email})
    </insert>
</mapper>

3.3 动态SQL实现

XML方式实现动态SQL更加直观：

xml复制<select id="getUserList" resultType="User">
    SELECT * FROM users
    <where>
        <if test="name != null">
            AND name like CONCAT(#{name},'%')
        </if>
        <if test="email != null">
            AND email = #{email}
        </if>
    </where>
    ORDER BY id DESC
</select>

4. 混合使用策略与最佳实践

4.1 注解与XML的适用场景

4.2 性能优化技巧

1. 批量插入优化：

java复制@Insert("<script>" +
        "INSERT INTO users(name,email) VALUES " +
        "<foreach collection='list' item='item' separator=','>" +
        "(#{item.name},#{item.email})" +
        "</foreach>" +
        "</script>")
void batchInsert(@Param("list") List<User> users);

2. 二级缓存配置：

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

3. 分页查询实现：

java复制@Select("SELECT * FROM users LIMIT #{offset}, #{pageSize}")
List<User> selectByPage(@Param("offset") int offset, 
                       @Param("pageSize") int pageSize);

4.3 常见问题排查

1. 参数绑定错误：

• 现象：There is no getter for property named 'xxx' in 'class java.lang.Long'
• 解决方案：使用@Param注解明确参数名

2. 事务不生效：

• 检查点：
  • 确保方法为public
  • 确保调用来自外部类（自调用不生效）
  • 检查异常类型是否被捕获未抛出

3. XML文件加载失败：

• 典型表现：Invalid bound statement (not found)
• 排查步骤：
  1. 检查mybatis.mapper-locations配置路径
  2. 确认XML文件名与Mapper接口名一致
  3. 检查XML文件中的namespace是否正确

5. 高级特性集成

5.1 类型处理器扩展

自定义类型处理器示例：

java复制@MappedTypes(PhoneNumber.class)
@MappedJdbcTypes(JdbcType.VARCHAR)
public class PhoneNumberTypeHandler extends BaseTypeHandler<PhoneNumber> {
    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, 
                                  PhoneNumber parameter, JdbcType jdbcType) {
        ps.setString(i, parameter.getValue());
    }
    // 其他方法实现...
}

5.2 插件开发

实现分页插件示例：

java复制@Intercepts(@Signature(type = StatementHandler.class, 
                      method = "prepare", 
                      args = {Connection.class, Integer.class}))
public class PaginationInterceptor implements Interceptor {
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        // 分页逻辑实现...
        return invocation.proceed();
    }
}

5.3 多数据源配置

Spring Boot多数据源配置要点：

java复制@Configuration
@MapperScan(basePackages = "com.example.primary.mapper", 
           sqlSessionFactoryRef = "primarySqlSessionFactory")
public class PrimaryDataSourceConfig {
    
    @Bean
    @ConfigurationProperties("spring.datasource.primary")
    public DataSource primaryDataSource() {
        return DataSourceBuilder.create().build();
    }
    
    @Bean
    public SqlSessionFactory primarySqlSessionFactory(
            @Qualifier("primaryDataSource") DataSource dataSource) throws Exception {
        SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
        factoryBean.setDataSource(dataSource);
        return factoryBean.getObject();
    }
}

在实际项目开发中，我倾向于采用"注解为主，XML为辅"的策略。简单CRUD使用注解保持代码紧凑，复杂查询则通过XML实现更好的可维护性。特别是在团队协作中，XML文件更易于进行版本控制和代码评审。对于性能敏感的操作，建议通过XML配置明确SQL执行计划，避免注解方式可能带来的字符串拼接性能损耗。