nacos源码阅读

代码学习

代码用法

AtomicReference

参考

项目使用

保存白名单配置,并在合适的时候更新配置

public class AggrWhitelist {

    /**
     * 判断指定的dataId是否在聚合dataId白名单。
     */
    static public boolean isAggrDataId(String dataId) {
        if (null == dataId) {
            throw new IllegalArgumentException();
        }

        for (Pattern pattern : AGGR_DATAID_WHITELIST.get()) {
            if (pattern.matcher(dataId).matches()) {
                return true;
            }
        }
        return false;
    }

    /**
     * 传入内容,重新加载聚合白名单
     */
    static public void load(String content) {
        if (StringUtils.isBlank(content)) {
            fatalLog.error("aggr dataId whitelist is blank.");
            return;
        }
        defaultLog.warn("[aggr-dataIds] {}", content);

        try {
            List<String> lines = IOUtils.readLines(new StringReader(content));
            compile(lines);
        } catch (Exception ioe) {
            defaultLog.error("failed to load aggr whitelist, " + ioe.toString(), ioe);
        }
    }

    static void compile(List<String> whitelist) {
        List<Pattern> list = new ArrayList<Pattern>(whitelist.size());

        for (String line : whitelist) {
            if (!StringUtils.isBlank(line)) {
                String regex = RegexParser.regexFormat(line.trim());
                list.add(Pattern.compile(regex));
            }
        }
        AGGR_DATAID_WHITELIST.set(list);
    }

    static public List<Pattern> getWhiteList() {
        return AGGR_DATAID_WHITELIST.get();
    }

    // =======================

    static public final String AGGRIDS_METADATA = "com.alibaba.nacos.metadata.aggrIDs";

    static final AtomicReference<List<Pattern>> AGGR_DATAID_WHITELIST = new AtomicReference<List<Pattern>>(
        new ArrayList<Pattern>());
}

关键代码
private volatile V value;
//这个方法是原子操作的基本
public final boolean compareAndSet(V expect, V update) {
        return unsafe.compareAndSwapObject(this, valueOffset, expect, update);
    }

public final V getAndUpdate(UnaryOperator<V> updateFunction) {
        V prev, next;
        do {
            prev = get();
            next = updateFunction.apply(prev);
        } while (!compareAndSet(prev, next));
        return prev;
    }
public final V getAndSet(V newValue) {
        return (V)unsafe.getAndSetObject(this, valueOffset, newValue);
    }
public final Object getAndSetObject(Object o, long offset, Object newValue) {
        Object v;
        do {
            v = getObjectVolatile(o, offset);
        } while (!compareAndSwapObject(o, offset, v, newValue));
        return v;
    }

用法——volatile+原子更新

对于一般的自增更新或者先获取值,再更新原值的操作,都会出现并发问题。volatile只能解决可见性,但是不能保证跟原值有关的更新操作的原子性。如果更新时,使用compareAndSet等操作,就可以解决这个问题。
发现项目中使用了AtomicBoolean等作为标志,但是没用compareAndSet等方法,是因为它只是为了使用volatile特性,保证可见性。

用法示例
public class BankCardARTest {

    private static AtomicReference<BankCard> bankCardRef = new AtomicReference<>(new BankCard("cxuan",100));

    public static void main(String[] args) {

        for(int i = 0;i < 10;i++){
            new Thread(() -> {
                while (true){
                    // 使用 AtomicReference.get 获取
                    final BankCard card = bankCardRef.get();
                    BankCard newCard = new BankCard(card.getAccountName(), card.getMoney() + 100);
                    // 使用 CAS 乐观锁进行非阻塞更新
                    if(bankCardRef.compareAndSet(card,newCard)){
                        System.out.println(newCard);
                    }
                    try {
                        TimeUnit.SECONDS.sleep(1);
                    } catch (Exception e) {
                        e.printStackTrace();
                    }
                }
            }).start();
        }
    }
}

@FunctionalInterface
项目使用
@FunctionalInterface
public interface TransactionCallback<T> {
	@Nullable
	T doInTransaction(TransactionStatus status);
}
用法

由java8引入,被@FunctionalInterface注解的接口称为函数式接口,可以使用lambda表达式。特点:
(1)接口有且仅有一个抽象方法
(2)该注解不是必须的,如果一个接口符合"函数式接口"定义,那么加不加该注解都没有影响。加上该注解能够更好地让编译器进行检查。如果编写的不是函数式接口,但是加上了@FunctionInterface,那么编译器会报错

