Ribbon源码解析

尚品网 陈博,宾俊杰 唐龙,河南ktv命案

在上篇文章ribbon架构剖析中，我们已经介绍了ribbon的架构组成以及很多重要的对象，相信你已经对ribbon已经有一个清晰的认识了。本篇文章则研究一下ribbon的原理

首先我们知道，在普通项目中ribbon的使用是这样的

@springbootapplication
@ribbonclient(name = "provider-demo", configuration = cn.org.config.loadbalanced.class)
public class clouddemoconsumerapplication {
    @bean
    @loadbalanced
    public resttemplate resttemplate(){
        return new resttemplate();
    }
    public static void main(string[] args) {
        springapplication.run(clouddemoconsumerapplication.class, args);
    }
}

这里面最引人瞩目的就是注解@ribbonclient了，看一下这个注解都是做了什么吧

@ribbonclient

观察@ribbonclient的源码可知，这个注解使用@import注解引入了配置类ribbonclientconfigurationregistrar，看一下这个类的registerbeandefinitions方法

public void registerbeandefinitions(annotationmetadata metadata,
            beandefinitionregistry registry) {
        map<string, object> attrs = metadata.getannotationattributes(
                ribbonclients.class.getname(), true);
        if (attrs != null && attrs.containskey("value")) {
            annotationattributes[] clients = (annotationattributes[]) attrs.get("value");
            for (annotationattributes client : clients) {
                registerclientconfiguration(registry, getclientname(client),
                        client.get("configuration"));
            }
        }
        if (attrs != null && attrs.containskey("defaultconfiguration")) {
            string name;
            if (metadata.hasenclosingclass()) {
                name = "default." + metadata.getenclosingclassname();
            } else {
                name = "default." + metadata.getclassname();
            }
            registerclientconfiguration(registry, name,
                    attrs.get("defaultconfiguration"));
        }
        map<string, object> client = metadata.getannotationattributes(
                ribbonclient.class.getname(), true);
        string name = getclientname(client);
        if (name != null) {
            registerclientconfiguration(registry, name, client.get("configuration"));
        }
    }

1. 首先会判断是否存在注解@ribbonclients，注意，这里可是多了一个s的
2. 然后判断@ribbonclients注解上是否存在属性value和defaultconfiguration，如果存在的话分别注册他们
3. 接着最后才是处理@ribbonclient注解
4. 这里我们就可以猜测ribbonclientconfigurationregistrar这个类应该是可以同时处理这两个注解的，观察一下@ribbonclients注解的源码发现它确实是引入的也是这个类
5. 这两个注解的区别应该也可以猜测出来，单数和双数
6. 观察最后注册的代码，可以看到最后注册bean的类型都是ribbonclientspecification，这里留意一下

    private void registerclientconfiguration(beandefinitionregistry registry,
            object name, object configuration) {
        beandefinitionbuilder builder = beandefinitionbuilder
                .genericbeandefinition(ribbonclientspecification.class);
        builder.addconstructorargvalue(name);
        builder.addconstructorargvalue(configuration);
        registry.registerbeandefinition(name + ".ribbonclientspecification",
                builder.getbeandefinition());
    }

自动装配

上方看完这些代码之后，我们了解了@ribbonclients和@ribbonclient两个注解，可以对整体的流程还是有些疑惑。那么接下来就看看自动装配都是做了什么吧

查看ribbon包下的spring.factories文件，发现引入了一个配置类ribbonautoconfiguration，那么从这个类开始看起吧

先决条件

1. @conditionalonclass，当前环境必须存在这几个类： iclient, resttemplate, asyncresttemplate, ribbon
2. @ribbonclients，这个注解刚才已经讲过了，暂且不提
3. @autoconfigureafter，负载均衡肯定是要基于注册中心来做的，所以自动装配是在eureka初始化完毕之后初始化的
4. @autoconfigurebefore，这里的两个类先不说，保持神秘
5. @enableconfigurationproperties，两个配置类，其中：
   1. ribboneagerloadproperties类中是关于ribbon的饥饿加载模式的属性
   2. serverintrospectorproperties类中是关于安全端口的属性

装配bean

这个配置类加载的类挺多的，但是比较重要的有这几个：

1. springclientfactory，我们知道每一个微服务在都会调用多个微服务，而调用各个微服务的配置可能是不一样的，所以就需要这个创建客户端负载均衡器的工厂类，它可以为每一个ribbon客户端生成不同的spring上下文，而观察这个类的configurations属性也验证了这一点

@autowired(required = false)
    private list<ribbonclientspecification> configurations = new arraylist<>();
    @bean
    public springclientfactory springclientfactory() {
        springclientfactory factory = new springclientfactory();
        factory.setconfigurations(this.configurations);
        return factory;
    }

