【云原生&微服务】SpringCloud Commons通用抽象

 Spring家族及微服务系列文章 

✨【微服务】SpringCloud中OpenFeign请求处理及负载均衡流程

✨【微服务】SpringCloud中Ribbon的WeightedResponseTimeRule策略

✨【微服务】SpringCloud中Ribbon的轮询(RoundRobinRule)与重试(RetryRule)策略

✨【微服务】SpringCloud中Ribbon集成Eureka实现负载均衡

✨【微服务】SpringCloud轮询拉取注册表及服务发现源码解析

✨【微服务】SpringCloud微服务续约源码解析

✨【微服务】SpringCloud微服务注册源码解析

✨【微服务】Nacos2.x服务发现？RPC调用？重试机制？

✨【微服务】Nacos通知客户端服务变更以及重试机制

✨【微服务】Nacos服务发现源码分析

✨【微服务】SpringBoot监听器机制以及在Nacos中的应用

✨【微服务】Nacos服务端完成微服务注册以及健康检查流程

✨【微服务】Nacos客户端微服务注册原理流程

✨【微服务】SpringCloud中使用Ribbon实现负载均衡的原理

✨【微服务】SpringBoot启动流程注册FeignClient

✨【微服务】SpringBoot启动流程初始化OpenFeign的入口

✨Spring Bean的生命周期

✨Spring事务原理

✨SpringBoot自动装配原理机制及过程

✨SpringBoot获取处理器流程

✨SpringBoot中处理器映射关系注册流程

✨Spring5.x中Bean初始化流程

✨Spring中Bean定义的注册流程

✨Spring的处理器映射器与适配器的架构设计

✨SpringMVC执行流程图解及源码

目录

一、前言

二、SpringCloud Commons通用抽象

1、 @EnableDiscoveryClient

1.1、健康指标

1.2、订阅DiscoveryClient实例

2、服务注册

2.1、ServiceRegistry自动注册

2.2、服务注册表执行器端点

3、Spring RestTemplate作为负载均衡器客户端

4、Spring WebClient作为负载均衡器客户端

4.1、重试失败的请求

5、多个RestTemplate对象

6、多个WebClient对象

7、Spring WebFlux WebClient作为负载均衡器客户端

7.1、Spring具有响应式负载均衡器的WebFlux WebClient

7.2、Spring WebFlux WebClient，带有非反应式负载均衡器客户端

7.3、传递自己的Load-Balancer客户端配置

8、忽略网络接口

9、HTTP客户端工厂

10、启用的功能

10.1、特征类型

10.2、声明功能

11、Spring Cloud兼容性验证

---

一、前言

    目前市面上服务注册发现中心有好几个：中国阿里巴巴的Nacos、Netflix公司的Eureka、google开源的Consul、Google的Chubby一个开源的实现Zookeeper等。而Nacos作为国产项目，凭借着既支持AP模式又支持CP模式等优点，被许许多多的公司青睐。

    但是SpringBoot项目已经非常成熟并具备许多优点，大大小小的公司都把项目建立在此基础之上，同时SpringCloud项目也集成了不少优秀的项目，自己也提供了一些优秀的组件。但是服务发现、负载平衡和断路器，SpringCloud只是集成者(当然后面它也有了自己的一些量身打造的项目)，而SpringCloud也不知道你们怎么实现，所以就提供了通用的抽象层，可以由所有Spring Cloud客户端使用，而与实现无关（例如，使用Eureka或Consul进行的发现）。也就是你们爱怎么实现就怎么实现，你们按照我的抽象层来实现，然后依照SpringBoot的自动装配机制自己集成进来，我就可以拿到我想要的数据了。

二、SpringCloud Commons通用抽象

3.1、 @EnableDiscoveryClient