Assert.state
关键代码
public static void state(boolean expression, String message) {
		if (!expression) {
			throw new IllegalStateException(message);
		}
	}
public static void isTrue(boolean expression, String message) {
		if (!expression) {
			throw new IllegalArgumentException(message);
		}
	}
用法

和Assert.isTrue方法比较,只是返回的异常类型不一样

Assert.state(this.transactionManager != null, "No PlatformTransactionManager set");
事件发布和监听模型+发布订阅模式
项目使用+关键代码
//事件接口
public interface Event {
}
//业务事件接口
public class ConfigDataChangeEvent implements Event {

    final public boolean isBeta;
    final public String dataId;
    final public String group;
    final public String tenant;
    final public String tag;
    final public long lastModifiedTs;

    public ConfigDataChangeEvent(boolean isBeta, String dataId, String group, String tenant, String tag,
                                 long gmtModified) {
        if (null == dataId || null == group) {
            throw new IllegalArgumentException();
        }
        this.isBeta = isBeta;
        this.dataId = dataId;
        this.group = group;
        this.tenant = tenant;
        this.tag = tag;
        this.lastModifiedTs = gmtModified;
    }
}
//父类事件监听器,提供onEvent事件监听方法 
public abstract class AbstractEventListener {

        public AbstractEventListener() {
            /**
             * automatic register
             */
            EventDispatcher.addEventListener(this);
        }

        /**
         * 感兴趣的事件列表
         *
         * @return event list
         */
        abstract public List<Class<? extends Event>> interest();

        /**
         * 处理事件
         *
         * @param event event
         */
        abstract public void onEvent(Event event);
    }
    
//事件监听器的业务处理
public class AsyncNotifyService extends AbstractEventListener {
@Override
    public void onEvent(Event event) {

        // 并发产生 ConfigDataChangeEvent
        // 通过instanceof,处理自己感兴趣的事件
        if (event instanceof ConfigDataChangeEvent) {
            ConfigDataChangeEvent evt = (ConfigDataChangeEvent) event;
            long dumpTs = evt.lastModifiedTs;
            String dataId = evt.dataId;
            String group = evt.group;
            String tenant = evt.tenant;
            String tag = evt.tag;
            List<?> ipList = serverListService.getServerList();

            // 其实这里任何类型队列都可以
            Queue<NotifySingleTask> queue = new LinkedList<NotifySingleTask>();
            for (int i = 0; i < ipList.size(); i++) {
                queue.add(new NotifySingleTask(dataId, group, tenant, tag, dumpTs, (String) ipList.get(i), evt.isBeta));
            }
            EXECUTOR.execute(new AsyncTask(httpclient, queue));
        }
    }
}

// 事件与监听器绑定模型
static private class Entry {
    	//能处理的事件类型
        final Class<? extends Event> eventType;
        //该类型事件的监听器列表
        final CopyOnWriteArrayList<AbstractEventListener> listeners;

        Entry(Class<? extends Event> type) {
            eventType = type;
            listeners = new CopyOnWriteArrayList<AbstractEventListener>();
        }
}

//事件分发器。简单理解其结构为List<Map<eventType,List<Listener>>>,这里Map用了包装对象,不然太low了
public class EventDispatcher {

    //绑定事件与监听器
    static public void addEventListener(AbstractEventListener listener) {
        for (Class<? extends Event> type : listener.interest()) {
            getEntry(type).listeners.addIfAbsent(listener);
        }
    }

    //发布事件,并通知监听者
    static public void fireEvent(Event event) {
        if (null == event) {
            throw new IllegalArgumentException();
        }
		//根据事件的class类型,获取对应的监听器,触发监听方法
        for (AbstractEventListener listener : getEntry(event.getClass()).listeners) {
            try {
                listener.onEvent(event);
            } catch (Exception e) {
                log.error(e.toString(), e);
            }
        }
    }
    // 根据事件类型获取事件监听者绑定,如果事件之前没保存,就新增一个保存
    static Entry getEntry(Class<? extends Event> eventType) {
        for (; ; ) {
            for (Entry entry : LISTENER_HUB) {
                if (entry.eventType == eventType) {
                    return entry;
                }
            }

            Entry tmp = new Entry(eventType);
            /**
             *  false means already exists
             */
            if (LISTENER_HUB.addIfAbsent(tmp)) {
                return tmp;
            }
        }
    }

