Spring Cloud Alibaba实现服务的无损下线功能

小咪咪 2024-03-26 19:44 96阅读 0赞

#### 文章目录 ####

*  1、背景
 *  2、解决方案
 *   *  2.1 找到通过负载均衡组件获取可用服务信息的地方
     *  2.2 解决思路
 *  3、部分实现代码
 *   *  3.1 引入jar
     *  3.2 编写服务下线方法
     *  3.3 监听配置变更，清除服务缓存
     *   *  3.3.1 使@NacosConfigListener注解生效
         *  3.3.2 监听配置、清除缓存
 *  4、实现
 *   *  4.1 服务准备
     *  4.2 演示
 *  5、完整代码
 *  6、参考链接

## 1、背景 ##

最近用到了`Spring Cloud Alibaba`开发微服务，在开发的过程中发现，当我们的`服务上线`或`下线`的时候，我们的`Spring Cloud Gateway`需要一段时间才能感知到，那么有没有办法能够让服务立即感知到呢？`答案是可以的`。

`此种实现方式是我自己记录下，目前未在生产环境中使用，此处记录是为了以后遇到此种场景，可以找到一种解决方案`

## 2、解决方案 ##

### 2.1 找到通过负载均衡组件获取可用服务信息的地方 ###

![获取到一个可用的服务实例][4a8ce85ce3d54185b929a4335b700380.png]  
通过一顿`Debug`之后，从上图中可知，我们获取到可用的服务实例信息，`会从缓存中获取`，那么如果当服务下线后，我们清空这个服务的缓存的信息，那么下次在获取这个服务的信息就是最新的了，那么问题就解决了。

### 2.2 解决思路 ###

![服务下线时序图][dd6cf0db79a04f4ca3962880e911f1ad.png]

1.  服务提供方或消费方，同时监听 `Spring Cloud Config`中的某个配置文件，比如`lossless`文件
2.  服务下线时， **第一步：** 从`nacos`上将自身这个实例下线。 **第二步：** 通过`api`更新`lossless` 文件中的内容，`记录服务下线的服务名加上时间戳`。
3.  消费者或网关，监听到`lossless`配置文件的变更，获取到`服务名`，然后将这个服务名对应的`缓存清空`。

## 3、部分实现代码 ##

### 3.1 引入jar ###

<dependencies>
    	
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
        
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>
        
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-spring-context</artifactId>
            <version>1.1.1</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-loadbalancer</artifactId>
        </dependency>
        
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-bootstrap</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>

### 3.2 编写服务下线方法 ###

@Component
    @Slf4j
    public class LosslessOfflineApi {
        
    
        @Resource
        private NacosConfigManager nacosConfigManager;
        @Resource
        private NacosServiceManager nacosServiceManager;
        @Resource
        private NacosDiscoveryProperties nacosDiscoveryProperties;
    
        /**
         * 服务下线
         *
         * @throws NacosException NacosException
         */
        public void offlineService() throws NacosException {
        
            log.info("触发服务下线 serviceName:[{}]", nacosDiscoveryProperties.getService());
            nacosServiceManager.nacosServiceShutDown();
            nacosConfigManager.getConfigService()
                    .publishConfig(NacosConstant.DATA_ID, NacosConstant.GROUP,
                            nacosDiscoveryProperties.getService() + NacosConstant.SPLIT + System.currentTimeMillis());
        }
    }

**此处需要注意的是：** 使用`nacosConfigManager.getConfigService().publishConfig` 发布配置，此处更新配置中的 `服务名+时间戳`，如果只是更新服务名，则可能不会触发监听事件。

### 3.3 监听配置变更，清除服务缓存 ###

#### 3.3.1 使@NacosConfigListener注解生效 ####

1、引入配置

<dependency>
        <groupId>com.alibaba.nacos</groupId>
        <artifactId>nacos-spring-context</artifactId>
        <version>1.1.1</version>
    </dependency>

2、开启注解

@Configuration
    @EnableNacos(globalProperties =
    	@NacosProperties(serverAddr = "${spring.cloud.nacos.config.server-addr}")
    )
    public class NacosConfiguration {
        
    }

3、注解生效参考文档

