本文共 24021 字,大约阅读时间需要 80 分钟。
基于http
的客户端经常被用作微服务的消费者,因为http
本身是平台无关的、语言无关的,所以基于http
的客户端往往会被广大的社区支持
特点:
URL
,就能直接连过去,获取到资源IP
下的某个资源时,如果这个IP
地址或这个IP
地址所绑定的主机宕机了,这个资源就无法拿到,因为服务直连模式无法做到负载均衡,也就无法保证服务的可用性与客户端发现模式最大的区别在于:负载均衡不是由客户端来做,而是在服务端实现,负载均衡器是独立部署在服务端的
用来提供高效、功能丰富的http
协议的客户端工具包,能支持http
协议最新的版本和建议。Apache HttpClient
能对JDK
提供一些非常好的补充,方便开发人员测试基于http
的接口,从而提高开发效率及代码健壮性
//依赖关系dependencies { //添加Apache HttpClient依赖 compile('org.apache.httpcomponents:httpclient:4.5.6')}
import org.springframework.beans.factory.annotation.Autowired;import org.springframework.boot.web.client.RestTemplateBuilder;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.web.client.RestTemplate;@Configuration//rest配置类,配置restTemplatepublic class RestConfiguration { @Autowired private RestTemplateBuilder builder; @Bean public RestTemplate restTemplate() { return builder.build(); } }
@Servicepublic class WeatherDataServiceImpl implements WeatherDataService { @Autowired private RestTemplate restTemplate; private WeatherResponse doGetWeather(String uri) { ResponseEntityrespString = restTemplate.getForEntity(uri, String.class); //... } //...}
Ribbon
是Spring Cloud
中的一个组件,是基于Netflix Ribbon
实现客户端负载均衡的一个工具,基于HTTP
和TCP
来实现客户端的负载均衡
Spring Cloud Ribbon
虽然只是一个工具类框架,它不像服务注册中心、配置中心、API
网关那样需要独立部署,但是它几乎存在于每一个Spring Cloud
构建的微服务和基础设施中。因为微服务间的调用,API
网关的请求转发等内容,实际上都是通过Ribbon
来实现的,包括后续我们的Feign
,也是基于Ribbon
实现的工具。所以,对Spring Cloud Ribbon
的理解和使用,对于我们使用Spring Cloud
来构建微服务非常重要。
负载均衡在系统架构中是一个非常重要,并且是不得不去实施的内容。因为负载均衡是对系统的高可用、网络压力的缓解和处理能力扩容的重要手段之一。
我们通常说的负载均衡都指的是服务端负载均衡,其中分为硬件负载均衡和软件负载均衡。硬件负载均衡主要通过在服务器节点之间安装专门用于负载均衡的设备,比如F5
等;而软件负载均衡则是通过在服务器上安装一些具有均衡负载功能或模块的软件来完成请求分发工作,比如Nginx
等。不论采用硬件负载均衡还是软件负载均衡,只要是服务端负载均衡都能以类似下图的架构方式构建起来:
而客户端负载均衡和服务端负载均衡最大的不同点在于上面所提到的服务清单所存储的位置。在客户端负载均衡中,所有客户端节点都维护着自己要访问的服务端清单,而这些服务端的清单来自于服务注册中心。同服务端负载均衡的架构类似,在客户端负载均衡中也需要心跳去维护服务端清单的健康性,只是这个步骤需要与服务注册中心配合完成。在Spring Cloud
实现的服务治理框架中,默认会创建针对各个服务治理框架的Ribbon
自动化整合配置,比如Eureka
中的org.springframework.cloud.netflix.ribbon.eureka.RibbonEurekaAutoConfiguration
,Consul
中的org.springframework.cloud.consul.discovery.RibbonConsulAutoConfiguration
。在实际使用的时候,我们可以通过查看这两个类的实现,以找到它们的配置详情来帮助我们更好地使用它。
通过Spring Cloud Ribbon
的封装,我们在微服务架构中使用客户端负载均衡调用非常简单,只需要如下两步:
@LoadBalanced
注解修饰过的RestTemplate
来实现面向服务的接口调用。这样,我们就可以将服务提供者的高可用以及服务消费者的负载均衡调用一起实现了。
Ribbon
的每个负载均衡器一起协作,可以根据需要与远程服务器进行交互,来获取包含命名客户端名词的集合,Ribbon
经常与Eureka
结合使用,在典型的分布式部署中,Eureka
为所有的微服务实例提供服务注册,Ribbon
提供服务消费的客户端
Ribbon
有很多负载均衡的算法
//依赖关系dependencies { //添加Spring Cloud Starter Netflix Ribbon依赖 compile('org.springframework.cloud:spring-cloud-starter-netflix-ribbon')}
build.gradle
完整代码如下:
//buildscript代码块中脚本优先执行buildscript { //ext用于定义动态属性 ext { springBootVersion = '2.0.0.M3' } //使用了Maven的中央仓库及Spring自己的仓库(也可以指定其他仓库) repositories { //mavenCentral() maven{ url "https://repo.spring.io/snapshot" } maven{ url "https://repo.spring.io/milestone" } maven{ url "http://maven.aliyun.com/nexus/content/groups/public/" } } //依赖关系 dependencies { //classpath声明了在执行其余的脚本时,ClassLoader可以使用这些依赖项 classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}") }}//使用插件apply plugin: 'java'apply plugin: 'eclipse'apply plugin: 'org.springframework.boot'apply plugin: 'io.spring.dependency-management'//指定了生成的编译文件的版本,默认是打成了jar包group = 'com.study.spring.cloud'version = '1.0.0'//指定编译.java文件的JDK版本sourceCompatibility = 1.8//使用了Maven的中央仓库及Spring自己的仓库(也可以指定其他仓库)repositories { //mavenCentral() maven{ url "https://repo.spring.io/snapshot" } maven{ url "https://repo.spring.io/milestone" } maven{ url "http://maven.aliyun.com/nexus/content/groups/public/" }}ext { springCloudVersion = 'Finchley.M2'}//依赖关系dependencies { //该依赖用于编译阶段 compile('org.springframework.boot:spring-boot-starter-web') //Eureka Client compile('org.springframework.cloud:spring-cloud-starter-netflix-eureka-client') //添加Spring Cloud Starter Netflix Ribbon依赖 compile('org.springframework.cloud:spring-cloud-starter-netflix-ribbon') //该依赖用于测试阶段 testCompile('org.springframework.boot:spring-boot-starter-test')}//Spring Cloud依赖管理dependencyManagement{ imports{ mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}" }}
为RestTemplate
增加@LoadBalanced
注解:
import org.springframework.beans.factory.annotation.Autowired;import org.springframework.boot.web.client.RestTemplateBuilder;import org.springframework.cloud.client.loadbalancer.LoadBalanced;import org.springframework.cloud.netflix.ribbon.RibbonClient;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.web.client.RestTemplate;@Configuration@RibbonClient(name = "ribbon-client",configuration = RibbonConfiguration.class)public class RestConfiguration { @Autowired private RestTemplateBuilder builder; @Bean @LoadBalanced public RestTemplate restTemplate() { return builder.build(); } }
import com.netflix.loadbalancer.IPing;import com.netflix.loadbalancer.PingUrl;import org.springframework.cloud.netflix.ribbon.ZonePreferenceServerListFilter;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;@Configurationpublic class RibbonConfiguration { @Bean public ZonePreferenceServerListFilter serverListFilter(){ ZonePreferenceServerListFilter filter = new ZonePreferenceServerListFilter(); filter.setZone("myZone"); return filter; } @Bean public IPing ribbonPing(){ return new PingUrl(); }}
直接通过RestTemplate
发起请求:
import org.springframework.beans.factory.annotation.Autowired;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.RestController;import org.springframework.web.client.RestTemplate;@RestControllerpublic class CityController { @Autowired private RestTemplate restTemplate; @GetMapping("/cities") public String listCity(){ //通过应用名词来查找 String body=restTemplate.getForEntity("http://msa-weather-city-eureka/cities", String.class).getBody(); return body; }}
这里请求的host
位置并没有使用一个具体的IP
地址和端口的形式,而是采用了服务名的方式组成。那么这样的请求为什么可以调用成功呢?因为Spring Cloud Ribbon
有一个拦截器,它能够在这里进行实际调用的时候,自动的去选取服务实例,并将实际要请求的IP
地址和端口替换这里的服务名,从而完成服务接口的调用。
#应用名称spring.application.name=micro-weather-eureka-client-ribbon#指定Eureka服务器地址eureka.client.service-url.defaultZone=http://localhost:8761/eureka/
RestTemplate
针对几种不同请求类型和参数类型的服务调用实现:
在RestTemplate
中,对GET
请求可以通过如下两个方法进行调用实现:
getForEntity
函数getForObject
函数getForEntity
方法返回的是ResponseEntity
,该对象是Spring
对HTTP
请求响应的封装,其中主要存储了HTTP
的几个重要元素,比如HTTP
请求状态码的枚举对象HttpStatus
(也就是我们常说的404
、500
这些错误码)、在它的父类HttpEntity
中还存储着HTTP
请求的头信息对象HttpHeaders
以及泛型类型的请求体对象。比如下面的例子,就是访问USER-SERVICE
服务的/user
请求,同时最后一个参数didi
会替换url
中的{1}
占位符,而返回的ResponseEntity
对象中的body
内容类型会根据第二个参数转换为String
类型。
RestTemplate restTemplate=new RestTemplate();ResponseEntityresponseEntity=restTemplate.getForEntity("http://USER-SERVICE/user?name={1}",String.class,"didi" );String body=responseEntity.getBody();
若我们希望返回的body
是一个User
对象类型,也可以这样实现:
RestTemplate restTemplate=new RestTemplate();ResponseEntityresponseEntity=restTemplate.getForEntity("http://USER-SERVICE/user?name={1}",User.class,"didi" );User body=responseEntity.getBody();
上面的例子是比较常用的方法,getForEntity
函数实际上提供了以下三种不同的重载实现:
//url为请求的地址,responseType为请求响应体body的包装类型,urlVariables为url中的参数绑定//由于urlVariables参数是一个数组,所以它的顺序会对应url中占位符定义的数字顺序getForEntity(String url,Class responseType,Object... urlVariables);//只有urlVariables的参数类型与上面的方法不同//这里使用了Map类型,所以使用该方法进行参数绑定时需要在占位符中指定Map中参数的key值getForEntity(String url,Class responseType,Map urlVariables);//使用URI对象来替代之前的url和urlVariables参数来指定访问地址和参数绑定//URI是JDK java.net包下的一个类,它表示一个统一资源标识符(Uniform Resource Identifier)引用getForEntity(URI url,Class responseType);
getForObject
方法可以理解为对getForEntity
的进一步封装,它通过HttpMessageConverterExtractor
对Http
的请求响应体body
内容进行对象转换,实现请求返回包装好的对象内容。比如:
RestTemplate restTemplate=new RestTemplate();String result=restTemplate.getForObject(uri, String.class);
当body
是一个User
对象时,可以直接这样实现:
RestTemplate restTemplate=new RestTemplate();User result=restTemplate.getForObject(uri, User.class);
当不需要关注请求响应除body
外的其他内容时,该函数就非常好用,可以少一个从Response
中获取body
的步骤。它与getForEntity
函数类似,也提供了三种不同的重载实现:
//url参数指定访问的地址,responseType定义该方法的返回类型,urlVariables为url中占位符对应的参数getForObject(String url, Class responseType, Object... urlVariables);//使用Map类型的urlVariables替代上面数组形式的urlVariables//使用时在url中需要将占位符的名称与Map类型中的key一一对应设置getForObject(String url, Class responseType, Map urlVariables);//使用URI对象来替代之前的url和urlVariables参数使用getForObject(URI url, Class responseType);
在RestTemplate
中,对POST
请求时可以通过如下三个方法进行调用实现:
postForEntity
函数postForObject
函数postForLocation
函数postForEntity
函数方法会在调用后返回ResponseEntity<T>
对象,其中T
为请求响应的body
类型。比如下面这个例子,使用postForEntity
提交POST
请求到USER-SERVICE
服务的/user
接口,提交的body
内容为user
对象,请求响应返回的body
类型为String
。
RestTemplate restTemplate=new RestTemplate();User user=new User("didi",30);ResponseEntityresponseEntity=restTemplate.postForEntity("http://USER-SERVICE/user", user, String.class);String body=responseEntity.getBody();
postForEntity
函数也实现了三种不同的重载方法:
postForEntity(String url, Object request, Class responseType, Object ... urlVariables);postForEntity(String url, Object request, Class responseType, Map urlVariables);postForEntity(URI url, Object request, Class responseType);
上面新增加的request
参数可以是一个普通对象,也可以是一个HttpEntity
对象。如果是一个普通对象,而非HttpEntity
对象的时候,RestTemplate
会将请求对象转换为一个HttpEntity
对象来处理,其中Object
就是request
的类型,request
内容会被视作完整的body
来处理;而如果request
是一个HttpEntity
对象,那么就会被当作一个完成的HTTP
请求对象来处理,这个request
中不仅包含了body
的内容,也包含了header
的内容。
postForObject
方法作用是简化postForEntity
的后续处理。通过直接将请求响应的body
内容包装成对象来返回使用,比如下面的例子:
RestTemplate restTemplate=new RestTemplate();User user=new User("didi",30);String postResult=restTemplate.postForObject("http://USER-SERVICE/user", user, String.class);
postForObject
函数也实现了三种不同的重载方法:
postForObject(String url, Object request, Class responseType, Object ... urlVariables);postForObject(String url, Object request, Class responseType, Map urlVariables);postForObject(URI url, Object request, Class responseType);
postForLocation
方法实现了以POST
请求提交资源,并返回新资源的URI
,比如下面的例子:
RestTemplate restTemplate=new RestTemplate();User user=new User("didi",30);URI responseURI=restTemplate.postForLocation("http://USER-SERVICE/user", user);
postForLocation
函数也实现了三种不同的重载方法:
postForLocation(String url, Object request, Object ... urlVariables);postForLocation(String url, Object request, Map urlVariables);postForLocation(URI url, Object request);
由于postForLocation
函数会返回新资源的URI
,该URI
就相当于指定了返回类型,所以此方法实现的POST
请求不需要像postForEntity
和postForObject
那样指定responseType
。
在RestTemplate
中,对PUT
请求可以通过put
方法进行调用实现,比如:
RestTemplate restTemplate=new RestTemplate();Long id=10001L;User user=new User("didi",30);restTemplate.put("http://USER-SERVICE/user/{1}",user,id);
put
函数也实现了三种不同的重载方法:
put(String url, Object request, Object ... urlVariables);put(String url, Object request, Map urlVariables);put(URI url, Object request);
put
函数为void
类型,所以没有返回内容,也就没有其他函数定义的responseType
参数,除此之外的其他传入参数定义为用法与postForObject
基本一致。
在RestTemplate
中,对DELETE
请求可以通过delete
方法进行调用实现,比如:
RestTemplate restTemplate=new RestTemplate();Long id=10001L;restTemplate.delete("http://USER-SERVICE/user/{1}",id);
delete
函数也实现了三种不同的重载方法:
delete(String url, Object ... urlVariables);delete(String url, Map urlVariables);delete(URI url);
由于我们在进行REST
请求时,通常都将DELETE
请求的唯一标识拼接在url
中,所以DELETE
请求也不需要request
的body
信息,就如上面的三个函数实现一样,非常简单。url
指定DELETE
请求的位置,urlVariables
绑定url
中的参数即可。
@LoadBalanced
注解用来给RestTemplate
做标记,以使用负载均衡的客户端(LoadBalancerClient
)来配置它。
LoadBalancerAutoConfiguration
为实现客户端负载均衡器的自动化配置类。
Ribbon
实现的负载均衡自动化配置需要满足下面两个条件:
RestTemplate
类必须存在于当前工程的环境中。Spring
的Bean
工程中必须有LoadBalancerClient
的实现Bean
。自动化配置类中主要做了下面三件事:
LoadBalancerInterceptor
的Bean
,用于实现对客户端发起请求时进行拦截,以实现客户端负载均衡。RestTemplateCustomizer
的Bean
,用于给RestTemplate
增加LoadBalancerInterceptor
拦截器。@LoadBalanced
注解修饰的RestTemplate
对象列表,并在这里进行初始化,通过调用RestTemplateCustomizer
的实例来给需要客户端负载均衡的RestTemplate
增加LoadBalancerInterceptor
拦截器。BaseLoadBalancer
类实现了基础的负载均衡,而DynamicServerListLoadBalancer
和ZoneAwareLoadBalancer
在负载均衡的策略上做了一些功能的扩展。
在整合Ribbon
的时候,Spring Cloud
默认采用了ZoneAwareLoadBalancer
来实现负载均衡器。
AbstractLoadBalancer
:ILoadBalancer
接口的抽象实现。BaseLoadBalancer
:Ribbon
负载均衡器的基础实现类,在该类中定义了很多关于负载均衡器相关的基础内容。DynamicServerListLoadBalancer
:继承于BaseLoadBalancer
类,它是对基础负载均衡器的扩展。在该负载均衡器中,实现了服务实例清单在运行期的动态更新能力;同时,它还具备了对服务实例清单的过滤功能,也就是说,我们可以通过过滤器来选择性地获取一批服务实例清单。ZoneAwareLoadBalancer
:是对DynamicServerListLoadBalancer
的扩展。在引入Spring Cloud Ribbon的依赖之后,就能够自动化构建下面这些接口的实现:
IClientConfig
:Ribbon
的客户端配置,默认采用com.netflix.client.config.DefaultClientConfigImpl
实现。IRule
:Ribbon
的负载均衡策略,默认采用com.netflix.loadbalancer.ZoneAvoidanceRule
实现,该策略能够在多区域环境下选出最佳区域的实例进行访问。IPing
:Ribbon
的实例检查策略,默认采用com.netflix.loadbalancer.NoOpPing
实现,该检查策略是一个特殊的实现,实际上它并不会检查实例是否可用,而是始终返回true
,默认认为所有服务实例都是可用的。ServerList<Server>
:服务实例清单的维护机制,默认采用com.netflix.loadbalancer.ConfigurationBasedServerList
实现。ServerListFilter<Server>
:服务实例清单过滤机制,默认采用org.springframework.cloud.netflix.ribbon.ZonePrefenceServerListFilter
实现,该策略能够优先过滤出与请求调用方处于同区域的服务实例。ILoadBalancer
:负载均衡器,默认采用com.netflix.loadbalancer.ZoneAwareLoadBalancer
实现,它具备了区域感知的能力。上面这些自动化配置内容仅在没有引入Spring Cloud Eureka
等服务治理框架时如此,在同时引入Eureka
和Ribbon
依赖时,自动化配置会有一些不同。
通过自动化配置的实现,可以轻松地实现客户端负载均衡。同时,针对一些个性化需求,也可以方便地替换上面的这些默认实现。只需要在Spring Boot
应用中创建对应的实现实例就能覆盖这些默认的配置实现。比如下面的配置内容,由于创建了PingUrl
实例,所以默认的NoOpPing
就不会被创建。
@Configurationpublic class MyRibbonCconfiguration{ @Bean public IPing ribbonPing(IClientConfig config){ return new PingUrl(); }}
另外,也可以通过使用@RibbonClient
注解来实现更细粒度的客户端配置,比如下面的代码实现了为hello-service
服务使用HelloServiceConfiguration
中的配置。
@Configuration@RibbonClient(name="hello-service",configuration=HelloServiceConfiguration.class)public class RibbonConfiguration{ }
上面介绍在Brixton
版本中对RibbonClient
的IPing
、IRule
等接口实现进行个性化定制的方法,主要通过独立创建一个Configuration
类来定义IPing
、IRule
等接口的具体实现Bean
,然后在创建RibbonClient
时制定要使用的具体Configuration
类来覆盖自动化配置的默认实现。虽然这种方式已经能够实现个性化的定义,但是当有大量这类配置的时候,对于各个RibbonClient
的制定配置信息都将分散在这些配置类的注解定义中,这使得管理和修改都变得非常不方便。所以,在Camden
版本中,Sping Cloud Ribbon
对RibbonClient
定义个性化配置的方法做了进一步优化。可以直接通过<clientName>.ribbon.<key>=<value>
的形式进行配置。比如我们要实现与上面例子一样的配置(将hello-service
服务客户端的IPing
接口实现替换为PingUrl
),只需在application.properties
配置中增加如下内容即可:
hello-service.ribbon.NFLoadBalancePingClassName=com.netflix.loadbalancer.PingUrl
其中hello-service
为服务名,NFLoadBalancerPingClassName
参数用来指定具体的IPing
接口实现类。
在Camden
版本中我们可以通过配置的方式,更加方便地为RibbonClient
指定ILoadBalancer
、IPing
、IRule
、ServerList
和ServerListFilter
的定制化实现。
对于Ribbon
的参数配置通常有两种方式:全局配置以及指定客户端配置。
ribbon.<key>=<value>
格式进行配置即可。 其中,<key>
代表了Ribbon
客户端配置的参数名,<value>
则代表了对应参数的值。全局配置可以作为默认值进行设置,当指定客户端配置了相应key
的值时,将覆盖全局配置的内容。我们可以像下面这样全局配置Ribbon
创建连接的超时时间:ribbon.ConnetcTimeout=250
<client>.ribbon.<key>=<value>
的格式进行配置。其中,<key>
和<value>
的含义同全局配置相同,而<client>
代表了客户端的名称,如上文中我们在@RibbonClient
中指定的名称,也可以将它理解为是一个服务名。为了方便理解这种配置方式,举一个例子:假设,有一个服务消费者通过RestTemplate
来访问hello-service
服务的/hello
接口,这时会这样调用restTemplate.getForEntity(“http://hello-service/hello“,String.class).getBody();
如果没有服务治理框架的帮助,我们需要为该客户端指定具体的实例清单,可以指定服务名来做详细的配置,具体如下:hello-service.ribbon.listOfServers=localhost:8001,localhost:8002,localhost:8003
当在Spring Cloud
的应用中同时引入Spring Cloud Ribbon
和Spring Cloud Eureka
依赖时,会触发Eureka
中实现的对Ribbon
的自动化配置。这时ServerList
的维护机制实现将被com.netflix.niws.loadbalancer.DiscoveryEnabledNIWSServerList
的实例所覆盖,该实现会将服务清单列表交给Eureka
的服务治理机制来进行维护;IPing
的实现将被com.netflix.niws.loadbalancer.NIWSDiscoveryPing
的实例所覆盖,该实现也将实例检查的任务交给了服务治理框架来进行维护。默认情况下,用于获取实例请求的ServerList
接口实现将采用Spring Cloud Eureka
中封装的org.springframework.cloud.netflix.ribbon.eureka.DomainExtractingServerList
,其目的是为了让实例维护策略更加通用,所以将使用物理元数据来进行负载均衡,而不是使用原生的AWS AMI
元数据。
由于Spring Cloud Ribbon
默认实现了区域亲和策略,所以,可以通过Eureka
实例的元数据配置来实现区域化的实例配置方案。比如,可以将处于不同机房的实例配置成不同的区域值,以作为跨区域的容错机制实现。而实现的方式非常简单,只需要在服务实例的元数据中增加zone
参数来指定自己所在的区域,比如:
eureka.instance.metadataMap.zone=shanghai
在Spring Cloud Ribbon
与Spring Cloud Eureka
结合的工程中,我们也可以通过参数配置的方式来禁用Eureka
对Ribbon
服务实例的维护实现。只需要在配置中加入如下参数,这时我们对于服务实例的维护就又回归到使用<client>.ribbon.listOfServers
参数配置的方式来实现了。
ribbon.eureka.enabled=false
由于Spring Cloud Eureka
实现的服务治理机制强调了CAP
原理中的AP
,即可用性与可靠性,它与ZooKeeper
这类强调CP
(一致性、可靠性)的服务治理框架最大的区别就是,Eureka
为了实现更高的服务可用性,牺牲了一定的一致性,在极端情况下它宁愿接受故障实例也不要丢掉“健康”实例,比如,当服务注册中心的网络发生故障断开时,由于所有的服务实例无法维持续约心跳,在强调AP的服务治理中会把所有服务实例都剔除掉,而Eureka则会因为超过85%的实例丢失心跳而会触发保护机制,注册中心将会保留此时的所有节点,以实现服务间依然可以进行互相调用的场景,即使其中有部分故障节点,但这样做可以继续保障大多数的服务正常消费。
由于Spring Cloud Eureka
在可用性与一致性上的取舍,不论是由于触发了保护机制还是服务剔除的延迟,引起服务调用到故障实例的时候,我们还是希望能够增强对这类问题的容错。所以,我们在实现服务调用的时候通常会加入一些重试机制。从Camden SR2
版本开始,Spring Cloud
整合了Spring Retry
来增强RestTemplate
的重试能力,对于开发者来说只需通过简单的配置,原来那些通过RestTemplate
实现的服务访问就会自动根据配置来实现重试策略。
以之前对hello-service
服务的调用为例,可以在配置文件中增加如下内容:
spring.cloud.loadbalancer.retry.enabled=truehystrix.command.default.execution.isolation.thread.timeoutInMillseconds=10000hello-service.ribbon.ConnetTimeout=250hello-service.ribbon.ReadTimeout=1000hello-service.ribbion.OkToRetryOnAllOperations=truehello-service.ribbon.MaxAutoRetriesNextServer=2hello-service.ribbon.MaxAutoRetries=1
说明:
spring.cloud.loadbalancer.retry.enabled
:该参数用来开启重试机制,它默认是关闭的。hystrix.command.default.execution.isolation.thread.timeoutInMillseconds
:断路器的超时时间需要大于Ribbon
的超时时间,不然不会触发重试。hello-service.ribbon.ConnectTimeout
:请求连接的超时时间。hello-service.ribbon.ReadTimeout
:请求处理的超时时间。hello-service.ribbon.OkToRetryOnAllOperations
:对所有操作请求都进行重试。hello-service.ribbon.MaxAutoRetriesNextServer
:切换实例的重试次数。hello-service.ribbon.MaxAutoRetries
:对当前实例的重试次数。根据如上配置,当访问到故障请求的时候,它会再尝试访问一次当前实例(次数由MaxAutoRetries
配置),如果不行,就换一个实例进行访问,如果还不行,再换一次实例访问(更换次数由MaxAutoRetriesNextServer
配置),如果依然不行,返回失败信息。
Spring Cloud Ribbon
和Spring Cloud Hystrix
被作为基础工具类框架广泛地应用在各个微服务的实现中,不仅包括我们自身的业务类微服务,也包括一些基础设施类微服务(比如网关)。此外,在实践过程中,我们会发现对这两个框架的使用几乎是同时出现的。Spring Cloud Feign
就是整合了这两个基础工具来简化开发的一个工具。
Spring Cloud Feign
是一套基于Netflix Feign
实现的声明式服务调用客户端。它整合了Spring Cloud Ribbon
与Spring Cloud Hystrix
,除了提供这两者的强大功能之外,它还提供了一种声明式的Web
服务客户端定义方式。
它使得编写Web
服务客户端变得更加简单。我们只需要通过创建接口并用注解来配置它,即可完成对服务提供方的接口绑定,简化了在使用Spring Cloud Ribbon时自行封装服务调用客户端的开发量。
它具备可插拔的注解支持,包括Feign
注解、JAX-RS
注解。它也支持可插拔的编码器和解码器。Spring Cloud Feign
还扩展了对Spring MVC
注解的支持,同时还整合了Ribbon
和Eureka
来提供均衡负载的HTTP
客户端实现。
前面在使用Ribbon+RestTemplate
时,利用RestTemplate
对http
请求的封装处理,形成了一套模板化的调用方法。但是在实际开发中,由于对服务依赖的调用可能不止一处,往往一个接口会被多处调用,所以通常都会针对每个微服务自行封装一些客户端类来包装这些依赖服务的调用。所以,Feign
在此基础上做了进一步封装,由他来帮助我们定义和实现依赖服务接口的定义。在Feign
的实现下,我们只需创建一个接口并使用注解的方式来配置它(以前是Dao
接口上面标注Mapper
注解,现在是一个微服务接口上面标注一个Feign
注解即可),即可完成对服务提供方的接口绑定,简化了使用Spring Cloud Ribbon
时,自动封装服务调用客户端的开发量。
JDK8+
Gradle4+
Redis 3.2.100
Spring Boot 2.0.0.M3
Spring Cloud Starter Netflix Eureka Client Finchley.M2
Spring Cloud Starter OpenFeign Finchley.M2
复制之前的micro-weather-eureka-client
项目,将副本改名为micro-weather-eureka-client-feign
修改build.gradle
配置,添加Feign
依赖:
//依赖关系dependencies { //Eureka Client compile('org.springframework.cloud:spring-cloud-starter-netflix-eureka-client') //Feign compile('org.springframework.cloud:spring-cloud-starter-openfeign:2.0.0.M3') //该依赖用于测试阶段 testCompile('org.springframework.boot:spring-boot-starter-test')}
此处要注意Feign
依赖的版本,如果不加版本号,将默认下载2.0.0.M2
版本,源码中是没有LoadBalancedRetryFactory
的,运行会导致以下报错:
java.lang.ClassNotFoundException: org.springframework.cloud.client.loadbalancer.LoadBalancedRetryFactory
修改com.study.spring.cloud.weather
包下的Application
类,加入@EnableFeignClients
注解,开启扫描Spring Cloud Feign
客户端的功能:
package com.study.spring.cloud.weather;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;import org.springframework.cloud.client.discovery.EnableDiscoveryClient;import org.springframework.cloud.netflix.feign.EnableFeignClients;/* * @SpringBootApplication注解声明Spring Boot应用 * 作用等同于@Configuration, @EnableAutoConfiguration, @ComponentScan, * 简化Spring配置*/@SpringBootApplication//启用可发现的客户端@EnableDiscoveryClient//启用Feign@EnableFeignClients//Application类一定要处于整个工程的根目录下,这样它才能根据配置去扫描子节点下的Spring的Beanpublic class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); }}
新建com.study.spring.cloud.weather.service
包,在包下新建接口CityClient
,使用@FeignClient
注解来指定这个接口所要调用的服务名称,接口中定义的各个函数使用Spring MVC
的注解就可以来绑定服务提供方的REST
接口:
package com.study.spring.cloud.weather.service;import org.springframework.cloud.netflix.feign.FeignClient;import org.springframework.web.bind.annotation.GetMapping;//指明服务地址@FeignClient("mas-weather-city-eureka")public interface CityClient { @GetMapping("/cities") String listCity();}
这里服务名不区分大小写,所以使用mas-weather-city-eureka
和MAS-WEATHER-CITY-EUREKA
都是可以的。
在com.study.spring.cloud.weather.controller
包下新建类CityController
,使用@Autowired
直接注入上面定义的CityClient
实例,并在listCity
函数中调用这个绑定了mas-weather-city-eureka
服务接口的客户端来向该服务发起/cities
接口的调用,通过定义的Feign
客户端来调用服务提供方的接口:
package com.study.spring.cloud.weather.controller;import com.study.spring.cloud.weather.service.CityClient;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.RestController;//用于处理rest请求的controller@RestControllerpublic class CityController { @Autowired private CityClient cityClient; @GetMapping("/cities") public String listCity() { //通过Feign客户端来查找 String body=cityClient.listCity(); return body; } }
修改application.properties
配置文件:
#应用名称spring.application.name=micro-weather-eureka-client-feign#注册服务器的URLeureka.client.service-url.defaultZone=http://localhost:8761/eureka/#请求服务时的超时时间feign.client.config.feignName.connect-timeout=5000#读数据时的超时时间feign.client.config.feignName.read-timeout=5000
IDE
上运行micro-weather-eureka-server
msa-weather-city-eureka
: 因为之前已经编译过,直接进入E:\workspace\workspace-study\springcloud-study\imooc-spring-cloud-study\msa-weather-city-eureka\build\libs
目录, 再通过命令java -jar msa-weather-city-eureka-1.0.0.jar --server.port=8081
运行jar
包即可IDE
上运行micro-weather-eureka-client-feign
,运行结果如下: http://localhost:8761
页面,可以看到Eureka
的管理页面: http://localhost:8080/cities
页面: 通过Spring Cloud Feign
来实现服务调用的方式更加简单了,通过@FeignClient
定义的接口来统一的生命我们需要依赖的微服务接口。而在具体使用的时候就跟调用本地方法一点的进行调用即可。由于Feign
是基于Ribbon
实现的,所以它自带了客户端负载均衡功能,也可以通过Ribbon
的IRule
进行策略扩展。另外,Feign
还整合的Hystrix
来实现服务的容错保护,在Dalston
版本中,Feign
的Hystrix
默认是关闭的。
在Spring Cloud Feign
中,除了引入了用于客户端负载均衡的Spring Cloud Ribbon
之外,还引入了服务保护与容错的工具Hystrix
。默认情况下,Spring Cloud Feign
会为将所有Feign
客户端的方法都封装到Hystrix
命令中进行服务保护。
对于Hystrix
的全局配置同Spring Cloud Ribbon
的全局配置一样,直接使用它的默认配置前缀hystrix.command.default
就可以进行设置,比如设置全局的超时时间:
hystrix.command.default.execution.isolation.thread.timeoutInMilliseconds=5000
另外,在对Hystrix
进行配置之前,我们需要确认feign.hystrix.enabled
参数没有被设置为false
,否则该参数设置会关闭Feign
客户端的Hystrix
支持。
对于Hystrix
命令的配置,在实际应用时往往也会根据实际业务情况制定出不同的配置方案。配置方法也跟传统的Hystrix
命令的参数配置相似,采用hystrix.command.<commandKey>
作为前缀。而<commandKey>
默认情况下会采用Feign
客户端中的方法名作为标识,比如对/hello
接口的熔断超时时间的配置可以通过其方法名作为<commandKey>
来进行配置,具体如下:
hystrix.command.hello.execution.isolation.thread.timeoutInMilliseconds=5000
在使用指定命令配置的时候,需要注意,由于方法名很有可能重复,这个时候相同方法名的Hystrix
配置会共用,所以在进行方法定义与配置的时候需要做好一定的规划。当然,也可以重写Feign.Builder
的实现,并在应用主类中创建它的实例来覆盖自动化配置的HystrixFeign.Builder
实现。
Spring Cloud Feign
支持对请求与响应进行GZIP
压缩,以减少通信过程中的性能损耗。我们只需通过下面两个参数设置,就能开启请求与响应的压缩功能:
feign.compression.request.enabled=truefeign.compression.response.enabled=true
同时,我们还能对请求压缩做一些更细致的设置,比如下面的配置内容指定了压缩的请求数据类型,并设置了请求压缩的大小下限,只有超过这个大小的请求才会对其进行压缩。
feign.compression.request.enabled=truefeign.compression.request.mime-types=text/xml,application/jsonfeign.compression.request.min-request-size=2048
上述配置的feign.compression.request.mime-types
和feign.compression.request.min-request-size
均为默认值。
转载地址:http://hgiwi.baihongyu.com/