RocketMQ路由中心NameServer

NameServer架構設計

image.png

Broker消息服務器在啟動時向所有NameServer注冊,消息生產(chǎn)者(Producer)在發(fā)送消息之前先從NameServer獲取Broker服務器地址列表,然后根據(jù)負載均衡算法從列表中選擇一臺服務器進行消息發(fā)送束亏。NameServer與每臺Broker保持長連接,并間隔10s檢測Broker是否存活,如果檢測到Broker宕機,則從路由注冊表中將其移除涨醋。

但是路由變化不會馬上通知消息生產(chǎn)者,為什么要這樣設計呢?
這是為了降低NameServer實現(xiàn)的復雜性,在消息發(fā)送端提供容錯機制來保證消息發(fā)送的高可用性。

NameServer本身的高可用可通過部署多臺NameServer服務器來實現(xiàn),但彼此之間互不通信,也就是NameServer服務器之間在某一時刻的數(shù)據(jù)并不會完全相同,但這對消息發(fā)送不會造成任何影響,這也是RocketMQ NameServer設計的一個亮點,RocketMQ NameServer設計追求簡單高效美侦。

NameServer啟動流程

NameServer啟動類: org.apache.rocketmq.namesrv.NamesrvStartup
Step1: 首先來解析配置文件,需要填充NamesrvConfig系谐、NettyServerConfig屬性值岭埠。

            final NamesrvConfig namesrvConfig = new NamesrvConfig();
            final NettyServerConfig nettyServerConfig = new NettyServerConfig();
            nettyServerConfig.setListenPort(9876);
            if (commandLine.hasOption('c')) {
                String file = commandLine.getOptionValue('c');
                if (file != null) {
                    InputStream in = new BufferedInputStream(new FileInputStream(file));
                    properties = new Properties();
                    properties.load(in);
                    MixAll.properties2Object(properties, namesrvConfig);
                    MixAll.properties2Object(properties, nettyServerConfig);

                    namesrvConfig.setConfigStorePath(file);

                    System.out.printf("load config properties file OK, " + file + "%n");
                    in.close();
                }
            }

            if (commandLine.hasOption('p')) {
                MixAll.printObjectProperties(null, namesrvConfig);
                MixAll.printObjectProperties(null, nettyServerConfig);
                System.exit(0);
            }

            MixAll.properties2Object(ServerUtil.commandLine2Properties(commandLine), namesrvConfig);

從代碼我們可以知道先創(chuàng)建NamesrvConfig(NameServer業(yè)務參數(shù))、NettyServerConfig(NameServer網(wǎng)絡參數(shù)),然后在解析啟動時把指定的配置文件或啟動命令中的選項值,填充到namesrvConfig,nettyServerConfig對象蔚鸥。
參數(shù)來源有如下兩種方式:
1惜论、-c configFile通過-c命令指定配置文件的路徑
2、使用"--屬性名屬性值",例如--listenPort 9876

NameServerConfig屬性

    private String rocketmqHome = System.getProperty(MixAll.ROCKETMQ_HOME_PROPERTY, System.getenv(MixAll.ROCKETMQ_HOME_ENV));
    private String kvConfigPath = System.getProperty("user.home") + File.separator + "namesrv" + File.separator + "kvConfig.json";
    private String configStorePath = System.getProperty("user.home") + File.separator + "namesrv" + File.separator + "namesrv.properties";
    private String productEnvName = "center";
    private boolean clusterTest = false;
    private boolean orderMessageEnable = false;

rocketmqhome: rocketmq主目錄,可以通過-Drocketmq.home.dir=path或通過設置環(huán)境變量ROCKETMQ_HOME來配置RocketMQ的主目錄止喷。
kvConfigPath: NameServer存儲KV配置屬性的持久化路徑馆类。
configStorePath: nameServer默認配置文件路徑,不生效。nameServer啟動時如果要通過配置文件配置NameServer啟動屬性的話,請使用-c選項弹谁。
orderMessageEnable: 是否支持順序消息,默認是不支持

