Filter 寫好了胚想,那么就需要配置上去琐凭,我們需要的 優(yōu)雅的 功能開關(guān),畢竟不是每個(gè)項(xiàng)目都要默認(rèn)啟用此FIlter浊服。
聽起來(lái)最簡(jiǎn)單的是统屈,讀取配置,根據(jù)配置項(xiàng)來(lái)決定是否注入 某Filter牙躺。
遺憾的是愁憔,我看到了一個(gè) 更裝逼,更優(yōu)雅的方式孽拷。
注解吨掌。
@UrlParamCheck // 只需要增加這個(gè)注解,就可以啟用 UrlParamFilter脓恕。反之思犁,不啟用
public class App {
public static void main(String[] args) {
SpringApplication.run(App.class, args);
}
}
現(xiàn)在開始動(dòng)手實(shí)現(xiàn)。
第一步 肯定是 定義注解
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE) // 此注解作用于類 上
@Documented
@Import(UrlParamCheckConfigRegistrar.class)
public @interface UrlParamCheck {
int order() default Ordered.LOWEST_PRECEDENCE;
}
第二步 編寫一個(gè)工具類进肯,用于 將一個(gè)filter 轉(zhuǎn)換為 一份 Bean聲明,并注冊(cè)到 spring bean 聲明的注冊(cè)中心去棉磨。
@UtilityClass
@Slf4j
public class BeanDefinitionUtils {
/**
* 注冊(cè)一個(gè) filter
* @param registry 注冊(cè)中心 江掩,待傳入
* @param order Filter的掛載順序
* @param name spring bean 的名稱,全局唯一
* @param urlPatterns url過(guò)濾規(guī)則
* @param filter 待注冊(cè)的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);
}
}
第三步乘瓤,也是最重要的一步 編寫 一個(gè)bean 聲明 注冊(cè)器
public class UrlParamCheckConfigRegistrar implements ImportBeanDefinitionRegistrar {
@Override
public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
AnnotationAttributes attributes = AnnotationAttributes //固定寫法环形,用于后續(xù)獲取 此注解使用時(shí)所 定義的屬性的值
.fromMap(importingClassMetadata
.getAnnotationAttributes(UrlParamCheck.class.getName()));
int order = attributes.getNumber("order"); // 通過(guò)attributes 可以獲取注解所定義的屬性的值
// 使用鋼材聲明的工具類,將 UrlParamCheckFilter 注冊(cè)進(jìn)spring
BeanDefinitionUtils.registerFilter(registry, order, "urlParamCheckFilter", Collections.singleton("/*"), new UrlParamCheckFilter());
}
}
實(shí)現(xiàn)完畢衙傀,最核心的就是 通過(guò) 注解上的 @Import(UrlParamCheckConfigRegistrar.class) 來(lái)引導(dǎo)spring 導(dǎo)入新的注冊(cè)器抬吟,再通過(guò)注冊(cè)器,注冊(cè)一份新的 bean 聲明统抬,此處聲明的是一個(gè)filter bean火本。其他的bean可以同樣處理。