Filter 寫好了,那么就需要配置上去,我們需要的 優(yōu)雅的 功能開關(guān),畢竟不是每個項目都要默認啟用此FIlter。
聽起來最簡單的是,讀取配置,根據(jù)配置項來決定是否注入 某Filter。
遺憾的是,我看到了一個 更裝逼,更優(yōu)雅的方式。
注解。
@UrlParamCheck // 只需要增加這個注解,就可以啟用 UrlParamFilter。反之,不啟用
public class App {
public static void main(String[] args) {
SpringApplication.run(App.class, args);
}
}
現(xiàn)在開始動手實現(xiàn)。
第一步 肯定是 定義注解
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE) // 此注解作用于類 上
@Documented
@Import(UrlParamCheckConfigRegistrar.class)
public @interface UrlParamCheck {
int order() default Ordered.LOWEST_PRECEDENCE;
}
第二步 編寫一個工具類,用于 將一個filter 轉(zhuǎn)換為 一份 Bean聲明,并注冊到 spring bean 聲明的注冊中心去。
@UtilityClass
@Slf4j
public class BeanDefinitionUtils {
/**
* 注冊一個 filter
* @param registry 注冊中心 ,待傳入
* @param order Filter的掛載順序
* @param name spring bean 的名稱,全局唯一
* @param urlPatterns url過濾規(guī)則
* @param filter 待注冊的filter
*/
public static void registerFilter(BeanDefinitionRegistry registry, int order, String name, Collection<String> urlPatterns, Object filter) {
if (registry.containsBeanDefinition(name)) {
log.warn("duplicate beanName, the bean exist in spring IOC,will skip :" + name);
return;
}
BeanDefinition annotationProcessor = BeanDefinitionBuilder
.genericBeanDefinition(FilterRegistrationBean.class)
.addPropertyValue("urlPatterns", urlPatterns)
.addPropertyValue("name", name)
.addPropertyValue("order", order)
.addPropertyValue("filter", filter)
.getBeanDefinition();
registry.registerBeanDefinition(name, annotationProcessor);
}
}
第三步,也是最重要的一步 編寫 一個bean 聲明 注冊器
public class UrlParamCheckConfigRegistrar implements ImportBeanDefinitionRegistrar {
@Override
public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
AnnotationAttributes attributes = AnnotationAttributes //固定寫法,用于后續(xù)獲取 此注解使用時所 定義的屬性的值
.fromMap(importingClassMetadata
.getAnnotationAttributes(UrlParamCheck.class.getName()));
int order = attributes.getNumber("order"); // 通過attributes 可以獲取注解所定義的屬性的值
// 使用鋼材聲明的工具類,將 UrlParamCheckFilter 注冊進spring
BeanDefinitionUtils.registerFilter(registry, order, "urlParamCheckFilter", Collections.singleton("/*"), new UrlParamCheckFilter());
}
}
實現(xiàn)完畢,最核心的就是 通過 注解上的 @Import(UrlParamCheckConfigRegistrar.class) 來引導(dǎo)spring 導(dǎo)入新的注冊器,再通過注冊器,注冊一份新的 bean 聲明,此處聲明的是一個filter bean。其他的bean可以同樣處理。