​    Spring Cloud Commons提供了@EnableDiscoveryClient注解。SpringBoot在自动装配时，将寻找META-INF/spring.factories与DiscoveryClient接口的实现。Discovery Client的实现在org.springframework.cloud.client.discovery.EnableDiscoveryClient键下将配置类添加到spring.factories。前面的文章SpringBoot的自动装配原理机制及过程已经详细分析，感兴趣的读者可以去看看。DiscoveryClient实现的示例包括Nacos服务发现、Spring Cloud Netflix Eureka，Spring Cloud Consul发现和Spring Cloud Zookeeper发现。

    默认情况下，DiscoveryClient的实现会自动将本地Spring Boot服务器(客户端微服务)注册到远程发现服务器(注册中心)。可以通过在@EnableDiscoveryClient中设置autoRegister=false来禁用此行为。

3.1.1、健康指标

    公用创建了Spring Boot HealthIndicator，DiscoveryClient实现可以通过实现DiscoveryHealthIndicator来参与。要禁用复合HealthIndicator，请设置spring.cloud.discovery.client.composite-indicator.enabled=false。基于DiscoveryClient的通用HealthIndicator是自动配置的（DiscoveryClientHealthIndicator）。要禁用它，请设置spring.cloud.discovery.client.health-indicator.enabled=false。要禁用DiscoveryClientHealthIndicator的描述字段，请设置spring.cloud.discovery.client.health-indicator.include-description=false。否则，它可能会像已卷起的HealthIndicator中的description一样冒泡。

3.1.2、订阅DiscoveryClient实例

    DiscoveryClient接口扩展了Ordered。当使用多个发现客户端时，这很有用，因为它允许定义返回的发现客户端的顺序，类似于如何订阅由Spring应用程序加载的beans。默认情况下，任何DiscoveryClient的顺序都设置为0。如果要为自定义DiscoveryClient实现设置不同的顺序，则只需覆盖getOrder()方法，以便它返回适合设置的值。除此之外，可以使用属性来设置Spring Cloud提供的DiscoveryClient实现的顺序，其中包括NacosDiscoveryClient，ConsulDiscoveryClient，EurekaDiscoveryClient和ZookeeperDiscoveryClient。为此，只需要将spring.cloud.{clientIdentifier}.discovery.order（对于Eureka，则为eureka.client.order）属性设置为所需的值。

、2、服务注册

    Commons现在提供一个ServiceRegistry接口，该接口提供诸如register(Registration)和deregister(Registration)之类的方法，这些方法可以提供自定义的注册服务。Registration是专门维护需注册的数据。

    以下示例显示了正在使用的ServiceRegistry：

​
@Configuration
@EnableDiscoveryClient(autoRegister=false)
public class MyConfiguration {
    private ServiceRegistry registry;

    public MyConfiguration(ServiceRegistry registry) {
        this.registry = registry;
    }

    // called through some external process, such as an event or a custom actuator endpoint
    public void register() {
        Registration registration = constructRegistration();
        this.registry.register(registration);
    }
}

​

每个ServiceRegistry实现都有自己的Registry实现。

• NacosRegistration与NacosServiceRegistry一起使用
• EurekaRegistration与EurekaServiceRegistry一起使用
• ZookeeperRegistration与ZookeeperServiceRegistry一起使用
• ConsulRegistration与ConsulServiceRegistry一起使用

如果使用的是ServiceRegistry接口，则将需要为使用的ServiceRegistry实现传递正确的Registry实现。

3.2.1、ServiceRegistry自动注册

    默认情况下，ServiceRegistry实现会自动注册正在运行的服务。要禁用该行为，可以设置：* @EnableDiscoveryClient(autoRegister=false)以永久禁用自动注册。* spring.cloud.service-registry.auto-registration.enabled=false通过配置禁用行为。

ServiceRegistry自动注册Events

    服务自动注册时将触发两个事件。注册服务之前会触发名为InstancePreRegisteredEvent的第一个事件。注册服务后，将触发名为InstanceRegisteredEvent的第二个事件。可以注册ApplicationListener，以收听和响应这些事件。如果将spring.cloud.service-registry.auto-registration.enabled设置为false，则不会触发这些事件