[https://github.com/nacos-group/nacos-spring-project][https_github.com_nacos-group_nacos-spring-project]  
[https://github.com/alibaba/spring-cloud-alibaba/issues/458][https_github.com_alibaba_spring-cloud-alibaba_issues_458]

#### 3.3.2 监听配置、清除缓存 ####

@Component
    @RequiredArgsConstructor
    @Slf4j
    public class ListenerConfigChange {
        
        @Resource
        private DefaultLoadBalancerCacheManager defaultLoadBalancerCacheManager;
        @Resource
        private NacosServiceManager nacosServiceManager;
        @Resource
        private NacosDiscoveryProperties nacosDiscoveryProperties;
        @Resource
        private NacosServiceDiscovery nacosServiceDiscovery;
        @Resource
        private NacosConfigManager nacosConfigManager;
    
        @NacosConfigListener(groupId = GROUP, dataId = DATA_ID)
        public void configChange(String config) {
        
            log.warn("==>接收到 无损服务下线 配置变更:[{}]", config);
            String serviceName = config.split(SPLIT)[0];
            log.info("需要无损下线的服务名:[{}]", serviceName);
    
            Cache cache = defaultLoadBalancerCacheManager.getCache(SERVICE_INSTANCE_CACHE_NAME);
            if (null != cache) {
        
                cache.evict(serviceName);
                log.info("失效serviceName:[{}]的缓存", serviceName);
            }
        }
    }

## 4、实现 ##

### 4.1 服务准备 ###

<table> 
 <thead> 
  <tr> 
   <th align="left">服务</th> 
   <th align="left">端口</th> 
   <th align="left">提供api</th> 
   <th align="left">备注</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">nacos-lossless-gateway</td> 
   <td align="left">9001</td> 
   <td align="left">/consumer/**</td> 
   <td align="left">路由到consumer服务</td> 
  </tr> 
  <tr> 
   <td align="left">nacos-feign-consumer</td> 
   <td align="left">9002</td> 
   <td align="left">/fetchProviderServerInfo</td> 
   <td align="left">通过feign接口，获取provider服务的ip和port</td> 
  </tr> 
  <tr> 
   <td align="left">nacos-provider-9003</td> 
   <td align="left">9003</td> 
   <td align="left">/shutdown</td> 
   <td align="left">从nacos server上下线服务，发布配置变更</td> 
  </tr> 
  <tr> 
   <td align="left">nacos-provider-9004</td> 
   <td align="left">9004</td> 
   <td align="left">/shutdown</td> 
   <td align="left">从nacos server上下线服务，发布配置变更</td> 
  </tr> 
 </tbody> 
</table>

**解释：**  
1、通过`gateway`访问 `http://localhost:9001/consumer/fetchProviderServerInfo`将会返回`provider`的`ip`和`port`信息。  
2、`http://localhost:9003/shutdown` 将会将自己从nacos server下线，并且操作 nacos config，变更配置文件的内容。  
3、`gateway`和`consumer`监听到配置变更，更新服务的缓存，从而下次访问，不会访问到这个下线的服务。

### 4.2 演示 ###

![演示][33abb7ded73b474fb31bbb386eca4887.gif_pic_center]

## 5、完整代码 ##

[https://gitee.com/huan1993/spring-cloud-alibaba-parent/tree/master/nacos-lossless-offline][https_gitee.com_huan1993_spring-cloud-alibaba-parent_tree_master_nacos-lossless-offline]

## 6、参考链接 ##

1、[https://github.com/nacos-group/nacos-spring-project][https_github.com_nacos-group_nacos-spring-project]  
2、[https://github.com/alibaba/spring-cloud-alibaba/issues/458][https_github.com_alibaba_spring-cloud-alibaba_issues_458]

[4a8ce85ce3d54185b929a4335b700380.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/f1cfc4414ca841c1bc6046ec91db788b.png
[dd6cf0db79a04f4ca3962880e911f1ad.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/636f35aba56c479b94f66a7ab1dd5f72.png
[https_github.com_nacos-group_nacos-spring-project]: https://github.com/nacos-group/nacos-spring-project
[https_github.com_alibaba_spring-cloud-alibaba_issues_458]: https://github.com/alibaba/spring-cloud-alibaba/issues/458
[33abb7ded73b474fb31bbb386eca4887.gif_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/d7f7a8e8bb954abcbca5fde5ff3710db.png
[https_gitee.com_huan1993_spring-cloud-alibaba-parent_tree_master_nacos-lossless-offline]: https://gitee.com/huan1993/spring-cloud-alibaba-parent/tree/master/nacos-lossless-offline%20%20