    static private class Entry {
    	//能处理的事件类型
        final Class<? extends Event> eventType;
        //该类型事件的监听器列表
        final CopyOnWriteArrayList<AbstractEventListener> listeners;

        Entry(Class<? extends Event> type) {
            eventType = type;
            listeners = new CopyOnWriteArrayList<AbstractEventListener>();
        }

        @Override
        public boolean equals(Object obj) {
            if (null == obj || obj.getClass() != getClass()) {
                return false;
            }
            if (this == obj) {
                return true;
            }
            return eventType == ((Entry)obj).eventType;
        }

        @Override
        public int hashCode() {
            return super.hashCode();
        }

    }
    static private final Logger log = LoggerFactory.getLogger(EventDispatcher.class);

    static final CopyOnWriteArrayList<Entry> LISTENER_HUB = new CopyOnWriteArrayList<Entry>();
}
用法

事件发布和监听模型(发布订阅模式),主要是用来做异步、解耦的,使得事件的发布者和订阅者完全解耦。有时如果是异步的,则可通过队列、线程池来做异步。

订阅模式,是观察者模式的一个别称。但是经过时间的沉淀,已经独立于观察者模式,成为另外一种不同的设计模式。在现在的发布订阅模式中,称为发布者的消息发送者不会将消息直接发送给订阅者,这意味着发布者和订阅者不知道彼此的存在。在发布者和订阅者之间存在第三个组件,称为调度中心或事件通道,它维持着发布者和订阅者之间的联系,过滤所有发布者传入的消息并相应地分发它们给订阅者。
举一个例子,你在微博上关注了A,同时其他很多人也关注了A,那么当A发布动态的时候,微博就会为你们推送这条动态。A就是发布者,你是订阅者,微博就是调度中心,你和A是没有直接的消息往来的,全是通过微博来协调的(你的关注,A的发布动态)。
在这里插入图片描述

CloseableHttpAsyncClient

普通httpclient发出请求之后,连接会等到服务端返回信息;而http异步请求,则多个请求可以共用一个连接,请求放到缓冲区,哪个请求有返回就处理哪个。通过提供回调方法,完成响应的处理。

ThreadFactory

通过线程工厂,给线程设置名字,设置线程为守护线程

static class NotifyThreadFactory implements ThreadFactory {
	   private final AtomicInteger count = new AtomicInteger(1);
	   private String threadNamePrefix = "com.alibaba.nacos.AsyncNotifyServiceThread";

        @Override
        public Thread newThread(Runnable r) {
            Thread thread = new Thread(r);
            thread.setDaemon(true);
	                thread.setName(threadNamePrefix + count.getAndIncrement());
            return thread;
        }
    }
守护线程

根据jdk的注释,当所有正在运行的线程都是用户线程时,那么jvm会自动退出,自然守护线程也会自动关闭。
创建线程池时,有时可以通过把线程设置为守护线程,来隐式的关闭线程池。

失败任务再加入队列

//失败任务重试时,时间指数增加,以免断网场景不断重试无效任务,影响正常同步

private static int getDelayTime(NotifySingleTask task) {
        int failCount = task.getFailCount();
        int delay = MIN_RETRY_INTERVAL + failCount * failCount * INCREASE_STEPS;
        if (failCount <= MAX_COUNT) {
            task.setFailCount(failCount + 1);
        }
        return delay;
    }
隐式调用构造方法,并通过this完成bean的初始化
项目代码
//父类
public abstract class AbstractEventListener {

        public AbstractEventListener() {
            /**
             * automatic register
             */
            EventDispatcher.addEventListener(this);
        }
        abstract public List<Class<? extends Event>> interest();
}
//子类
public class AsyncNotifyService extends AbstractEventListener {

    @Override
    public List<Class<? extends Event>> interest() {
        List<Class<? extends Event>> types = new ArrayList<Class<? extends Event>>();
        // 触发配置变更同步通知
        types.add(ConfigDataChangeEvent.class);
        return types;
    }
    @Autowired
    public AsyncNotifyService(ServerListService serverListService) {
        this.serverListService = serverListService;
        httpclient.start();
    }
}
父类构造方法调用

