Spring Cloud Hystrix缓存与合并请求

╰+攻爆jí腚メ 2024-03-31 17:46 60阅读 0赞

缓存在开发中经常用到，我们常用 Redis 这种第三方的缓存数据库对数据进行缓存处理。本节讲解 Hystrix 缓存的实现和清除，以及请求的合并。

### 结果缓存 ###

在 Hystrix 中也为我们提供了方法级别的缓存。通过重写 getCacheKey 来判断是否返回缓存的数据，getCacheKey 可以根据参数来生成。这样，同样的参数就可以都用到缓存了。

改造之前的 MyHystrixCommand，在其中增加 getCacheKey 的重写实现，代码如下所示。

> 1.  `@Override`
> 2.  `protected String getCacheKey() {`
> 3.  `return String.valueOf(this.name);`
> 4.  `}`

在上面的代码中，我们把创建对象时传进来的 name 参数作为缓存的 key。

为了证明能够用到缓存，在 run 方法中加一行输出，在调用多次的情况下，如果控制台只输出了一次，那么可以知道后面的都是走的缓存逻辑，代码如下所示。

> 1.  `@Override`
> 2.  `protected String run() {`
> 3.  `System.err.println("get data");`
> 4.  `return this.name + ":" + Thread.currentThread().getName();`
> 5.  `}`

执行 main 方法，发现程序报错了，如图 1 所示：

![ef24fc17463942829e0dbc25bc1afd68.png][]  
图 1 运行结果

完整错误信息如下：

> 1.  `Caused by: java.lang.IllegalStateException: Request caching is not available. Maybe you need to initialize the HystrixRequestContext?`

根据错误提示可以知道，缓存的处理取决于请求的上下文，我们必须初始化 Hystrix-RequestContext。

改造 main 方法中的调用代码，初始化 HystrixRequestContext，代码如下所示。

> 1.  `public static void main(String[] args) throws InterruptedException, ExecutionException {`
> 2.  `HystrixRequestContext context = HystrixRequestContext.initializeContext();`
> 3.  `String result = new MyHystrixCommand("zhangsan").execute();`
> 4.  `System.out.println(result);`
> 5.  `Future<String> future = new MyHystrixCommand("zhangsan").queue();`
> 6.  `System.out.println(future.get());`
> 7.  `context.shutdown();`
> 8.  `}`

改造完之后重写执行 main 方法，就可以做正常运行了，输出结果如图 2 所示：

![f9bbb1e5f674b0e71805fc2a103f0469.png][]

图 2 运行结果

我们可以看到只输出了一次 get data，缓存生效。

### 缓存清除 ###

刚刚我们学习了如何使用 Hystrix 来实现数据缓存功能。有缓存必然就有清除缓存的动作。

当数据发生变动时，必须将缓存中的数据也更新掉，不然就会出现脏数据的问题。同样地，Hystrix 也有清除缓存的功能。

增加一个支持缓存清除的类，代码如下所示。

> 1.  `public class ClearCacheHystrixCommand extends HystrixCommand<String> {`
> 2.  `private final String name;`
> 3.  `private static final HystrixCommandKey GETTER_KEY = HystrixCommandKey.Factory.asKey("MyKey");`
> 4.  `public ClearCacheHystrixCommand(String name) {`
> 5.  `super(HystrixCommand.Setter.withGroupKey(HystrixCommandGroupKey.Factory.asKey("MyGroup"))`
> 6.  `.andCommandKey(GETTER_KEY));`
> 7.  `this.name = name;`
> 8.  `}`
> 9.  `public static void flushCache(String name) {`
> 10. `HystrixRequestCache.getInstance(GETTER_KEY,HystrixConcurrencyStrategyDefault.getInstance()).clear(name);`
> 11. `}`
> 12. `@Override`
> 13. `protected String getCacheKey() {`
> 14. `return String.valueOf(this.name);`
> 15. `}`
> 16. `@Override`
> 17. `protected String run() {`
> 18. `System.err.println("get data");`
> 19. `return this.name + ":" + Thread.currentThread().getName();`
> 20. `}`
> 21. `@Override`
> 22. `protected String getFallback() {`
> 23. `return "失败了 ";`
> 24. `}`
> 25. `}`

flushCache 方法就是清除缓存的方法，通过 HystrixRequestCache 来执行清除操作，根据 getCacheKey 返回的 key 来清除。

修改调用代码来验证清除是否有效果，代码如下所示。

