详解Spring Cloud Hystrix断路器实现容错和降级
简介
Springcloud提供了Hystrix容错库用以在服务不可用时,对配置了断路器的方法实行降级策略,临时调用备用方法。这篇文章将创建一个产品微服务,注册到eureka服务注册中心,然后我们使用web客户端访问/productsAPI来获取产品列表,当产品服务故障时,则调用本地备用方法,以降级但正常提供服务。
基础环境
- JDK1.8
- Maven3.3.9
- IntelliJ2018.1
Git:项目源码
添加产品服务
在intelliJ中创建一个新的maven项目,使用如下配置
- groupId:cn.zxuqian
- artifactId:productService
然后在pom.xml中添加如下代码:
4.0.0 cn.zxuqian productService 1.0-SNAPSHOT org.springframework.boot spring-boot-starter-parent 2.0.1.RELEASE UTF-8 1.8 org.springframework.cloud spring-cloud-starter-netflix-eureka-client org.springframework.cloud spring-cloud-starter-config org.springframework.boot spring-boot-starter-web org.springframework.boot spring-boot-starter-test test org.springframework.cloud spring-cloud-dependencies Finchley.M9 pom import org.springframework.boot spring-boot-maven-plugin spring-milestones SpringMilestones https://repo.spring.io/libs-milestone false
我们继续使用了spring-cloud-starter-netflix-eureka-client以使产品服务自动注册到eureka服务中。然后还使用了spring-cloud-starter-config读取配置服务中心的配置文件。这个项目只是一个简单的springweb项目。
在src/main/resources下创建bootstrap.yml文件,添加如下内容:
spring: application: name:product-service cloud: config: uri:http://localhost:8888
在配置中心的git仓库中创建product-service.yml文件添加如下配置并提交:
server: port:8081
此配置指定了产品服务的端口为8081。接着创建Application类,添加如下代码:
packagecn.zxuqian; importorg.springframework.boot.SpringApplication; importorg.springframework.boot.autoconfigure.SpringBootApplication; importorg.springframework.cloud.client.discovery.EnableDiscoveryClient; @EnableDiscoveryClient @SpringBootApplication publicclassApplication{ publicstaticvoidmain(String[]args){ SpringApplication.run(Application.class,args); } }
@EnableDiscoveryClient注解将指示springcloud自动把本服务注册到eureka。最后创建cn.zxuqian.controllers.ProductController控制器,提供/productsAPI,返回示例数据:
packagecn.zxuqian.controllers; importorg.springframework.web.bind.annotation.RequestMapping; importorg.springframework.web.bind.annotation.RestController; @RestController publicclassProductController{ @RequestMapping("/products") publicStringproductList(){ return"外套,夹克,毛衣,T恤"; } }
配置Web客户端
打开我们之前创建的web项目,在pom.xml中新添Hystrix依赖:
org.springframework.cloud spring-cloud-starter-netflix-hystrix
然后更新Application类的代码:
packagecn.zxuqian; importorg.springframework.boot.SpringApplication; importorg.springframework.boot.autoconfigure.SpringBootApplication; importorg.springframework.boot.web.client.RestTemplateBuilder; importorg.springframework.cloud.client.circuitbreaker.EnableCircuitBreaker; importorg.springframework.cloud.client.discovery.EnableDiscoveryClient; importorg.springframework.context.annotation.Bean; importorg.springframework.web.client.RestTemplate; @EnableCircuitBreaker @EnableDiscoveryClient @SpringBootApplication publicclassApplication{ publicstaticvoidmain(String[]args){ SpringApplication.run(Application.class,args); } @Bean publicRestTemplaterest(RestTemplateBuilderbuilder){ returnbuilder.build(); } }
这里使用@EnableCircuitBreaker来开启断路器功能,然后还添加了一个rest方法并使用@Bean注解。这部分属于Spring依赖注入功能,使用@Bean标记的方法将告诉如何初始化此类对象,比如本例中就是使用RestTemplateBuilder来创建一个RestTemplate的对象,这个稍后在使用断路器的service中用到。
创建cn.zxuqian.service.ProductService类,并添加如下代码:
packagecn.zxuqian.services; importcom.netflix.hystrix.contrib.javanica.annotation.HystrixCommand; importorg.springframework.beans.factory.annotation.Autowired; importorg.springframework.cloud.client.ServiceInstance; importorg.springframework.cloud.client.discovery.DiscoveryClient; importorg.springframework.stereotype.Service; importorg.springframework.web.client.RestTemplate; importjava.util.List; @Service publicclassProductService{ privatefinalRestTemplaterestTemplate; @Autowired privateDiscoveryClientdiscoveryClient; publicProductService(RestTemplaterestTemplate){ this.restTemplate=restTemplate; } @HystrixCommand(fallbackMethod="backupProductList") publicStringproductList(){ Listinstances=this.discoveryClient.getInstances("product-service"); if(instances!=null&&instances.size()>0){ returnthis.restTemplate.getForObject(instances.get(0).getUri()+"/products",String.class); } return""; } publicStringbackupProductList(){ return"夹克,毛衣"; } }
之所以要创建一个Service类,是因为Hystrix只能在标记为@Service或@Component的类中使用,这样才能够正常使用SpringContext所提供的API。这个以后深入Spring时再作说明。
使用@HystrixCommand注解后,Hystrix将监控被注解的方法即productList(底层使用proxy包装此方法以此实现监控),一旦此方法的错误累积到一定门槛的时候,就会启动断路器,后续所有调用productList方法的请求都会失败,而会临时调用fallbackMethod指定的方法backupProductList(),然后当服务恢复正常时,断路器就会关闭。
我们还在此类中用了DiscoveryClient用以寻找产品服务的uri地址,使用产品服务的spring.application.name配置项的值,即product-service作为serviceID传给discoveryClient.getInstances()方法,然后会返回一个list,因为目前我们只有一个产品服务启动着,所以只需要取第一个实例的uri地址即可。
然后我们使用RestTemplate来访问产品服务的api,注意这里使用了Spring的构造方法注入,即之前我们用@Bean注解的方法会被用来初始化restTemplate变量,不需我们手动初始化。RestTemplate类提供了getForObject()方法来访问其它RestAPI并把结果包装成对象的形式,第一个参数是要访问的api的uri地址,第二参数为获取的结果的类型,这里我们返回的是String,所以传给他String.class。
backupProductList()方法返回了降级后的产品列表信息。
最后创建一个控制器cn.zxuqian.controllers.ProductController并添加如下代码:
packagecn.zxuqian.controllers; importcn.zxuqian.services.ProductService; importorg.springframework.beans.factory.annotation.Autowired; importorg.springframework.web.bind.annotation.RequestMapping; importorg.springframework.web.bind.annotation.RestController; @RestController publicclassProductController{ @Autowired privateProductServiceproductService; @RequestMapping("/products") publicStringproductList(){ returnproductService.productList(); } }
这里使用ProductService为/products路径提供数据。
测试
首先,我们使用spring-boot:run插件启动配置中心服务,config-server,然后启动eureka-server,再启动product-service,最后启动web客户端,稍等片刻待eureka服务注册成功之后访问http://localhost:8080/products,正常的情况下会得到外套,夹克,毛衣,T恤结果,然后我们关闭product-service,之后再访问同样的路径,会得到降级后的结果:夹克,毛衣
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持毛票票。