首页 > 软件编程 > java > Spring Boot 集成 mybatis

Spring Boot 集成 mybatis核心机制

2025-11-26 10:58:48 作者：chxii

这篇文章给大家介绍Spring Boot 集成 mybatis核心机制,本文结合实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧

Spring Boot浅析

Spring Boot 并不是对 Spring 框架的替代，而是对 Spring 的“自动配置”和“快速启动”的封装与增强。

1.依赖管理（Starter POMs）

Spring Boot 提供了一系列 spring-boot-starter-* 依赖，这些 starter 内部已经预定义了常用 Spring 模块（如 Spring Core、Spring Context、Spring Web、Spring Data 等）的兼容版本。

例如：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

这个 starter 自动引入了：

Spring MVC（用于 Web 开发）
Spring Core / Context（IoC 容器）
Jackson（JSON 处理）
Tomcat（内嵌 Web 容器）
其他 Web 相关依赖

这样开发者无需手动管理大量依赖及其版本。

2.自动配置（AutoConfiguration）

Spring Boot 通过 @EnableAutoConfiguration（通常由 @SpringBootApplication 启用）扫描 classpath 中存在的类，自动配置 Spring 应用上下文。

例如：

如果 classpath 中有 DispatcherServlet（来自 Spring Web），Spring Boot 会自动配置一个基于 Spring MVC 的 Web 应用。
如果检测到 HikariCP 和 MySQL 驱动，会自动配置数据源。

这一切都建立在 Spring 的条件化配置（@Conditional）机制之上，是 Spring Framework 本身提供的能力。

3.内嵌容器支持

Spring Boot 内置了 Tomcat、Jetty 或 Undertow，使得 Web 应用可以独立运行（jar 包直接启动），而不需要部署到外部 Servlet 容器。但底层处理 HTTP 请求、路由、拦截器等，依然依赖 Spring MVC。

4.Spring Boot = Spring + 约定优于配置 + 快速启动工具

本质上，Spring Boot 是 Spring 生态的“脚手架”，它让开发者能以最少的配置快速构建生产级应用，但核心功能（IoC、AOP、事务、Web 层等）仍然由 Spring Framework 提供。

对于 Web 应用（尤其是 REST API 或传统 Web 项目），Spring Boot 默认使用 Spring MVC 作为 Web 层框架，因此很多人感觉“Spring Boot = Spring MVC”。
spring-boot-starter-web 默认引入 Spring MVC，并自动配置 DispatcherServlet、视图解析器、消息转换器等，使得 Web 开发极其便捷。

❌ 误解澄清：

Spring Boot 不仅限于 Web 应用。你也可以构建：
命令行应用（无 Web）
消息驱动应用（如集成 Kafka、RabbitMQ）
批处理应用（配合 Spring Batch）
响应式应用（使用 WebFlux 而非 MVC）
在这些场景中，Spring MVC 根本不会被使用。例如：

@SpringBootApplication
public class BatchApplication {
    public static void main(String[] args) {
        SpringApplication.run(BatchApplication.class, args);
    }
}

这个应用可能只用到 Spring Core、Spring Batch，完全不涉及 MVC。

📌 更准确的说法：

Spring Boot 的核心是 Spring Framework，而 Spring MVC 是其在构建 Web 应用时默认采用的 Web 层实现。

核心机制：Starter + AutoConfiguration

1.Starter 依赖（约定优于配置）

Spring Boot 提供了一系列 spring-boot-starter-* 依赖，每个 starter 封装了某个功能领域所需的全部依赖。

例如：

<!-- Web 应用 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- 数据访问（JPA） -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<!-- 安全控制 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-security</artifactId>
</dependency>

这些 starter 内部已经：

引入了对应的 Spring 模块（如 spring-webmvc、spring-data-jpa、spring-security-web）
设置了兼容的版本（通过 spring-boot-dependencies 管理）
包含了自动配置类（位于 META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports）

2.自动配置（AutoConfiguration）

Spring Boot 在启动时（通过 @EnableAutoConfiguration）会扫描所有 starter 中声明的自动配置类，并根据 条件注解（@Conditional...） 决定是否启用。

