Nacos 实现服务平滑上下线(Ribbon 和 LB)

前言

不知道各位在使用 SpringCloud Gateway + Nacos的时候有没有遇到过服务刚上线偶尔会出现一段时间的503 Service Unavailable,或者服务下线后,下线服务仍然被调用的问题。而以上问题都是由于Ribbon或者LoadBalancer的默认处理策略有关,其中Ribbon默认是 30s 更新一次服务信息,LoadBalancer则是默认 35s 更新一次缓存。接下来本文讲解则如何通过监听Nacos 的服务变更事件来实时进行相关服务的更新,以实现服务的平滑上下线。

监听 Nacos 服务变更实现

首先我们要知道的是,在前言中提到的服务上线未被及时感知是由于使用Ribbon或者LoadBalancer组件的默认处理策略所导致的,Nacos是可以及时感知并触发服务上下线的事件,因为我们要做的就是监听Nacos的这个事件,然后在事件处理中,自己手动去调用相关的更新操作以实现需求。而com.alibaba.nacos.client.naming.event.InstancesChangeEvent这个事件则正是符合我们需求的事件,然后我们就可以参考com.alibaba.nacos.client.naming.event.InstancesChangeNotifier这个类来实现一个我们自己的订阅类:

import com.alibaba.nacos.api.common.Constants;
import com.alibaba.nacos.client.naming.event.InstancesChangeEvent;
import com.alibaba.nacos.common.notify.NotifyCenter;
import com.alibaba.nacos.common.notify.listener.Subscriber;
import com.alibaba.nacos.common.notify.Event;
import com.netflix.loadbalancer.*;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import javax.annotation.PostConstruct;
​
/**
 * 服务变更监听
 *
 * @author butterfly
 * @date 2023-09-24
 */
@Slf4j
@Component
public class ServiceChangeNotifier extends Subscriber {
​
    @PostConstruct
    public void init() {
        // 注册当前自定义的订阅者以获取通知
        NotifyCenter.registerSubscriber(this);
    }
​
    @Override
    public void onEvent(InstancesChangeEvent event) {
        String serviceName = event.getServiceName();
        // 使用 dubbo 时包含 rpc 服务类会注册以 providers: 或者 consumers: 开头的服务
        // 由于不是正式的服务, 这里需要进行排除, 如果未使用 dubbo 则不需要该处理
        if (serviceName.contains(":")) {
            return;
        }
        // serviceName 格式为 groupName@@name
        String split = Constants.SERVICE_INFO_SPLITER;
        if (serviceName.contains(split)) {
            serviceName = serviceName.substring(serviceName.indexOf(split) + split.length());
        }
        log.info("服务上下线: {}", serviceName);
        // 针对服务进行后续更新操作
    }
​
    @Override
    public Class