前言
目前公司后端服務(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è)的方案:
- 生成 RequestMappingInfo 信息
- 獲取 @FeignClient 的 path 信息生成 RequestMappingInfo
- 獲取 @FeignClient 注解接口的方法注解信息生成 RequestMappingInfo
- 合并上列 RequestMappingInfo须误,生成一個(gè)完整的 RequestMappingInfo
- 通過 @FeignClient 注解的接口和此接口的實(shí)現(xiàn)類,生成動(dòng)態(tài)代理類
- 遍歷實(shí)現(xiàn)類方法和接口方法將其緩存到映射中仇轻,然后生成一個(gè) InvocationHandler 對(duì)象
- 通過 Proxy.newProxyInstance 生成代理類
- 通過反射調(diào)用 RequestMappingHandlerMapping#registerHandlerMethod 注冊(cè)Handler
方案2京痢,通過繼承 RequestMappingInfoHandlerMapping 的方式來實(shí)現(xiàn):
- 覆蓋 isHandler 方法,注解了 @FeignClient 接口的實(shí)現(xiàn)類即為 Handler
- 覆蓋 getMappingForMethod 方法篷店,通過 @FeignClient 注解信息和接口中方法對(duì)應(yīng)信息生成 RequestMappingInfo
- 將該 HandlerMapping 注冊(cè)到IOC容器中祭椰,此時(shí)就完成了整個(gè)功能了。
這兩個(gè)方案都要注意掃描范圍船庇,不然會(huì)將引入的模塊也生成了Handler吭产。
方案2比較簡(jiǎn)單,花了一點(diǎn)點(diǎn)時(shí)間實(shí)現(xiàn)了方案2鸭轮,目前已應(yīng)用在項(xiàng)目中臣淤,源碼見此地址。