摘要:在 Spring 和 MyBatis 集成开发中,@ComponentScan 和 @MapperScan 是两个核心注解,但它们的用途和工作机制截然不同。本文将通过通俗的语言和示例代码,带您轻松掌握它们的区别和使用方法。
在 Spring 和 MyBatis 集成开发中,@ComponentScan 和 @MapperScan 是两个核心注解,但它们的用途和工作机制截然不同。本文将通过通俗的语言和示例代码,带您轻松掌握它们的区别和使用方法。
1.@ComponentScan:Spring 的“通用扫描仪”
作用:扫描并注册 Spring 容器中的组件(如 @Service、@Repository、@Controller 等注解标注的类)。
特点:
默认扫描主类所在包及其子包。
无需额外配置即可自动装配通用组件。
无法直接处理 MyBatis 的 Mapper 接口(需要配合 @MapperScan)。
2. @MapperScan:MyBatis 的“专用扫描仪”
作用:扫描并注册 MyBatis 的 Mapper 接口(即数据库操作接口),将其转换为 Spring Bean。
特点:
需要显式配置扫描路径。
通过动态代理生成 Mapper 接口的实现类。
与 @Mapper 注解配合使用(可选)。
场景:管理通用 Spring 组件(如 Service、Repository)
示例代码:
// 主类(默认扫描当前包及子包)@SpringBootApplicationpublic class Application {public static void main(String args) {SpringApplication.run(Application.class, args);}}// Service 层@Servicepublic class UserService {public String getUser {return "User from Service";}}// Repository 层@Repositorypublic class UserRepository {public String getUser {return "User from Repository";}}自定义扫描路径:
@SpringBootApplication@ComponentScan(basePackages = {"com.example.service", "com.example.repository"})public class Application {// ...}2. @MapperScan 的使用
场景:管理 MyBatis 的 Mapper 接口
示例代码:
// 主类配置@SpringBootApplication@MapperScan("com.example.mapper") // 指定 Mapper 接口扫描路径public class Application {public static void main(String args) {SpringApplication.run(Application.class, args);}}// Mapper 接口@Mapper // 可选,如果 @MapperScan 已指定路径,则无需在此添加public interface UserMapper {@Select("SELECT * FROM users")List findAll;}替代方案:在配置类中使用:
@Configuration@MapperScan("com.example.mapper") // 配置类中同样有效public class MyBatisConfig {// 可配置 MyBatis 相关 Bean(如拦截器)}原因:@ComponentScan 只负责注册 Bean,但 MyBatis 的 Mapper 接口需要动态代理生成实现类。如果仅依赖 @ComponentScan,调用时会抛出异常。
解决方法:必须使用 @MapperScan 或在每个 Mapper 接口上添加 @Mapper 注解。
2. @MapperScan 和 @ComponentScan 能同时使用吗?
答案:可以,但需注意扫描路径冲突。
Mapper 接口:始终使用 @MapperScan 配置扫描路径,避免在每个接口上添加 @Mapper。
通用组件:依赖 @SpringBootApplication 内置的 @ComponentScan,或显式扩展扫描路径。
2. 错误示例与修正
错误示例:
// 仅使用 @ComponentScan 扫描 Mapper 接口(不可行)@SpringBootApplication@ComponentScan("com.example.mapper")public class Application {// ...}修正方法:// 正确方式:使用 @MapperScan@SpringBootApplication@MapperScan("com.example.mapper")public class Application {// ...}@ComponentScan关键点:管理通用 Spring 组件(Service、Repository 等) 默认启用,无需额外配置
@MapperScan关键点:管理 MyBatis 的 Mapper 接口 必须显式配置扫描路径,支持动态代理生成
通过合理使用 @ComponentScan 和 @MapperScan,您可以高效管理 Spring 和 MyBatis 的组件,简化代码结构并提高开发效率。记住:Mapper 接口需要专用扫描仪(@MapperScan),而通用组件交给通用扫描仪(@ComponentScan)!
来源:晋城教育