> 1.  `public static void main(String[] args) throws InterruptedException, ExecutionException {`
> 2.  `HystrixRequestContext context = HystrixRequestContext.initializeContext();`
> 3.  `String result = new ClearCacheHystrixCommand("zhangsan").execute();`
> 4.  `System.out.println(result);`
> 5.  `ClearCacheHystrixCommand.flushCache("zhangsan");`
> 6.  `Future<String> future = new ClearCacheHystrixCommand("zhangsan").queue();`
> 7.  `System.out.println(future.get());`
> 8.  `}`

执行两次相同的 key，在第二次执行之前调用缓存清除的方法，也就是说第二次用不到缓存，输出结果如图 3 所示：

![419df6069b9bab81b81d29056f5cdea6.png][]

图 3 运行结果

由此可以看出，输出两次 get data，这证明缓存确实被清除了。可以把 ClearCache-HystrixCommand.flushCache 这行代码注释掉再执行一次，就会发现只输出了一次 get data，缓存是有效的，输入结果如图 2 所示。

### 合并请求 ###

Hystrix 支持将多个请求自动合并为一个请求（代码如下所示），利用这个功能可以节省网络开销，比如每个请求都要通过网络访问远程资源。如果把多个请求合并为一个一起执行，将多次网络交互变成一次，则会极大地节省开销。

> 1.  `public class MyHystrixCollapser extends HystrixCollapser<List<String>, String, String> {`
> 2.  `private final String name;`
> 3.  `public MyHystrixCollapser(String name) {`
> 4.  `this.name = name;`
> 5.  `}`
> 6.  `@Override`
> 7.  `public String getRequestArgument() {`
> 8.  `return name;`
> 9.  `}`
> 10. `@Override`
> 11. `protected HystrixCommand<List<String>> createCommand(final Collection<CollapsedRequest<String, String>> requests) {`
> 12. `return new BatchCommand(requests);`
> 13. `}`
> 14. `@Override`
> 15. `protected void mapResponseToRequests(List<String> batchResponse,`
> 16. `Collection<CollapsedRequest<String, String>> requests) {`
> 17. `int count = 0;`
> 18. `for (CollapsedRequest<String, String> request : requests) {`
> 19. `request.setResponse(batchResponse.get(count++));`
> 20. `}`
> 21. `}`
> 22. `private static final class BatchCommand extends HystrixCommand<List<String>> {`
> 23. `private final Collection<CollapsedRequest<String, String>> requests;`
> 24. `private BatchCommand(Collection<CollapsedRequest<String, String>> requests) {`
> 25. `super(Setter.withGroupKey(HystrixCommandGroupKey.Factory.asKey("ExampleGroup"))`
> 26. `.andCommandKey(HystrixCommandKey.Factory.asKey("GetValueForKey")));`
> 27. `this.requests = requests;`
> 28. `}`
> 29. `@Override`
> 30. `protected List<String> run() {`
> 31. `System.out.println(" 真正执行请求......");`
> 32. `ArrayList<String> response = new ArrayList<String>();`
> 33. `for (CollapsedRequest<String, String> request : requests) {`
> 34. `response.add(" 返回结果 : " + request.getArgument());`
> 35. `}`
> 36. `return response;`
> 37. `}`
> 38. `}`
> 39. `}`

接下来编写测试代码，代码如下所示。

> 1.  `public static void main(String[] args) throws InterruptedException, ExecutionException {`
> 2.  `HystrixRequestContext context = HystrixRequestContext.initializeContext();`
> 3.  `Future<String> f1 = new MyHystrixCollapser("zhangsan").queue();`
> 4.  `Future<String> f2 = new MyHystrixCollapser("zhangsan333").queue();`
> 5.  `System.out.println(f1.get() + "=" + f2.get());`
> 6.  `context.shutdown();`
> 7.  `}`

通过 MyHystrixCollapser 创建两个执行任务，按照正常的逻辑肯定是分别执行这两个任务，通过 HystrixCollapser 可以将多个任务合并到一起执行。从输出结果就可以看出，任务的执行是在 run 方法中去做的，输出结果如图 4 所示：

![b80cfc11f57abe023ce0dad35cc37369.png][]

图 4 运行结果

[ef24fc17463942829e0dbc25bc1afd68.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/ae204a6f74d94d9daa3a193ba98f14fc.png
[f9bbb1e5f674b0e71805fc2a103f0469.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/e8e28bebc59d43cd8a3ca0c38413f618.png
[419df6069b9bab81b81d29056f5cdea6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/a94124a07fc048d19b387bcede6870cc.png
[b80cfc11f57abe023ce0dad35cc37369.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/33dc1508036f4d11bd8f5388cdc6a600.png