这是我参与8月更文挑战的第17天，活动详情查看：8月更文挑战
一、Netty客户端/服务器概览
下图展示了Netty客户端与服务器的交互：
Echo客户端和服务器之间的交互是非常简单的；在客户端建立一个连接之后，它会向服务器发送一个或多个消息，反过来，服务器又会将每个消息回送给客户端。虽然它本身看起来好像用处不大，但充分地体现了客户端/服务器中典型的请求-响应交互模式。
二、编写Echo服务器
所有的Netty服务器都需要以下两部分：
- 至少一个ChannelHandler——该组件实现了服务器对从客户端接收的数据的处理，即它的业务逻辑。
- 引导——这是配置服务器的启动代码。至少，它会将服务器绑定到它要监听连接请求的端口上。
2.1 ChannelHandler和业务逻辑
因为服务器需要响应传入的消息，所以需要实现ChannelInboundHandler接口，用来定义响应入站事件的方法。这个简单的应用程序只需要用到少量的这些方法，所以继承ChannelInboundHandlerAdapter类就足够了，它提供了ChannelInboundHandler的默认实现。
在这个应用程序里，感兴趣的方法是：
- channelRead()——对于每个传入的消息都要调用；
- channelReadComplete()——通知ChannelInboundHandler最后一次对channelRead()的调用是当前批量读取中的最后一条消息；
- exceptionCaught()——在读取操作期间，有异常抛出时会调用。
该Echo服务器的ChannelHandler实现是EchoServerHandler，代码清单如下：
// 标示一个ChannelHandler可以被多个Channel安全地共享
@ChannelHandler.Sharable
public class EchoServerHandler extends ChannelInboundHandlerAdapter {
@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) {
ByteBuf in = (ByteBuf) msg;
// 输出接收到的消息
System.out.println("Server received: " + in.toString(CharsetUtil.UTF_8));
// 将接收到的消息写给发送者，而不冲刷出站消息
ctx.write(in);
}
@Override
public void channelReadComplete(ChannelHandlerContext ctx) {
// 将暂存于ChannelOutboundBuffer中的消息，冲刷到运程节点，并且关闭该Channel
ctx.writeAndFlush(Unpooled.EMPTY_BUFFER).addListener(ChannelFutureListener.CLOSE);
}
@Override
public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) {
// 打印异常跟踪
cause.printStackTrace();
// 关闭该Channel
ctx.close();
}
}
ChannelInboundHandlerAdapter有一个直观的API，并且它的每个方法都可以被重写以挂钩到事件生命周期的恰当点上。因为需要处理所有接收数据，所以重写了channelRead()方法。
重写exceptionCaught()方法允许对Throwable的任何子类型做出反应，在这里我们记录了异常并关闭了连接。
2.2 引导服务器
经过EchoServerHandler实现的核心业务逻辑之后，我们现在来探讨引导服务器本身的过程，具体包括以下内容：
1、绑定到服务器将在其上监听并接受传入连接请求的端口；
2、配置Channel，以将有关的入站信息通知给EchoServerHandler实例。
以下是EchoServer类的完整代码：
public class EchoServer {
private final int port;
public EchoServer(int port) {
this.port = port;
}
public static void main(String[] args) throws Exception {
// 启动服务器
new EchoServer(2048).start();
}
private void start() throws Exception {
final EchoServerHandler serverHandler = new EchoServerHandler();
// 创建EventLoopGroup，由于使用NIO传输，所以指定了NioEventLoopGroup来接受和处理新连接
EventLoopGroup group = new NioEventLoopGroup();
try {
// 创建ServerBootstrap
ServerBootstrap b = new ServerBootstrap();
b.group(group)
// 指定使用的NIO传输Channel
.channel(NioServerSocketChannel.class)
// 使用指定的端口设置套接字地址
.localAddress(new InetSocketAddress(port))
// 添加一个EchoServerHandler到子Channel的ChannelPipeline
// 当新的连接被授受时，一个新的子Channel将会被创建，ChannelInitializer将会把EchoServerHandler
// 的实例添加到该Channel的ChannelPipeline中
.childHandler(new ChannelInitializer<SocketChannel>() {
@Override
protected void initChannel(SocketChannel ch) throws Exception {
// 由于serverHandler被@Shareable，所以我们总是可以使用同样的实例
ch.pipeline().addLast(serverHandler);
}
});
// 异步地绑定服务器，调用sync()方法阻塞等待直到绑定完成
ChannelFuture f = b.bind().sync();
// 获取Channel的CloseFuture,并且阻塞当前线程直到它完成
f.channel().closeFuture().sync();
} finally {
// 关闭EventLoopGroup资源
group.shutdownGracefully().sync();
}
}
}
三、编写Echo客户端
Echo客户端将会：
(1) 连接到服务器；
(2) 发送一个或者多个消息；
(3) 对于每个消息，等待并接收从服务器发回相同的消息；
(4) 关闭连接；
编写客户端所涉及的两个主要代码部分也是业务逻辑和引导。
3.1 通过ChannelHandler实现客户端逻辑
如同服务器，客户端将拥有一个用来处理数据的ChannelInboundHandler。在这个场景下，你将扩展SimpleChannelInboundHandler类以处理所有必须的任务，代码清单如下，我们需要重写下面的方法：
- channelActive()——在到服务器的连接已建立之后将被调用；
- channelRead0()——当从服务器接收到一条消息时被调用;
- exceptionCaught()——在处理过程中引发异常时被调用。
// 标记该类可以被多个Channel共享
@ChannelHandler.Sharable
public class EchoClientHandler extends SimpleChannelInboundHandler<ByteBuf> {
@Override
public void channelActive(ChannelHandlerContext ctx) {
// 当被通知Channel是活跃的时候，发送一条消息
ctx.writeAndFlush(Unpooled.copiedBuffer("Netty rocks!", CharsetUtil.UTF_8));
}
@Override
protected void channelRead0(ChannelHandlerContext ctx, ByteBuf in) {
// 记录已接收消息的传储
System.out.println("Client received: " + in.toString(CharsetUtil.UTF_8));
}
@Override
public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) {
// 在发生异常时，记录错误并关闭Channel
cause.printStackTrace();
ctx.close();
}
}
重写了channelRead0()方法。每当接收数据时，都会调用这个方法。需要注意的是，由服务器发送的消息可能会被分块接收。也就是说，如果服务器发送了5字节，那么不能保证这5字节会被一次性接收。即使是对于这么少量的数据，channelRead0()方法也可能会被调用两次，第一次使用一个持有3字节的ByteBuf(Netty的字节容器)，第二次使用一个持有2字节的ByteBuf。作为一个面向流的协议，TCP保证了字节数组将会按照服务器发送它们的顺序被接收。
3.2 引导客户端
引导客户端类似于引导服务器，不同的是，客户端是使用主机和端口参数来连接远程地址，也就是这里的Echo服务器地址，而不是绑定到一个一直被监听的端口。代码清单如下：
public class EchoClient {
private final String host;
private final int port;
public EchoClient(String host, int port) {
this.host = host;
this.port = port;
}
public void start() throws Exception {
EventLoopGroup group = new NioEventLoopGroup();
try {
Bootstrap b = new Bootstrap();
// 指定EventLoopGroup以处理客户端事件；需要适用于NIO的实现
b.group(group)
// 适用于NIO传输的Channel类型
.channel(NioSocketChannel.class)
// 配置服务器的地址
.remoteAddress(new InetSocketAddress(host, port))
// 在创建Channel时向ChannelPipeline中添加一个EchoClientHandler实例
.handler(new ChannelInitializer<SocketChannel>() {
@Override
protected void initChannel(SocketChannel ch) throws Exception {
ch.pipeline().addLast(
new EchoClientHandler());
}
});
// 阻塞，直到连接完成
ChannelFuture f = b.connect().sync();
// 阻塞直到channel关闭
f.channel().closeFuture().sync();
} finally {
// 释放资源
group.shutdownGracefully().sync();
}
}
public static void main(String[] args) throws Exception {
String host = "192.168.0.103";
int port = 2048;
new EchoClient(host, port).start();
}
}
和服务器一样，使用了NIO传输。注意，可以客户端和服务器上分别使用不同的传输。例如，在服务器端使用NIO传输，而在客户端使用OIO传输。
