MyBatis中 @Mapper 和 @MapperScan 的区别与使用

在开发基于 Spring Boot 和 MyBatis 的应用时，我们经常会遇到两个非常常用的注解：@Mapper 和 @MapperScan。这两个注解的主要作用是帮助 MyBatis 框架识别和管理 Mapper 接口，然而它们在实际应用中有不同的使用方式和适用场景。

本文将深入解析 @Mapper 和 @MapperScan 的区别与使用方式，帮助大家更好地理解它们的作用，并在实际开发中做出更好的选择。

---

1. @Mapper 注解

@Mapper 是 MyBatis 提供的注解，用来标记 Mapper 接口。它告诉 MyBatis 这个接口是一个 Mapper，MyBatis 将会自动生成对应的实现类，并使其能通过依赖注入被 Spring 管理。

使用方法

在 Mapper 接口上直接加上 @Mapper 注解即可：

import org.apache.ibatis.annotations.Mapper;

@Mapper
public interface UserMapper {
    User findById(int id);
    List<User> findAll();
}

@Mapper 的作用

1. 标记接口：@Mapper 注解标记这个接口是一个 MyBatis 的 Mapper 接口，MyBatis 会自动为这个接口生成代理对象。
2. 交给 Spring 管理：通过 @Mapper，接口将被 Spring 容器扫描并作为 Bean 管理。Spring 会负责将数据源注入到对应的 SQL 会话中，完成 SQL 操作。
3. 简洁明了：每个 Mapper 接口都需要标注 @Mapper 注解，简洁直接。

使用场景

• 如果项目中的 Mapper 接口较少，且不需要批量扫描 Mapper 接口，使用 @Mapper 标注在每个 Mapper 接口上是非常直接和简单的。
• 适用于小型项目或对 Mapper 注册没有特殊要求的情况。

---

2. @MapperScan 注解

@MapperScan 是 Spring 提供的注解，用来批量扫描指定包路径下的所有 Mapper 接口。通过 @MapperScan 注解，Spring 会自动扫描并注册所有符合条件的 Mapper 接口，省去了在每个接口上都添加 @Mapper 注解的麻烦。

使用方法

在 Spring Boot 的主类或者配置类上添加 @MapperScan 注解，指定要扫描的包路径：

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan("com.example.mapper") // 批量扫描包路径下的所有 Mapper 接口
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

@MapperScan 的作用

1. 批量扫描：通过 @MapperScan 指定一个包路径，Spring 会自动扫描该包下的所有 Mapper 接口，并将其注册为 MyBatis 的 Mapper。
2. 简化配置：减少在每个接口上单独添加 @Mapper 注解的繁琐，可以更集中地管理 Mapper 接口。
3. 灵活配置：如果项目有多个 Mapper 包，可以使用多个 @MapperScan 注解指定不同的包路径。

使用场景

• 当项目中有多个 Mapper 接口时，使用 @MapperScan 可以避免每个 Mapper 接口上都加 @Mapper 注解，使代码更加简洁。
• 适用于中大型项目，尤其是在有多个包管理多个 Mapper 接口的情况下，@MapperScan 可以提供更高效的管理方式。

---

3. @Mapper 和 @MapperScan 的对比

特性	@Mapper	@MapperScan
作用范围	标注在单个 Mapper 接口上	批量扫描指定包下的所有 Mapper 接口
使用场景	Mapper 接口较少，或者需要单独控制 Mapper 注册	Mapper 接口较多，想要批量管理
代码简洁性	每个接口需要标注 @Mapper 注解	只需在启动类或配置类上标注一次
灵活性	可以对每个 Mapper 接口进行精细控制	批量扫描，适合大规模 Mapper 管理

---

4. 实际开发中如何选择

• 小型项目或简单场景：如果你的项目中只有少数的 Mapper 接口，并且不涉及复杂的包结构，可以使用 @Mapper 注解在每个 Mapper 接口上，简单直接。

• 中大型项目或复杂场景：如果项目中有大量的 Mapper 接口，并且这些接口分布在多个包中，使用 @MapperScan 会更方便，避免了在每个接口上都添加 @Mapper 注解，也可以更方便地进行包路径的管理和配置。

示例：多个包下的 Mapper 扫描

假设项目中有多个包包含不同的 Mapper 接口：

@MapperScan("com.example.mapper.user")  // 扫描 User 相关的 Mapper
@MapperScan("com.example.mapper.order") // 扫描 Order 相关的 Mapper

这种情况下，你可以分别为不同的模块或领域指定扫描路径，使得项目结构更加清晰。

---

5. 总结

@Mapper 和 @MapperScan 都是 MyBatis 与 Spring Boot 集成时非常重要的注解，它们各有特点和适用场景：

• @Mapper 注解适合 Mapper 接口较少或需要手动管理接口的情况，简单明了，控制粒度高。
• @MapperScan 注解适合 Mapper 接口较多或需要批量扫描接口的情况，简化了配置和管理。

根据项目的复杂度和需求，选择合适的方式来管理你的 Mapper 接口，能提高开发效率并使代码更加简洁。希望本文能够帮助你更好地理解 @Mapper 和 @MapperScan 的使用，提升开发中的代码质量和可维护性。

---

参考资料

• Spring Boot MyBatis 官方文档
• MyBatis 官方文档

---