基于FeignClient的Controller自動(dòng)生成注入機(jī)制

前言

目前公司后端服務(wù)項(xiàng)目結(jié)構(gòu)為嗅战,xxx-api妄田、xxx-service 其中 api模塊定義了此微服務(wù)模塊對(duì)外暴露的接口,service模塊實(shí)現(xiàn)了api模塊定義的接口并創(chuàng)建了對(duì)應(yīng)供調(diào)用的Controller驮捍。所以實(shí)際來說Controller就是一個(gè)代理類疟呐,用來代理實(shí)現(xiàn)Service模塊真正對(duì)外的HTTP請(qǐng)求響應(yīng)。那么我們是不是可以通過生成Controller代理類然后注入到容器的方式來代替手寫Controller來自動(dòng)實(shí)現(xiàn)這些代理類了东且?

實(shí)現(xiàn)思路

能不能實(shí)現(xiàn)了启具?顯然是可以的,實(shí)現(xiàn)的首要條件是:1)請(qǐng)求規(guī)則如何定義珊泳、2)如何注入Controller到Spring IOC容器中鲁冯,下面我們來一一解答。

請(qǐng)求規(guī)則如何定義色查?

我們?cè)谑褂梦⒎?wù)調(diào)用時(shí)晓褪,實(shí)際都是通過Feign來進(jìn)行實(shí)際使用的,所以請(qǐng)求路徑實(shí)際上來說在基于Feign的接口上都已經(jīng)通過注解標(biāo)明了信息综慎。如:

@FeignClient(value = "user", path = "user") //等同于Controller上的 @RequestMapping("user")
public interface UserService{
    
    @GetMapping("findById") 
    Response<User> findById(@RequestParam("id") Long id);   

}

如何注入Controller到Spring IOC容器中?

這里我們首先要了解Spring MVC的運(yùn)行機(jī)制勤庐,實(shí)際的請(qǐng)求處理是通過DispatcherServlet映射給注冊(cè)到HandlerMapping中的Handler進(jìn)行處理的示惊,這個(gè)時(shí)候我們可以發(fā)現(xiàn)通過注冊(cè)Handler到HandlerMapping 即可實(shí)現(xiàn)這個(gè)注入邏輯了好港。在Spring Boot中默認(rèn)會(huì)注冊(cè)七個(gè)HandlerMapping,我們只需要關(guān)注 RequestMappingHandlerMapping 和 SimpleUrlHandlerMapping米罚,更詳細(xì)的內(nèi)容可自行查看 WebMvcAutoConfiguration 類钧汹。因?yàn)榻涌诙x的關(guān)系這里我們只能通過注冊(cè) Handler 到 RequestMappingHandlerMapping 來實(shí)現(xiàn)注冊(cè)邏輯。

如何注冊(cè) Handler 到 RequestMappingHandlerMapping录择?