3.2.2、服务注册表执行器端点

    Spring Cloud Commons提供了一个/service-registry执行器端点。该端点依赖于Spring应用程序上下文中的Registration bean。使用GET调用/service-registry会返回Registration的状态。对具有JSON正文的同一终结点使用POST会将当前Registration的状态更改为新值。JSON正文必须包含带有首选值的status字段。请参阅更新状态时用于允许值的ServiceRegistry实现的文档以及为状态返回的值。例如，Eureka的受支持状态为UP，DOWN，OUT_OF_SERVICE和UNKNOWN。

3 3、Spring RestTemplate作为负载均衡器客户端

    RestTemplate可以自动配置为在后台使用负载均衡器客户端。要创建负载均衡的RestTemplate，请创建RestTemplate @Bean并使用@LoadBalanced限定符，如以下示例所示：

@Configuration
public class MyConfiguration {

    @LoadBalanced
    @Bean
    RestTemplate restTemplate() {
        return new RestTemplate();
    }
}

public class MyClass {
    @Autowired
    private RestTemplate restTemplate;

    public String doOtherStuff() {
        String results = restTemplate.getForObject("http://stores/stores", String.class);
        return results;
    }
}

注意：

• RestTemplate bean不再通过自动配置创建。各个应用程序必须创建它。
• URI需要使用虚拟主机名（即服务名【spring.application.name】，而不是主机名）。Ribbon客户端用于创建完整的物理地址。
• 为了使用负载均衡的RestTemplate，需要在类路径中具有负载均衡器实现。推荐的实现是BlockingLoadBalancerClient-添加org.springframework.cloud:spring-cloud-loadbalancer以便使用它。RibbonLoadBalancerClient也可以使用，但是目前正在维护中，不建议将其添加到新项目中。
• 如果要使用BlockingLoadBalancerClient，请确保项目类路径中没有RibbonLoadBalancerClient，因为向后兼容的原因，默认情况下将使用它。

3.4、Spring WebClient作为负载均衡器客户端

WebClient可以自动配置为使用负载均衡器客户端。要创建负载均衡的WebClient，请创建WebClient.Builder @Bean并使用@LoadBalanced限定符，如以下示例所示：

@Configuration
public class MyConfiguration {

	@Bean
	@LoadBalanced
	public WebClient.Builder loadBalancedWebClientBuilder() {
		return WebClient.builder();
	}
}

public class MyClass {
    @Autowired
    private WebClient.Builder webClientBuilder;

    public Mono doOtherStuff() {
        return webClientBuilder.build().get().uri("http://stores/stores")
        				.retrieve().bodyToMono(String.class);
    }
}

URI需要使用虚拟主机名（即服务名，而不是主机名）。Ribbon客户端用于创建完整的物理地址。

注意：

• 如果要使用@LoadBalanced WebClient.Builder，则需要在类路径中有一个loadbalancer实现。建议您将org.springframework.cloud:spring-cloud-loadbalancer依赖项添加到项目中。然后，将在下面使用ReactiveLoadBalancer。或者，此功能也可以在spring-cloud-starter-netflix-ribbon上使用，但是该请求将由后台的非响应LoadBalancerClient处理。此外，spring-cloud-starter-netflix-ribbon已经处于维护模式，因此不建议将其添加到新项目中。
• 在下面使用的ReactorLoadBalancer支持缓存。如果检测到cacheManager，将使用ServiceInstanceSupplier的缓存版本。如果没有，将从发现服务中检索实例，而不进行缓存。如果使用ReactiveLoadBalancer，建议在项目中启用缓存。

3.4.1、重试失败的请求

