基于netty的websocket的生产实践

问题:由于项目需要与web端进行通讯,web端需要获取同步信息的进度(由于同步过程可能会持续比较长时间,所以采用websocket进行通讯,不在需要web端定时轮询pull拉取进度信息);

背景:

由于项目需要与web端进行通讯,web端需要获取同步信息的进度(由于同步过程可能会持续比较长时间,所以采用websocket进行通讯,不在需要web端定时轮询pull拉取进度信息);

解决思路:

  1. 从整体上看是有两个思路:
    前端通过定时器pull去服务端拉取同步信息,通过前端轮询会增加很多无效的请求,即是无效的查询,增加了很多无效的轮询;减少了工作量,加快了开发进度,但是进度同步给用户一个很不实时与直观的界面。
    使用websocket,客户端与服务端增加socket通讯的,所以决定采用push的方式,与web端保持长连接,通过长连接来推送进度消息。
  2. 设备同步流程:
    ~~ 通过前端轮询会增加很多无效的请求,即是无效的查询,增加了很多无效的轮询;所以决定采用push的方式,与web端保持长连接,通过长连接来推送进度消息。

~~ 服务消息是通过web端发起http同步请求,建立socket连接,服务端进行异步处理需要同步的信息,在服务端进行同,通过Kafka发送进度消息,推送到对应消息中转服务,消息中转服务进行 分发到对应的push服务上(netty服务),netty服务上收到对应的消息,通过缓存对应用户的channl进行channel.writeAndFlush()把消息推送的到对应的长连接客户端上,完成整个流程。

image.png

方案介绍

~~对于长连接方案有很对种实现方式,当时也对于选型比较纠结,最终由于与web端交互,无法直接使用socket进行连接,使用了websocket进行推送。例如 IM,实时消息推送还有很多消息推送也使用了这个协议。

接下来我们比较一下websocket的框架,比较主流的有netty、tomcat、socketIO 三个框架。

基于支持websocket的容器,开发简单,例如tomcat,但在高并发的支持不是很好,连接的时候容易连接断开,还有就是依赖容器。
netty-socketIO是在netty4基础之上做了一层封装,效率如同netty一样,是一个全平台方案,友好的API,京东的logbook也是用了socketIO来传递日志,也是我们的一个备选方案。
netty是业内主流的NIO框架,netty对javaNIO做了封装,让开发者更多关注业务,降低开发成本,很多著名的RPC框架都采用了netty作为传输层,友好的API,功能强大,内置了很多编解码协议,实现websocket协议也是十分方便。

1、整个架构设计如下 image01.png
image01.png
2. 推送服务会在业务服务端与netty之间建立一个分发机制,分发机制主要作用:

从redis中获取连接通道与netty服务的对应关系,就是对应通道推送到哪一台服务器上。
接收消息与分发消息(通过异步http分发或者kafka分发)。

3. 选型netty的原因,
  1. 由于对应社区的活跃度高;
  2. 服务相对稳定;
  3. 被大多数公司采纳,已经有一套完整的解决方案。
    netty是具有异步非阻塞的特性,传统的IO是面向流的,NIO是面向缓冲区的,是非阻塞的。

netty使用的是reactor模型,有boss线程和worker线程。

  • boss线程其实是一个独立的线程池,是专门负责接收client请求的,默认的线程池大小是1,由于我们只开一个端口,设置为默认值1就可以了。
  • worker线程池通过名字就可以得知是工作线程池,专门负责处理读写操作,默认线程池的大小为2*cpu个数。
服务中的URL校验与权限校验Handler

1、校验请求URL
2、校验token
3、判断对应用户的连接数量
4、保存对应信息到缓存(1、channel的对象到本地缓存;2、用户对应的key,channel的list到redis)


public class HttpRequestHandler extends SimpleChannelInboundHandler<Object> {

    private String wsUri;

    private Integer port;

