微服务可靠性建设—Spring Cloud Hystrix的接入

最新推荐文章于 2024-10-01 00:15:00 发布

原创最新推荐文章于 2024-10-01 00:15:00 发布 · 431 阅读

0 ·

CC 4.0 BY-SA版权

【微服务/SpringCloud】同时被 3 个专栏收录

233 篇文章

订阅专栏

【微服务项目】

135 篇文章

订阅专栏

【微服务/SpringCloud/Hystrix】

9 篇文章

订阅专栏

本文介绍了如何在微服务环境中使用Spring Cloud Hystrix进行可靠性建设。首先，详细讲解了接入步骤，包括引入maven依赖、配置application.properties以及在UserDao中设置断路器默认配置。接着，讨论了在需要调用外部服务的方法上使用@HystrixCommand注解实现断路器，并提供了降级处理的方法。最后，强调启动类需添加@EnableCircuitBreaker注解以启用断路器功能。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

微服务可靠性建设—Spring Cloud Hystrix的接入

Spring Cloud Hystrix

接入步骤

引入maven依赖

application.properties

UserDao

修改启动类

微服务可靠性建设—Spring Cloud Hystrix的接入

Spring Cloud Hystrix

接入步骤

引入maven依赖

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-actuator</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-hystrix</artifactId>
		</dependency>

application.properties

hystrix.command.default.execution.isolation.thread.timeoutInMilliseconds=1
hystrix.threadpool.default.coreSize=1
hystrix.threadpool.default.maxQueueSize=1
hystrix.threadpool.default.maximumSize=1

hystrix.command.default.circuitBreaker.errorThresholdPercentage=1
hystrix.command.default.circuitBreaker.sleepWindowInMilliseconds=100000

UserDao

package com.mooc.house.api.dao;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.ParameterizedTypeReference;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Repository;

import com.mooc.house.api.common.RestResponse;
import com.mooc.house.api.config.GenericRest;
import com.mooc.house.api.model.Agency;
import com.mooc.house.api.model.ListResponse;
import com.mooc.house.api.model.User;
import com.mooc.house.api.utils.Rests;
import com.netflix.hystrix.contrib.javanica.annotation.DefaultProperties;
import com.netflix.hystrix.contrib.javanica.annotation.HystrixCommand;
import com.netflix.hystrix.contrib.javanica.annotation.HystrixProperty;

@Repository
@DefaultProperties(
        groupKey="userDao",
        commandProperties={@HystrixProperty(name="execution.isolation.thread.timeoutInMilliseconds",value="2000")},
        threadPoolProperties={
                @HystrixProperty(name="coreSize",value="10"), 
                @HystrixProperty(name="maxQueueSize",value="1000")
        },
        threadPoolKey="userDao"
)
public class UserDao {

  @Autowired
  private GenericRest rest;
  
  @Value("${user.service.name}")
  private String userServiceName;

  @HystrixCommand
  public List<User> getUserList(User query) {
    ResponseEntity<RestResponse<List<User>>> resultEntity = rest.post("http://"+ userServiceName + "/user/getList",query, new ParameterizedTypeReference<RestResponse<List<User>>>() {});
    RestResponse<List<User>> restResponse  = resultEntity.getBody();
    if (restResponse.getCode() == 0) {
        return restResponse.getResult();
    }else {
        return null;
    }
  }

  @HystrixCommand
  public User addUser(User account) {
    String url = "http://" + userServiceName + "/user/add";
    ResponseEntity<RestResponse<User>> responseEntity = rest.post(url,account, new ParameterizedTypeReference<RestResponse<User>>() {});
    RestResponse<User> response = responseEntity.getBody();
    if (response.getCode() == 0) {
       return response.getResult();
    }{
       throw new IllegalStateException("Can not add user");
    }
  }

  @HystrixCommand
  public User authUser(User user) {
    String url = "http://" + userServiceName + "/user/auth";
    ResponseEntity<RestResponse<User>> responseEntity =  rest.post(url, user, new ParameterizedTypeReference<RestResponse<User>>() {});
    RestResponse<User> response = responseEntity.getBody();
    if (response.getCode() == 0) {
      return response.getResult();
   }{
      throw new IllegalStateException("Can not add user");
   }
  }

  @HystrixCommand
  public void logout(String token) {
    String url = "http://" + userServiceName + "/user/logout?token=" + token;
    rest.get(url, new ParameterizedTypeReference<RestResponse<Object>>() {});
  }

  public User getUserByTokenFb(String token){
    return new User();
  }
  
  /**
   * 调用鉴权服务
   * @param token
   * @return
   */
  @HystrixCommand(fallbackMethod="getUserByTokenFb")
  public User getUserByToken(String token) {
    String url = "http://" + userServiceName + "/user/get?token=" + token;
    ResponseEntity<RestResponse<User>> responseEntity = rest.get(url, new ParameterizedTypeReference<RestResponse<User>>() {});
    RestResponse<User> response = responseEntity.getBody();
    if (response == null || response.getCode() != 0) {
       return null;
    }
    return response.getResult();
  }

  @HystrixCommand
  public List<Agency> getAllAgency() {
    return Rests.exc(() ->{
      String url = Rests.toUrl(userServiceName, "/agency/list");
      ResponseEntity<RestResponse<List<Agency>>> responseEntity =
          rest.get(url, new ParameterizedTypeReference<RestResponse<List<Agency>>>() {});
      return responseEntity.getBody();
    }).getResult();
  } 

  public User updateUser(User user) {
    return Rests.exc(() ->{
      String url = Rests.toUrl(userServiceName, "/user/update");
      ResponseEntity<RestResponse<User>> responseEntity =
          rest.post(url, user, new ParameterizedTypeReference<RestResponse<User>>() {});
      return responseEntity.getBody();
    }).getResult();
  }