這里一個(gè)核心的問題就是Spring MVC默認(rèn)是通過獲取類和方法的注解信息創(chuàng)建 RequestMappingInfo 然后將 RequestMappingInfo拔莱、Handler實(shí)例以及方法注冊(cè)到 HandlerMapping 中,他實(shí)際的過程是全自動(dòng)的隘竭,通過獲取IOC容器中注解了 @Controller 和 @RequestMapping 的Bean塘秦,直接解析然后注冊(cè)進(jìn)去(AbstractHandlerMethodMaping#detectHandlerMethods),我們要通過動(dòng)態(tài)代理生成對(duì)應(yīng)Bean动看,那么就沒有了對(duì)應(yīng)的類層級(jí)的 @RequestMapping 注解了尊剔,所以通過手動(dòng)創(chuàng)建 RequestMappingInfo 然后手動(dòng)調(diào)用方法注冊(cè)的方式進(jìn)行注冊(cè)了(AbstractHandlerMethodMaping#registerHandlerMethod)。

方案

方案1菱皆,手動(dòng)生成信息注冊(cè)的方案:

  1. 生成 RequestMappingInfo 信息
    1. 獲取 @FeignClient 的 path 信息生成 RequestMappingInfo
    2. 獲取 @FeignClient 注解接口的方法注解信息生成 RequestMappingInfo
    3. 合并上列 RequestMappingInfo须误,生成一個(gè)完整的 RequestMappingInfo
  2. 通過 @FeignClient 注解的接口和此接口的實(shí)現(xiàn)類,生成動(dòng)態(tài)代理類
    1. 遍歷實(shí)現(xiàn)類方法和接口方法將其緩存到映射中仇轻,然后生成一個(gè) InvocationHandler 對(duì)象
    2. 通過 Proxy.newProxyInstance 生成代理類
  3. 通過反射調(diào)用 RequestMappingHandlerMapping#registerHandlerMethod 注冊(cè)Handler

方案2京痢,通過繼承 RequestMappingInfoHandlerMapping 的方式來實(shí)現(xiàn):

  1. 覆蓋 isHandler 方法,注解了 @FeignClient 接口的實(shí)現(xiàn)類即為 Handler
  2. 覆蓋 getMappingForMethod 方法篷店,通過 @FeignClient 注解信息和接口中方法對(duì)應(yīng)信息生成 RequestMappingInfo
  3. 將該 HandlerMapping 注冊(cè)到IOC容器中祭椰,此時(shí)就完成了整個(gè)功能了。

這兩個(gè)方案都要注意掃描范圍船庇,不然會(huì)將引入的模塊也生成了Handler吭产。
方案2比較簡(jiǎn)單,花了一點(diǎn)點(diǎn)時(shí)間實(shí)現(xiàn)了方案2鸭轮,目前已應(yīng)用在項(xiàng)目中臣淤,源碼見此地址

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末窃爷,一起剝皮案震驚了整個(gè)濱河市邑蒋,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌按厘,老刑警劉巖医吊,帶你破解...
    沈念sama閱讀 212,454評(píng)論 6 493
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異逮京,居然都是意外死亡卿堂,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,553評(píng)論 3 385
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來草描,“玉大人览绿,你說我怎么就攤上這事∷肽剑” “怎么了饿敲?”我有些...
    開封第一講書人閱讀 157,921評(píng)論 0 348
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)逛绵。 經(jīng)常有香客問我怀各,道長(zhǎng),這世上最難降的妖魔是什么术浪? 我笑而不...
    開封第一講書人閱讀 56,648評(píng)論 1 284
  • 正文 為了忘掉前任瓢对,我火速辦了婚禮,結(jié)果婚禮上添吗,老公的妹妹穿的比我還像新娘沥曹。我一直安慰自己,他們只是感情好碟联,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,770評(píng)論 6 386
  • 文/花漫 我一把揭開白布妓美。 她就那樣靜靜地躺著,像睡著了一般鲤孵。 火紅的嫁衣襯著肌膚如雪壶栋。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,950評(píng)論 1 291
  • 那天普监,我揣著相機(jī)與錄音贵试,去河邊找鬼。 笑死凯正,一個(gè)胖子當(dāng)著我的面吹牛毙玻,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播廊散,決...
    沈念sama閱讀 39,090評(píng)論 3 410
  • 文/蒼蘭香墨 我猛地睜開眼桑滩,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了运准?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,817評(píng)論 0 268
  • 序言:老撾萬榮一對(duì)情侶失蹤缭受,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后米者,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體韭畸,經(jīng)...
    沈念sama閱讀 44,275評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,592評(píng)論 2 327
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了胰丁。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片普筹。...
    茶點(diǎn)故事閱讀 38,724評(píng)論 1 341
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖隘马,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情妻顶,我是刑警寧澤酸员,帶...
    沈念sama閱讀 34,409評(píng)論 4 333
  • 正文 年R本政府宣布,位于F島的核電站讳嘱,受9級(jí)特大地震影響幔嗦,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜沥潭,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 40,052評(píng)論 3 316
  • 文/蒙蒙 一邀泉、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧钝鸽,春花似錦汇恤、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,815評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至颜懊,卻和暖如春财岔,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背河爹。 一陣腳步聲響...
    開封第一講書人閱讀 32,043評(píng)論 1 266
  • 我被黑心中介騙來泰國(guó)打工匠璧, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人咸这。 一個(gè)月前我還...
    沈念sama閱讀 46,503評(píng)論 2 361
  • 正文 我出身青樓夷恍,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親炊苫。 傳聞我的和親對(duì)象是個(gè)殘疾皇子裁厅,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,627評(píng)論 2 350

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