netty(七) Handler的执行顺序

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 代码如下

1. package com.guowl.testmultihandler;
2. import io.netty.bootstrap.ServerBootstrap;
3. import io.netty.channel.ChannelFuture;
4. import io.netty.channel.ChannelInitializer;
5. import io.netty.channel.ChannelOption;
6. import io.netty.channel.EventLoopGroup;
7. import io.netty.channel.nio.NioEventLoopGroup;
8. import io.netty.channel.socket.SocketChannel;
9. import io.netty.channel.socket.nio.NioServerSocketChannel;
10. public class HelloServer {
11. public void start(int port) throws Exception {
12. EventLoopGroup bossGroup = new NioEventLoopGroup();
13. EventLoopGroup workerGroup = new NioEventLoopGroup();
14. try {
15. ServerBootstrap b = new ServerBootstrap();
16. b.group(bossGroup, workerGroup).channel(NioServerSocketChannel.class)
17. .childHandler(new ChannelInitializer<SocketChannel>() {
18. @Override
19. public void initChannel(SocketChannel ch) throws Exception {
20. // 注册两个OutboundHandler，执行顺序为注册顺序的逆序，所以应该是OutboundHandler2 OutboundHandler1
21. ch.pipeline().addLast(new OutboundHandler1());
22. ch.pipeline().addLast(new OutboundHandler2());
23. // 注册两个InboundHandler，执行顺序为注册顺序，所以应该是InboundHandler1 InboundHandler2
24. ch.pipeline().addLast(new InboundHandler1());
25. ch.pipeline().addLast(new InboundHandler2());
26. }
27. }).option(ChannelOption.SO_BACKLOG, 128)
28. .childOption(ChannelOption.SO_KEEPALIVE, true);
29. ChannelFuture f = b.bind(port).sync();
30. f.channel().closeFuture().sync();
31. } finally {
32. workerGroup.shutdownGracefully();
33. bossGroup.shutdownGracefully();
34. }
35. }
36. public static void main(String[] args) throws Exception {
37. HelloServer server = new HelloServer();
38. server.start(8000);
39. }
40. }

2、InboundHandler1

1. package com.guowl.testmultihandler;
2. import io.netty.channel.ChannelHandlerContext;
3. import io.netty.channel.ChannelInboundHandlerAdapter;
4. import org.slf4j.Logger;
5. import org.slf4j.LoggerFactory;
6. public class InboundHandler1 extends ChannelInboundHandlerAdapter {
7. private static Logger   logger  = LoggerFactory.getLogger(InboundHandler1.class);
8. @Override
9. public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
10. logger.info("InboundHandler1.channelRead: ctx :" + ctx);
11. // 通知执行下一个InboundHandler
12. ctx.fireChannelRead(msg);
13. }
14. @Override
15. public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
16. logger.info("InboundHandler1.channelReadComplete");
17. ctx.flush();
18. }
19. }

3、InboundHandler2

1. package com.guowl.testmultihandler;
2. import io.netty.buffer.ByteBuf;
3. import io.netty.channel.ChannelHandlerContext;
4. import io.netty.channel.ChannelInboundHandlerAdapter;
5. import org.slf4j.Logger;
6. import org.slf4j.LoggerFactory;
7. public class InboundHandler2 extends ChannelInboundHandlerAdapter {
8. private static Logger   logger  = LoggerFactory.getLogger(InboundHandler2.class);
9. @Override
10. // 读取Client发送的信息，并打印出来
11. public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
12. logger.info("InboundHandler2.channelRead: ctx :" + ctx);
13. ByteBuf result = (ByteBuf) msg;
14. byte[] result1 = new byte[result.readableBytes()];
15. result.readBytes(result1);
16. String resultStr = new String(result1);
17. System.out.println("Client said:" + resultStr);
18. result.release();
19. ctx.write(msg);
20. }
21. @Override
22. public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
23. logger.info("InboundHandler2.channelReadComplete");
24. ctx.flush();
25. }
26. }

4、OutboundHandler1

1. package com.guowl.testmultihandler;
2. import io.netty.buffer.ByteBuf;
3. import io.netty.channel.ChannelHandlerContext;
4. import io.netty.channel.ChannelOutboundHandlerAdapter;
5. import io.netty.channel.ChannelPromise;
6. import org.slf4j.Logger;
7. import org.slf4j.LoggerFactory;
8. public class OutboundHandler1 extends ChannelOutboundHandlerAdapter {
9. private static Logger   logger  = LoggerFactory.getLogger(OutboundHandler1.class);
10. @Override
11. // 向client发送消息
12. public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {
13. logger.info("OutboundHandler1.write");
14. String response = "I am ok!";
15. ByteBuf encoded = ctx.alloc().buffer(4 * response.length());
16. encoded.writeBytes(response.getBytes());
17. ctx.write(encoded);
18. ctx.flush();
19. }
20. }

