Nodejs 使用 ZooKeeper 做服務發現

將單體服務拆分為微服務後，為了服務高可用，一般會做叢集多例項。但在分散式下，怎麼進行高效、便捷的進行服務訪問問題，出現了各類服務註冊和服務發現框架。這裡使用的是Zookeeper。ZooKeeper 官網 https://zookeeper.apache.org。

我們的業務系統使用的開發語言是JAVA，但是部分頁面請求是先到nodejs 做的webportal服務，進行許可權校驗，校驗透過後呼叫Java提供的API。當前階段Java端已經微服務化，使用Zookeeper作為註冊中心，目前只需要讓nodejs端，也接入到Zookeeper，作為服務消費者，就能搭建機器環境。

找輪子

透過查詢，發現npm有現成的庫 node-zookeeper-client ,避免重複造輪子，就用它了。

接入思路

由於我們只是作為服務消費者，不需要使用服務註冊的api，大部分可以直接在文件中找到API。

編碼過程 

npm 安裝

 npm i node-zookeeper-client 

連線ZK

const Zookeeper = require('node-zookeeper-client');
const CONNECTION_STRING = "127.0.0.1:2181"; // ZK的服務地址
const OPTIONS = {
  sessionTimeout: 5000 
}
const zk = Zookeeper.createClient(CONNECTION_STRING, OPTIONS);
  zk.on('connected', function(){
  console.log("zk=====", zk);
});
//獲取根節點下的子節點資料
zk.getChildren('/', function(error, children, stat){
  if(error){
    console.log(error.stack);
    return;
  }
  console.log(children);
})
zk.connect();

其他API（僅供參考）

// 判斷節點是否已存在
zk.exists('/phpnode',function(error,stat){
   if(stat){
        console.log("節點存在");
   }else{
       console.log("節點不存在");
   }
})
 
 // 建立/註冊節點
zk.create('/phpnode',new Buffer('hello'),function(error,path){
   console.log(path);
})

// 獲取節點資料
zk.getData('/phpnode',function(error,data,stat){
   console.log(data.toString());
});

//節點刪除
zk.remove('/phpnode',function(error){
   if(!error){
       console.log('node 節點刪除成功');
    }
})

於是有了第一版本程式碼

const zookeeper = require('node-zookeeper-client');


// ZK基礎配置資訊，正式專案需要從環境檔案匯入
export const ZK = {
    clientAddress: 'localhost:2181/zk/test', // ZK地址
    servicePath: '/test-service', // 服務路徑
};

let zkClient = null;

// 獲取服務ip+port
export const getZKServiceBaseUrl = (servicePath) => {
    return new Promise((resolve, reject) => {
        try {
            // 防止重複連線
            if (zkClient) {
                disconnectZKService();
            }

            // 新建連線
            zkClient = zookeeper.createClient(ZK.clientAddress);
            // 連線後執行一次
            zkClient.once('connected', async function () {
                // 獲取服務節點資訊
                const res = await listChildren(zkClient, servicePath);
                res.message ? reject(res) : resolve(res);
            });

            zkClient.connect();
        } catch (error) {
            reject(error);
        }
    });
};

// 斷開連結
export const disconnectZKService = () => {
    if (zkClient) {
        zkClient.close();
    }
};

// 獲取節點資訊，ip+port
function listChildren(client, path) {
    return new Promise((resolve, reject) => {
        client.getChildren(path,
            function () {},
            function (error, children) {
                if (error) {
                    reject({
                        ...error,
                        message: `獲取ZK節點error，Path: ${path}`
                    });
                }
                try {
                    let addressPath = path + '/';
                    if (children.length > 1) {
                        //若存在多個地址，則隨機獲取一個地址
                        addressPath += children[Math.floor(Math.random() * children.length)];
                    } else {
                        //若只有唯一地址，則獲取該地址
                        addressPath += children[0];
                    }
                    //獲取服務地址
                    client.getData(addressPath, function (err, data) {
                        if (err) {
                            reject({
                                ...error,
                                message: `獲取ZK服務地址error，Stack: ${err.stack}`
                            });
                        }
                        if (!data) {
                            reject({
                                ...error,
                                message: `ZK data is not exist`
                            });
                        }
                        const serviceInfo = JSON.parse(data);

                        const url = serviceInfo.address + ':' + serviceInfo.port;
                        resolve(url);
                    });
                } catch (error) {
                    reject({
                        ...error,
                        message: `list ZK children error`
                    });
                }
            }
        );
    });
}

透過測試程式碼，可以實現呼叫Java服務。可能一般的程式設計師實現功能了就好了，可是作為一個有點追求的，感覺程式碼哪裡有問題。具體是哪裡呢，盯著螢幕瞅了兩分鐘，發現每次獲取服務都取 ZK 註冊中心獲取，這個過程涉及到的網路請求而且還不是一次HTTP，如果只是這麼簡單的改造，程式單純在效能響應上很有可能還不如老版本。我們可以在獲取服務的真實遠端地址前，新增一個本地快取。透過ZK訂閱機制，更新本地快取資料。

