解決Spring Boot 多模組注入訪問不到jar包中的Bean問題
情景描述
一個聚合專案spring-security-tutorial，其中包括4個module，pom如下所示：
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.github.jdkong.security</groupId>
<artifactId>spring-security-tutorial</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>pom</packaging>
<modules>``
<module>security-core</module>
<module>security-app</module>
<module>security-browser</module>
<module>security-demo</module>
</modules>
<!-- 其他部分省略-->
</project>
在此專案中，子專案security-browser是一個簡單的maven專案，打成jar包，供security-demo使用，security-demo專案是一個springboot專案。
問題描述
在security-browser專案中自動注入了一個配置類，如下所示：
/**
* @author jdkong
*/
@Slf4j
@Configuration
public class BrowserSecurityConfig extends WebSecurityConfigurerAdapter {
@Override
protected void configure(HttpSecurity http) throws Exception {
http.formLogin()
.and()
.authorizeRequests()
.anyRequest()
.authenticated();
}
}在security-demo中使用此配置類時，不起作用。
問題分析
導致此類問題的主要原因是，此類不在Spring Boot的元件掃描範圍之內。
1. 關於 Spring Boot 自動注入及元件掃描
在平時使用 Spring Boot 時，常常會使用到@Configuration,@Contoller,@Service,@Component等註解，被新增這些註解的類，在 Spring Boot 啟動時，會自動被 Spring 容器管理起來。
上面提到了，添加了一些註解的類會在Spring Boot 容器啟動時，被載入到Spring 容器中。那麼，元件掃描的作用就是：當 Spring Boot 啟動時，根據定義的掃描路徑，把符合掃描規則的類裝配到spring容器中。
2. Spring Boot 中 @ComponentScan
簡單的介紹了@ComponentScan的基礎作用，這個註解為我們使用提供了一些可自定義配置屬性，先來看看@ComponentScan註解原始碼：
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
@Documented
@Repeatable(ComponentScans.class)
public @interface ComponentScan {
// 指定掃描包的位置(同：basePackages 屬性),可以是單個路徑，也可以是掃描的路徑陣列
@AliasFor("basePackages")
String[] value() default {};
// 指定掃描包的位置(同：value 屬性)
@AliasFor("value")
String[] basePackages() default {};
// 指定具體的掃描的類
Class<?>[] basePackageClasses() default {};
// bean的名稱的生成器
Class<? extends BeanNameGenerator> nameGenerator() default BeanNameGenerator.class;
Class<? extends ScopeMetadataResolver> scopeResolver() default AnnotationScopeMetadataResolver.class;
ScopedProxyMode scopedProxy() default ScopedProxyMode.DEFAULT;
// 控制符合元件檢測條件的類檔案 預設是包掃描下的 **/*.class
String resourcePattern() default "**/*.class";
// 是否開啟對@Component，@Repository，@Service，@Controller的類進行檢測
boolean useDefaultFilters() default true;
// 包含的過濾條件
// 1. FilterType.ANNOTATION： 按照註解過濾
// 2. FilterType.ASSIGNABLE_TYPE： 按照給定的型別
// 3. FilterType.ASPECTJ： 使用ASPECTJ表示式
// 4. FilterType.REGEX： 正則
// 5. FilterType.CUSTOM： 自定義規則
ComponentScan.Filter[] includeFilters() default {};
// 排除的過濾條件，用法和includeFilters一樣
ComponentScan.Filter[] excludeFilters() default {};
boolean lazyInit() default false;
@Retention(RetentionPolicy.RUNTIME)
@Target({})
public @interface Filter {
FilterType type() default FilterType.ANNOTATION;
@AliasFor("classes")
Class<?>[] value() default {};
@AliasFor("value")
Class<?>[] classes() default {};
String[] pattern() default {};
}
}
總結一下@ComponentScan的常用方式如下:
通過使用value，basePackages屬性來指定掃描範圍；
自定掃描路徑下邊帶有@Controller，@Service，@Repository，@Component註解加入Spring容器
通過includeFilters加入掃描路徑下沒有以上註解的類加入spring容器
通過excludeFilters過濾出不用加入spring容器的類
自定義增加了@Component註解的註解方式
3. Spring Boot 中 @SpringBootApplication
在建立Spring Boot 專案之後，在預設的啟動類上會被新增@SpringBootApplication註解，這個註解預設幫我們開啟一些自動配置的功能，比如：基於Java的Spring配置，元件掃描，特別是用於啟用Spring Boot的自動配置功能。
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration // 允許自動配置
@ComponentScan(
excludeFilters = {@Filter( // 定義排除規則
type = FilterType.CUSTOM,// 採用自定義的方式
classes = {TypeExcludeFilter.class} // 自定義實現邏輯
),@Filter( // 同上
type = FilterType.CUSTOM,classes = {AutoConfigurationExcludeFilter.class}
)}
)
public @interface SpringBootApplication {
// 為 @EnableAutoConfiguration 新增 exclude 規則
@AliasFor(
annotation = EnableAutoConfiguration.class,attribute = "exclude"
)
Class<?>[] exclude() default {};
// 為 @EnableAutoConfiguration 新增 excludeName 規則
@AliasFor(
annotation = EnableAutoConfiguration.class,attribute = "excludeName"
)
String[] excludeName() default {};
// 為 @ComponentScan 新增 basePackages 規則
@AliasFor(
annotation = ComponentScan.class,attribute = "basePackages"
)
String[] scanBasePackages() default {};
// 為 @ComponentScan 新增 basePackageClasses 規則
@AliasFor(
annotation = ComponentScan.class,attribute = "basePackageClasses"
)
Class<?>[] scanBasePackageClasses() default {};
}
從上面的原始碼部分可以看到，@SpringBootApplication是一個組合註解，也就相當於使用一個@SpringBootApplication可以替代@SpringBootConfiguration，@EnableAutoConfiguration，@ComponentScan幾個註解聯合使用。
注：此註釋從SpringBoot 1.2開始提供，這意味著如果你執行的是較低的版本，並且如果你需要這些功能，你需要手動新增@Configuration，@CompnentScan和@EnableAutoConfiguration。
那麼，可能會有這樣的問題，我只是使用了一個@SpringBootApplication註解，但是我如何對@ComponentScan的屬性做自定義配置呢？
當然，Spring 團隊已經很好的解決了這個問題，在@SpringBootApplication註解類中的屬性上新增@AliasFor註解，從而實現通過對@SpringBootApplication中的屬性進行自定義，達到對對應的註解的屬性的自定義。
比如:
@AliasFor(
annotation = ComponentScan.class,attribute = "basePackages"
)
String[] scanBasePackages() default {};
這段程式碼就是實現，通過對@SpringBootApplication的屬性scanBasePackages，實現對@ComponentScan中的屬性basePackages進行自定義。
4. 回答開篇問題
先看看專案結構，專案入口檔案在子專案security-demo中，並且入口類所在包位置為：package com.github.jdkong.security。
也就是說，在不做任何配置的情況下，此專案只會掃描當前包路徑及其子路徑下的檔案，並將符合條件的物件注入到容器中管理。
再看看配置檔案所在的包路徑位置：package com.github.jdkong.browser.config，可見此包路徑並不在專案掃描的路徑範圍之內。
這也就導致了，我們定義的配置類，雖然加了@Configuration也不會對我們的專案起到作用。
可以對專案註解進行稍微修改，制定掃描包的範圍，就可以簡單的解決這個問題。如下：
@SpringBootApplication(scanBasePackages="com.github.jdkong")
public class SecurityApplication {
public static void main(String[] args) {
SpringApplication.run(SecurityApplication.class,args);
}
}
5. 補充說明：@AliasFor
在Spring註解中，經常會發現很多註解的不同屬性起著相同的作用，比如@ComponentScan的value屬性和basePackages屬性。所以在使用的時候就需要做一些基本的限制，比如value和basePackages的值不能衝突，比如任意設定value或者設定basePackages屬性的值，都能夠通過另一個屬性來獲取值等等。為了統一處理這些情況，Spring建立了@AliasFor標籤。
以上這篇解決Spring Boot 多模組注入訪問不到jar包中的Bean問題就是小編分享給大家的全部內容了，希望能給大家一個參考，也希望大家多多支援我們。