参考
如果父类没有显式的构造方法,那么它会有一个默认的无参构造方法;
但是一旦有显式的构造方法,不管有参还是无参,则不会有默认的无参构造方法;
调用子类构造方法时,默认会先调用父类的无参构造方法,也可以通过super显式的调用父类构造方法。
父类构造方法被调用时,this参数传递的是子类的对象。

@PostConstruct将bean设置给其他类的属性,以便其他类能调用bean的@Autowired注入的bean
用法

因为bean的生命周期里,是先设置属性(@Autowired注入、@Value注入),后调用初始化后置方法。如果不这样写,通常是用new Service()手工管理,来保证单例,而不通过spring管理,会没那么优雅。

项目代码
@Service
public class DumpService {
	@Autowired
    PersistService persistService;

    @PostConstruct
    public void init() {
    	//这里this,会把DumpService这个bean传给DumpProcessor的
        DumpProcessor processor = new DumpProcessor(this);
}
//通过dumpService.persistService,调用persistService的方法
class DumpProcessor implements TaskProcessor {

    DumpProcessor(DumpService dumpService) {
        this.dumpService = dumpService;
    }
    final DumpService dumpService;
    @Override
    public boolean process(String taskType, AbstractTask task) {
    ConfigInfo4Beta cf = dumpService.persistService.findConfigInfo4Beta(dataId, group, tenant);
    ...}

}
大量数据分页加载
项目代码
//先查出最大id,因为id是主键,所以很快
long currentMaxId = persistService.findConfigMaxId();
        long lastMaxId = 0;
        while (lastMaxId < currentMaxId) {
            Page<PersistService.ConfigInfoWrapper> page = persistService.findAllConfigInfoFragment(lastMaxId,
                PAGE_SIZE);
                //ELECT id,data_id,group_id,tenant_id,app_name,content,md5,gmt_modified from config_info where id > ? order by id asc limit ?,?
            if (page != null && page.getPageItems() != null) {
                for (PersistService.ConfigInfoWrapper cf : page.getPageItems()) {
                    long id = cf.getId();
                    //更新lastMaxId
                    lastMaxId = id > lastMaxId ? id : lastMaxId;
                	//业务处理
            } else {
                lastMaxId += PAGE_SIZE;
            }
        }
java SPI机制

nacos的客户端配置感知,采用了java SPI机制

java spi 实现

参考

架构

配置中心

在这里插入图片描述

Nacos配置中心集群中,没有主从之分,各个节点是对等的。通过增加虚拟ip(viper)的方式,实现高可用。
Nacos的数据存储分为两部分:
(1)所有节点共用的mysql。Mysql是一个中心数据仓库,且认为在Mysql中的数据是绝对正确的
(2)每个节点都会在内存和磁盘维护一份数据。当节点启动时,把全量的mysql数据加载到磁盘。

用户更新配置,服务端配置更新流程

(1)接收到更新配置的http请求后,节点把配置更新到数据库后,直接返回true,更新成功
(2)以namespace+group+dataId作为key,通过事件分发器发布配置变更事件
(3)事件分发器触发该事件对应的所有listener的处理方法
a.获取配置集群的所有节点的ip端口
b.为每个节点生成一个配置变更任务,并放到队列里
c.由一个调度线程池处理队列中的任务:只要队列不为空,就从队列poll任务,发送http异步请求节点的dataChange接口,并注册回调方法。如果请求失败,把失败任务放入一个新队列,使用调度线程池延迟一定时间后再执行这个队列的任务进行重试。延迟时间会根据失败次数指数增加
d.可以看出,节点之间通过http异步的同步,数据只保证最终一致性
(4)其他节点(包括自身)收到dataChange通知后,发布一个dump任务,讲任务放到内存ConcurrentHashMap中
(5)有一个dump线程,通过死循环+sleep 100ms的方式,处理这个任务map集
(6)循环处理map中的任务:
a.从数据库中查出任务的配置
b.讲配置内容的md5和内存中该配置的md5相比较。此处内存使用的是ConcurrentHashMap,如果内存中不存在,md5就用null比较
c.md5相同,则忽略此次更新;否则把数据更新到磁盘文件
d.更新内存的md5,内存这里只保存md5,无需更新内容
e.发布本地数据变更事件。这里应该是一个扩展点,因为没有listener
(7)如果任务处理失败,设置任务的上次处理时间,把任务再加回任务map中,等待下次处理

这里充分利用了异步。在配置变更那里,通过把任务放入队列,并用调度线程池触发+调度,完成异步。在dataChange那里,把任务放到内存map中,通过一个线程循环处理,来异步处理
容错:通过重试容错;如果节点宕机,那么加入到内存中的任务就没了。但是节点启动时,会把mysql中的所有数据再通过任务的方式更新到磁盘和内存,就解决了这个问题

Nacos配置中心集群原理及源码分析

启动初始化流程

(1)分页查询配置信息,循环处理配置信息,跟上面的流程一样,更新md5,再更新磁盘
(2)调度线程池每隔6小时,dump一次全量数据到磁盘,作为保底
(3)加载节点的ip端口信息。如果是单机启动,就只加载本机,否则从cluster.conf文件中读取所有节点的ip端口进行加载。并且用调度线程池每隔5s,更新一次配置
(4)同时每隔5秒,对上面加载的节点都通过异步http调用一次健康检查。回调中,根据检查结果来更新节点的失败次数,并根据失败次数判断是否从健康节点集中剔除

客户端获取服务端配置流程

长轮询

客户端

1.发送HTTP请求后,由于服务端hold会阻塞直到服务端返回或超时
2.第一个请求结束,立马发第二次http请求

服务端

1.从request的header获取配置Long-Pulling-Timeout。如果不为空,说明该请求是长轮询;否则,说明是短轮询。
2.短轮询。立即和服务器上的cache的配置做比较,返回变化了的dataId列表。服务器上的cache是一个ConcurrentHashMap,存了dataId和MD5,比较的是MD5
3.长轮询。
(1)先得到超时时间30s,然后提前500ms,得到超时执行的时间29.5s
(2)把request和response封装到异步上下文AsyncContext,开启异步处理
(3)调度线程池延迟29.5s后执行
a.删除订阅关系,防止重复触发。订阅是为了如果在29.5秒内,数据发生变化时发出事件,能收到通知提前返回
b.和服务器上的cache的配置做比较,得到变化了的dataId列表,从AsyncContext中获取reponse,组装并返回。通过asyncContext.complete(),来完成异步的response的返回
c.添加订阅关系

订阅

1.通过观察者模式,观察数据变更事件。
2.判断调度任务存在,则取消调度任务。调度线程池提交任务的时候,是有返回值的,返回的是任务的句柄
3.给所有事件的订阅者通过AsyncContext发送response
详解Nacos 配置中心客户端配置缓存动态更新的源码实现

推拉模式

##Push 推模式

优缺点

优点:及时,一旦有数据变更,客户端立马能感知到。
缺点;(1)不知道客户端的数据消费能力,可能导致数据积压在客户端,来不及处理。
(2)服务端需要维持所有客户端的连接信息,以便推送数据
##Pull 拉模式
客户端主动向服务端发出请求,拉取相关数据。

优缺点

优点:由于是客户端发起请求,故不存在推模式中的数据积压问题。同时服务端对客户端“无感知”,无需维持客户端的连接信息
缺点:可能有数据延时。对客户端来说需要考虑拉取的逻辑、拉取频率等

轮询Polling

Polling是指不管服务端数据有无更新,客户端每隔定长时间请求拉取一次数据,可能有更新数据返回,也可能什么都没有。
优点:代码编写简单
缺点:请求中有大半是无用,浪费带宽和服务器资源。获取消息最多有一个轮询间隔的延迟。

Long Polling

优点:请求频度大大减少,消息第一时间收到
缺点:服务端hold连接消耗资源
原理为,相比Polling,客户端发起Long Polling,此时如果服务端没有相关数据,会hold住请求,直到服务端有相关数据,
或者等待一定时间超时才会返回。返回后,客户端又会立即再次发起下一次Long Polling。这种方式也是对拉模式的一个优化,
解决了拉模式数据通知不及时,以及减少了大量的无效轮询次数。(所谓的hold住请求指的服务端暂时不回复结果,保存相关请求,
不关闭请求连接,等相关数据准备好,写回客户端。

为什么不是在一个长轮询请求里一直等待到服务端数据准备好再返回,这样也不需要再次发起下一次的Long Polling,节省资源?

如果只用一次连接,在客户端发起请求之后,如果一直收不到服务端的返回。这时客户端无法区分服务端是宕机了还是没有数据变更。一旦服务端
宕机,客户端是无法及时发现的。而且tcp也有一个超时时间,超过超时时间后,TCP也会断开,还是需要发第二次轮询。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值