示例：Spring Data JPA 的自动配置

当你引入 spring-boot-starter-data-jpa 后：

Spring Boot 检测到 classpath 中存在 EntityManager.class 和 DataSource.class
自动配置类 JpaRepositoriesAutoConfiguration 被激活
自动创建 EntityManagerFactory、TransactionManager、JpaRepository 实现等

你只需写：

public interface UserRepository extends JpaRepository<User, Long> {}

无需手动配置数据源、事务、实体管理器等。

条件化配置的关键注解：

@ConditionalOnClass：当 classpath 存在某类时生效
@ConditionalOnMissingBean：当容器中没有某 Bean 时才创建
@ConditionalOnProperty：根据配置属性决定是否启用

常见 Spring 模块集成示例

Spring 模块	Starter 依赖	自动配置效果
Spring MVC	`spring-boot-starter-web`	自动配置 `DispatcherServlet`、内嵌 Tomcat、消息转换器等
Spring Data JPA	`spring-boot-starter-data-jpa`	自动配置数据源、JPA、事务、Repository 实现
Spring Security	`spring-boot-starter-security`	自动启用安全过滤器链，默认登录页面、CSRF 保护等
Spring AOP	`spring-boot-starter-aop`	自动启用基于代理的 AOP（需配合 `@EnableAspectJAutoProxy`，但 Boot 通常自动处理）
Spring Batch	`spring-boot-starter-batch`	自动配置 JobRepository、JobLauncher、数据库 schema 初始化
Spring Cache	`spring-boot-starter-cache`	启用缓存抽象，配合 `@EnableCaching`，可自动集成 Caffeine/Redis/Ehcache
Spring Integration	`spring-boot-starter-integration`	自动配置消息通道、适配器等

自定义集成：如何集成非官方或自研模块？

即使没有官方 starter，也可以手动集成 Spring 模块：

步骤：

引入依赖（如第三方库或自定义 Spring 组件）
编写自动配置类（可选）
在 application.properties 中提供配置项
使用 @Import 或 @ComponentScan 加载配置

示例：手动集成 MyBatis（虽有官方 starter，但演示原理）

@Configuration
@ConditionalOnClass(SqlSessionFactory.class)
@EnableConfigurationProperties(MyBatisProperties.class)
public class MyBatisAutoConfig {
    @Bean
    @ConditionalOnMissingBean
    public SqlSessionFactory sqlSessionFactory(DataSource dataSource) {
        // 手动构建 SqlSessionFactory
    }
}

然后在 resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports 中注册该配置类，即可实现类似 starter 的效果。

手动集成步骤详解（无 starter）

✅ 目标

不使用 mybatis-spring-boot-starter，而是通过手动配置，让 MyBatis 在 Spring Boot 中正常工作。

第 1 步：添加依赖

在 pom.xml 中引入必要依赖（注意：不引入 starter）：

<!-- MyBatis 核心 -->
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.13</version>
</dependency>
<!-- MyBatis 与 Spring 集成桥接 -->
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis-spring</artifactId>
    <version>3.0.3</version>
</dependency>
<!-- 数据库驱动（以 H2 为例） -->
<dependency>
    <groupId>com.h2database</groupId>
    <artifactId>h2</artifactId>
    <scope>runtime</scope>
</dependency>
<!-- Spring Boot JDBC（提供 DataSource 自动配置） -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>

💡 注意：我们只用了 spring-boot-starter-jdbc 来让 Spring Boot 自动配置 DataSource，但没有用 MyBatis 的 starter。

第 2 步：配置数据源（application.yml）

spring:
  datasource:
    url: jdbc:h2:mem:testdb
    driver-class-name: org.h2.Driver
    username: sa
    password: ''

Spring Boot 会自动创建一个 DataSource Bean。

第 3 步：编写 MyBatis 配置类（核心！）

这是手动集成的关键：用 Java Config 替代 XML 配置。

