@AutoConfigurationPackage 和 @ComponentScan 有何區別？

來源：江南一點雨

面試真是越來越捲了，最近又有小夥伴在微信上問到松哥這樣一個面試題，想到這兩個的區別其實還有點意思，因為整一篇文章和小夥伴們捋一捋。

首先，從名字上看，這兩個註解意義特別接近，@AutoConfigurationPackage 就是自動配置包，自動配置包的目的是能讓系統掃描到包內的 Bean；@ComponentScan 則是元件掃描，這個松哥在之前的教程中也多次提到過了，就不再贅述了，所以這裡就有一個問題，這兩個註解有啥區別？

首先大家思考這樣一個問題：

現在大多數專案可能都是用的 MyBatis 或者 MyBatis-Plus 這樣的資料持久化框架，當我們在 Spring Boot 中使用 MyBatis 的時候，我們一般需要在 Mapper 介面上新增一個 @Mapper 註解，類似下面這樣：

@Mapper
public interface UserMapper {
}

或者在啟動類上加 Mapper 掃描註解去統一掃描所有的 Mapper 介面，類似下面這樣：

@SpringBootApplication
@MapperScan(basePackages = "org.javaboy.auto_package")
public class AutoPackageApplication {

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

}

平時我們都這樣寫，沒有任何問題，現在假設我們換一個寫法，假如我的類結構如下：

├── main
│   ├── java
│   │   └── org
│   │       └── javaboy
│   │           └── auto_package
│   │               ├── config
│   │               │   ├── AutoPackageApplication.java
│   │               │   └── UserController.java
│   │               ├── mapper
│   │               │   └── UserMapper.java
│   │               └── service
│   │                   └── UserService.java

小夥伴們看到，我把啟動類和 UserController 放在一個單獨的包中，UserMapper 和 UserService 也分別位於不同的包中，其中在 UserController 中注入了 UserService，在 UserService 中則注入了 UserMapper，大致上就這麼一個關係。

按照我們之前對 Spring Boot 的理解，這個專案啟動肯定會報錯，因為預設情況下，系統掃描的 Bean 是啟動類所在的包以及子包下的所有 Bean（因為 @SpringBootApplication 註解在啟動類上），所以上面這個專案啟動的時候，能掃描到 UserController，但是掃描不到 UserService，所以啟動的時候會報錯，如下：

大家看下，這意思很明確，UserService 找不到，所以啟動失敗。

解決這個問題的辦法很簡單，要麼將啟動類放到根包下面，這樣所有的 Bean 預設就都能掃描到了，要麼我們重新配置包掃描，這裡我採用第二種方案，我們在啟動類上加 @ComponentScan 註解，重新指定掃描的包，如下：

@SpringBootApplication
@ComponentScan(basePackages = "org.javaboy.auto_package")
public class AutoPackageApplication {

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

}

加上之後，我們再次啟動，發現又報錯了，如下：

雖然再次出錯，但是跟之前的錯誤並不一樣，這次是沒找到 UserMapper 這個 Bean，說明 UserService 是找到了！

從這裡我們就可以看出來，@ComponentScan 註解掃描元件是不會掃描到 @Mapper 註解的！

事實上，@ComponentScan 註解主要是掃描 Spring 家族的各種 Bean，如 @Controller、@Service、@Component、@Repository 以及由此衍生出來的一些其他的 Bean，對於 Spring 家族之外的 Bean，如 MyBatis 的 @Mapper、@MapperScan，JPA 的 @Entity 等，@ComponentScan 都掃不到！

誰能掃到呢？那就是我們今天的另外一個主角 @AutoConfigurationPackage，這個註解其實就是專門用來掃這些第三方的各種 Bean 的。

現在，我們在專案啟動上加上 @AutoConfigurationPackage 註解，並設定需要掃描的位置，如下：

@SpringBootApplication
@AutoConfigurationPackage(basePackages = "org.javaboy.auto_package")
@ComponentScan(basePackages = "org.javaboy.auto_package")
public class AutoPackageApplication {

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

}

此時，專案就可以成功啟動了，因為 @AutoConfigurationPackage(basePackages = "org.javaboy.auto_package") 註解可以掃描到 @Mapper 註解。

當然，這裡只是為了給大家演示問題，實際場景下直接在啟動類上加 @MapperScan(basePackages = "org.javaboy.auto_package") 註解就可以了。因為 @MapperScan 註解是 mybatis-spring 提供的，而 @Mapper 是 MyBatis 自己提供的，兩個註解的出處本身就不同。

預設情況下，Spring Boot 專案的啟動註解中，實際上已經包含了 @AutoConfigurationPackage 註解，具體位置在 @SpringBootApplication->@EnableAutoConfiguration->@AutoConfigurationPackage，預設該註解沒有指定 basePackages 屬性，表示使用啟動類所在的包作為根包，掃描該包下的所有第三方 Bean，所以我們平時在 Spring Boot 中使用 MyBatis 的時候，是不需要額外加 @AutoConfigurationPackage 註解的。

經過上面問題的演示，相信小夥伴們已經搞明白了 @AutoConfigurationPackage 和 @ComponentScan 的區別了吧？

小結

總結一下：

1. 兩者都是用來掃描 Bean 的。
2. @ComponentScan 主要用來掃描和 Spring 容器相關的 Bean。
3. @AutoConfigurationPackage 主要用來掃描第三方的 Bean。

僅此而已。