可以配置负载均衡的RestTemplate以重试失败的请求。默认情况下，禁用此逻辑。可以通过在应用程序的类路径中添加Spring重试来启用它。负载平衡的RestTemplate遵循与重试失败的请求有关的某些Ribbon配置值。可以使用client.ribbon.MaxAutoRetries，client.ribbon.MaxAutoRetriesNextServer和client.ribbon.OkToRetryOnAllOperations属性。如果要通过对类路径使用Spring重试来禁用重试逻辑，则可以设置spring.cloud.loadbalancer.retry.enabled=false。有关这些属性的作用的说明，请参见Ribbon文档。

如果要在重试中实现BackOffPolicy，则需要创建LoadBalancedRetryFactory类型的bean并覆盖createBackOffPolicy方法：

@Configuration
public class MyConfiguration {
    @Bean
    LoadBalancedRetryFactory retryFactory() {
        return new LoadBalancedRetryFactory() {
            @Override
            public BackOffPolicy createBackOffPolicy(String service) {
        		return new ExponentialBackOffPolicy();
        	}
        };
    }
}

前面示例中的client应替换为Ribbon客户名称。

如果要向重试功能中添加一个或多个RetryListener实现，则需要创建类型为LoadBalancedRetryListenerFactory的bean，并返回要用于给定服务的RetryListener数组，如以下示例所示：

@Configuration
public class MyConfiguration {
    @Bean
    LoadBalancedRetryListenerFactory retryListenerFactory() {
        return new LoadBalancedRetryListenerFactory() {
            @Override
            public RetryListener[] createRetryListeners(String service) {
                return new RetryListener[]{new RetryListener() {
                    @Override
                    public  boolean open(RetryContext context, RetryCallback callback) {
                        //TODO Do you business...
                        return true;
                    }

                    @Override
                     public  void close(RetryContext context, RetryCallback callback, Throwable throwable) {
                        //TODO Do you business...
                    }

                    @Override
                    public  void onError(RetryContext context, RetryCallback callback, Throwable throwable) {
                        //TODO Do you business...
                    }
                }};
            }
        };
    }
}

3.5、多个RestTemplate对象

如果想要一个RestTemplate而不是负载均衡的，请创建一个RestTemplate bean并注入它。要访问负载均衡的RestTemplate，请在创建@Bean时使用@LoadBalanced限定符，如以下示例所示：

@Configuration
public class MyConfiguration {

    @LoadBalanced
    @Bean
    RestTemplate loadBalanced() {
        return new RestTemplate();
    }

    @Primary
    @Bean
    RestTemplate restTemplate() {
        return new RestTemplate();
    }
}

public class MyClass {
@Autowired
private RestTemplate restTemplate;

    @Autowired
    @LoadBalanced
    private RestTemplate loadBalanced;

    public String doOtherStuff() {
        return loadBalanced.getForObject("http://stores/stores", String.class);
    }

    public String doStuff() {
        return restTemplate.getForObject("https://example.com", String.class);
    }
}

注意：

• 在前面的示例中，在普通的RestTemplate声明上使用了@Primary批注，以消除不合格的@Autowired注入的歧义。
• 如果看到诸如java.lang.IllegalArgumentException: Can not set org.springframework.web.client.RestTemplate field com.my.app.Foo.restTemplate to com.sun.proxy.$Proxy89之类的错误，请尝试注入RestOperations或设置spring.aop.proxyTargetClass=true。

3.6、多个WebClient对象

    如果要使WebClient负载不均衡，请创建一个WebClient bean并注入它。要访问负载均衡的WebClient，请在创建@Bean时使用@LoadBalanced限定符，如以下示例所示：

@Configuration
public class MyConfiguration {

    @LoadBalanced
    @Bean
    WebClient.Builder loadBalanced() {
        return WebClient.builder();
    }

    @Primary
    @Bean
    WebClient.Builder webClient() {
        return WebClient.builder();
    }
}

public class MyClass {
    @Autowired
    private WebClient.Builder webClientBuilder;

    @Autowired
    @LoadBalanced
    private WebClient.Builder loadBalanced;

    public Mono doOtherStuff() {
        return loadBalanced.build().get().uri("http://stores/stores")
        				.retrieve().bodyToMono(String.class);
    }