    /**
     * 描述:读取完连接的消息后,对消息进行处理。
     * 这里仅处理HTTP请求,WebSocket请求交给下一个处理器。
     */
    @Override
    protected void channelRead0(ChannelHandlerContext ctx, Object msg) throws Exception {
        if (msg instanceof FullHttpRequest) {
           //判断第一次连接,进行权限校验
            authCheck(ctx, (FullHttpRequest) msg);
            ctx.fireChannelRead(((FullHttpRequest)msg).retain());
        } else if (msg instanceof WebSocketFrame) {
            ctx.fireChannelRead(((WebSocketFrame) msg).retain());
        }
    }


    /**
     * 第一次HTTP连接的时候,做权限校验,并保存对应的channel,
     */
    private void authCheck(ChannelHandlerContext ctx, FullHttpRequest req) {

        if (!req.uri().startsWith(wsUri)) {
            return;
        }
        //根据uri中的值来获取值,ws/tocken/MAC
        String[] split = req.uri().split("/");
        if (split.length < 2) {
            return;
        }
        //通过token做权限校验,并获取用户信息
        SysUserInfo userInfo;
        try {
            userInfo = getUserInfo(split[2]);
        } catch (Exception e) {
            LoggerUtils.error("连接异常", e);
            //返回断开连接,没有权限code信息
            HttpResponse response = new DefaultHttpResponse(req.protocolVersion(), HttpResponseStatus.OK);
            response.headers().set(HttpHeaderNames.CONTENT_TYPE, "text/html; charset=UTF-8");
            response.setStatus(HttpResponseStatus.UNAUTHORIZED);
            ctx.write(response);
            return;
        }
       //把对应关系放入redis,(channelID , userID),
        //(userID, IP+PORT, Set<channelID>)
      //....
      //根据缓存中信息,判断每个用户超过最大连接数量 size
      //...
        LoggerUtils.info(" IP+PORT" + sendServerApi);
        //缓存到每次map中 (保存对应channelID和,channel的关系,这样保存也为了删除可以快速删除,不用遍历)
        NettyWebSocketHolder.put(ctx.channel().id().asLongText(), ctx.channel());
    }

    private SysUserInfo getUserInfo(String token) {
       //根据自己系统做权限校验
    }
    /**
     * 描述:异常处理,关闭channel
     */
    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        cause.printStackTrace();
        ctx.close();
    }
}
业务处理

1、根据用户的心跳延长对应有redis有效期
2、断开连接清除对应channel信息(1,本地的channel对象;2、redis的channel的ID)

//处理文本协议数据,处理TextWebSocketFrame类型的数据,websocket专门处理文本的frame就是TextWebSocketFrame
public class TextWebSocketFrameHandler extends SimpleChannelInboundHandler<TextWebSocketFrame> {

    private RedissonClient redissonClient;

    private Integer port;

    public TextWebSocketFrameHandler(RedissonClient redissonClient, Integer port) {
        this.redissonClient = redissonClient;
        this.port = port;
    }

    //读到客户端的内容并且向客户端去写内容
    @Override
    protected void channelRead0(ChannelHandlerContext ctx, TextWebSocketFrame msg) throws Exception {
        LoggerUtils.info("收到消息:" + msg.text());
        //接收客户端保持心跳, 延长redis的有效时间
    }

    //每个channel都有一个唯一的id值
    @Override
    public void handlerAdded(ChannelHandlerContext ctx) throws Exception {
        //打印出channel唯一值,asLongText方法是channel的id的全名
        LoggerUtils.info("handlerAdded:" + ctx.channel().id().asLongText());

    }

