Spring?Cloud?Alibaba實現服務的無損下線功能(案例講解)
1、背景
最近用到了Spring Cloud Alibaba
開發(fā)微服務,在開發(fā)的過程中發(fā)現,當我們的服務上線
或下線
的時候,我們的Spring Cloud Gateway
需要一段時間才能感知到,那么有沒有辦法能夠讓服務立即感知到呢?答案是可以的
。
此種實現方式是我自己記錄下,目前未在生產環(huán)境中使用,此處記錄是為了以后遇到此種場景,可以找到一種解決方案
2、解決方案
2.1 找到通過負載均衡組件獲取可用服務信息的地方
通過一頓Debug
之后,從上圖中可知,我們獲取到可用的服務實例信息,會從緩存中獲取
,那么如果當服務下線后,我們清空這個服務的緩存的信息,那么下次在獲取這個服務的信息就是最新的了,那么問題就解決了。
2.2 解決思路
- 服務提供方或消費方,同時監(jiān)聽
Spring Cloud Config
中的某個配置文件,比如lossless
文件 - 服務下線時, 第一步: 從
nacos
上將自身這個實例下線。 第二步: 通過api
更新lossless
文件中的內容,記錄服務下線的服務名加上時間戳
。 - 消費者或網關,監(jiān)聽到
lossless
配置文件的變更,獲取到服務名
,然后將這個服務名對應的緩存清空
。
3、部分實現代碼
3.1 引入jar
<dependencies> <!-- 服務發(fā)現 --> <dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId> </dependency> <!-- nacos 配置 --> <dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId> </dependency> <!-- 引入這個是為了使 @NacosConfigListener 注解生效 --> <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> <!-- 使bootstrap.yaml中的配置生效 --> <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("觸發(fā)服務下線 serviceName:[{}]", nacosDiscoveryProperties.getService()); nacosServiceManager.nacosServiceShutDown(); nacosConfigManager.getConfigService() .publishConfig(NacosConstant.DATA_ID, NacosConstant.GROUP, nacosDiscoveryProperties.getService() + NacosConstant.SPLIT + System.currentTimeMillis()); } }
此處需要注意的是: 使用nacosConfigManager.getConfigService().publishConfig
發(fā)布配置,此處更新配置中的 服務名+時間戳
,如果只是更新服務名,則可能不會觸發(fā)監(jiān)聽事件。
3.3 監(jiān)聽配置變更,清除服務緩存
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/alibaba/spring-cloud-alibaba/issues/458
3.3.2 監(jiān)聽配置、清除緩存
@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 服務準備
服務 | 端口 | 提供api | 備注 |
---|---|---|---|
nacos-lossless-gateway | 9001 | /consumer/** | 路由到consumer服務 |
nacos-feign-consumer | 9002 | /fetchProviderServerInfo | 通過feign接口,獲取provider服務的ip和port |
nacos-provider-9003 | 9003 | /shutdown | 從nacos server上下線服務,發(fā)布配置變更 |
nacos-provider-9004 | 9004 | /shutdown | 從nacos server上下線服務,發(fā)布配置變更 |
解釋:
1、通過gateway
訪問 http://localhost:9001/consumer/fetchProviderServerInfo
將會返回provider
的ip
和port
信息。
2、http://localhost:9003/shutdown
將會將自己從nacos server下線,并且操作 nacos config,變更配置文件的內容。
3、gateway
和consumer
監(jiān)聽到配置變更,更新服務的緩存,從而下次訪問,不會訪問到這個下線的服務。
4.2 演示
5、完整代碼
https://gitee.com/huan1993/spring-cloud-alibaba-parent/tree/master/nacos-lossless-offline
6、參考鏈接
1、https://github.com/nacos-group/nacos-spring-project
2、https://github.com/alibaba/spring-cloud-alibaba/issues/458
到此這篇關于Spring Cloud Alibaba實現服務的無損下線功能的文章就介紹到這了,更多相關Spring Cloud Alibaba無損下線內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
Java并發(fā)編程中的Callable、Future和FutureTask詳解
這篇文章主要介紹了Java并發(fā)編程中的Callable、Future和FutureTask詳解,創(chuàng)建線程的2種方式,一種是直接繼承Thread,另外一種就是實現Runnable接口,這2種方式都有一個缺陷就是:在執(zhí)行完任務之后無法獲取執(zhí)行結果,需要的朋友可以參考下2023-07-07public?static?void?main(String[]?args)使用解讀
這篇文章主要介紹了public?static?void?main(String[]?args)的使用,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-01-01