SpringBoot中TypeExcludeFilter的作用及使用方式
SpringBoot中TypeExcludeFilter的作用及使用
在Spring Boot應(yīng)用程序中，TypeExcludeFilter 是一個用于過濾特定類型的組件，使之不被Spring容器自動掃描和注冊為bean的工具。
這在你想要排除某些類或類型（如配置類、組件等）而不希望它們參與Spring的自動裝配時非常有用。
作用
通常情況下，Spring Boot應(yīng)用會通過包掃描的方式自動識別并加載帶有@Component, @Service, @Repository, 或者@Configuration等注解的類。
然而，在一些場景下，我們可能不希望某些特定的類被自動加載，例如測試環(huán)境中的特殊實現(xiàn)，或者是為了優(yōu)化啟動速度而排除不必要的組件。
此時，TypeExcludeFilter就派上用場了，它允許開發(fā)者根據(jù)類型來排除這些不需要的組件。
使用示例
假設(shè)我們有一個項目結(jié)構(gòu)如下：
com.example ├── config │ └── AppConfig.java └── service │ ├── HelloService.java │ └── WorldService.java └── MyApplication.java
這兩個 Service 默認(rèn)都會被 SpringBootApplication 自動掃描。
我們可以利用TypeExcludeFilter來確保MockService不會在非測試環(huán)境中被加載。
首先，我們需要創(chuàng)建一個自定義的過濾器，該過濾器繼承自TypeExcludeFilter并重寫matches方法來指定哪些類型應(yīng)該被排除。
請注意：
- 我們繼承
TypeExcludeFilter并重寫方法而不是直接實現(xiàn)TypeFilter接口中的matches方法。 - 這是因為
TypeExcludeFilter是@SpringBootApplication注解自動掃描時候已經(jīng)默認(rèn)配置的過濾器類
如下是源碼片段：
@ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
...
}編寫自定義過濾器
創(chuàng)建自定義過濾器類，繼承 TypeExcludeFilter 并重寫 match 方法：
package com.example.filter;
import org.springframework.context.annotation.TypeExcludeFilter;
import org.springframework.core.type.classreading.MetadataReader;
import org.springframework.core.type.classreading.MetadataReaderFactory;
public class MyTypeExcludeFilter extends TypeExcludeFilter {
@Override
public boolean match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory) throws IOException {
String className = metadataReader.getClassMetadata().getClassName();
// 根據(jù)需要設(shè)置排除邏輯，例如這里排除特定類。比如你還可以排除所有 Test開頭、Demo開頭這樣的類。
return className.startsWith("com.example.service.HelloService");
}
}注冊自定義過濾器
為了確保我們的自定義過濾器能夠在應(yīng)用啟動時生效，我們需要創(chuàng)建一個實現(xiàn)了ApplicationContextInitializer接口的類，并在此類中注冊我們的過濾器。
package com.example.initializer;
import com.example.filter.MyTypeExcludeFilter;
import org.springframework.context.ApplicationContextInitializer;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.annotation.ClassPathBeanDefinitionScanner;
import org.springframework.core.type.filter.TypeFilter;
public class MyTypeExcludeFilterInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
@Override
public void initialize(@NonNull ConfigurableApplicationContext applicationContext) {
applicationContext.getBeanFactory().registerSingleton("myTypeExcludeFilter", new MyTypeExcludeFilter());
}
}配置 spring.factories
最后一步是在META-INF/spring.factories文件中注冊我們的ApplicationContextInitializer，這樣它就可以在應(yīng)用啟動時被自動加載：
org.springframework.context.ApplicationContextInitializer=\ com.example.initializer.MyTypeExcludeFilterInitializer
這行配置告訴Spring Boot，在應(yīng)用啟動時，應(yīng)該查找并初始化MyTypeExcludeFilterInitializer。
之所以需要在 spring.factories 中進(jìn)行配置，是因為我們需要在 @ComponentScan 注解執(zhí)行之前就將我們的自定義過濾器類注冊到 spring 上下文中，否則自定義的類就沒用了。
總結(jié)
通過上述步驟，我們成功地將TypeExcludeFilter集成到了Spring Boot應(yīng)用中，并且不需要顯式地編寫@ComponentScan注解或修改任何現(xiàn)有的配置。
這種方式不僅簡化了代碼結(jié)構(gòu)，也使得我們可以更加靈活地控制哪些類型的組件應(yīng)該被排除在外。
以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
- 如何解決springboot啟動的時候required a bean of type 'XXX' not be問題
- SpringBoot中MyBatis使用自定義TypeHandler的實現(xiàn)
- SpringBoot3.1.2 引入Swagger報錯Type javax.servlet.http.HttpServletRequest not present解決辦法
- SpringBoot升級3.2報錯Invalid value type for attribute ‘factoryBeanObjectType‘: java.lang.String的解決方案
- 解決springboot+thymeleaf視圖映射報錯There?was?an?unexpected?error?(type=Not?Found,?status=404)
相關(guān)文章
Java語法基礎(chǔ)之選擇結(jié)構(gòu)的if語句、switch語句詳解
這篇文章主要為大詳細(xì)介紹了Java語法基礎(chǔ)之選擇結(jié)構(gòu)的if語句、switch語句，感興趣的小伙伴們可以參考一下2016-09-09
在Java當(dāng)中synchronized關(guān)鍵字通常是用來標(biāo)記一個方法或者代碼塊。本文將通過示例為大家詳細(xì)介紹一下Synchronized的各種使用方法，需要的可以參考一下2022-08-08
這篇文章主要介紹了Spring Boot Logback配置日志過程解析,文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2019-10-10
Feign可以幫助我們定義和實現(xiàn)服務(wù)之間的 RESTful 接口,使得服務(wù)之間的調(diào)用更加方便和可靠,本文主要介紹了SpringBoot中@FeignClient 注解的作用,感興趣的可以了解一下2024-06-06
這篇文章主要為大家詳細(xì)介紹了javaweb圖書商城設(shè)計之購物車模塊的相關(guān)資料,具有一定的參考價值，感興趣的小伙伴們可以參考一下2016-11-11
在IDEA中查看某個分支的新增和修改代碼,可以通過切換分支、點擊Git分支名、找到master分支并右鍵選擇Compare with來實現(xiàn),在彈出的窗口中,可以查看新增、修改和刪除的文件,并雙擊文件查看具體的代碼對比2026-02-02
這篇文章主要介紹了Spring Bean如何實現(xiàn)自動配置代碼實例,文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2020-09-09
這篇文章主要為大家詳細(xì)介紹了如何基于Java編寫一個emoji表情處理工具類,文中的示例代碼講解詳細(xì),感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2024-03-03
java自定義切面增強(qiáng)方式(關(guān)于自定義注解aop)
這篇文章主要介紹了java自定義切面增強(qiáng)方式(關(guān)于自定義注解aop)，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-04-04
這篇文章主要介紹了Java使用Condition控制線程通信的方法,結(jié)合實例形式分析了使用Condition類同步檢測控制線程通信的相關(guān)操作技巧,需要的朋友可以參考下2019-09-09