    @Override
    public void handlerRemoved(ChannelHandlerContext ctx) throws Exception {
         //断开连接时,删除本地缓存的map中的channel
        NettyWebSocketHolder.remove(ctx.channel().id().asLongText());
        LoggerUtils.error("handlerRemoved:" + ctx.channel().id().asLongText());

    }

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
         //异常断开连接时,删除本地缓存的map中的channel
        NettyWebSocketHolder.remove(ctx.channel().id().asLongText());
        LoggerUtils.info("异常发生");
        ctx.close();
    }


    @Override
    public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception {

        if (evt instanceof IdleStateEvent){
            IdleStateEvent idleStateEvent = (IdleStateEvent) evt ;
            LoggerUtils.info("userEventTriggered");
            if (idleStateEvent.state() == IdleState.READER_IDLE){
                LoggerUtils.info("已经很久没有收到信息!");
                NettyWebSocketHolder.remove(ctx.channel().id().asLongText());
               //清除redis的连接
              //  ...
                LoggerUtils.info("清除后的连接数量:"+mapCache.get(sendServerApi));
            }
        }
        super.userEventTriggered(ctx, evt);
    }
}
对于nginx的配置

可以利用nginx进行负载均衡,也使用了改域名的ssl加密。在连接的时候需要使用 wss://

# 实际websocket服务器地址
upstream wss_svr {
    server 10.186.135.6:22222 weight=1;  
    server 10.186.135.7:22222 weight=1;
}

# 443 ssl端口配置,实际websockets(wss)地址
server {

    listen 443;
    server_name *.test.com;
    ssl on;

    # 自己的证书,放在与nginx.conf同一文件夹下。(若放不同文件夹注意路径问题)
     #ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
     ssl_certificate  /usr/local/zz/nginx/server.crt;
     ssl_certificate_key  /usr/local/zz/nginx/server.key;
        
    ssl_session_timeout 5m;
    ssl_session_cache shared:SSL:10m;
    ssl_protocols TLSv1 TLSv1.1 TLSv1.2 SSLv2 SSLv3;
    ssl_ciphers ALL:!ADH:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP;
    ssl_prefer_server_ciphers on;
    ssl_verify_client off;
        
    location /ws {      
        proxy_redirect off;
        proxy_pass http://wss_svr;      # 转发
        proxy_set_header Host $host;
        proxy_set_header X-Real_IP $remote_addr;
        proxy_set_header X-Forwarded-For $remote_addr:$remote_port;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;   # 升级协议头
        proxy_set_header Connection upgrade;
    }
        
}

总结

目前系统服务以及集成设备同步进度的消息推送,与客户端同步稳定,在测试环节有3W台设备的压力测试,保证同步的稳定性。
目前准备接入web页面与pc客户端的二维码登录,通过websocket连接可以保证客户端对消息的实时性变化。
websocket技术可以提升效率,适合对于实时性要求比较高的业务使用。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,542评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,596评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,021评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,682评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,792评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,985评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,107评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,845评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,299评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,612评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,747评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,441评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,072评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,828评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,069评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,545评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,658评论 2 350

推荐阅读更多精彩内容

  • 网关基于Netty 在Http 协议的实践 我们网关现在完全基于netty 实现http 协议,包含客户端和服务端...
    绝尘驹阅读 4,887评论 4 14
  • Swift1> Swift和OC的区别1.1> Swift没有地址/指针的概念1.2> 泛型1.3> 类型严谨 对...
    cosWriter阅读 11,093评论 1 32
  • 在一个方法内部定义的变量都存储在栈中,当这个函数运行结束后,其对应的栈就会被回收,此时,在其方法体中定义的变量将不...
    Y了个J阅读 4,413评论 1 14
  • 夜已深,街巷无几人逗留,只有卖小吃的小贩在等客人,秋风卷着落叶占据了街巷的正中央,风吹过时可以听到呼呼声……一个看...
    池浅笑安然阅读 798评论 0 0
  • 看着你红红的眼睛 我居然马大哈忽略了 你哭过了 看着发红的眼睛 心疼 我是个无法定义自己的人 时而孩童般无忧无虑 ...
    石川河女神阅读 239评论 2 3