SpringBoot+Netty+WebSocket实现实时通讯

这篇随笔暂时不讲原理,首先搭建起一个简单的能够实现通讯的Demo。以后的一系列随笔会进行一些原理上的分享。html

不过在这以前你们最好了解一下Netty的线程模型和NIO编程模型,会对它的总体逻辑有所了解。前端

更新一篇关于NIO的博客:手动搭建I/O网络通讯框架3:NIO编程模型,升级改造聊天室web

首先建立好项目后在pom.xml引入Netty依赖编程

<dependency>
            <groupId>io.netty</groupId>
            <artifactId>netty-all</artifactId>
</dependency>

 

用Netty搭建一个WebSocket服务器总体上须要三样东西,无论是否是用的SpringBoot框架,这三样东西是必不可少的。json

1.启动服务器的类(NettyServer),会进行一些初步的配置工做。后端

2.助手类(Handler),有本身定义的助手类,也有Netty提供的一些基本的助手类,好比对Http、WebSocket支持的助手类。api

3.初始化器(Initializer),咱们下面使用的是主从线程模型,从线程组里会分配出不一样channel去处理不一样客户端的请求,而每一个channel里就会有各类助手类去实现一些功能。初始化器的做用就是对各类助手类进行绑定。
浏览器

 

服务器启动类:服务器

 

public class NettyServer {
    private static int port;

    public NettyServer(int port) {
        this.port = port;
    }
    public static void start() throws InterruptedException {//在main方法里调用这个方法,并用构造函数设置端口号
        //建立主线程组,接收请求
        EventLoopGroup bossGroup = new NioEventLoopGroup();
        //建立从线程组,处理主线程组分配下来的io操做
        EventLoopGroup workerGroup = new NioEventLoopGroup();
        //建立netty服务器
        try {
            ServerBootstrap serverBootstrap = new ServerBootstrap();
            serverBootstrap.group(bossGroup, workerGroup)//设置主从线程组
                    .channel(NioServerSocketChannel.class)//设置通道
                    .childHandler(new NettyServerInitializer());//子处理器,用于处理workerGroup中的操做
            //启动server
            ChannelFuture channelFuture = serverBootstrap.bind(port).sync();
            //监听关闭channel
            channelFuture.channel().closeFuture().sync();
        } finally {
            bossGroup.shutdownGracefully();//关闭主线程
            workerGroup.shutdownGracefully();//关闭从线程
        }
    }
}

 

 

初始化器:websocket

 

public class NettyServerInitializer extends ChannelInitializer<SocketChannel> {
    @Override
    protected void initChannel(SocketChannel socketChannel) throws Exception {
        ChannelPipeline pipeline= socketChannel.pipeline();
        //如下三个是Http的支持
        //http解码器
        pipeline.addLast(new HttpServerCodec());
        //支持写大数据流
        pipeline.addLast(new ChunkedWriteHandler());
        //http聚合器
        pipeline.addLast(new HttpObjectAggregator(1024*62));
        //websocket支持,设置路由
        pipeline.addLast(new WebSocketServerProtocolHandler("/ws"));
        //添加自定义的助手类
        pipeline.addLast(new NettyHandler());
    }
}

 

 

自定义助手类:

这个类就是业务的核心,客户端的请求会在这里处理。好比客户端链接、客户端发送消息、给客户端发送消息等等。

自定义助手类须要重写的方法能够根据本身的需求重写,这里就不把每一个方法都重写一遍了,完整的你们能够去找找文档看看。

若是须要在助手类中用到@Autowire注解,能够参考这个博客,网上有不少说明,这里就再也不重复了https://blog.csdn.net/weixin_30828379/article/details/95009595

 

public class NettyHandler extends SimpleChannelInboundHandler<TextWebSocketFrame> {//TextWebSocketFrame是netty用于处理websocket发来的文本对象
  //全部正在链接的channel都会存在这里面,因此也能够间接表明在线的客户端
    public static ChannelGroup channelGroup = new DefaultChannelGroup(GlobalEventExecutor.INSTANCE);
  //在线人数
    public static int online;
    //接收到客户都发送的消息
    @Override
    public void channelRead0(ChannelHandlerContext ctx, TextWebSocketFrame msg) throws Exception {
        SendAllMessages(ctx,send_message);//send_message是个人自定义类型,先后端分离每每须要统一数据格式,能够先把对象转成json字符串再发送给客户端
    }
    //客户端创建链接
    @Override
    public void handlerAdded(ChannelHandlerContext ctx) throws Exception {
        channelGroup.add(ctx.channel());
        online=channelGroup.size();
        System.out.println(ctx.channel().remoteAddress()+"上线了!");
    }
    //关闭链接
    @Override
    public void handlerRemoved(ChannelHandlerContext ctx) throws Exception {
        channelGroup.remove(ctx.channel());
        online=channelGroup.size();
        System.out.println(ctx.channel().remoteAddress()+"断开链接");
    }

    //出现异常
    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        cause.printStackTrace();
    }

    //给某我的发送消息
    private void SendMessage(ChannelHandlerContext ctx, Send_Message msg) {
        ctx.channel().writeAndFlush(new TextWebSocketFrame(JSON.toJSONString(msg)));
    }

    //给每一个人发送消息,除发消息人外
    private void SendAllMessages(ChannelHandlerContext ctx,Send_Message msg) {
        for(Channel channel:channelGroup){
            if(!channel.id().asLongText().equals(ctx.channel().id().asLongText())){
                channel.writeAndFlush(new TextWebSocketFrame(JSON.toJSONString(msg)));
            }
        }
    }
}

 

 

 

 

前端建立WebSocket对象进行访问

经过socket就能够用一些api进行发送消息,接收消息的操做。而后把接收的数据按各自的需求展现出来就好了,前端部分就再也不赘述了。

下面8088端口记得要在main方法里面设置。

 

if (window.WebSocket) {
        var host = window.location.hostname;
        var url = "ws://" + host + ":8088/ws";
        var socket = new WebSocket(url);
}else{
     alert("你的浏览器不支持WebSocket。请不要使用低版本的IE浏览器。");   
}
相关文章
相关标签/搜索