spring中怎么集成mybatis

发布时间：2021-06-18 16:47:18 作者：Leah
来源：亿速云阅读：191

# Spring中怎么集成MyBatis

## 目录
1. [引言](#引言)
2. [环境准备](#环境准备)
3. [MyBatis基础概念](#mybatis基础概念)
4. [Spring集成MyBatis的三种方式](#spring集成mybatis的三种方式)
   - [4.1 原生集成方式](#41-原生集成方式)
   - [4.2 MyBatis-Spring整合包](#42-mybatis-spring整合包)
   - [4.3 Spring Boot自动配置](#43-spring-boot自动配置)
5. [详细集成步骤](#详细集成步骤)
   - [5.1 数据源配置](#51-数据源配置)
   - [5.2 SqlSessionFactory配置](#52-sqlsessionfactory配置)
   - [5.3 Mapper接口扫描](#53-mapper接口扫描)
   - [5.4 事务管理](#54-事务管理)
6. [高级配置](#高级配置)
   - [6.1 多数据源配置](#61-多数据源配置)
   - [6.2 分页插件集成](#62-分页插件集成)
   - [6.3 二级缓存配置](#63-二级缓存配置)
7. [最佳实践](#最佳实践)
8. [常见问题排查](#常见问题排查)
9. [总结](#总结)

## 引言

在现代Java企业级应用开发中，Spring框架和MyBatis持久层框架的组合被广泛采用。Spring提供了全面的基础设施支持，而MyBatis则以灵活的SQL映射著称。本文将深入探讨如何在Spring环境中集成MyBatis，涵盖从基础配置到高级特性的完整方案。

## 环境准备

### 基础依赖
```xml
<!-- Spring核心依赖 -->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-context</artifactId>
    <version>5.3.18</version>
</dependency>

<!-- MyBatis核心 -->
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.9</version>
</dependency>

<!-- MyBatis-Spring整合包 -->
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis-spring</artifactId>
    <version>2.0.7</version>
</dependency>

<!-- 数据库驱动 -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.28</version>
</dependency>

<!-- 数据源 -->
<dependency>
    <groupId>com.zaxxer</groupId>
    <artifactId>HikariCP</artifactId>
    <version>4.0.3</version>
</dependency>

MyBatis基础概念

核心组件

SqlSessionFactory：MyBatis的核心对象，负责创建SqlSession
SqlSession：包含执行SQL命令所需的所有方法
Mapper接口：通过动态代理机制将接口调用转换为SQL执行

配置文件结构

<!-- mybatis-config.xml -->
<configuration>
    <settings>
        <setting name="mapUnderscoreToCamelCase" value="true"/>
    </settings>
    <typeAliases>
        <package name="com.example.model"/>
    </typeAliases>
</configuration>

Spring集成MyBatis的三种方式

4.1 原生集成方式

@Configuration
public class MyBatisConfig {
    
    @Bean
    public DataSource dataSource() {
        HikariDataSource ds = new HikariDataSource();
        ds.setJdbcUrl("jdbc:mysql://localhost:3306/test");
        ds.setUsername("root");
        ds.setPassword("123456");
        return ds;
    }
    
    @Bean
    public SqlSessionFactory sqlSessionFactory() throws Exception {
        SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
        factoryBean.setDataSource(dataSource());
        factoryBean.setConfigLocation(
            new ClassPathResource("mybatis-config.xml"));
        return factoryBean.getObject();
    }
}

4.2 MyBatis-Spring整合包

<!-- 添加Mapper扫描 -->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
    <property name="basePackage" value="com.example.mapper"/>
</bean>

4.3 Spring Boot自动配置

# application.yml
mybatis:
  mapper-locations: classpath:mapper/*.xml
  type-aliases-package: com.example.model
  configuration:
    map-underscore-to-camel-case: true

详细集成步骤

5.1 数据源配置

@Bean
@ConfigurationProperties(prefix = "spring.datasource.hikari")
public DataSource dataSource() {
    return DataSourceBuilder.create().type(HikariDataSource.class).build();
}

5.2 SqlSessionFactory配置

@Bean
public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
    SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
    sessionFactory.setDataSource(dataSource);
    sessionFactory.setTypeAliasesPackage("com.example.model");
    
    // 自定义配置
    org.apache.ibatis.session.Configuration configuration = new Configuration();
    configuration.setMapUnderscoreToCamelCase(true);
    sessionFactory.setConfiguration(configuration);
    
    return sessionFactory.getObject();
}

5.3 Mapper接口扫描

@Configuration
@MapperScan("com.example.mapper")
public class MyBatisConfig {
    // 配置类内容
}

5.4 事务管理

@Configuration
@EnableTransactionManagement
public class TransactionConfig {
    
    @Bean
    public PlatformTransactionManager transactionManager(DataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }
}

高级配置

6.1 多数据源配置

@Primary
@Bean(name = "primaryDataSource")
@ConfigurationProperties(prefix = "spring.datasource.primary")
public DataSource primaryDataSource() {
    return DataSourceBuilder.create().build();
}

@Bean(name = "secondaryDataSource")
@ConfigurationProperties(prefix = "spring.datasource.secondary")
public DataSource secondaryDataSource() {
    return DataSourceBuilder.create().build();
}

@Bean
@Qualifier("primarySqlSessionFactory")
public SqlSessionFactory primarySqlSessionFactory(
    @Qualifier("primaryDataSource") DataSource dataSource) throws Exception {
    // 同单数据源配置
}

6.2 分页插件集成

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

6.3 二级缓存配置

<!-- mapper.xml -->
<cache eviction="LRU" flushInterval="60000" size="512" readOnly="true"/>

最佳实践

Mapper接口规范：
- 保持接口方法单一职责
- 使用@Param注解明确参数名称
- 避免在Service层直接暴露MyBatis API

SQL编写建议：

<select id="selectUserWithRoles" resultMap="userResultMap">
   SELECT u.*, r.role_name 
   FROM user u LEFT JOIN user_role ur ON u.id = ur.user_id
   LEFT JOIN role r ON ur.role_id = r.id
   WHERE u.id = #{userId}
</select>

事务管理原则：
- 在Service层使用@Transactional
- 合理设置事务隔离级别和传播行为
- 避免长事务

常见问题排查

问题1：Mapper接口未注册

现象：Invalid bound statement (not found) 解决方案： 1. 检查@MapperScan配置的包路径 2. 确认mapper.xml文件在classpath下 3. 检查mybatis.mapper-locations配置

问题2：事务不生效

排查步骤： 1. 确认是否启用@EnableTransactionManagement 2. 检查方法是否为public 3. 确认是否发生自调用

问题3：性能问题

优化建议： 1. 启用连接池监控 2. 检查慢SQL 3. 合理使用二级缓存

总结

Spring与MyBatis的集成提供了灵活的数据访问方案，本文详细介绍了： - 三种不同的集成方式及其适用场景 - 从基础到高级的完整配置流程 - 生产环境中的最佳实践 - 常见问题的解决方案

通过合理配置和规范使用，可以构建出高效、可维护的数据访问层。建议根据项目规模选择合适的集成方案，小型项目可采用Spring Boot自动配置，复杂企业应用则推荐使用精细化配置。

本文共计约7200字，涵盖Spring集成MyBatis的核心知识点和实践经验。具体实现时请根据实际项目需求调整配置参数。 “`

注：实际7200字的内容会包含更多细节示例、代码注释、原理分析和案例说明。以上为精简版框架，完整版需要扩展每个章节的详细内容，包括： 1. 更深入的原理解析 2. 完整的配置示例 3. 性能对比数据 4. 安全注意事项 5. 与JPA的对比分析等