spring cloud中容错处理Hystrix
一、简介
Hystrix是Netflix开源的延迟和容错工具库,在分布式环境中,提供了超时和熔断功能。同时提供了服务监控功能,结合Turbine,可以聚合监控各Hystrix各端点数据。
二、开发步骤
2.1 容错开发步骤
熔断功能是在调用端配置,也就是客户端开发,步骤如下:
- 在客户端启动类添加注解@EnableHystrix;
- 在调用方法上添加@HystrixCommand注解,注解参数指定熔断处理方法名,并实现熔断处理方法;
2.2 开启监控功能步骤
监控是新开服务,区别客户端,开发步骤如下:
- 监控服务启动类上添加注解@EnableHystrixDashboard;
- 监控服务启动后,在浏览器上打开类似地址http://localhost:8015/hystrix,在监控输入框中输入监控对象,类似
http://localhost:8054/actuator/hystrix.stream
2.3 开启聚合监控功能步骤
结合turbine,可以对多个hystrix进行聚合监控,步骤如下:
-
在监控服务启动类上添加注解@EnableTurbine;
-
application.yaml中添加聚合监控配置,如下:
turbine: app-config: spring-cloud-client-hystrix #监控的对象,多个用英文逗号分隔 combine-host-port: true cluster-name-expression: new String("default")
-
监控服务启动后,在浏览器上打开类似地址http://localhost:8015/hystrix,在监控输入框中输入监控对象,类似
http://localhost:8054/turbine.stream
三、示例
这里使用注册中心spring_cloud_register_center、客户端spring_cloud_client_hystrix、监控服务spring_cloud_hystrix进行示例。
3.1 注册中心
注册中心为spring_cloud_register_center项目。
3.1.1 maven依赖
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.3.2.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.dragon.study</groupId>
<artifactId>spring_cloud_register_center</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>spring_cloud_register_center</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
<spring-cloud.version>Hoxton.SR6</spring-cloud.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring-cloud.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
3.1.2 application.yaml配置
server:
port: 8010
spring:
application:
name: spring-cloud-register-center
eureka:
client:
serviceUrl:
defaultZone: http://localhost:${server.port}/eureka/
fetchRegistry: false #是否拉取注册信息,由于注册中心是单个结点,不需要拉取
registerWithEureka: false #是否注册自己,由于当前就是注册中心,帮不需要注册
3.1.3 启动类
package com.dragon.study.spring_cloud_register_center;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;
@SpringBootApplication
@EnableEurekaServer
public class SpringCloudRegisterCenterApplication {
public static void main(String[] args) {
SpringApplication.run(SpringCloudRegisterCenterApplication.class, args);
}
}
3.2 客户端
客户端,即调用方为spring_cloud_client_hystrix项目。
3.2.1 maven依赖
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.3.2.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.dragon.study</groupId>
<artifactId>spring_cloud_client_hystrix</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>spring_cloud_client_hystrix</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
<spring-cloud.version>Hoxton.SR6</spring-cloud.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.6</version>
<scope>compile</scope>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring-cloud.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
3.2.2 application.yaml配置
server:
port: 8054
spring:
application:
name: spring-cloud-client-hystrix
management:
endpoints:
web:
exposure:
include: '*'
eureka:
client:
service-url:
defaultZone: http://localhost:8010/eureka/
3.2.3 客户端相关类
定义实体bean类Stu.java
package com.dragon.study.spring_cloud_provider.bean;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Stu {
private String stuId;
private Integer age;
}
定义服务controller类StuController.java
package com.dragon.study.spring_cloud_client_hystrix.controller;
import com.dragon.study.spring_cloud_client_hystrix.bean.Stu;
import com.netflix.hystrix.contrib.javanica.annotation.HystrixCommand;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;
import javax.annotation.Resource;
@RestController
@RequestMapping("stu")
public class StuController {
@Resource
private RestTemplate restTemplate;
//当服务不可用时,调用指定的熔断处理方法为getStuFallback
@HystrixCommand(fallbackMethod = "getStuFallback")
@RequestMapping("getStu")
public Object getStu(Stu stu) {
MultiValueMap<String, Object> map = new LinkedMultiValueMap<>();
map.add("stuId", stu.getStuId());
map.add("age", stu.getAge());
return restTemplate.postForObject("http://spring-cloud-provider/stu/getStu", map, Stu.class);
}
//熔断方法
public Stu getStuFallback(Stu stu) {
return new Stu("000", 18);
}
}
定义启动类SpringCloudClientHystrixApplication.java
package com.dragon.study.spring_cloud_client_hystrix;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import org.springframework.cloud.netflix.hystrix.EnableHystrix;
import org.springframework.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;
@SpringBootApplication
@EnableEurekaClient
@EnableHystrix //开启熔断
public class SpringCloudClientHystrixApplication {
@Bean
@LoadBalanced
public RestTemplate restTemplate(){
return new RestTemplate();
}
public static void main(String[] args) {
SpringApplication.run(SpringCloudClientHystrixApplication.class, args);
}
}
3.3 监控服务
监控服务为spring_cloud_hystrix项目。
3.3.1 maven依赖
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.5.RELEASE</version>
</parent>
<groupId>com.dragon.study</groupId>
<artifactId>spring_cloud_hystrix</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>spring_cloud_hystrix</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
<spring-cloud.version>Greenwich.SR1</spring-cloud.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-hystrix</artifactId>
<version>1.4.7.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-netflix-hystrix</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-hystrix-dashboard</artifactId>
<version>1.4.7.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-turbine</artifactId>
<version>1.4.7.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-netflix-turbine</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring-cloud.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
3.3.2 application.yaml配置
server:
port: 8015
spring:
application:
name: sprin-cloud-hystrix
eureka:
client:
service-url:
defaultZone: http://localhost:8010/eureka/
turbine:
app-config: spring-cloud-client-hystrix #监控的对象,多个用英文逗号分隔
combine-host-port: true
cluster-name-expression: new String("default")
management:
endpoints:
web:
exposure:
include: '*'
4.4 测试
依次启动注册中心spring_cloud_register_center、客户端spring_cloud_client_hystrix、监控服务spring_cloud_hystrix。
常规测试:
#在客户端调用,由于无可用服务,故返回结果为熔断方法中的结果
GET http://localhost:8054/stu/getStu?stuId=001&age=17
Accept: application/json
上面输出如下:
{
"stuId": "000",
"age": 18
}
监控测试,在浏览器打开http://10.131.30.98:8015/hystrix,在输入界面输入:
- http://10.131.30.98:8054/actuator/hystrix.stream ,进行单个hystrix测试;
- http://10.131.30.98:8015/turbine.stream,进行聚全测试;
四、备注
4.1 监控界面出错
报错:监控界面一直是loading状态
解决:检查调整方法是带容错(熔错)功能,检查是否因maven版本依赖导致的js报错。