  @HystrixCommand
  public User getAgentById(Long id) {
   return Rests.exc(() ->{
      String url = Rests.toUrl(userServiceName, "/agency/agentDetail?id=" +id);
      ResponseEntity<RestResponse<User>> responseEntity = rest.get(url, new ParameterizedTypeReference<RestResponse<User>>() {});
      return responseEntity.getBody();
    }).getResult();
  }
  
  /**
   * 用户激活
   * @param key
   */
  public boolean enable(String key) {
    Rests.exc(() ->{
        String url = Rests.toUrl(userServiceName, "/user/enable?key=" + key);
        ResponseEntity<RestResponse<Object>> responseEntity = rest.get(url, new ParameterizedTypeReference<RestResponse<Object>>() {});
        return responseEntity.getBody();
      }
    );
    return true;
  }

  public Agency getAgencyById(Integer id) {
    return Rests.exc(() -> {
      String url = Rests.toUrl(userServiceName, "/agency/agencyDetail?id=" + id);
      ResponseEntity<RestResponse<Agency>> responseEntity = rest.get(url, new ParameterizedTypeReference<RestResponse<Agency>>() {});
      return responseEntity.getBody();
    }).getResult();
  }

  public void addAgency(Agency agency) {
     Rests.exc(() -> {
      String url = Rests.toUrl(userServiceName, "/agency/add");
      ResponseEntity<RestResponse<Object>> responseEntity = rest.post(url, agency,new ParameterizedTypeReference<RestResponse<Object>>() {});
      return responseEntity.getBody();
    });
  }

  public ListResponse<User> getAgentList(Integer limit, Integer offset) {
    return Rests.exc(() -> {
      String url = Rests.toUrl(userServiceName, "/agency/agentList?limit=" + limit + "&offset="+offset);
      ResponseEntity<RestResponse<ListResponse<User>>> responseEntity = rest.get(url,new ParameterizedTypeReference<RestResponse<ListResponse<User>>>() {});
      return responseEntity.getBody();
    }).getResult();
  }

  public String getEmail(String key) {
    return Rests.exc(() -> {
      String url = Rests.toUrl(userServiceName, "/user/getKeyEmail?key=" + key);
      ResponseEntity<RestResponse<String>> responseEntity = rest.get(url,new ParameterizedTypeReference<RestResponse<String>>() {});
      return responseEntity.getBody();
    }).getResult();
  }

  public User reset(String key, String password) {
    return Rests.exc(() -> {
      String url = Rests.toUrl(userServiceName, "/user/reset?key=" + key + "&password="+password);
      ResponseEntity<RestResponse<User>> responseEntity = rest.get(url,new ParameterizedTypeReference<RestResponse<User>>() {});
      return responseEntity.getBody();
    }).getResult();
  }

  public void resetNotify(String email, String url) {
     Rests.exc(() -> {
          String sendUrl = Rests.toUrl(userServiceName, "/user/resetNotify?email=" + email + "&url="+url);
          rest.get(sendUrl,new ParameterizedTypeReference<RestResponse<Object>>() {});
          return new Object();
    });
  }

  
}

说明：

1）在api-gateway网关UserDao中添加入断路器默认配置；

@DefaultProperties(
        groupKey="userDao",
        commandProperties={@HystrixProperty(name="execution.isolation.thread.timeoutInMilliseconds",value="2000")},
        threadPoolProperties={
                @HystrixProperty(name="coreSize",value="10"),
                @HystrixProperty(name="maxQueueSize",value="1000")
        },
        threadPoolKey="userDao"
)

2）在需要调用外部服务的方法上加上注解@HystrixCommand；

  @HystrixCommand
  public List<User> getUserList(User query) {
    ResponseEntity<RestResponse<List<User>>> resultEntity = rest.post("http://"+ userServiceName + "/user/getList",query, new ParameterizedTypeReference<RestResponse<List<User>>>() {});
    RestResponse<List<User>> restResponse  = resultEntity.getBody();
    if (restResponse.getCode() == 0) {
        return restResponse.getResult();
    }else {
        return null;
    }
  }

3）也可以在@HystrixCommand注解上配置降级处理的方法

 /**
   * 调用鉴权服务
   * @param token
   * @return
   */
  @HystrixCommand(fallbackMethod="getUserByTokenFb")
  public User getUserByToken(String token) {
    String url = "http://" + userServiceName + "/user/get?token=" + token;
    ResponseEntity<RestResponse<User>> responseEntity = rest.get(url, new ParameterizedTypeReference<RestResponse<User>>() {});
    RestResponse<User> response = responseEntity.getBody();
    if (response == null || response.getCode() != 0) {
       return null;
    }
    return response.getResult();
  }

  public User getUserByTokenFb(String token){
    return new User();
  }

修改启动类

package com.mooc.house.api;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.ServiceInstance;
import org.springframework.cloud.client.circuitbreaker.EnableCircuitBreaker;
import org.springframework.cloud.client.discovery.DiscoveryClient;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.netflix.ribbon.RibbonClient;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import com.mooc.house.api.config.NewRuleConfig;


@SpringBootApplication
@EnableDiscoveryClient
@EnableCircuitBreaker
@Controller
//@RibbonClient(name="user",configuration=NewRuleConfig.class)
public class ApiGatewayApplication {

	public static void main(String[] args) {
		SpringApplication.run(ApiGatewayApplication.class, args);
	}
	
	@Autowired
	private DiscoveryClient discoveryClient;
	
	@RequestMapping("index1")
	@ResponseBody
	public List<ServiceInstance> getReister(){
	  return discoveryClient.getInstances("user");
	}
	
}

说明：

1）启动类需要添加@EnableCircuitBreaker注解，开启断路器功能；