@Configuration
@MapperScan(basePackages = "com.example.demo.mapper") // 扫描 Mapper 接口
public class MyBatisConfig {
    @Bean
    public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
        SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
        factoryBean.setDataSource(dataSource);
        // 可选：设置 MyBatis 全局配置（如驼峰映射）
        org.apache.ibatis.session.Configuration configuration = new org.apache.ibatis.session.Configuration();
        configuration.setMapUnderscoreToCamelCase(true);
        factoryBean.setConfiguration(configuration);
        // 可选：注册 Mapper XML 文件位置
        // factoryBean.setMapperLocations(new PathMatchingResourcePatternResolver()
        //     .getResources("classpath:mapper/*.xml"));
        return factoryBean.getObject();
    }
    @Bean
    public PlatformTransactionManager transactionManager(DataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }
}

关键点解析：

组件	作用
`@MapperScan`	等价于 XML 中的 `<mybatis:scan />`，自动为 `@Mapper` 接口生成代理 Bean
`SqlSessionFactoryBean`	Spring FactoryBean，用于创建 `SqlSessionFactory`
`PlatformTransactionManager`	启用 Spring 管理的事务（配合 `@Transactional`）

⚠️ 注意：SqlSessionFactoryBean 是 FactoryBean<SqlSessionFactory>，调用 .getObject() 才得到真正的 SqlSessionFactory。

第 4 步：编写 Mapper 接口和实体类

// 实体类
public class User {
    private Long id;
    private String name;
    // getter/setter
}
// Mapper 接口
@Mapper // 可省略，因为 @MapperScan 已覆盖
public interface UserMapper {
    @Select("SELECT * FROM user WHERE id = #{id}")
    User findById(Long id);
    @Insert("INSERT INTO user(name) VALUES(#{name})")
    @Options(useGeneratedKeys = true, keyProperty = "id")
    void insert(User user);
}

如果使用 XML 映射文件，需在 SqlSessionFactory 中通过 setMapperLocations() 指定路径。

第 5 步：在 Service 中使用

@Service
public class UserService {
    @Autowired
    private UserMapper userMapper;
    @Transactional
    public void createUser(String name) {
        User user = new User();
        user.setName(name);
        userMapper.insert(user); // 自动生成 ID
        System.out.println("Inserted user ID: " + user.getId());
    }
}

第 6 步：启动类

@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

对比官方 Starter 做了什么？

官方 mybatis-spring-boot-starter 实际上做了以下事情：

引入 mybatis + mybatis-spring
提供 MybatisProperties 类绑定 mybatis.* 配置项（如 mybatis.configuration.map-underscore-to-camel-case=true）
提供自动配置类 MybatisAutoConfiguration，内部逻辑几乎和我们上面写的 MyBatisConfig 一致
自动处理 MapperScannerRegistrar，支持 @MapperScan 或自动扫描带 @Mapper 的接口

所以，手动集成 = 把 starter 的自动配置代码自己写一遍。

到此这篇关于Spring Boot 集成 mybatis核心机制的文章就介绍到这了,更多相关Spring Boot 集成 mybatis内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

Spring Boot 集成 mybatis核心机制

Spring Boot浅析

1.依赖管理（Starter POMs）

2.自动配置（AutoConfiguration）

3.内嵌容器支持

4.Spring Boot = Spring + 约定优于配置 + 快速启动工具

❌ 误解澄清：

📌 更准确的说法：

核心机制：Starter + AutoConfiguration

1.Starter 依赖（约定优于配置）

2.自动配置（AutoConfiguration）

示例：Spring Data JPA 的自动配置

条件化配置的关键注解：

常见 Spring 模块集成示例

自定义集成：如何集成非官方或自研模块？

步骤：

示例：手动集成 MyBatis（虽有官方 starter，但演示原理）

手动集成步骤详解（无 starter）

✅ 目标

第 1 步：添加依赖

第 2 步：配置数据源（application.yml）

第 3 步：编写 MyBatis 配置类（核心！）

关键点解析：

第 4 步：编写 Mapper 接口和实体类

第 5 步：在 Service 中使用

第 6 步：启动类

对比官方 Starter 做了什么？

您可能感兴趣的文章: