文章目录
1. Bootstrap 和 ServerBootstrap
- Bootstrap 意思是引导,一个 Netty 应用通常由一个 Bootstrap 开始,主要作用是配置整个 Netty 程序,串联各个组件,Netty 中 Bootstrap类是客户端程序的启动引导类, ServerBootstrap是服务端启动引导类
- 常见的方法有
• public ServerBootstrap group(EventLoopGroup parentGroup, EventLoopGroup childGroup),该方法用于服务器端,用来设置两个 EventLoop
• public B channel(Class<? extends C> channelClass),该方法用来设置一个服务器端的通道实现
• public ChannelFuture bind(int inetPort) ,该方法用于服务器端,用来设置占用的端口号
• public B option(ChannelOption option, T value),用来给 ServerChannel 添加配置
• public B group(EventLoopGroup group) ,该方法用于客户端,用来设置一个 EventLoop
• public ChannelFuture connect(String inetHost, int inetPort) ,该方法用于客户端,用来连接服务器 端
• public ServerBootstrap childOption(ChannelOption childOption, T value),用来给接收到的通道添加配置
• public ServerBootstrap childHandler(ChannelHandler childHandler),该方法用来设置业务处理类 (自定义的 handler)
2. Future 和 ChannelFuture
- Netty 中所有的 IO 操作都是异步的,不能立刻得知消息是否被正确处理。但是可以过一会等它执行完成或者直接注册一个监听,具体的实现就是通过 Future 和 ChannelFutures,他们可以注册一个监听,当操作执行成功或失败时监听会自动触发注册的监听事件
- 常见的方法有
• Channel channel(),返回当前正在进行 IO 操作的通道
• ChannelFuture sync(),等待异步操作执行完毕
3. Channel
- Netty 网络通信的组件,能够用于执行网络 I/O 操作。
- 通过Channel 可获得当前网络连接的通道的状态
- 通过Channel 可获得网络连接的配置参数 (例如接收缓冲区大小)
- Channel 提供异步的网络 I/O 操作(如建立连接,读写,绑定端口),异步调用意味着任何 I/O 调用都将立即返回,并且不保证在调用结束时所请求的 I/O 操作已完成
- 调用立即返回一个 ChannelFuture 实例,通过注册监听器到 ChannelFuture 上,可以 I/O 操作成功、失败或取消时回调通知调用方
- 支持关联 I/O 操作与对应的处理程序
- 不同协议、不同的阻塞类型的连接都有不同的 Channel 类型与之对应
- 常用的 Channel 类型
• NioSocketChannel,异步的客户端 TCP Socket 连接。
• NioServerSocketChannel,异步的服务器端 TCP Socket 连接。
• NioDatagramChannel,异步的 UDP 连接。
• NioSctpChannel,异步的客户端 Sctp 连接。
• NioSctpServerChannel,异步的 Sctp 服务器端连接,这些通道涵盖了 UDP 和 TCP 网络 IO 以及文件 IO。
4. Selector
- Netty 基于 Selector 对象实现 I/O 多路复用,通过 Selector 一个线程可以监听多个连接的 Channel 事件。
- 当向一个 Selector 中注册 Channel 后,Selector 内部的机制就可以自动不断地查询 (Select) 这些注册的 Channel 是否有已就绪的 I/O 事件(例如可读,可写,网络连接 完成等),这样程序就可以很简单地使用一个线程高效地管理多个 Channel
5. ChannelHandler 及其实现类
-
ChannelHandler 是一个接口,处理 I/O 事件或拦截 I/O 操作,并将其转发到其 ChannelPipeline(业务处理链)中的下一个处理程序。
-
ChannelHandler 本身并没有提供很多方法,因为这个接口有许多的方法需要实现,方 便使用期间,可以继承它的子类
-
ChannelHandler 及其实现类一览图
说明 :
• ChannelInboundHandler 用于处理入站(事件运动方向:服务端 -> 客户端) I/O 事件
• ChannelOutboundHandler 用于 处理出站(事件运动方向:客户端 -> 服务端) I/O 操作
—适配器
• ChannelInboundHandlerAdapter 用于处理入站 I/O 事件。
• ChannelOutboundHandlerAdapt er 用于处理出站 I/O 操作。
• ChannelDuplexHandler 用于处理入站和出站事件。 -
我们经常需要自定义一 个 Handler 类去继承 ChannelInboundHandlerA dapter,然后通过重写相应方法实现业务逻辑
常用的方法
public class ChannelInboundHandlerAdapter extends ChannelHandlerAdapter implements ChannelInboundHandler { // 通道注册事件 public void channelRegistered(ChannelHandlerContext ctx) throws Exception { ctx.fireChannelRegistered(); } // 通道注销事件 public void channelUnregistered(ChannelHandlerContext ctx) throws Exception { ctx.fireChannelUnregistered(); } // 通道就绪事件 public void channelActive(ChannelHandlerContext ctx) throws Exception { ctx.fireChannelActive(); } // 通道读取数据事件 public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception { ctx.fireChannelRead(msg); } // 通道读取数据完毕事件 public void channelReadComplete(ChannelHandlerContext ctx) throws Exception { ctx.fireChannelReadComplete(); } // 通道发生异常事件 public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception { ctx.fireExceptionCaught(cause); } }
6. Pipeline 和 ChannelPipeline
- ChannelPipeline 是一个重点
-
ChannelPipeline 是一个 Handler 的集合,它负责处理和拦截 inbound(入站) 或者 outbound(出战) 的事件和操作,相当于一个贯穿 Netty 的链。(也可以这样理解: ChannelPipeline 是 保存 ChannelHandler 的 List,用于处理或拦截 Channel 的入站 和出站 事件 / 操作)
-
ChannelPipeline 实现了一种高级形式的拦截过滤器模式,使用户可以完全控制事件的处理方式,以及 Channel 中各个的 ChannelHandler 如何相互交互
-
在 Netty 中每个 Channel 都有且仅有一个 ChannelPipeline 与之对应,它们的组成关系如下
说明 :• 一个 Channel 包含了一个 ChannelPipeline,而 ChannelPipeline 中又维护了一个由 ChannelHandlerContext 组成的双向链表,并且每个 ChannelHandlerContext 中又关联着一个 ChannelHandler
• 入站事件和出站事件在一个双向链表中,入站事件会从链表 head 往后传递到最后一个入站的 handler, 出站事件会从链表 tail 往前传递到最前一个出站的 handler,两种类型的 handler 互不干扰 -
常用方法
• ChannelPipeline addFirst(ChannelHandler… handlers),把一个业务处理类(handler) 添加到链中的第一个位置
• ChannelPipeline addLast(ChannelHandler… handlers),把一个业务处理类(handler) 添加到链中的最后一个位置
7. ChannelHandlerContext
-
保存 Channel 相关的所有上下文信息,同时关联一个 ChannelHandler 对象
-
即ChannelHandlerContext 中 包 含 一 个 具 体 的 事 件 处 理 器 ChannelHandler , 同 时ChannelHandlerContext 中也绑定了对应的 pipeline 和 Channel 的信息,方便 对 ChannelHandler进行调用
-
常用方法
• ChannelFuture close(),关闭通道
• ChannelOutboundInvoker flush(),刷新
• ChannelFuture writeAndFlush(Object msg) , 将 数 据 写 到 ChannelPipeline 中 当 前
• ChannelHandler 的下一个 ChannelHandler 开始处理(出站)
8. ChannelOption
- Netty 在创建 Channel 实例后,一般都需要设置 ChannelOption 参数。
- ChannelOption 参数如下:
- ChannelOption.SO_BACKLOG :
对应 TCP/IP 协议 listen 函数中的 backlog 参数,用来初始化服务器可连接队列大小。服务端处理客户端连接请求是顺序处理的,所以同一时间只能处理一个客户端连接。多个客户 端来的时候,服务端将不能处理的客户端连接请求放在队列中等待处理,backlog 参数指定了队列的大小。- ChannelOption.SO_KEEPALIVE :
一直保持连接活动状态
9. EventLoopGroup 和其实现类 NioEventLoopGroup
-
EventLoopGroup 是一组 EventLoop 的抽象,Netty 为了更好的利用多核 CPU 资源, 一般会有多个 EventLoop 同时工作,每个 EventLoop 维护着一个 Selector 实例。
-
EventLoopGroup 提供 next 接口,可以从组里面按照一定规则获取其中一个 EventLoop来处理任务。在 Netty 服务器端编程中,我们一般都需要提供两个 EventLoopGroup,例如:BossEventLoopGroup 和 WorkerEventLoopGroup。
-
通常一个服务端口即一个 ServerSocketChannel对应一个Selector 和一个EventLoop 线程。BossEventLoop 负责接收客户端的连接并将 SocketChannel 交给 WorkerEventLoopGroup 来进行 IO 处理,如下图所示
说明:
- BossEventLoopGroup 通常是一个单线程的 EventLoop,EventLoop 维护着一个注册了ServerSocketChannel 的 Selector 实例,BossEventLoop 不断轮询 Selector 将连接事件分离出来
- 通常是 OP_ACCEPT 事件,然后将接收到的 SocketChannel 交给 WorkerEventLoopGroup
- WorkerEventLoopGroup 会由 next 选择 其中一个 EventLoop来将这个 SocketChannel 注册到其维护的 Selector 并对其后续的 IO 事件进行处理 ,一个 EventLoop 可以处理多个 Channel
- 常用方法
- public NioEventLoopGroup(),构造方法
- public Future<?> shutdownGracefully(),断开连接,关闭线程
10. Unpooled 类
-
Netty 提供一个专门用来操作缓冲区(即Netty的数据容器)的工具类
-
常用方法如下所示
public static ByteBuf copiedBuffer(CharSequence string, Charset charset)
通过给定的数据和字符编码返回一个 ByteBuf 对象(类似于 NIO 中的 ByteBuffer 但有区别) -
举例说明Unpooled 获取 Netty的数据容器ByteBuf 的基本使用
-
代码示例-1
体会以上三个属性值
public class ByteBuf01 { public static void main(String[] args) { // 创建一个 byteBuf /* 说明 1. 创建一个对象,该对象包含一个数组,是一个 byte[10] 2. Netty 的 Buf 存取数据,不需要像 NIO 一样使用 Filp 切换 Netty 底层维护了一个 ReaderIndex(下一个读的位置) 和 WriterIndex(下一个写的位置) */ ByteBuf buffer = Unpooled.buffer(10); // 向 buf 存数据 for (int i = 0; i < 10; i++) { buffer.writeByte(i); } System.out.println("写完数据后 {ReaderIndex: "+buffer.readerIndex()+", WriterIndex: "+buffer.writerIndex()+"}"); System.out.println("buf 的长度 - capacity :"+ buffer.capacity()); // 输出 for (int i = 0; i < buffer.capacity(); i++) { // 读数据的方式-1 :直接 get 第几个 byte //System.out.println(buffer.getByte(i)); // 读数据的方式-2 :通过移动 ReaderIndex 遍历 System.out.print(buffer.readByte() + " "); } System.out.println(); System.out.println("读完数据后 {ReaderIndex: "+buffer.readerIndex()+", WriterIndex: "+buffer.writerIndex()+"}"); } }
-
代码示例-2
Netty - Buf 的常用 API
public class ByteBuf02 { public static void main(String[] args) { // 用其他方式创建 Buf ,参数 :(存入 Buf 的文本 , 字符编码) ByteBuf byteBuf = Unpooled.copiedBuffer("【呵呵】:Hello,Buf", CharsetUtil.UTF_8); // 使用相关的 API if (byteBuf.hasArray()){ // 如果有内容 // 获得 buf 中的数据 byte[] bytes = byteBuf.array(); // 转成 String 输出 System.out.println(new String(bytes, CharsetUtil.UTF_8)); // 查看 ByteBuf 中真正存的是什么 System.out.println("ByteBuf : "+ byteBuf); // 数组的偏移量 System.out.println("偏移量 :"+ byteBuf.arrayOffset()); System.out.println("WriterIndex: "+byteBuf.writerIndex()); byteBuf.getByte(0); System.out.println("getByte 后 :ReaderIndex: "+byteBuf.readerIndex()+",可读取的字节数 :" + byteBuf.readableBytes()); byteBuf.readByte(); System.out.println("readByte 后 :ReaderIndex: "+byteBuf.readerIndex()+",可读取的字节数 :" + byteBuf.readableBytes()); // 读取某一段,参数:(起点,终点,字符集编码) System.out.println(byteBuf.getCharSequence(9, 24, CharsetUtil.UTF_8)); } } }
11. Netty应用实例-群聊系统
- 要求:
- 编写一个 Netty 群聊系统,实现服务器端和客户端之间的数据简单通讯(非阻塞)
- 实现多人群聊
- 服务器端:可以监测用户上线,离线,并实现消息转发功能
- 客户端:通过channel 可以无阻塞发送消息给其它所有用户,同时可以接受其它用 户发送的消息(有服务器转发得到)
- 目的:
进一步理解Netty非阻塞网络编程机制
-
代码实现
服务端 : ChatServer
public class ChatServer { // 端口 private int port; /** * 构造器 */ public ChatServer(int port) { this.port = port; } /** * 处理客户端的请求 */ public void run() throws InterruptedException { // 创建两个线程组 EventLoopGroup bossGroup = new NioEventLoopGroup(1); EventLoopGroup workerGroup = new NioEventLoopGroup(8); try { ServerBootstrap serverBootstrap = new ServerBootstrap(); serverBootstrap.group(bossGroup, workerGroup) .channel(NioServerSocketChannel.class) .option(ChannelOption.SO_BACKLOG,128) .childOption(ChannelOption.SO_KEEPALIVE, true) .childHandler(new ChannelInitializer<SocketChannel>() { @Override protected void initChannel(SocketChannel socketChannel) throws Exception { // 获取 Pipeline ChannelPipeline pipeline = socketChannel.pipeline(); // 通过 Pipeline 添加编、解码器(Netty 自带) pipeline.addLast("decoder",new StringDecoder()); pipeline.addLast("encoder",new StringEncoder()); // 加入自己的 Handler pipeline.addLast(new ChatServerHandler()); } }); System.out.println("服务端准备完毕"); ChannelFuture channelFuture = serverBootstrap.bind(port).sync(); channelFuture.channel().closeFuture().sync(); } finally { bossGroup.shutdownGracefully(); workerGroup.shutdownGracefully(); } } public static void main(String[] args) throws InterruptedException { new ChatServer(8000).run(); } }
服务端的处理器 :ChatServerHandler
public class ChatServerHandler extends SimpleChannelInboundHandler<String> { /** * 定义一个 Channel 线程组,管理所有的 Channel, 参数 执行器 * GlobalEventExecutor => 全局事件执行器 * INSTANCE => 表示是单例的 */ private static ChannelGroup channelGroup = new DefaultChannelGroup(GlobalEventExecutor.INSTANCE); //定义一个时间的输出格式 SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"); /** * 当连接建立之后,第一个被执行 * 一连接成功,就把当前的 Channel 加入到 ChannelGroup,并将上线消息推送给其他客户 */ @Override public void handlerAdded(ChannelHandlerContext ctx) throws Exception { // 获取当前 Channel Channel channel = ctx.channel(); // 将该客户上线的信息,推送给其他在线的 客户端 // 该方法,会将 ChannelGroup 中所有的 Channel 遍历,并发送消息 Date date = new Date(System.currentTimeMillis()); channelGroup.writeAndFlush("[客户端] ["+dateFormat.format(date)+"] "+channel.remoteAddress()+" 加入群聊~\n"); // 将当前 Channel 加入 ChannelGroup channelGroup.add(channel); } /** * 当断开连接激活,将 XXX 退出群聊消息推送给当前在线的客户 * 当某个 Channel 执行到这个方法,会自动从 ChannelGroup 中移除 */ @Override public void handlerRemoved(ChannelHandlerContext ctx) throws Exception { Date date = new Date(System.currentTimeMillis()); channelGroup.writeAndFlush("[客户端] ["+dateFormat.format(date)+"] "+ctx.channel().remoteAddress() + " 退出群聊~\n"); // 输出 ChannelGroup 的大小 System.out.println("==== ChannelGroup-Size : " + channelGroup.size()); } /** * 当 Channel 处于一个活动的状态激活,可以提示 XXX 上线 */ @Override public void channelActive(ChannelHandlerContext ctx) throws Exception { Date date = new Date(System.currentTimeMillis()); System.out.println("["+dateFormat.format(date)+"] "+ctx.channel().remoteAddress() + " 已上线~\n"); } /** * 当 Channel 处于不活动的状态激活,提示 XXX 离线 */ @Override public void channelInactive(ChannelHandlerContext ctx) throws Exception { Date date = new Date(System.currentTimeMillis()); System.out.println("["+dateFormat.format(date)+"] "+ctx.channel().remoteAddress() + " 已下线~\n"); } /** * 读取数据,并把读取到的数据转发给所有 客户 */ @Override protected void channelRead0(ChannelHandlerContext channelHandlerContext, String s) throws Exception { // 获取到 当前 Channel Channel channel = channelHandlerContext.channel(); Date date = new Date(System.currentTimeMillis()); //遍历 ChannelGroup 根据不同的情况,推送不同的消息 channelGroup.forEach(ch -> { if (ch != channel){//遍历到的当前的 ch 不是发消息的 Channel ch.writeAndFlush("[客户端] ["+dateFormat.format(date)+"] "+channel.remoteAddress()+" 发送了消息 :"+s+"\n"); }else {// 当前 ch 就是发消息的那个客户 ch.writeAndFlush("[自己] ["+dateFormat.format(date)+"] "+s+" | 发送成功~\n"); } }); } /** * 异常处理 */ @Override public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception { // 关闭该通道 ctx.close(); } }
客户端 :ChatClient
public class ChatClient { // 主机地址 private final String HOST; // 端口号 private final int PORT; public ChatClient(String HOST, int PORT) { this.HOST = HOST; this.PORT = PORT; } public void run() throws InterruptedException { EventLoopGroup eventLoopGroup = new NioEventLoopGroup(); try { Bootstrap bootstrap = new Bootstrap(); bootstrap.group(eventLoopGroup) .channel(NioSocketChannel.class) .handler(new ChannelInitializer<SocketChannel>() { @Override protected void initChannel(SocketChannel socketChannel) throws Exception { ChannelPipeline pipeline = socketChannel.pipeline(); pipeline.addLast("decoder", new StringDecoder()); pipeline.addLast("encoder", new StringEncoder()); pipeline.addLast(new ChatClientHandler()); } }); System.out.println("客户端准备完毕"); ChannelFuture channelFuture = bootstrap.connect(HOST, PORT).sync(); Channel channel = channelFuture.channel(); System.out.println("------ "+ channel.localAddress()+" ------"); // 因为客户端需要输入信息,所以需要扫描器 Scanner scanner = new Scanner(System.in); while (scanner.hasNextLine()){ String s = scanner.nextLine(); // 通过 Channel 发送到 服务端 channel.writeAndFlush(s+"\r\n"); } channelFuture.channel().closeFuture().sync(); } finally { eventLoopGroup.shutdownGracefully(); } } public static void main(String[] args) throws InterruptedException { new ChatClient("localhost",8000).run(); } }
客户端的处理器 :ChatClientHandler
public class ChatClientHandler extends SimpleChannelInboundHandler<String> { @Override protected void channelRead0(ChannelHandlerContext channelHandlerContext, String msg) throws Exception { // 直接输出从服务端获得的信息 System.out.println(msg.trim()); } }
-
启动测试
启动服务端,三个客户端
服务端的控制台输出
三个客户端的输出
客户端-1 发送消息——“呵呵”
三个客户端下线
12. Netty心跳检测机制案例
- 要求:
- 编写一个 Netty心跳检测机制案例, 当服务器超过3秒没有读时,就提示读空闲
- 当服务器超过5秒没有写操作时,就提示写空闲
- 实现当服务器超过7秒没有读或者写操作时,就提示读写空闲
-
代码实现
服务端 :Server
public class Server { public static void main(String[] args) throws InterruptedException { EventLoopGroup bossGroup = new NioEventLoopGroup(1); EventLoopGroup workerGroup = new NioEventLoopGroup(8); try { ServerBootstrap bootstrap = new ServerBootstrap(); bootstrap.group(bossGroup, workerGroup) .channel(NioServerSocketChannel.class) .handler(new LoggingHandler(LogLevel.INFO))// 在 bossGroup 增加 日志处理器 .childHandler(new ChannelInitializer<SocketChannel>() { @Override protected void initChannel(SocketChannel socketChannel) throws Exception { ChannelPipeline pipeline = socketChannel.pipeline(); /* 说明: 1. IdleStateHandler 是 Netty 提供的 空闲状态处理器 2. 四个参数: readerIdleTime : 表示多久没有 读 事件后,就会发送一个心跳检测包,检测是否还是连接状态 writerIdleTime : 表示多久没有 写 事件后,…… allIdleTime : 表示多久 既没读也没写 后,…… TimeUnit : 时间单位 3. 当 Channel 一段时间内没有执行 读 / 写 / 读写 事件后,就会触发一个 IdleStateEvent 空闲状态事件 4. 当 IdleStateEvent 触发后,就会传递给 Pipeline 中的下一个 Handler 去处理, 通过回调下一个 Handler 的 userEventTriggered 方法,在该方法中处理 IdleStateEvent */ pipeline.addLast(new IdleStateHandler(3, 5, 7, TimeUnit.SECONDS)); // 对 空闲检测 进一步处理的 自定义的 Handler pipeline.addLast(new ServerHandler()); } }); System.out.println("服务器准备好了"); ChannelFuture channelFuture = bootstrap.bind(8000).sync(); channelFuture.channel().closeFuture().sync(); }finally { bossGroup.shutdownGracefully(); workerGroup.shutdownGracefully(); } } }
服务端的处理器(空闲事件处理):
public class ServerHandler extends ChannelInboundHandlerAdapter { /** * 对 空闲事件 的处理 * @param ctx 上下文 * @param evt 传递过来的事件 * @throws Exception */ private int list[] = new int[3]; @Override public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception { // 判断这个事件是否是 IdleStateEvent 空闲事件 if (evt instanceof IdleStateEvent){ // 将 event 向下转型 => IdleStateEvent IdleStateEvent event = (IdleStateEvent) evt; String eventType = null; int index = -1; // 判断具体是哪一个空闲事件 switch (event.state()){ // 读空闲 case READER_IDLE: eventType = "读空闲"; index = 0; break; case WRITER_IDLE: eventType = "写空闲"; index = 1; break; case ALL_IDLE: eventType = "读写空闲"; index = 2; break; } list[index] ++; System.out.println("[超时事件] "+ctx.channel().remoteAddress()+" 发生了 "+eventType+"---第"+list[index]+"次"); System.out.println("服务器进行相应处理"); if (list[index] >= 3){ ctx.channel().close(); System.out.println("关闭该通道"); } } } }
-
启动测试
启动服务端,再启动上一个群聊案例的客户端,进行测试
13. Netty 通过WebSocket编程实现服务器和客户端长连接
- 要求:
- 实现基于webSocket的长连接 的全双工的交互
- 改变Http协议多次请求的约束,实 现长连接了, 服务器可以发送消息 给浏览器
- 客户端浏览器和服务器端会相互感 知,比如服务器关闭了,浏览器会 感知,同样浏览器关闭了,服务器 会感知
-
代码实现
服务端 :WebServer
public class WebServer { public static void main(String[] args) throws InterruptedException { EventLoopGroup bossGroup = new NioEventLoopGroup(1); EventLoopGroup workerGroup = new NioEventLoopGroup(8); try { ServerBootstrap bootstrap = new ServerBootstrap(); bootstrap.group(bossGroup, workerGroup) .channel(NioServerSocketChannel.class) .handler(new LoggingHandler(LogLevel.INFO)) .childHandler(new ChannelInitializer<SocketChannel>() { @Override protected void initChannel(SocketChannel socketChannel) throws Exception { ChannelPipeline pipeline = socketChannel.pipeline(); // 因为基于 HTTP 协议,所以需要使用 HTTP 的编解码器 pipeline.addLast(new HttpServerCodec()); // 添加块处理器 pipeline.addLast(new ChunkedWriteHandler()); /* 说明: 1. 因为 HTTP 数据传输时是分段的,HttpObjectAggregator 可以将多个端聚合 2. 这就是为什么浏览器发送大量数据时,就会发出多次 HTTP 请求 */ pipeline.addLast(new HttpObjectAggregator(8192)); /* 说明: 1. 对于 WebSocket 是以 帧 的形式传递的 2. 后面的参数表示 :请求的 URL 3. WebSocketServerProtocolHandler 将 HTTP 协议升级为 WebSocket 协议,即保持长连接 */ pipeline.addLast(new WebSocketServerProtocolHandler("/hello")); // 自定义的 Handler pipeline.addLast(new WebServerHandler()); } }); System.out.println("服务器准备好了"); ChannelFuture channelFuture = bootstrap.bind(8000).sync(); channelFuture.channel().closeFuture().sync(); }finally { bossGroup.shutdownGracefully(); workerGroup.shutdownGracefully(); } } }
服务端的处理器 :WebServerHandler
public class WebServerHandler extends SimpleChannelInboundHandler<TextWebSocketFrame> { // TextWebSocketFrame 类型是 WebSocket 的一个子类,表示一个文本帧 @Override protected void channelRead0(ChannelHandlerContext channelHandlerContext, TextWebSocketFrame msg) throws Exception { System.out.println("服务器端收到消息:" + msg.text()); // 回复浏览器 channelHandlerContext.channel().writeAndFlush( new TextWebSocketFrame("【服务器】"+ LocalDateTime.now()+" | "+msg.text())); } // web 连接后触发 @Override public void handlerAdded(ChannelHandlerContext ctx) throws Exception { // id 表示标识,asLongText 输出的是唯一的,asShortText 不一定是唯一的 System.out.println("handlerAdded 被调用-- "+ctx.channel().id().asLongText()+" (LongText)"); System.out.println("handlerAdded 被调用-- "+ctx.channel().id().asShortText()+" (ShortText)"); } @Override public void handlerRemoved(ChannelHandlerContext ctx) throws Exception { // id 表示标识,asLongText 输出的是唯一的,asShortText 不一定是唯一的 System.out.println("handlerRemoved 被调用-- "+ctx.channel().id().asLongText()+" (LongText)"); System.out.println("handlerRemoved 被调用-- "+ctx.channel().id().asShortText()+" (ShortText)"); } @Override public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception { System.out.println("【异常】 " + cause.getMessage()); ctx.close(); } }
网页客户端:
<body> <form onsubmit="return false"> <p>输入文本</p> <textarea id="message" name="message" style="height: 300px; width: 300px"></textarea> <input type="button" value="发送消息" onclick="send(this.form.message.value)"> <p>回复文本</p> <textarea id="responseText" style="height: 300px; width: 300px"></textarea> <input type="button" value="清空内容" onclick="document.getElementById('responseText').value=''"> </form> </body> <script> var socket; // 判断当前浏览器是否支持 WebSocket if (window.WebSocket){ socket = new WebSocket("ws://localhost:8000/hello"); // 相当于 channelRead0 方法,ev 收到服务器端回送的消息 socket.onmessage = function (ev){ var rt = document.getElementById("responseText"); rt.value = rt.value + "\n" + ev.data; } // 相当于连接开启,感知到连接开启 socket.onopen = function (){ var rt = document.getElementById("responseText"); rt.value = rt.value + "\n" + "连接开启……"; } // 感知连接关闭 socket.onclose = function (){ var rt = document.getElementById("responseText"); rt.value = rt.value + "\n" + "连接关闭……"; } }else { alert("不支持 WebSocket"); } // 发送消息到服务器 function send(message){ // 判断 WebSocket 是否创建好了 if (!window.socket){ return ; } // 判断 WebSocket 是否开启 if (socket.readyState == WebSocket.OPEN){ // 通过 Socket 发送消息 socket.send(message); }else { alert("连接未开启"); } } </script>
-
启动测试