NettyServerConfig屬性

    private int listenPort = 8888;
    private int serverWorkerThreads = 8;
    private int serverCallbackExecutorThreads = 0;
    private int serverSelectorThreads = 3;
    private int serverOnewaySemaphoreValue = 256;
    private int serverAsyncSemaphoreValue = 64;
    private int serverChannelMaxIdleTimeSeconds = 120;
    private int serverSocketSndBufSize = NettySystemConfig.socketSndbufSize;
    private int serverSocketRcvBufSize = NettySystemConfig.socketRcvbufSize;
    private boolean serverPooledByteBufAllocatorEnable = true;
    private boolean useEpollNativeSelector = false;

listenPort: NameServer監(jiān)聽端口,該值默認會被初始化9876乾巧。
serverWorkerThreads: Netty業(yè)務線程池線程個數(shù)。
serverCallbackExecutorThreads: Netty public 任務線程池線程個數(shù),Netty網(wǎng)絡設計,根據(jù)業(yè)務類型會常見不同的線程池,比如處理消息發(fā)送预愤、消息消費沟于、心跳檢測等等。如果該業(yè)務類型(RequestCode)未注冊線程池,則由public線程池執(zhí)行植康。
serverSelectorThreads:IO線程池線程個數(shù),主要是NameServer旷太、Broker端解析請求、返回相應的線程個數(shù),這類線程主要是處理網(wǎng)絡請求的,解析請求包,然后轉(zhuǎn)發(fā)到各個業(yè)務線程池完成具體的業(yè)務操作,然后將結果返回調(diào)用方。
serverOnewaySemaphoreValue: send oneway消息請求并發(fā)度(Broker端參數(shù))供璧。
serverAsyncSemaphoreValue: 異步消息發(fā)送最大并發(fā)度(Broker端參數(shù))存崖。
serverChannelMaxIdleTimeSeconds: 網(wǎng)絡連接最大空閑時間,默認120s。如果連接空閑時間超過該參數(shù)設置的值,連接將被關閉睡毒。
serverSocketSndBufSize: 網(wǎng)絡socket發(fā)送緩存區(qū)大小,默認64k来惧。
serverSocketRecBufSize: 網(wǎng)絡socket接收緩存區(qū)大小,默認64k。
serverPooledByteBufAllocatorEnable: ByteBuffer是否開啟緩存,建議開啟演顾。
useEpollNativeSelector: 是否啟用Epoll IO模型,Linux環(huán)境建議開啟供搀。

在啟動NameServer時,可以先使用./mqnameserver -c configFile -p 打印當前加載的配置屬性。

Step2: 根據(jù)啟動屬性創(chuàng)建NamesrvController實例,并初始化該實例,NamesrvController實例為NameServer核心控制器钠至。

NamesrvController#initialize代碼片段

    public boolean initialize() {

        this.kvConfigManager.load();

        this.remotingServer = new NettyRemotingServer(this.nettyServerConfig, this.brokerHousekeepingService);

        this.remotingExecutor =
            Executors.newFixedThreadPool(nettyServerConfig.getServerWorkerThreads(), new ThreadFactoryImpl("RemotingExecutorThread_"));

        this.registerProcessor();

        this.scheduledExecutorService.scheduleAtFixedRate(new Runnable() {

            @Override
            public void run() {
                NamesrvController.this.routeInfoManager.scanNotActiveBroker();
            }
        }, 5, 10, TimeUnit.SECONDS);

        this.scheduledExecutorService.scheduleAtFixedRate(new Runnable() {

            @Override
            public void run() {
                NamesrvController.this.kvConfigManager.printAllPeriodically();
            }
        }, 1, 10, TimeUnit.MINUTES);

        return true;
    }

加載KV配置,創(chuàng)建NettyServer網(wǎng)絡處理對象,然后開啟兩個定時任務,在RocketMQ中此類定時任務統(tǒng)稱為心跳檢測趁曼。

