基于FeignClient的Controller自动生成注入机制

前言

目前公司后端服务项目结构为,xxx-api、xxx-service 其中 api模块定义了此微服务模块对外暴露的接口,service模块实现了api模块定义的接口并创建了对应供调用的Controller。所以实际来说Controller就是一个代理类,用来代理实现Service模块真正对外的HTTP请求响应。那么我们是不是可以通过生成Controller代理类然后注入到容器的方式来代替手写Controller来自动实现这些代理类了?

实现思路

能不能实现了?显然是可以的,实现的首要条件是:1)请求规则如何定义、2)如何注入Controller到Spring IOC容器中,下面我们来一一解答。

请求规则如何定义?

我们在使用微服务调用时,实际都是通过Feign来进行实际使用的,所以请求路径实际上来说在基于Feign的接口上都已经通过注解标明了信息。如:

@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的运行机制,实际的请求处理是通过DispatcherServlet映射给注册到HandlerMapping中的Handler进行处理的,这个时候我们可以发现通过注册Handler到HandlerMapping 即可实现这个注入逻辑了。在Spring Boot中默认会注册七个HandlerMapping,我们只需要关注 RequestMappingHandlerMapping 和 SimpleUrlHandlerMapping,更详细的内容可自行查看 WebMvcAutoConfiguration 类。因为接口定义的关系这里我们只能通过注册 Handler 到 RequestMappingHandlerMapping 来实现注册逻辑。

如何注册 Handler 到 RequestMappingHandlerMapping?

这里一个核心的问题就是Spring MVC默认是通过获取类和方法的注解信息创建 RequestMappingInfo 然后将 RequestMappingInfo、Handler实例以及方法注册到 HandlerMapping 中,他实际的过程是全自动的,通过获取IOC容器中注解了 @Controller 和 @RequestMapping 的Bean,直接解析然后注册进去(AbstractHandlerMethodMaping#detectHandlerMethods),我们要通过动态代理生成对应Bean,那么就没有了对应的类层级的 @RequestMapping 注解了,所以通过手动创建 RequestMappingInfo 然后手动调用方法注册的方式进行注册了(AbstractHandlerMethodMaping#registerHandlerMethod)。

方案

方案1,手动生成信息注册的方案:

  1. 生成 RequestMappingInfo 信息
    1. 获取 @FeignClient 的 path 信息生成 RequestMappingInfo
    2. 获取 @FeignClient 注解接口的方法注解信息生成 RequestMappingInfo
    3. 合并上列 RequestMappingInfo,生成一个完整的 RequestMappingInfo
  2. 通过 @FeignClient 注解的接口和此接口的实现类,生成动态代理类
    1. 遍历实现类方法和接口方法将其缓存到映射中,然后生成一个 InvocationHandler 对象
    2. 通过 Proxy.newProxyInstance 生成代理类
  3. 通过反射调用 RequestMappingHandlerMapping#registerHandlerMethod 注册Handler

方案2,通过继承 RequestMappingInfoHandlerMapping 的方式来实现:

  1. 覆盖 isHandler 方法,注解了 @FeignClient 接口的实现类即为 Handler
  2. 覆盖 getMappingForMethod 方法,通过 @FeignClient 注解信息和接口中方法对应信息生成 RequestMappingInfo
  3. 将该 HandlerMapping 注册到IOC容器中,此时就完成了整个功能了。

这两个方案都要注意扫描范围,不然会将引入的模块也生成了Handler。
方案2比较简单,花了一点点时间实现了方案2,目前已应用在项目中,源码见此地址

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,504评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,434评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,089评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,378评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,472评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,506评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,519评论 3 413
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,292评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,738评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,022评论 2 329
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,194评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,873评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,536评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,162评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,413评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,075评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,080评论 2 352

推荐阅读更多精彩内容