1. ribbonloadbalancerclient,持有springclientfactory对象，当然，它还有其他的功能，这里暂且不提

负载均衡

上方虽然看了ribbon的自动装配功能，但是好像离真相还有一些距离，这是因为虽然ribbon准备好了，但是负载均衡还没看呢。springcloud把负载均衡相关的自动配置放在了spring-cloud-commons包下
负载均衡的配置类是loadbalancerautoconfiguration

这个类里注册的几个bean就比较核心了

loadbalancerinterceptor

客户端请求拦截器

resttemplatecustomizer

用于给所有的resttemplate增加拦截器

@bean
        @conditionalonmissingbean
        public resttemplatecustomizer resttemplatecustomizer(
                final loadbalancerinterceptor loadbalancerinterceptor) {
            return resttemplate -> {
                list<clienthttprequestinterceptor> list = new arraylist<>(
                        resttemplate.getinterceptors());
                list.add(loadbalancerinterceptor);
                resttemplate.setinterceptors(list);
            };
        }

负载均衡核心实现

现在我们就可以猜测，整个核心应该就是在这个拦截器上了，看一看拦截器的核心方法：

    public clienthttpresponse intercept(final httprequest request, final byte[] body,
            final clienthttprequestexecution execution) throws ioexception {
        final uri originaluri = request.geturi();
        string servicename = originaluri.gethost();
        assert.state(servicename != null, "request uri does not contain a valid hostname: " + originaluri);
        return this.loadbalancer.execute(servicename, requestfactory.createrequest(request, body, execution));
    }

其中requestfactory.createrequest(request, body, execution)方法是为了把请求参数封装为request
重点关注execute方法

    public <t> t execute(string serviceid, loadbalancerrequest<t> request) throws ioexception {
        iloadbalancer loadbalancer = getloadbalancer(serviceid);
        server server = getserver(loadbalancer);
        if (server == null) {
            throw new illegalstateexception("no instances available for " + serviceid);
        }
        ribbonserver ribbonserver = new ribbonserver(serviceid, server, issecure(server,
                serviceid), serverintrospector(serviceid).getmetadata(server));

        return execute(serviceid, ribbonserver, request);
    }

创建负载均衡器

我们知道，每个ribbon客户端的负载均衡器都是唯一的，第一行getloadbalancer就会去创建这个负载均衡器

   protected iloadbalancer getloadbalancer(string serviceid) {
        return this.clientfactory.getloadbalancer(serviceid);
    }
   public iloadbalancer getloadbalancer(string name) {
        return getinstance(name, iloadbalancer.class);
    }
    public <c> c getinstance(string name, class<c> type) {
        c instance = super.getinstance(name, type);
        if (instance != null) {
            return instance;
        }
        iclientconfig config = getinstance(name, iclientconfig.class);
        return instantiatewithconfig(getcontext(name), type, config);
    }

最后的逻辑是如果存在缓存则从缓存中获取，如果不存在创建

static <c> c instantiatewithconfig(annotationconfigapplicationcontext context,
                                        class<c> clazz, iclientconfig config) {
        c result = null;
        
        try {
            constructor<c> constructor = clazz.getconstructor(iclientconfig.class);
            result = constructor.newinstance(config);
        } catch (throwable e) {
            // ignored
        }
        
        if (result == null) {
            result = beanutils.instantiate(clazz);
            
            if (result instanceof iclientconfigaware) {
                ((iclientconfigaware) result).initwithniwsconfig(config);
            }
            
            if (context != null) {
                context.getautowirecapablebeanfactory().autowirebean(result);
            }
        }
        
        return result;
    }

创建的大题流程则就是通过文章开始提到的两个注解注册的几个ribbonclientspecification类型的配置来创建

获取服务

getserver方法的实现应该可以猜出来，使用具体的负载均衡器结合相应的负载均衡算法再加上服务列表过滤、服务健康检测等操作最后会获取的一个可用服务

调用服务

这里在调用之前把服务封装成了ribbonserver

        private final string serviceid;
        private final server server;
        private final boolean secure;
        private map<string, string> metadata;

除了这几个属性外，ribbonserver还有一个方法

public uri geturi() {
            return defaultserviceinstance.geturi(this);
        }

这个方法就把服务从实例id转化为一个可调用的url了

    public static uri geturi(serviceinstance instance) {
        string scheme = (instance.issecure()) ? "https" : "http";
        string uri = string.format("%s://%s:%s", scheme, instance.gethost(),
                instance.getport());
        return uri.create(uri);
    }

然后就是发送http请求

如对本文有疑问，请在下面进行留言讨论，广大热心网友会与你互动！！ 点击进行留言回复