Feign源码分析—替换(装饰)底层client完成Feign接口的监控

版本信息:

  • springBoot 2.2.6.RELEASE
  • springCloud Hoxton.RELEASE

源码分析

1.1 Feign支持替换OkHttp的做法

1.1.1 代码变动

  • 引入依赖
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- Spring Cloud OpenFeign的Starter的依赖 -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-openfeign</artifactId>
    </dependency>
    <dependency>
        <groupId>io.github.openfeign</groupId>
        <artifactId>feign-okhttp</artifactId>
    </dependency>
</dependencies>
  • 修改配置
feign:
  client:
    defaultToProperties: true
    defaultConfig: myconf
    config:
      myconf:
        connectTimeout: 8000
        readTimeout: 120000
  okhttp:
    enabled: true
  httpclient:
    enabled: false

1.1.2 原理分析

详见此类,当引入feign-okhttp配置后,且存在feign.okhttp.enabled配置时,将初始化该Config类,那么便会加载feignClient的bean。

@Configuration(proxyBeanMethods = false)
@ConditionalOnClass(OkHttpClient.class)
@ConditionalOnProperty("feign.okhttp.enabled")
@Import(OkHttpFeignConfiguration.class)
class OkHttpFeignLoadBalancedConfiguration {

    @Bean
    @ConditionalOnMissingBean(Client.class)
    public Client feignClient(CachingSpringLoadBalancerFactory cachingFactory,
            SpringClientFactory clientFactory, okhttp3.OkHttpClient okHttpClient) {
        OkHttpClient delegate = new OkHttpClient(okHttpClient);
        return new LoadBalancerFeignClient(delegate, cachingFactory, clientFactory);
    }

}

如上述代码所示:首先创建了feign.okhttp.OkHttpClient来装饰okhttp3.OkHttpClient对象(装饰器模式:接口不变,功能增强)然后作为实际的代理client传入了LoadBalancerFeignClient对象中。

故:若装饰底层的client对象,即可自定义实现feignClient

1.2 方案讨论

能否使用Feign提供的拦截器完成监控?

Feign接口提供了RequestInterceptor可拦截请求对象,文章详见——feign调用时使用RequestInterceptor设置request对象

那么若实现监控的逻辑能否写在RequestInterceptor中?

不可以!

理由:监控feign接口的调用情况,需要获取到的参数eureka的serverName、实际ip:port。但如下图所示,无法获取到上述参数。

feign拦截器.png

结论:只能去装饰Client对象完成监控逻辑。

1.3 装饰逻辑实现

1.3.1 自定义feignClient bean

@Configuration
public class FeignSupportConfig {

    @Bean
    public Client feignClient(CachingSpringLoadBalancerFactory cachingFactory,
                              SpringClientFactory clientFactory,okhttp3.OkHttpClient client) {
        
        MyOpenFeignHttpClient delegate = new MyOpenFeignHttpClient(new feign.okhttp.OkHttpClient(client));
        //先执行下面这个Client(MyLoadBalancerFeignClient)的execute -> 后再执行上面一个Client(MyOpenFeignHttpClient)的execute
        return new MyLoadBalancerFeignClient(delegate, cachingFactory, clientFactory);
    }

}

查看结果:

源码位置:feign.SynchronousMethodHandler#executeAndDecode

image.png

可以看到执行的client已经为自定义的MyLoadBalancerFeignClient

1.3.2 获取到serverName并放置到header

需要装饰LoadBalancerFeignClient类,将serverName放置到header中。代码如下面所示:

public class MyLoadBalancerFeignClient extends LoadBalancerFeignClient {

    public MyLoadBalancerFeignClient(Client delegate,
                                     CachingSpringLoadBalancerFactory lbClientFactory,
                                     SpringClientFactory clientFactory) {
        super(delegate, lbClientFactory, clientFactory);
    }

    /**
     * 装饰器模式
     *
     * @param request 不可改变的request对象,故填充header只能重写
     * @param options 配置信息
     * @return
     * @throws IOException
     */
    @Override
    public Response execute(Request request, Request.Options options) throws IOException {
        URI asUri = URI.create(request.url());
        String clientName = asUri.getHost();
        Collection<String> headerValues = new ArrayList<>();
        headerValues.add(clientName);
        Map<String, Collection<String>> safeCopy = new ConcurrentHashMap<>(request.headers());
        safeCopy.put(WPSConstants.FEIGN_METRIC_HEADER_SERVICENAME, headerValues);
        Request newRequest = Request.create(request.httpMethod(),
                request.url(),
                safeCopy,
                request.requestBody());
        return super.execute(newRequest, options);
    }

}

1.3.3 获取ip:port并完成监控逻辑

实际使用的Client对象为OkHttp,而在feignClient中,我们真正传入的为MyOpenFeignHttpClient

public class MyOpenFeignHttpClient implements Client {

    private final OkHttpClient client;


    public MyOpenFeignHttpClient(OkHttpClient client) {
        this.client = client;
    }

    @Override
    public Response execute(Request request, Request.Options options) throws IOException {
        URIBuilder uriBuilder;
        String serviceName = CollectionUtils.isEmpty(request.headers().get(WPSConstants.FEIGN_METRIC_HEADER_SERVICENAME)) ?
                "" : request.headers().get(WPSConstants.FEIGN_METRIC_HEADER_SERVICENAME).iterator().next();
        try {
            uriBuilder = new URIBuilder(request.url());
        } catch (URISyntaxException e) {
            throw new IOException("URL '" + request.url() + "' couldn't be parsed into a URI", e);
        }

        String remoteAddr =
                uriBuilder.getPort() > 0 ? uriBuilder.getHost() + ":" + uriBuilder.getPort() : uriBuilder.getHost();

        int status = 506;  //IOException的特定特殊码
        String path = uriBuilder.getPath();
        Response response;
        OpenFeignMetricsInstance openFeignMetricsInstance = (OpenFeignMetricsInstance) SpringUtils.getBean("openFeignMetricsInstance");
        try {
            //记录api的metric
            final Stopwatch stopwatch = Stopwatch.createStarted();
            //真正执行的逻辑
            response = client.execute(request, options);
            stopwatch.stop();
            status = response.status();
            long time = stopwatch.elapsed(TimeUnit.MILLISECONDS);
            //监控逻辑——记录status以及响应时间
            return response;
        } catch (Exception e) {
            //监控逻辑——记录异常
            throw e;
        } finally {
            //监控逻辑——记录总数
        }
    }

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

推荐阅读更多精彩内容