netty集群(一)-服务注册发现

上篇文章介绍了如何搭建一个单机版本的netty聊天室：https://www.jianshu.com/p/f786c70eeccc。

一、需要解决什么问题：

当连接数超过单机的极限时，需要将netty服务扩展成集群才能够承载更多的连接数，处理更多的消息。
在网上找了下似乎并没有非常成熟标准的netty集群相关框架或中间件，于是我决定用zookeeper作为服务注册中心来实现一个简单的netty集群。

二、基于zookeeper做netty集群服务注册发现的设计思路：

netty服务注册发现流程

关键的几个点：
1.netty服务在启动时，向zookeeper注册一个临时节点，挂载在永久父节点/netty下，节点名是当前节点的IP地址加端口，例如:192.168.1.1:7704。

2.和单点netty服务的区别是单点netty时客户端建立链接的netty地址是写死的，集群化后由注册中心zookeeper管理可用netty服务清单，客户端通过登录接口去获取可用netty服务地址，然后建立长连接。

3.当长连接断开时，重复上图过程。

三、关键部分代码

1.需要在netty应用和接口应用都引入下面三个工具类：

zookeeper发现节点工具类

package com.msgcenter.util.zookeeper;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ThreadLocalRandom;

import org.apache.zookeeper.KeeperException;
import org.apache.zookeeper.WatchedEvent;
import org.apache.zookeeper.Watcher;
import org.apache.zookeeper.ZooKeeper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class ServiceDiscovery {
     
    private static final Logger logger = LoggerFactory.getLogger(ServiceDiscovery.class);
 
    private CountDownLatch latch = new CountDownLatch(1);
 
    private volatile List<String> serviceAddressList = new ArrayList<>();
 
    private String registryAddress; // 注册中心的地址
 
    public ServiceDiscovery(String registryAddress) {
        this.registryAddress = registryAddress;
 
        ZooKeeper zk = connectServer();
        if (zk != null) {
            watchNode(zk);
        }
    }
 
    /**
     * 通过服务发现，获取服务提供方的地址
     * @return
     */
    public String discover() {
        String data = null;
        int size = serviceAddressList.size();
        if (size > 0) {
            if (size == 1) {  //只有一个服务提供方
                data = serviceAddressList.get(0);
                logger.info("unique service address : {}", data);
            } else {          //使用随机分配法。简单的负载均衡法
                data = serviceAddressList.get(ThreadLocalRandom.current().nextInt(size));
                logger.info("choose an address : {}", data);
            }
        }
        return data;
    }
 
    /**
     * 连接 zookeeper
     * @return
     */
    private ZooKeeper connectServer() {
 
        ZooKeeper zk = null;
        try {
            zk = new ZooKeeper(registryAddress, 2000, new Watcher() {
                @Override
                public void process(WatchedEvent event) {
                    if (event.getState() == Watcher.Event.KeeperState.SyncConnected) {
                        latch.countDown();
                    }
                }
            });
            latch.await();
        } catch (IOException | InterruptedException e) {
            logger.error("", e);
        }
        return zk;
    }
 
    /**
     * 获取服务地址列表
     * @param zk
     */
    private void watchNode(final ZooKeeper zk) {
 
        try {
            //获取子节点列表
            List<String> nodeList = zk.getChildren("/route", new Watcher() {
                @Override
                public void process(WatchedEvent event) {
                    if (event.getType() == Event.EventType.NodeChildrenChanged) {
                        //发生子节点变化时再次调用此方法更新服务地址
                        watchNode(zk);
                    }
                }
            });
            logger.info("node data: {}", nodeList);
            this.serviceAddressList = nodeList;
        } catch (KeeperException | InterruptedException e) {
            logger.error("", e);
        }
    }
}

zookeeper注册节点工具类

package com.msgcenter.util.zookeeper;

import java.util.concurrent.CountDownLatch;

import org.apache.zookeeper.CreateMode;
import org.apache.zookeeper.KeeperException;
import org.apache.zookeeper.WatchedEvent;
import org.apache.zookeeper.Watcher;
import org.apache.zookeeper.ZooDefs;
import org.apache.zookeeper.ZooDefs.Ids;
import org.apache.zookeeper.ZooKeeper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class ServiceRegistry {

    private static final Logger logger = LoggerFactory.getLogger(ServiceRegistry.class);
    
    private static final String ROOT_NODE = "/route";

    private CountDownLatch latch = new CountDownLatch(1);

    private String registryAddress;

    public ServiceRegistry(String registryAddress) {
        this.registryAddress = registryAddress;
    }

    public void register(String childNode) {
        if (childNode != null) {
            ZooKeeper zk = connectServer();
            if (zk != null) {
                try {
                    if (null == zk.exists(ROOT_NODE, false)) {
                        createRootNode(zk);
                    }
                    
                    
                } catch (KeeperException e) {
                    e.printStackTrace();
                } catch (InterruptedException e) {
                    e.printStackTrace();
                }
                createNode(zk, childNode);
            }
        }
    }

    /**
     * 连接 zookeeper 服务器
     * @return
     */
    private ZooKeeper connectServer() {
        ZooKeeper zk = null;
        try {
            zk = new ZooKeeper(registryAddress, 2000, new Watcher() {
                @Override
                public void process(WatchedEvent event) {
                    if (event.getState() == Event.KeeperState.SyncConnected) {
                        latch.countDown();
                    }
                }
            });
            latch.await();
        } catch (Exception e) {
            logger.error("", e);
        }
        return zk;
    }
    
    /**
     * 创建顶级节点
     * @param zk
     * @param data
     */
    private void createRootNode(ZooKeeper zk) {
        try {
            if (null == zk.exists(ROOT_NODE, false)) {
                String path = zk.create(ROOT_NODE, null, ZooDefs.Ids.OPEN_ACL_UNSAFE, CreateMode.PERSISTENT);
                logger.info("创建路由根节点 ({})", path);
            }
        } catch (KeeperException | InterruptedException e) {
            logger.error("创建路由根节点异常:", e);
        }
    }

    /**
     * 创建子节点
     * @param zk
     * @param data
     */
    private void createNode(ZooKeeper zk, String data) {
        try {
            String node = ROOT_NODE + "/" + data;
            if (null == zk.exists(node, false)) {
                byte[] bytes = data.getBytes();
                String path = zk.create(node, bytes, Ids.OPEN_ACL_UNSAFE, CreateMode.PERSISTENT);
                logger.info("创建节点 ({} => {})", path, data);
            }
        } catch (KeeperException | InterruptedException e) {
            logger.error("创建节点异常:", e);
        }
    }
    
}

