Handler在netty中,無疑占據着非常重要的地位。Handler與Servlet中的filter很像,通過Handler可以完成通訊報文的解碼編碼、攔截指定的報文、統一對日志錯誤進行處理、統一對請求進行計數、控制Handler執行與否。一句話,沒有它做不到的只有你想不到的。
Netty中的所有handler都實現自ChannelHandler接口。按照輸出輸出來分,分為ChannelInboundHandler、ChannelOutboundHandler兩大類。ChannelInboundHandler對從客戶端發往服務器的報文進行處理,一般用來執行解碼、讀取客戶端數據、進行業務處理等;ChannelOutboundHandler對從服務器發往客戶端的報文進行處理,一般用來進行編碼、發送報文到客戶端。
Netty中,可以注冊多個handler。ChannelInboundHandler按照注冊的先后順序執行;ChannelOutboundHandler按照注冊的先后順序逆序執行,如下圖所示,按照注冊的先后順序對Handler進行排序,request進入Netty后的執行順序為:


基本的概念就說到這,下面用一個例子來進行驗證。該例子模擬Client與Server間的通訊,Server端注冊了2個ChannelInboundHandler、2個ChannelOutboundHandler。當Client連接到Server后,會向Server發送一條消息。Server端通過ChannelInboundHandler 對Client發送的消息進行讀取,通過ChannelOutboundHandler向client發送消息。最后Client把接收到的信息打印出來。
Server端一共有5個類:HelloServer InboundHandler1 InboundHandler2 OutboundHandler1 OutboundHandler2
1、HelloServer 代碼如下
- package com.guowl.testmultihandler;
- import io.netty.bootstrap.ServerBootstrap;
- import io.netty.channel.ChannelFuture;
- import io.netty.channel.ChannelInitializer;
- import io.netty.channel.ChannelOption;
- import io.netty.channel.EventLoopGroup;
- import io.netty.channel.nio.NioEventLoopGroup;
- import io.netty.channel.socket.SocketChannel;
- import io.netty.channel.socket.nio.NioServerSocketChannel;
- public class HelloServer {
- public void start(int port) throws Exception {
- EventLoopGroup bossGroup = new NioEventLoopGroup();
- EventLoopGroup workerGroup = new NioEventLoopGroup();
- try {
- ServerBootstrap b = new ServerBootstrap();
- b.group(bossGroup, workerGroup).channel(NioServerSocketChannel.class)
- .childHandler(new ChannelInitializer<SocketChannel>() {
- @Override
- public void initChannel(SocketChannel ch) throws Exception {
- // 注冊兩個OutboundHandler,執行順序為注冊順序的逆序,所以應該是OutboundHandler2 OutboundHandler1
- ch.pipeline().addLast(new OutboundHandler1());
- ch.pipeline().addLast(new OutboundHandler2());
- // 注冊兩個InboundHandler,執行順序為注冊順序,所以應該是InboundHandler1 InboundHandler2
- ch.pipeline().addLast(new InboundHandler1());
- ch.pipeline().addLast(new InboundHandler2());
- }
- }).option(ChannelOption.SO_BACKLOG, 128)
- .childOption(ChannelOption.SO_KEEPALIVE, true);
- ChannelFuture f = b.bind(port).sync();
- f.channel().closeFuture().sync();
- } finally {
- workerGroup.shutdownGracefully();
- bossGroup.shutdownGracefully();
- }
- }
- public static void main(String[] args) throws Exception {
- HelloServer server = new HelloServer();
- server.start(8000);
- }
- }
2、InboundHandler1
- package com.guowl.testmultihandler;
- import io.netty.channel.ChannelHandlerContext;
- import io.netty.channel.ChannelInboundHandlerAdapter;
- import org.slf4j.Logger;
- import org.slf4j.LoggerFactory;
- public class InboundHandler1 extends ChannelInboundHandlerAdapter {
- private static Logger logger = LoggerFactory.getLogger(InboundHandler1.class);
- @Override
- public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
- logger.info("InboundHandler1.channelRead: ctx :" + ctx);
- // 通知執行下一個InboundHandler
- ctx.fireChannelRead(msg);
- }
- @Override
- public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
- logger.info("InboundHandler1.channelReadComplete");
- ctx.flush();
- }
- }
3、InboundHandler2
- package com.guowl.testmultihandler;
- import io.netty.buffer.ByteBuf;
- import io.netty.channel.ChannelHandlerContext;
- import io.netty.channel.ChannelInboundHandlerAdapter;
- import org.slf4j.Logger;
- import org.slf4j.LoggerFactory;
- public class InboundHandler2 extends ChannelInboundHandlerAdapter {
- private static Logger logger = LoggerFactory.getLogger(InboundHandler2.class);
- @Override
- // 讀取Client發送的信息,並打印出來
- public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
- logger.info("InboundHandler2.channelRead: ctx :" + ctx);
- ByteBuf result = (ByteBuf) msg;
- byte[] result1 = new byte[result.readableBytes()];
- result.readBytes(result1);
- String resultStr = new String(result1);
- System.out.println("Client said:" + resultStr);
- result.release();
- ctx.write(msg);
- }
- @Override
- public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
- logger.info("InboundHandler2.channelReadComplete");
- ctx.flush();
- }
- }
4、OutboundHandler1
- package com.guowl.testmultihandler;
- import io.netty.buffer.ByteBuf;
- import io.netty.channel.ChannelHandlerContext;
- import io.netty.channel.ChannelOutboundHandlerAdapter;
- import io.netty.channel.ChannelPromise;
- import org.slf4j.Logger;
- import org.slf4j.LoggerFactory;
- public class OutboundHandler1 extends ChannelOutboundHandlerAdapter {
- private static Logger logger = LoggerFactory.getLogger(OutboundHandler1.class);
- @Override
- // 向client發送消息
- public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {
- logger.info("OutboundHandler1.write");
- String response = "I am ok!";
- ByteBuf encoded = ctx.alloc().buffer(4 * response.length());
- encoded.writeBytes(response.getBytes());
- ctx.write(encoded);
- ctx.flush();
- }
- }
5、OutboundHandler2
- package com.guowl.testmultihandler;
- import io.netty.channel.ChannelHandlerContext;
- import io.netty.channel.ChannelOutboundHandlerAdapter;
- import io.netty.channel.ChannelPromise;
- import org.slf4j.Logger;
- import org.slf4j.LoggerFactory;
- public class OutboundHandler2 extends ChannelOutboundHandlerAdapter {
- private static Logger logger = LoggerFactory.getLogger(OutboundHandler2.class);
- @Override
- public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {
- logger.info("OutboundHandler2.write");
- // 執行下一個OutboundHandler
- super.write(ctx, msg, promise);
- }
- }
Client端有兩個類:HelloClient HelloClientIntHandler
1、HelloClient
- package com.guowl.testmultihandler;
- import io.netty.bootstrap.Bootstrap;
- import io.netty.channel.ChannelFuture;
- import io.netty.channel.ChannelInitializer;
- import io.netty.channel.ChannelOption;
- import io.netty.channel.EventLoopGroup;
- import io.netty.channel.nio.NioEventLoopGroup;
- import io.netty.channel.socket.SocketChannel;
- import io.netty.channel.socket.nio.NioSocketChannel;
- public class HelloClient {
- public void connect(String host, int port) throws Exception {
- EventLoopGroup workerGroup = new NioEventLoopGroup();
- try {
- Bootstrap b = new Bootstrap();
- b.group(workerGroup);
- b.channel(NioSocketChannel.class);
- b.option(ChannelOption.SO_KEEPALIVE, true);
- b.handler(new ChannelInitializer<SocketChannel>() {
- @Override
- public void initChannel(SocketChannel ch) throws Exception {
- ch.pipeline().addLast(new HelloClientIntHandler());
- }
- });
- // Start the client.
- ChannelFuture f = b.connect(host, port).sync();
- f.channel().closeFuture().sync();
- } finally {
- workerGroup.shutdownGracefully();
- }
- }
- public static void main(String[] args) throws Exception {
- HelloClient client = new HelloClient();
- client.connect("127.0.0.1", 8000);
- }
- }
2、HelloClientIntHandler
- package com.guowl.testmultihandler;
- import io.netty.buffer.ByteBuf;
- import io.netty.channel.ChannelHandlerContext;
- import io.netty.channel.ChannelInboundHandlerAdapter;
- import org.slf4j.Logger;
- import org.slf4j.LoggerFactory;
- public class HelloClientIntHandler extends ChannelInboundHandlerAdapter {
- private static Logger logger = LoggerFactory.getLogger(HelloClientIntHandler.class);
- @Override
- // 讀取服務端的信息
- public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
- logger.info("HelloClientIntHandler.channelRead");
- ByteBuf result = (ByteBuf) msg;
- byte[] result1 = new byte[result.readableBytes()];
- result.readBytes(result1);
- result.release();
- ctx.close();
- System.out.println("Server said:" + new String(result1));
- }
- @Override
- // 當連接建立的時候向服務端發送消息 ,channelActive 事件當連接建立的時候會觸發
- public void channelActive(ChannelHandlerContext ctx) throws Exception {
- logger.info("HelloClientIntHandler.channelActive");
- String msg = "Are you ok?";
- ByteBuf encoded = ctx.alloc().buffer(4 * msg.length());
- encoded.writeBytes(msg.getBytes());
- ctx.write(encoded);
- ctx.flush();
- }
- }
server端執行結果為:

在使用Handler的過程中,需要注意:
1、ChannelInboundHandler之間的傳遞,通過調用 ctx.fireChannelRead(msg) 實現;調用ctx.write(msg) 將傳遞到ChannelOutboundHandler。
2、ctx.write()方法執行后,需要調用flush()方法才能令它立即執行。
3、ChannelOutboundHandler 在注冊的時候需要放在最后一個ChannelInboundHandler之前,否則將無法傳遞到ChannelOutboundHandler。
-
如果調用的是ctx.channel().write()是從尾開始執行,不會有博主說的問題,如果是直接用ctx.write()時則會有博主說的問題