定時任務1: NameServer每隔10s掃描一次Broker,移除處于不激活狀態(tài)的Broker。
定時任務2: NameServer每隔十分鐘打印一次KV配置棕洋。

Step3: 注冊JVM鉤子函數(shù)并啟動服務器,以便監(jiān)聽Broker挡闰、消息生產(chǎn)者的網(wǎng)絡請求。

            Runtime.getRuntime().addShutdownHook(new ShutdownHookThread(log, new Callable<Void>() {
                @Override
                public Void call() throws Exception {
                    controller.shutdown();
                    return null;
                }
            }));

            controller.start();

NameServer路由注冊掰盘、故障剔除

NameServer主要作用是為消息生產(chǎn)者和消息消費者提供關于主題Topic的路由信息,那么NameServer需要存儲路由的基礎信息,還要能夠管理Broker節(jié)點,包括路由注冊摄悯、路由刪除等功能。

路由元信息

NameServer路由實現(xiàn)類: org.apache.rocketmq.namesrv.routeinfo.RouteInfoManager,在了解路由注冊之前,我們首先看一下NameServer到底存儲哪些信息愧捕。

    private final HashMap<String/* topic */, List<QueueData>> topicQueueTable;
    private final HashMap<String/* brokerName */, BrokerData> brokerAddrTable;
    private final HashMap<String/* clusterName */, Set<String/* brokerName */>> clusterAddrTable;
    private final HashMap<String/* brokerAddr */, BrokerLiveInfo> brokerLiveTable;
    private final HashMap<String/* brokerAddr */, List<String>/* Filter Server */> filterServerTable;

topicQueueTable: Topic消息隊列路由信息,消息發(fā)送時根據(jù)路由表進行負載均衡奢驯。
brokerAddrTable: Broker基礎信息,包含BrokerName、所屬集群名稱次绘、主備Broker地址瘪阁。
clusterAddrTable: Broker集群信息,存儲集群中所有Broker名稱。
brokerLiveTable: Broker狀態(tài)信息邮偎。NameServer每次收到心跳包時會替換該信息管跺。
filterServerTable: Broker上的FilterServer列表,用于類模式消息過濾。

RocketMQ基于訂閱發(fā)布機制,一個Topic擁有多個消息隊列,一個Broker為每一主題默認創(chuàng)建4個讀隊列4個寫隊列禾进。多個Broker組成一個集群,BrokerName由相同的多臺Broker組成Master-Slave架構,brokerId為0表示Master,大于0表示Slave豁跑。BrokerLiveInfo中的lastUpdateTimestamp存儲上次收到Broker心跳包的時間。

QueueData

    private String brokerName;
    private int readQueueNums;
    private int writeQueueNums;
    private int perm;
    private int topicSynFlag;

BrokerData

    private String cluster;
    private String brokerName;
    // brokerId為0表示Master,大于0表示Slave
    private HashMap<Long/* brokerId */, String/* broker address */> brokerAddrs;

BrokerLiveInfo

    private long lastUpdateTimestamp;
    private DataVersion dataVersion;
    private Channel channel;
    private String haServerAddr;

路由注冊

RocketMQ路由注冊是通過Broker與NameServer的心跳功能實現(xiàn)的泻云。Broker啟動時向集群中所有的NameServer發(fā)送心跳語句,每隔30秒向集群中所有NameServer發(fā)送心跳包,NameServer收到Broker心跳包時會更新brokerLiveTable緩存中BrokerLiveInfo的lastUpdateTimestamp,然后NameServer每隔10秒掃描brokerLiveTable,如果連續(xù)120s沒有收到心跳包,NameServer將移除該Broker的路由信息同時關閉Socket連接艇拍。

Broker發(fā)送心跳包

Broker發(fā)送心跳包的核心代碼如下所示。

