Feign核心流程源码分析

Feign是简化Java HTTP客户端开发的工具(java-to-httpclient-binder),它的灵感来自于Retrofit、JAXRS-2.0和WebSocket。Feign的初衷是降低统一绑定Denominator到HTTP API的复杂度。

下来我们通过简单用例来分析工作核心原理以及流程


interface GitHub {
  @RequestLine("GET /repos/{owner}/{repo}/contributors")
  List<Contributor> contributors(@Param("owner") String owner, @Param("repo") String repo);
}
 
static class Contributor {
  String login;
  int contributions;
}
 
public static void main(String... args) {
  GitHub github = Feign.builder()
                       .decoder(new GsonDecoder())
                       .target(GitHub.class, "https://api.github.com");
 
  // 获取贡献者列表,并打印其登录名以及贡献次数
  List<Contributor> contributors = github.contributors("netflix", "feign");
  for (Contributor contributor : contributors) {
    System.out.println(contributor.login + " (" + contributor.contributions + ")");
  }
}

  • ==通过上面样例我们看到首先定义了一个 GitHub接口,然后通过Feign.builder().target()创建了一个GitHub接口的实例。
    那么Feign.builder().target()这里应该就是Feign的核心部分了,接下来我们跟踪源码,查看Feign都为我们做了什么事情==
  1. Feign.builder()创建Builder实例对象
   //1.创建Builder实例对象
   public static Feign.Builder builder() {
        //调用创建Builder构建函数
        return new Feign.Builder();
    }


  //2.Builder构建函数,初始化组件信息,当然我们也可以自定义组件
    public Builder() {
           //日志级别
            this.logLevel = Level.NONE;
            //注解解析组件
            this.contract = new Default();
            //http发送组件
            this.client = new feign.Client.Default((SSLSocketFactory)null, (HostnameVerifier)null);
            //重试机制组件
            this.retryer = new feign.Retryer.Default();
            //日志
            this.logger = new NoOpLogger();
            //编码解码器组件
            this.encoder = new feign.codec.Encoder.Default();
            this.decoder = new feign.codec.Decoder.Default();
            this.errorDecoder = new feign.codec.ErrorDecoder.Default();
            this.options = new Options();
            //默认的反射InvocationHandlerFactory  
            // Feign 使用的jdk自带的动态代理
            this.invocationHandlerFactory = new feign.InvocationHandlerFactory.Default();
        }
        
  1. Builder.target()创建目标实例对象
    //1. 调用target传入目标接口以及请求URL
    public <T> T target(Class<T> apiType, String url) {
       
         return this.target(new HardCodedTarget(apiType, url));
    }

    //2.根据Target包装对象创建目标接口的实例对象
    public <T> T target(Target<T> target) {
            //通过3构建一个Feign对象,然后通过newInstance方法获取目标实例对象
            return this.build().newInstance(target);
    }

    // 3. 构建Feign对象
    public Feign build() {
            //创建方法代理类工厂
            Factory synchronousMethodHandlerFactory = new Factory(this.client, this.retryer, this.requestInterceptors, this.logger, this.logLevel, this.decode404);
            //
            ParseHandlersByName handlersByName = new ParseHandlersByName(this.contract, this.options, this.encoder, this.decoder, this.errorDecoder, synchronousMethodHandlerFactory);
            //这里返回真实的Feign对象
            return new ReflectiveFeign(handlersByName, this.invocationHandlerFactory);
    }
  1. Feign.newInstance()(通过2我们可以看出实际是通过ReflectiveFeign对象的newInstance方法创建)
//1. 这里是创建目录接口实例对象的真正地方
// 这里可以看到是使用了jdk自带的动态代理实现
//可以很清楚的看到返回的是目标接口的代理对象
 public <T> T newInstance(Target<T> target) {
        Map<String, MethodHandler> nameToHandler = this.targetToHandlersByName.apply(target);
        Map<Method, MethodHandler> methodToHandler = new LinkedHashMap();
        List<DefaultMethodHandler> defaultMethodHandlers = new LinkedList();

        InvocationHandler handler = this.factory.create(target, methodToHandler);
        //这里可以看到是使用了jdk自带的动态代理实现的
        //那么我们知道jdk动态代理真正执行的是InvocationHandler接口中的invoke方法,我们再跟踪invoke,看下执行目标接口方法时具体逻辑。
        T proxy = Proxy.newProxyInstance(target.type().getClassLoader(), new Class[]{target.type()}, handler);
        return proxy;
    }
  
    //2. 执行目标接口方法带来具体实现(FeignInvocationHandler)
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
     //在此我们可以看出目标函数除了equals,hashCode,toString方法外都会调用this.dispatch.get(method)).invoke(args)
     //dispatch是目标函数代理类集合,目标接口中每个函数都会对应有一个MethodHandler类,至于怎么得到的有兴趣可以查看源码
            if(!"equals".equals(method.getName())) {
                return "hashCode".equals(method.getName())?Integer.valueOf(this.hashCode()):("toString".equals(method.getName())?this.toString():((MethodHandler)this.dispatch.get(method)).invoke(args));
            } else {
               
            }
        }
  1. 通过3我们看出了目录接口每个函数的执行其实是执行其MethodHandler类的invoke方法那么下来我们看下这里具体逻辑
    MethodHandler默认实现SynchronousMethodHandler
//1. 接口方法执行都会调用其对应的invoke方法
 public Object invoke(Object[] argv) throws Throwable {
        RequestTemplate template = this.buildTemplateFromArgs.create(argv);
        //重试组件
        Retryer retryer = this.retryer.clone();

        while(true) {
            try {
                //执行请求并解码
                return this.executeAndDecode(template);
            } catch (RetryableException var5) {
                retryer.continueOrPropagate(var5);
                if(this.logLevel != Level.NONE) {
                    this.logger.logRetry(this.metadata.configKey(), this.logLevel);
                }
            }
        }
    }
    
    //2 构建request请求并执行和解码
    Object executeAndDecode(RequestTemplate template) throws Throwable {
        //1. 获取request请求
        Request request = this.targetRequest(template);
      
        long start = System.nanoTime();
        Response response;
        try {
           //通过http组件发送请求
            response = this.client.execute(request, this.options);
            response.toBuilder().request(request).build();
        } catch (IOException var15) {
           
        }
        //解码操作调用解码组件进行解码
        //这里省略
        return var9;
    }
   
    //3组装request请求,这里同时完成了拦截器调用的逻辑
     Request targetRequest(RequestTemplate template) {
        //获取当前请求的所有拦截器
        Iterator var2 = this.requestInterceptors.iterator();

        while(var2.hasNext()) {
            RequestInterceptor interceptor = (RequestInterceptor)var2.next();
            //依次调用拦截器进行拦截操作
            interceptor.apply(template);
        }

        //返回Request对象
        return this.target.apply(new RequestTemplate(template));
    }
 

通过上面四步我们可以清晰的看出我们通过定义目标接口是怎么一步一步的完成了http请求发送与接收。
在项目中我们使用Feign是简化我们的http操作,同时我们理解整个http请求响应是怎么通过Feign来完成的。这样后期不管是定制还是问题定位,我们都能快速有效的分析。

后记

本文记录了使用Feign后想了解Feign实现原理然后跟踪源码的一些流程和心得。

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

推荐阅读更多精彩内容