测试服务注册发现工具类：

package com.msgcenter.util.zookeeper;

import java.net.UnknownHostException;
import java.util.HashMap;
import java.util.Map;

import com.msgcenter.constant.WebSocketConstant;

public class ZookeeperTester {
    
    public static void main(String[] args) throws UnknownHostException, InterruptedException {
        // 获取zookeeper注册地址
        String registryAddress = "47.106.99.2:2181";
        // 将本机netty服务实例注册到zookeeper
        ServiceRegistry serviceRegistry = new ServiceRegistry(registryAddress);
        
        // 获取本机ip
//      String ip = InetAddress.getLocalHost().getHostAddress();
        String ip1 = "192.168.1.1";
        String ip2 = "192.168.1.2";
        String ip3 = "192.168.1.3";
        serviceRegistry.register(ip1 + ":" + WebSocketConstant.WEB_SOCKET_PORT);
        serviceRegistry.register(ip2 + ":" + WebSocketConstant.WEB_SOCKET_PORT);
        serviceRegistry.register(ip3 + ":" + WebSocketConstant.WEB_SOCKET_PORT);
        

        ServiceDiscovery serviceDiscovery = new ServiceDiscovery(registryAddress);
        Map<String, Integer> routeMap = new HashMap<String, Integer>();
        for (int i = 0; i < 10; i++) {
            String address = serviceDiscovery.discover();
            if (!routeMap.containsKey(address)) {
                routeMap.put(address, 0);
            }
            routeMap.put(address, routeMap.get(address) + 1);
        }
        System.out.println("获取10次服务命中情况:");
        for (Map.Entry<String, Integer> entry : routeMap.entrySet()) {
            System.out.println(entry.getKey() + ":" + entry.getValue());
        }
    }
    

}
2.netty应用引入上面三个工具类，启动时向zookeeper注册自己的代码如下，在netty服务启动时调用：
    /**
     * 向注册中心注册自己
     * @throws UnknownHostException 
     */
    public static void registerZK() throws UnknownHostException {
        // 获取本机ip
        String ip = InetAddress.getLocalHost().getHostAddress();
        // 获取zookeeper注册地址
        String registeyAddress = PropKit.use("zookeeper.properties").get("zk_registry_address");
        // 将本机netty服务实例注册到zookeeper，以ip加端口作为znode名，挂载到父节点下面，成为可用服务实例列表
        ServiceRegistry serviceRegistry = new ServiceRegistry(registeyAddress);
        serviceRegistry.register(ip + ":" + WebSocketConstant.WEB_SOCKET_PORT);
    }

3.接口服务引入三个工具类-获取可用netty服务地址代码示例如下:

    public ResponseResult<String> getNettyServer() {
        String discoveryAddress = "47.106.99.2:2181";
        ServiceDiscovery serviceDiscovery = new ServiceDiscovery(discoveryAddress);
        String address = serviceDiscovery.discover();
        return new ResponseResult<String>(address);
    }

上述步骤解决了建立连接路由的问题，下一步还需要解决消息的路由问题：
1.点对点发送消息，如何知道这条消息存在哪个netty服务节点，需要通知哪个服务节点推送消息。
2.对群成员广播消息时，如何知道这个群的成员分布在哪些netty服务节点上。

下篇博文描述消息的路由和推送

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 194,242评论 5赞 459
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 81,769评论 2赞 371
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 141,484评论 0赞 319
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 52,133评论 1赞 263
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 61,007评论 4赞 355
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 46,080评论 1赞 272
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 36,496评论 3赞 381
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 35,190评论 0赞 253
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 39,464评论 1赞 290
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,549评论 2赞 309
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,330评论 1赞 326
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 32,205评论 3赞 312
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 37,567评论 3赞 298
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,889评论 0赞 17
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,160评论 1赞 250
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 41,475评论 2赞 341
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 40,650评论 2赞 335