API-Server構(gòu)建指南(2)-使用注解作為功能開關(guān)

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可以同樣處理。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末聪建,一起剝皮案震驚了整個(gè)濱河市钙畔,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌金麸,老刑警劉巖擎析,帶你破解...
    沈念sama閱讀 216,692評(píng)論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異挥下,居然都是意外死亡揍魂,警方通過(guò)查閱死者的電腦和手機(jī)桨醋,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,482評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)现斋,“玉大人喜最,你說(shuō)我怎么就攤上這事〔皆穑” “怎么了返顺?”我有些...
    開封第一講書人閱讀 162,995評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)蔓肯。 經(jīng)常有香客問(wèn)我遂鹊,道長(zhǎng),這世上最難降的妖魔是什么蔗包? 我笑而不...
    開封第一講書人閱讀 58,223評(píng)論 1 292
  • 正文 為了忘掉前任秉扑,我火速辦了婚禮,結(jié)果婚禮上调限,老公的妹妹穿的比我還像新娘舟陆。我一直安慰自己,他們只是感情好耻矮,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,245評(píng)論 6 388
  • 文/花漫 我一把揭開白布秦躯。 她就那樣靜靜地躺著,像睡著了一般裆装。 火紅的嫁衣襯著肌膚如雪踱承。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,208評(píng)論 1 299
  • 那天哨免,我揣著相機(jī)與錄音茎活,去河邊找鬼。 笑死琢唾,一個(gè)胖子當(dāng)著我的面吹牛载荔,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播采桃,決...
    沈念sama閱讀 40,091評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼懒熙,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了普办?” 一聲冷哼從身側(cè)響起煌珊,我...
    開封第一講書人閱讀 38,929評(píng)論 0 274
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎泌豆,沒(méi)想到半個(gè)月后定庵,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,346評(píng)論 1 311
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,570評(píng)論 2 333
  • 正文 我和宋清朗相戀三年蔬浙,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了猪落。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,739評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡畴博,死狀恐怖笨忌,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情俱病,我是刑警寧澤官疲,帶...
    沈念sama閱讀 35,437評(píng)論 5 344
  • 正文 年R本政府宣布,位于F島的核電站亮隙,受9級(jí)特大地震影響途凫,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜溢吻,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,037評(píng)論 3 326
  • 文/蒙蒙 一维费、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧促王,春花似錦犀盟、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,677評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至迅耘,卻和暖如春贱枣,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背豹障。 一陣腳步聲響...
    開封第一講書人閱讀 32,833評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留焦匈,地道東北人血公。 一個(gè)月前我還...
    沈念sama閱讀 47,760評(píng)論 2 369
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像缓熟,于是被迫代替她去往敵國(guó)和親累魔。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,647評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容