Spring Cloud - 使用 Hystrix 的断路器
介绍
在分布式环境中，服务需要相互通信。通信可以同步或异步发生。当服务同步通信时，可能有多种原因导致出现问题。例如 -
被调用者服务不可用- 正在调用的服务由于某种原因而关闭，例如 - bug、部署等。
被调用者服务需要时间来响应- 由于高负载或资源消耗，正在调用的服务可能会很慢，或者正在初始化服务。
无论哪种情况，调用者等待被调用者响应都会浪费时间和网络资源。对于服务来说，在一段时间后退出并调用被调用者服务或共享默认响应更有意义。
Netflix Hystrix、Resilince4j是两个著名的断路器，用于处理此类情况。在本教程中，我们将使用 Hystrix。
Hystrix – 依赖设置
让我们以之前使用过的 Restaurant 为例。让我们将hystrix 依赖项添加到调用客户服务的餐厅服务中。首先，让我们使用以下依赖项更新服务的pom.xml -
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-hystrix</artifactId> <version>2.7.0.RELEASE</version> </dependency>
然后，使用正确的注释来注释我们的 Spring 应用程序类，即@EnableHystrix
package com.tutorialspoint;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.circuitbreaker.EnableCircuitBreaker;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.netflix.hystrix.EnableHystrix;
import org.springframework.cloud.openfeign.EnableFeignClients;
@SpringBootApplication
@EnableFeignClients
@EnableDiscoveryClient
@EnableHystrix
public class RestaurantService{
public static void main(String[] args) {
SpringApplication.run(RestaurantService.class, args);
}
}
注意事项
@EnableDiscoveryClient和@EnableFeignCLient - 我们已经在上一章中查看了这些注释。
@EnableHystrix - 此注释扫描我们的包并查找使用 @HystrixCommand 注释的方法。
Hystrix 命令注解
完成后，我们将重用我们之前在餐厅服务中为客户服务类定义的 Feign 客户端，这里没有任何更改 -
package com.tutorialspoint;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
@FeignClient(name = "customer-service")
public interface CustomerService {
@RequestMapping("/customer/{id}")
public Customer getCustomerById(@PathVariable("id") Long id);
}
现在，让我们在这里定义将使用 Feign 客户端的服务实现类。这将是一个围绕假客户端的简单包装。
package com.tutorialspoint;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import com.netflix.hystrix.contrib.javanica.annotation.HystrixCommand;
@Service
public class CustomerServiceImpl implements CustomerService {
@Autowired
CustomerService customerService;
@HystrixCommand(fallbackMethod="defaultCustomerWithNYCity")
public Customer getCustomerById(Long id) {
return customerService.getCustomerById(id);
}
// assume customer resides in NY city
public Customer defaultCustomerWithNYCity(Long id) {
return new Customer(id, null, "NY");
}
}
现在，让我们从上面的代码中了解几点 -
HystrixCommand 注释- 这负责包装getCustomerById函数调用并提供围绕它的代理。然后，代理提供各种钩子，通过它们我们可以控制对客户服务的调用。例如，请求超时、请求池、提供后备方法等。
Fallback method - 我们可以指定当 Hystrix 确定被调用者出现问题时要调用的方法。该方法需要与被注释的方法具有相同的签名。在我们的例子中，我们决定将数据提供给纽约市的控制器。
该注释提供了几个有用的选项 -
错误阈值百分比- 在电路跳闸（即调用回退方法）之前允许失败的请求的百分比。这可以通过使用 cicutiBreaker.errorThresholdPercentage 来控制
超时后放弃网络请求- 如果被调用方服务（在我们的例子中为客户服务）速度很慢，我们可以设置超时，之后我们将删除请求并转到后备方法。这是通过设置execution.isolation.thread.timeoutInMilliseconds来控制的
最后，这是我们的控制器，我们称之为CustomerServiceImpl
package com.tutorialspoint;
import java.util.HashMap;
import java.util.List;
import java.util.stream.Collectors;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
class RestaurantController {
@Autowired
CustomerServiceImpl customerService;
static HashMap<Long, Restaurant> mockRestaurantData = new HashMap();
static{
mockRestaurantData.put(1L, new Restaurant(1, "Pandas", "DC"));
mockRestaurantData.put(2L, new Restaurant(2, "Indies", "SFO"));
mockRestaurantData.put(3L, new Restaurant(3, "Little Italy", "DC"));
mockRestaurantData.put(3L, new Restaurant(4, "Pizeeria", "NY"));
}
@RequestMapping("/restaurant/customer/{id}")
public List<Restaurant> getRestaurantForCustomer(@PathVariable("id") Long
id)
{
System.out.println("Got request for customer with id: " + id);
String customerCity = customerService.getCustomerById(id).getCity();
return mockRestaurantData.entrySet().stream().filter(
entry -> entry.getValue().getCity().equals(customerCity))
.map(entry -> entry.getValue())
.collect(Collectors.toList());
}
}
电路跳闸/开路
现在我们已经完成了设置，让我们尝试一下。这里只是一些背景知识，我们要做的如下 -
启动尤里卡服务器
启动客户服务
启动餐厅服务，该服务将在内部调用客户服务。
对 Restaurant Service 进行 API 调用
关闭客户服务
对 Restaurant Service 进行 API 调用。如果客户服务出现故障，就会导致失败，最终会调用回退方法。
现在让我们编译餐厅服务代码并使用以下命令执行 -
java -Dapp_port=8082 -jar .\target\spring-cloud-feign-client-1.0.jar
另外，启动客户服务和 Eureka 服务器。请注意，这些服务没有任何变化，它们与前面章节中看到的保持相同。
现在，让我们尝试为住在华盛顿的 Jane 寻找餐厅。
{
"id": 1,
"name": "Jane",
"city": "DC"
}
为此，我们将点击以下 URL：http://localhost:8082/restaurant/customer/1
[
{
"id": 1,
"name": "Pandas",
"city": "DC"
},
{
"id": 3,
"name": "Little Italy",
"city": "DC"
}
]
所以，这里没什么新鲜事，我们得到了华盛顿特区的餐馆。现在，让我们转到有趣的部分，即关闭客户服务。您可以通过按 Ctrl+C 或简单地终止 shell 来完成此操作。
现在让我们再次点击相同的 URL - http://localhost:8082/restaurant/customer/1
{
"id": 4,
"name": "Pizzeria",
"city": "NY"
}
从输出中可以看出，尽管我们的客户来自华盛顿，但我们得到了来自纽约的餐馆。这是因为我们的后备方法返回了位于纽约的虚拟客户。虽然没有用，但上面的示例显示回退已按预期调用。
将缓存与 Hystrix 集成
为了让上述方法更加有用，我们可以在使用Hystrix时集成缓存。这是一种有用的模式，可以在底层服务不可用时提供更好的答案。
首先，让我们创建该服务的缓存版本。
package com.tutorialspoint;
import java.util.HashMap;
import java.util.Map;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import com.netflix.hystrix.contrib.javanica.annotation.HystrixCommand;
@Service
public class CustomerServiceCachedFallback implements CustomerService {
Map<Long, Customer> cachedCustomer = new HashMap<>();
@Autowired
CustomerService customerService;
@HystrixCommand(fallbackMethod="defaultToCachedData")
public Customer getCustomerById(Long id) {
Customer customer = customerService.getCustomerById(id);
// cache value for future reference
cachedCustomer.put(customer.getId(), customer);
return customer;
}
// get customer data from local cache
public Customer defaultToCachedData(Long id) {
return cachedCustomer.get(id);
}
}
我们使用 hashMap 作为存储来缓存数据。这是出于发展目的。在生产环境中，我们可能希望使用更好的缓存解决方案，例如Redis、Hazelcast等。
现在，我们只需要更新控制器中的一行即可使用上述服务 -
@RestController
class RestaurantController {
@Autowired
CustomerServiceCachedFallback customerService;
static HashMap<Long, Restaurant> mockRestaurantData = new HashMap();
…
}
我们将遵循与上面相同的步骤 -
启动尤里卡服务器。
启动客户服务。
启动餐厅服务，在内部调用客户服务。
对餐厅服务进行 API 调用。
关闭客户服务。
对餐厅服务进行 API 调用。鉴于客户服务已关闭但数据已缓存，我们将获得一组有效的数据。
现在，让我们遵循相同的过程直到步骤 3。
现在点击 URL：http://localhost:8082/restaurant/customer/1
[
{
"id": 1,
"name": "Pandas",
"city": "DC"
},
{
"id": 3,
"name": "Little Italy",
"city": "DC"
}
]
所以，这里没什么新鲜事，我们得到了华盛顿特区的餐馆。现在，让我们转到有趣的部分，即关闭客户服务。您可以通过按 Ctrl+C 或简单地终止 shell 来完成此操作。
现在让我们再次点击相同的 URL - http://localhost:8082/restaurant/customer/1
[
{
"id": 1,
"name": "Pandas",
"city": "DC"
},
{
"id": 3,
"name": "Little Italy",
"city": "DC"
}
]
从输出中可以看出，我们得到了来自华盛顿特区的餐厅，这正是我们所期望的，因为我们的客户来自华盛顿特区。这是因为我们的后备方法返回了缓存的客户数据。
Feign 与 Hystrix 集成
我们了解了如何使用 @HystrixCommand 注释来触发电路并提供后备。但我们必须额外定义一个 Service 类来包装我们的 Hystrix 客户端。然而，我们也可以通过简单地将正确的参数传递给 Feign 客户端来实现相同的目的。让我们尝试这样做。为此，首先通过添加后备类来更新 CustomerService 的 Feign 客户端。
package com.tutorialspoint;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
@FeignClient(name = "customer-service", fallback = FallBackHystrix.class)
public interface CustomerService {
@RequestMapping("/customer/{id}")
public Customer getCustomerById(@PathVariable("id") Long id);
}
现在，让我们为 Feign 客户端添加后备类，当 Hystrix 电路跳闸时将调用该类。
package com.tutorialspoint;
import org.springframework.stereotype.Component;
@Component
public class FallBackHystrix implements CustomerService{
@Override
public Customer getCustomerById(Long id) {
System.out.println("Fallback called....");
return new Customer(0, "Temp", "NY");
}
}
最后，我们还需要创建application- Circuit.yml来启用 hystrix。
spring:
application:
name: restaurant-service
server:
port: ${app_port}
eureka:
client:
serviceURL:
defaultZone: http://localhost:8900/eureka
feign:
circuitbreaker:
enabled: true
现在，我们已经准备好了设置，让我们测试一下。我们将遵循以下步骤 -
启动尤里卡服务器。
我们不启动客户服务。
启动餐厅服务，该服务将在内部调用客户服务。
对 Restaurant Service 进行 API 调用。鉴于客户服务中断，我们将注意到回退。
假设第一步已经完成，让我们进入步骤 3。让我们编译代码并执行以下命令 -
java -Dapp_port=8082 -jar .\target\spring-cloud-feign-client-1.0.jar -- spring.config.location=classpath:application-circuit.yml
现在让我们尝试点击 - http://localhost:8082/restaurant/customer/1
由于我们尚未启动客户服务，因此将调用回退，并且回退将纽约作为城市发送，这就是为什么我们在以下输出中看到纽约餐馆。
{
"id": 4,
"name": "Pizzeria",
"city": "NY"
}
另外，为了确认，在日志中，我们会看到 -
…. 2021-03-13 16:27:02.887 WARN 21228 --- [reakerFactory-1] .s.c.o.l.FeignBlockingLoadBalancerClient : Load balancer does not contain an instance for the service customer-service Fallback called.... 2021-03-13 16:27:03.802 INFO 21228 --- [ main] o.s.cloud.commons.util.InetUtils : Cannot determine local hostname …..