Broker端心跳包發(fā)送(BrokerController#start)

        this.scheduledExecutorService.scheduleAtFixedRate(new Runnable() {
            @Override
            public void run() {
                try {
                    BrokerController.this.registerBrokerAll(true, false);
                } catch (Throwable e) {
                    log.error("registerBrokerAll Exception", e);
                }
            }
        }, 1000 * 10, 1000 * 30, TimeUnit.MILLISECONDS);

BrokerOuterAPI#registerBrokerAll

        List<String> nameServerAddressList = this.remotingClient.getNameServerAddressList();
        if (nameServerAddressList != null) {
            for (String namesrvAddr : nameServerAddressList) {// 遍歷所有NameServer列表
                try {
                    RegisterBrokerResult result = this.registerBroker(namesrvAddr, clusterName, brokerAddr, brokerName, brokerId,
                        haServerAddr, topicConfigWrapper, filterServerList, oneway, timeoutMills);// 分別向NameServer注冊
                    if (result != null) {
                        registerBrokerResult = result;
                    }

                    log.info("register broker to name server {} OK", namesrvAddr);
                } catch (Exception e) {
                    log.warn("registerBroker Exception, {}", namesrvAddr, e);
                }
            }
        }

BrokerOuteAPI#registerBroker(網(wǎng)絡發(fā)送代碼)

        RegisterBrokerRequestHeader requestHeader = new RegisterBrokerRequestHeader();
        requestHeader.setBrokerAddr(brokerAddr);
        requestHeader.setBrokerId(brokerId);
        requestHeader.setBrokerName(brokerName);
        requestHeader.setClusterName(clusterName);
        requestHeader.setHaServerAddr(haServerAddr);
        RemotingCommand request = RemotingCommand.createRequestCommand(RequestCode.REGISTER_BROKER, requestHeader);

        RegisterBrokerBody requestBody = new RegisterBrokerBody();
        requestBody.setTopicConfigSerializeWrapper(topicConfigWrapper);
        requestBody.setFilterServerList(filterServerList);
        request.setBody(requestBody.encode());

        if (oneway) {
            try {
                this.remotingClient.invokeOneway(namesrvAddr, request, timeoutMills);
            } catch (RemotingTooMuchRequestException e) {
                // Ignore
            }
            return null;
        }

        RemotingCommand response = this.remotingClient.invokeSync(namesrvAddr, request, timeoutMills);

發(fā)送心跳包具體邏輯,首先封裝請求包頭(Header)宠纯。

brokerAddr: broker地址卸夕。
brokerId: brokerId,0: Master ; 大于0: Slave。
brokerName: broker名稱婆瓜。
clusterName: 集群名稱快集。
haServerAddr: master地址,初次請求時該值為空,slave向Nameserver注冊后返回。
requestBody:
- filterServerList: 消息過濾服務器列表。
- topicConfigWapper: 主題配置,topicConfigWrapper內(nèi)部封裝的是TopicConfigManager中的topicConfigTable,內(nèi)部存儲的是Broker啟動時默認的一些Topic,MixAll.SELF_TEST_TOPIC碍讨、MixAll.DEFAULT_TOPICC(AutoCreateTopicEnable=true)治力、MixAll.BENCHMARK_TOPIC蒙秒、MixAll.OFFSET_MOVED_EVENT勃黍、BrokerConfig#brokerClusterName、BrokerConfig#brokerName晕讲。Broker中Topic默認存儲在${Rocket_Home}/store/config/topics.json中覆获。

NameServer處理心跳包

org.apache.rocketmq.namesrv.processor.DefaultRequestProcessor網(wǎng)絡處理器解析請求類型,如果請求類型為RequestCode.REGISTER_BROKER,則請求最終轉(zhuǎn)發(fā)到RouteInfoManager#registerBroker。

Step1: 路由注冊需要加寫鎖,防止并發(fā)修改RouteInfoManager中的路由表瓢省。首先判斷Broker所屬集群是否存在,如果不存在,則創(chuàng)建,然后將broker名加入到集群Broker集合中弄息。

RouteInfoManager#registerBroker clusterAddrTable維護

                this.lock.writeLock().lockInterruptibly();
                Set<String> brokerNames = this.clusterAddrTable.get(clusterName);
                if (null == brokerNames) {
                    brokerNames = new HashSet<String>();
                    this.clusterAddrTable.put(clusterName, brokerNames);
                }
                brokerNames.add(brokerName);

Step2: 維護BrokerData信息,首先從brokerAddrTable根據(jù)BrokerName嘗試獲取Broker信息,如果不存在,則新建BrokerData并放入brokerAddrTable,registerFirst設置為true;如果存在,直接替換原先的,registerFirst設置為false,表示非第一次注冊

RouteInfoManager#registerBroker brokerAddrTable維護

                BrokerData brokerData = this.brokerAddrTable.get(brokerName);
                if (null == brokerData) {
                    registerFirst = true;
                    brokerData = new BrokerData(clusterName, brokerName, new HashMap<Long, String>());
                    this.brokerAddrTable.put(brokerName, brokerData);
                }
                String oldAddr = brokerData.getBrokerAddrs().put(brokerId, brokerAddr);
                registerFirst = registerFirst || (null == oldAddr);

Step3: 如果Broker為Master,并且Broker Topic配置信息發(fā)變化或者是初次注冊,則需要創(chuàng)建或更新Topic路由元數(shù)據(jù),填充topicQueueTable,其實就是為默認主題自動注冊路由信息,其中包含MixAll.DEFAULT_TOPIC的路由信息。當消費生產(chǎn)者發(fā)送主題時,如果該主題未創(chuàng)建并且BrokerConfig的autoCreateTopicEnable為true時,則返回MixAll.DEFAULT_TOPIC的路由信息勤婚。

                if (null != topicConfigWrapper
                    && MixAll.MASTER_ID == brokerId) {
                    if (this.isBrokerTopicConfigChanged(brokerAddr, topicConfigWrapper.getDataVersion())
                        || registerFirst) {
                        ConcurrentMap<String, TopicConfig> tcTable =
                            topicConfigWrapper.getTopicConfigTable();
                        if (tcTable != null) {
                            for (Map.Entry<String, TopicConfig> entry : tcTable.entrySet()) {
                                this.createAndUpdateQueueData(brokerName, entry.getValue());
                            }
                        }
                    }
                }

根據(jù)TopicConfig創(chuàng)建QueueData數(shù)據(jù)結構,然后更新topicQueueTable
RouteInfoManager#createAndUpdateQueueData

    private void createAndUpdateQueueData(final String brokerName, final TopicConfig topicConfig) {
        QueueData queueData = new QueueData();
        queueData.setBrokerName(brokerName);
        queueData.setWriteQueueNums(topicConfig.getWriteQueueNums());
        queueData.setReadQueueNums(topicConfig.getReadQueueNums());
        queueData.setPerm(topicConfig.getPerm());
        queueData.setTopicSynFlag(topicConfig.getTopicSysFlag());

        List<QueueData> queueDataList = this.topicQueueTable.get(topicConfig.getTopicName());
        if (null == queueDataList) {
            queueDataList = new LinkedList<QueueData>();
            queueDataList.add(queueData);
            this.topicQueueTable.put(topicConfig.getTopicName(), queueDataList);
            log.info("new topic registered, {} {}", topicConfig.getTopicName(), queueData);
        } else {
            boolean addNewOne = true;

            Iterator<QueueData> it = queueDataList.iterator();
            while (it.hasNext()) {
                QueueData qd = it.next();
                if (qd.getBrokerName().equals(brokerName)) {
                    if (qd.equals(queueData)) {
                        addNewOne = false;
                    } else {
                        log.info("topic changed, {} OLD: {} NEW: {}", topicConfig.getTopicName(), qd,
                            queueData);
                        it.remove();
                    }
                }
            }

            if (addNewOne) {
                queueDataList.add(queueData);
            }
        }
    }

Step4: 更新BrokerLiveInfo,存活Broker信息表,BrokerLiveInfo是執(zhí)行路由刪除的重要依據(jù)

RouteInfoManager#registerBroker

                BrokerLiveInfo prevBrokerLiveInfo = this.brokerLiveTable.put(brokerAddr,
                    new BrokerLiveInfo(
                        System.currentTimeMillis(),
                        topicConfigWrapper.getDataVersion(),
                        channel,
                        haServerAddr));
                if (null == prevBrokerLiveInfo) {
                    log.info("new broker registered, {} HAServer: {}", brokerAddr, haServerAddr);
                }

Step5: 注冊Broker的過濾器Server地址列表,一個Broker上會關聯(lián)多個FilterServer消息過濾服務器;如果此Broker為從節(jié)點,則需要查找該Broker的Master的節(jié)點信息,并更新對應的masterAddr屬性摹量。

                if (filterServerList != null) {
                    if (filterServerList.isEmpty()) {
                        this.filterServerTable.remove(brokerAddr);
                    } else {
                        this.filterServerTable.put(brokerAddr, filterServerList);
                    }
                }

                if (MixAll.MASTER_ID != brokerId) {
                    String masterAddr = brokerData.getBrokerAddrs().get(MixAll.MASTER_ID);
                    if (masterAddr != null) {
                        BrokerLiveInfo brokerLiveInfo = this.brokerLiveTable.get(masterAddr);
                        if (brokerLiveInfo != null) {
                            result.setHaServerAddr(brokerLiveInfo.getHaServerAddr());
                            result.setMasterAddr(masterAddr);
                        }
                    }
                }

路由刪除

NameServer會每隔10s掃描brokerLiveTable狀態(tài)表,如果BrokerLive的lastUpdateTimestamp的時間戳距當前時間超過120s,則認為Broker失效,移除該Broker,關閉與Broker連接,并同時更新topicQueueTable、brokerAddrTable馒胆、brokerLiveTable缨称、filterServerTable。

RocketMQ有兩個觸發(fā)點來出發(fā)路由刪除祝迂。
1睦尽、NameServer定時掃描brokerLiveTable檢測上次心跳包與當前系統(tǒng)時間的時間差,如果時間戳大于120s,則需要移除該Broker信息。
2型雳、Broker在正常被關閉的情況下,會執(zhí)行unregisterBroker指令当凡。
由于不管是何種方式出發(fā)的路由刪除,路由刪除的方法都是一樣的,就是從topicQueueTable、brokerAddrTable纠俭、brokerLiveTable沿量、filterServerTable刪除與該Broker相關的信息。

RouteInfoManager#scanNotActiveBroker

    public void scanNotActiveBroker() {
        Iterator<Entry<String, BrokerLiveInfo>> it = this.brokerLiveTable.entrySet().iterator();
        while (it.hasNext()) {
            Entry<String, BrokerLiveInfo> next = it.next();
            long last = next.getValue().getLastUpdateTimestamp();
            if ((last + BROKER_CHANNEL_EXPIRED_TIME) < System.currentTimeMillis()) {
                RemotingUtil.closeChannel(next.getValue().getChannel());
                it.remove();
                log.warn("The broker channel expired, {} {}ms", next.getKey(), BROKER_CHANNEL_EXPIRED_TIME);
                this.onChannelDestroy(next.getKey(), next.getValue().getChannel());
            }
        }
    }

遍歷brokerLiveInfo路由表(HashMap),檢測BrokerLiveInfo的lastUpdateTimestamp上次收到心跳包的時間如果超過當前時間120s,NameServer則認為該Broker已不可用,故需要將它移除,關閉Channel,然后刪除與該Broker相關的路由信息,路由表維護過程,需要申請寫鎖冤荆。

Step1: 申請寫鎖,根據(jù)brokerAddress從brokerLiveTable欧瘪、filterServerTable移除