服务引用配置对象缓存

在 Dubbo3 中缓存 ReferenceConfig

特性说明

ReferenceConfig 实例很重，封装了与注册中心的连接以及与提供者的连接，需要缓存。否则重复生成 ReferenceConfig 可能造成性能问题并且会有内存和连接泄漏。在 API 方式编程时，容易忽略此问题。

因此，自 2.4.0 版本开始， dubbo 提供了简单的工具类 ReferenceConfigCache用于缓存 ReferenceConfig 实例。

使用场景

网关等存在动态创建订阅的场景，由于 ReferenceConfig 本身很重，会创建特别多的中间对象，而 proxy 本身是可以复用的，所以通过 ReferenceConfigCache 可以缓存这部分的属性。

使用方式

消除并销毁

消除 Cache 中的 ReferenceConfig，将销毁 ReferenceConfig 并释放对应的资源。

  1. ReferenceConfig<XxxService> reference = new ReferenceConfig<XxxService>();  
  2. reference.setInterface(XxxService.class);  
  3. reference.setVersion("1.0.0");  
  4. ......  
  5. ReferenceConfigCache cache = ReferenceConfigCache.getCache();  
  6. // cache.get方法中会缓存 Reference对象，并且调用ReferenceConfig.get方法启动ReferenceConfig  
  7. XxxService xxxService = cache.get(reference);  
  8. // 注意！ Cache会持有ReferenceConfig，不要在外部再调用ReferenceConfig的destroy方法，导致Cache内的ReferenceConfig失效！  
  9. // 使用xxxService对象  
  10. xxxService.sayHello();
  1. ReferenceConfigCache cache = ReferenceConfigCache.getCache();  
  2. cache.destroy(reference);

缺省 ReferenceConfigCache 把相同服务 Group、接口、版本的 ReferenceConfig 认为是相同，缓存一份。即以服务 Group、接口、版本为缓存的 Key。

修改策略

可以修改这个策略，在 ReferenceConfigCache.getCache 时，传一个 KeyGenerator。详见 ReferenceConfigCache 类的方法。

  1. KeyGenerator keyGenerator = new ...  
  2. ReferenceConfigCache cache = ReferenceConfigCache.getCache(keyGenerator);

最后修改 December 16, 2022: Fix check (#1736) (97972c1)