    public Mono doStuff() {
        return webClientBuilder.build().get().uri("http://example.com")
        				.retrieve().bodyToMono(String.class);
    }
}

3.7、Spring WebFlux WebClient作为负载均衡器客户端

3.7.1、Spring具有响应式负载均衡器的WebFlux WebClient

    可以将WebClient配置为使用ReactiveLoadBalancer。如果将org.springframework.cloud:spring-cloud-loadbalancer添加到项目中，并且spring-webflux在类路径中，则会自动配置ReactorLoadBalancerExchangeFilterFunction。以下示例说明如何配置WebClient以在后台使用无功负载均衡器：

public class MyClass {
    @Autowired
    private ReactorLoadBalancerExchangeFilterFunction lbFunction;

    public Mono doOtherStuff() {
        return WebClient.builder().baseUrl("http://stores")
            .filter(lbFunction)
            .build()
            .get()
            .uri("/stores")
            .retrieve()
            .bodyToMono(String.class);
    }
}

    URI需要使用虚拟主机名（即服务名，而不是主机名）。ReactorLoadBalancerClient用于创建完整的物理地址。

3.7.2、Spring WebFlux WebClient，带有非反应式负载均衡器客户端

    如果项目中没有org.springframework.cloud:spring-cloud-loadbalancer，但是确实有spring-cloud-starter-netflix-ribbon，则仍可以将WebClient与LoadBalancerClient结合使用。如果spring-webflux在类路径中，将自动配置LoadBalancerExchangeFilterFunction。但是注意，这是在后台使用非反应性客户端。以下示例显示如何配置WebClient以使用负载均衡器：

public class MyClass {
    @Autowired
    private LoadBalancerExchangeFilterFunction lbFunction;

    public Mono doOtherStuff() {
        return WebClient.builder().baseUrl("http://stores")
            .filter(lbFunction)
            .build()
            .get()
            .uri("/stores")
            .retrieve()
            .bodyToMono(String.class);
    }
}

    URI需要使用虚拟主机名（即服务名，而不是主机名）。LoadBalancerClient用于创建完整的物理地址。

注意：现在不建议使用此方法。建议将WebFlux与电抗性负载平衡器一起使用。

3.7.3、传递自己的Load-Balancer客户端配置

    还可以使用@LoadBalancerClient批注传递自己的负载平衡器客户端配置，并传递负载平衡器客户端的名称和配置类，如下所示：

@Configuration
@LoadBalancerClient(value = "stores", configuration = StoresLoadBalancerClientConfiguration.class)
public class MyConfiguration {

	@Bean
	@LoadBalanced
	public WebClient.Builder loadBalancedWebClientBuilder() {
		return WebClient.builder();
	}
}

    也可以通过@LoadBalancerClients注释将多个配置（对于一个以上的负载均衡器客户端）一起传递，如下所示：

@Configuration
@LoadBalancerClients({@LoadBalancerClient(value = "stores", configuration = StoresLoadBalancerClientConfiguration.class), @LoadBalancerClient(value = "customers", configuration = CustomersLoadBalancerClientConfiguration.class)})
public class MyConfiguration {

	@Bean
	@LoadBalanced
	public WebClient.Builder loadBalancedWebClientBuilder() {
		return WebClient.builder();
	}
}

3.8、忽略网络接口

    有时，忽略某些命名的网络接口很有用，以便可以将它们从服务发现注册中排除（例如，在Docker容器中运行时）。可以设置正则表达式列表，以使所需的网络接口被忽略。以下配置将忽略docker0接口以及所有以veth开头的接口：

application.yml。 

spring:
  cloud:
    inetutils:
      ignoredInterfaces:
        - docker0
        - veth.*

还可以通过使用正则表达式列表来强制仅使用指定的网络地址，如以下示例所示：

bootstrap.yml。 

spring:
  cloud:
    inetutils:
      preferredNetworks:
        - 192.168
        - 10.0