5、OutboundHandler2

1. package com.guowl.testmultihandler;
2. import io.netty.channel.ChannelHandlerContext;
3. import io.netty.channel.ChannelOutboundHandlerAdapter;
4. import io.netty.channel.ChannelPromise;
5. import org.slf4j.Logger;
6. import org.slf4j.LoggerFactory;
7. public class OutboundHandler2 extends ChannelOutboundHandlerAdapter {
8. private static Logger   logger  = LoggerFactory.getLogger(OutboundHandler2.class);
9. @Override
10. public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {
11. logger.info("OutboundHandler2.write");
12. // 执行下一个OutboundHandler
13. super.write(ctx, msg, promise);
14. }
15. }

Client端有两个类：HelloClient  HelloClientIntHandler

1、HelloClient

1. package com.guowl.testmultihandler;
2. import io.netty.bootstrap.Bootstrap;
3. import io.netty.channel.ChannelFuture;
4. import io.netty.channel.ChannelInitializer;
5. import io.netty.channel.ChannelOption;
6. import io.netty.channel.EventLoopGroup;
7. import io.netty.channel.nio.NioEventLoopGroup;
8. import io.netty.channel.socket.SocketChannel;
9. import io.netty.channel.socket.nio.NioSocketChannel;
10. public class HelloClient {
11. public void connect(String host, int port) throws Exception {
12. EventLoopGroup workerGroup = new NioEventLoopGroup();
13. try {
14. Bootstrap b = new Bootstrap();
15. b.group(workerGroup);
16. b.channel(NioSocketChannel.class);
17. b.option(ChannelOption.SO_KEEPALIVE, true);
18. b.handler(new ChannelInitializer<SocketChannel>() {
19. @Override
20. public void initChannel(SocketChannel ch) throws Exception {
21. ch.pipeline().addLast(new HelloClientIntHandler());
22. }
23. });
24. // Start the client.
25. ChannelFuture f = b.connect(host, port).sync();
26. f.channel().closeFuture().sync();
27. } finally {
28. workerGroup.shutdownGracefully();
29. }
30. }
31. public static void main(String[] args) throws Exception {
32. HelloClient client = new HelloClient();
33. client.connect("127.0.0.1", 8000);
34. }
35. }

2、HelloClientIntHandler

1. package com.guowl.testmultihandler;
2. import io.netty.buffer.ByteBuf;
3. import io.netty.channel.ChannelHandlerContext;
4. import io.netty.channel.ChannelInboundHandlerAdapter;
5. import org.slf4j.Logger;
6. import org.slf4j.LoggerFactory;
7. public class HelloClientIntHandler extends ChannelInboundHandlerAdapter {
8. private static Logger   logger  = LoggerFactory.getLogger(HelloClientIntHandler.class);
9. @Override
10. // 读取服务端的信息
11. public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
12. logger.info("HelloClientIntHandler.channelRead");
13. ByteBuf result = (ByteBuf) msg;
14. byte[] result1 = new byte[result.readableBytes()];
15. result.readBytes(result1);
16. result.release();
17. ctx.close();
18. System.out.println("Server said:" + new String(result1));
19. }
20. @Override
21. // 当连接建立的时候向服务端发送消息 ，channelActive 事件当连接建立的时候会触发
22. public void channelActive(ChannelHandlerContext ctx) throws Exception {
23. logger.info("HelloClientIntHandler.channelActive");
24. String msg = "Are you ok?";
25. ByteBuf encoded = ctx.alloc().buffer(4 * msg.length());
26. encoded.writeBytes(msg.getBytes());
27. ctx.write(encoded);
28. ctx.flush();
29. }
30. }

server端执行结果为：

在使用Handler的过程中，需要注意：

1、ChannelInboundHandler之间的传递，通过调用 ctx.fireChannelRead(msg) 实现；调用ctx.write(msg) 将传递到ChannelOutboundHandler。

2、ctx.write()方法执行后，需要调用flush()方法才能令它立即执行。

3、ChannelOutboundHandler 在注册的时候需要放在最后一个ChannelInboundHandler之前，否则将无法传递到ChannelOutboundHandler。