springcloud @RibbonClients 与NamedContextFactory

本人博客原地址：springcloud @RibbonClients 与NamedContextFactory
创作时间： 2020.08.13 15:11:12

在讲@RibbonClients 之前，先来说说springcloud的子上下文概念也就是NamedContextFactory

子context或者叫子容器，子context维护自身的所有bean，也可从父context依赖到父context（AnnotationConfigServletWebServerApplicationContext）的bean，反过来，父context无法依赖到子context的bean，通过命名不同的子context，不同的子context之间可以共用configuration，也可以各自在共享的基础上自定义差异化的configuration。@RibbonClients就是使用场景之一，针对每个要调用的服务名，每个服务名定义一个子context对象，各自维护定期更新服务列表，server选择等任务。

上demo：

public class MyTestContextFactory extends NamedContextFactory<TestSpecification> {

    public MyTestContextFactory() {
//		自定义自动配置类
        super(TestContextAutoConfiguration.class, "testcontext", "testcontext.name");
    }
    public MyContextBean getMyContextBean(String name) {
        //自定义接口类型
        return getInstance(name, MyContextBean.class);
    }
    public MyShowContextBean getMyShowContextBean(String name) {
        //自定义接口类型
        return getInstance(name, MyShowContextBean.class);
    }
    @Override
    protected AnnotationConfigApplicationContext getContext(String name) {
        // TODO Auto-generated method stub
        return super.getContext(name);
    }
    public void setProperties() {

    }
}

@Configuration
@EnableConfigurationProperties
public class TestContextAutoConfiguration {

    String client = "test0";

    @Value("${testcontext.name:hello}")
    String name;

    @Autowired
    TestBean testBean;
    @Bean
    @ConditionalOnMissingBean
    public ITestContext getTestContext() {
        System.out.println(testBean.getName());
        return new MyContextBean(client+":"+name);
    }
}

@Configuration
@EnableConfigurationProperties
public class Test1ContextAutoConfiguration {

    String client = "test1";

    @Value("${testcontext.name:hello}")
    String name;
    @Bean
    @ConditionalOnMissingBean
    public ITestContext getTestContext() {
        return new MyContextBean(client+":"+name);
    }
}
@Configuration
@EnableConfigurationProperties
public class CommonContextAutoConfiguration {

    String client = "common";

    @Value("${testcontext.name:hello}")
    String name;

    @Bean
    @ConditionalOnMissingBean
    public MyShowContextBean getCommonContext() {
        return new MyShowContextBean(client+":"+name);
    }
}
public class TestSpecification implements Specification {
    private String name;
    private Class<?>[] configuration;
    public TestSpecification(String name,Class<?>[] configuration){
        this.name = name;
        this.configuration = configuration;
    }
    @Override
    public String getName() {
        // TODO Auto-generated method stub
        return name;
    }
    @Override
    public Class<?>[] getConfiguration() {
        // TODO Auto-generated method stub
        return configuration;
    }
    public void setName(String name) {
        this.name = name;
    }
    public void setConfiguration(Class<?>[] configuration) {
        this.configuration = configuration;
    }

}

以上是定义子context所需的类，具体的bean就不复制了。下面是使用的部分：

    /**
     * 先定义一个ContextFactory对象,通过TestSpecification定义不同命名的
     * 子context需要加载的configuration，当命名是以default开头的，所有的
     *  子context共用该TestSpecification定义的configuration。
     */
    @Bean
    public MyTestContextFactory getMyTestContextFactory(){
        MyTestContextFactory context = new MyTestContextFactory();
        TestSpecification spcification = new TestSpecification("test0", new Class[]{TestContextAutoConfiguration.class/*, CommonContextAutoConfiguration.class*/});
        TestSpecification spcification1 = new TestSpecification("test1", new Class[]{Test1ContextAutoConfiguration.class/*, CommonContextAutoConfiguration.class*/});
        TestSpecification spcification2 = new TestSpecification("default.common", new Class[]{CommonContextAutoConfiguration.class});
        List<TestSpecification> spe = new ArrayList<>();
        spe.add(spcification);
        spe.add(spcification1);
        spe.add(spcification2);
        context.setConfigurations(spe);
        return context;
    }

//业务代码调用
   @Autowired
   MyTestContextFactory contextFactory;

/**
  *  当传参是定义TestSpecification时的命名，生成子context时就是用对应的configuration
  *和公用的configuration，当没有对应的TestSpecification时，使用默认的configuration
  */
    @Test
    public void test() {
        MyContextBean myContextBean = contextFactory.getMyContextBean("test0");
        MyShowContextBean showContextBean = contextFactory.getMyShowContextBean("test0");
        MyContextBean myContextBean1 = contextFactory.getMyContextBean("test1");
        MyShowContextBean showContextBean1 = contextFactory.getMyShowContextBean("test1");
//该bean为空，因为公共的configuration没有定义这个bean
        MyContextBean myContextBean2 = contextFactory.getMyContextBean("noname");
        MyShowContextBean showContextBean2 = contextFactory.getMyShowContextBean("noname");
        context.getBean(MyContextBean.class);
    }

下面来具体看下NamedContextFactory的源码，从本demo的MyTestContextFactory 实例化说起。
1、创建实例

2、设置Specification

3、创建子context，获取bean
对于getBean方法，可以参考这里生成bean实例以及初始化
，这里主要看下org.springframework.cloud.context.named.NamedContextFactory#getContext
此demo中this.difaultConfigType是new MyTestContextFactory传入的配置类TestContextAutoConfiguration。
configuration的注册和bean的定义，可以参考这里bean的定义（非生成实例）

现在来看@RibbonClients就好受一点了，相对比上面demo中用new MyTestContextFactory的方式，spring用了比较装逼的方式如图:

可以看到，实际上@RibbonClients使用注解的方式完成Specification的实现和SpringClientFactory创建原理其实是和demo一样的。

通过LoadBalancerClient调用时通过传入的服务名生成服务名对应的子context
org.springframework.cloud.netflix.ribbon.RibbonLoadBalancerClient#choose(java.lang.String)
在此过程中也生成对应的loadbalencer,和ServerIntrospector，这两个东西是只为当前的服务名效力的。

@FeignClient生成FeignContext的原理也类似，只不过其使用时就需要设置好对应的服务名，因此在实例化feignClient对象的时候，就加载好对应服务命名的FeignContext。

对于rebbionClient的具体实现，本文不作累述