也可以只使用站点本地地址，如以下示例所示：.application.yml

spring:
  cloud:
    inetutils:
      useOnlySiteLocalInterfaces: true

3.9、HTTP客户端工厂

    SpringCloud Commons提供了beans用于创建Apache HTTP客户端（ApacheHttpClientFactory）和OK HTTP客户端（OkHttpClientFactory）。仅当OK HTTP jar位于类路径上时，才创建OkHttpClientFactory bean。此外，Spring Cloud Commons提供了beans用于创建两个客户端使用的连接管理器：ApacheHttpClientConnectionManagerFactory用于Apache HTTP客户端，OkHttpClientConnectionPoolFactory用于OK HTTP客户端。如果想自定义在下游项目中如何创建HTTP客户端，则可以提供自己的beans实现。另外，如果提供类型为HttpClientBuilder或OkHttpClient.Builder的bean，则默认工厂将使用这些构建器作为返回到下游项目的构建器的基础。还可以通过将spring.cloud.httpclientfactories.apache.enabled或spring.cloud.httpclientfactories.ok.enabled设置为false来禁用这些beans的创建。

3.10、启用的功能

    Spring Cloud Commons提供了一个/features执行器端点。该端点返回类路径上可用的功能以及是否已启用它们。返回的信息包括功能类型，名称，版本和供应商。

3.10.1、特征类型

​“功能”有两种类型：抽象和命名。

    抽象功能是定义接口或抽象类并创建实现的功能，例如DiscoveryClient，LoadBalancerClient或LockService。抽象类或接口用于在上下文中找到该类型的bean。显示的版本为bean.getClass().getPackage().getImplementationVersion()。

    命名功能是没有实现的特定类的功能，例如“ Circuit Breaker”，“ API Gateway”，“ Spring Cloud Bus”等。这些功能需要一个名称和一个bean类型。

3.10.2、声明功能

任何模块都可以声明任意数量的HasFeature beans，如以下示例所示：

@Bean
public HasFeatures commonsFeatures() {
  return HasFeatures.abstractFeatures(DiscoveryClient.class, LoadBalancerClient.class);
}

@Bean
public HasFeatures consulFeatures() {
  return HasFeatures.namedFeatures(
    new NamedFeature("Spring Cloud Bus", ConsulBusAutoConfiguration.class),
    new NamedFeature("Circuit Breaker", HystrixCommandAspect.class));
}

@Bean
HasFeatures localFeatures() {
  return HasFeatures.builder()
      .abstractFeature(Foo.class)
      .namedFeature(new NamedFeature("Bar Feature", Bar.class))
      .abstractFeature(Baz.class)
      .build();
}

这些beans中的每一个都应放入受到适当保护的@Configuration中。

3.11、Spring Cloud兼容性验证

    由于某些用户在设置Spring Cloud应用程序时遇到问题，决定添加兼容性验证机制。如果当前的设置与Spring Cloud要求不兼容，则会断开，并附上一份报告，说明出了什么问题。

目前，验证哪个版本的Spring Boot已添加到类路径中。

报告范例

***************************
APPLICATION FAILED TO START
***************************

Description:

Your project setup is incompatible with our requirements due to following reasons:

- Spring Boot [2.1.0.RELEASE] is not compatible with this Spring Cloud release train


Action:

Consider applying the following actions:

- Change Spring Boot version to one of the following versions [1.2.x, 1.3.x] .
You can find the latest Spring Boot versions here [https://spring.io/projects/spring-boot#learn].
If you want to learn more about the Spring Cloud Release train compatibility, you can visit this page [https://spring.io/projects/spring-cloud#overview] and check the [Release Trains] section.

为了禁用此功能，请将spring.cloud.compatibility-verifier.enabled设置为false。如果要覆盖兼容的Spring Boot版本，只需用兼容的Spring Boot版本的逗号分隔列表设置spring.cloud.compatibility-verifier.compatible-boot-versions属性。