思路雖然明確了，可以api掃了掃，沒有我們想要的監聽器，如下所示

 

這怎麼辦，按理說的應該會有一個，節點資料改變推送的監聽器，例如新增，刪除，修改等等。找了半天也沒找到合適的。

沒辦法，接著看原始碼吧，看了一會，忽然，看到一個似乎可用的，類

 

 這不就是我需要的類嗎，但是居然在一方法中注入監聽器，先試試吧。

 

 試了一下，嘿，真的可以了，當服務端節點資料發生變動後，會自動觸發監聽器 watcher 的回撥邏輯。這就好辦了，改造開始。

改進後的程式碼

const zookeeper = require('node-zookeeper-client');
var ZK = require('../config/env.js').zk;

const client = Object.freeze({
    zkClient: zookeeper.createClient(ZK.connectionString),
    serviceSet: [], //
    serviceCache: Object.freeze({
        map: new Map(),

        /**
         * 更新快取
         * @param {String} path 服務路徑
         * @param {Array<String>} arr 真實訪問集合
         */
        updateCache: function (path, arr) {
            this.map.set(path, arr);
        },

        /**
         * 從快取中獲取訪問地址
         * 
         * @param {String} path 服務路徑
         * @returns String 真實訪問地址
         */
        getRealPath: function (path) {
            let arr = this.map.get(path);

            if (arr.length > 1) //若存在多個地址，則隨機獲取一個地址
                return arr[Math.floor(Math.random() * arr.length)];
            else //若只有唯一地址，則獲取該地址
                return arr[0];
        }
    }),

    connect: function () {
        console.info("連線 zookeeper");

        this.zkClient.once('connected', function () {
            console.info("連線成功");
        });

        this.zkClient.connect();
    },

    getRealPath: function (serviceName) {
        return new Promise(async (resolve, reject) => {
            if (this.serviceSet.includes(serviceName)) {
                resolve(this.serviceCache.getRealPath(serviceName));
            } else {
                // 載入服務節點資訊
                this.loadChildren(serviceName).then(url => resolve(url)).catch(error => reject(error));
            }
        });
    },

    loadChildren: function (path) {
        console.info("進入 loadChildren ");
        return new Promise((resolve, reject) => {
            this.zkClient.getChildren(path, (event) => {
                console.info(" loadChildren watcher ", path, event);

                this.getChildren(event.path);
            }, (error, ids) => {
                console.info(" loadChildren callback ", path, error, ids);
                if (error) {
                    reject({
                        ...error,
                        message: `獲取ZK節點error，Path: ${path}`
                    });
                } else {
                    resolve(this.getData(path, ids));
                }
            });
        });
    },

    getChildren: function (path) {
        console.info("進入 getChildren ");
        return new Promise((resolve, reject) => {
            this.zkClient.getChildren(path, (error, ids) => {
                console.info(" getChildren callback ", path, error, ids);
                if (error) {
                    reject({
                        ...error,
                        message: `獲取ZK節點error，Path: ${path}`
                    });
                }

                resolve(this.getData(path, ids));
            });
        });
    },

    getData: function (path, ids) {
        console.info("進入 getData ");

        let pros = ids.map(id => new Promise((resolve, reject) => {
            //獲取服務地址
            this.zkClient.getData(path + "/" + id, (error, data) => {
                console.info(" getData callback ", path, id);
                if (error) {
                    reject({
                        ...error,
                        message: `獲取ZK服務地址error，Stack: ${err.stack}`
                    });
                }
                if (!data) {
                    reject({
                        ...error,
                        message: `ZK data is not exist`
                    });
                }

                const node = JSON.parse(data).payload;
                const protocol = node.ssl ? "https://" : "http://";

                resolve(`${protocol}${node.host}:${node.port}`);
            });
        }));

        return Promise.all(pros).then(arr => this.serviceCache.updateCache(path, arr)).then(() => this.serviceCache.getRealPath(path));
    },

    disconnect: function () { //斷開連線
        console.info("進入 disconnect ")
        if (this.zkClient) {
            console.info("執行 close")
            this.zkClient.close();
        }
    },
});

client.connect();

module.exports = {
    getServiceUrl: (path) => client.getRealPath(path),
    disconnect: () => client.disconnect(),
}

這樣終於，好一點了。

未完待續（多節點的選擇問題）

多節點選擇策略：隨機，輪轉，粘性 等等，一般不同的專案使用的策略也不太一樣，例項中使用的是簡單隨機策略，後續再進行節點選擇的策略問題最佳化啦。

關機，收工！！！