09 引导Netty应用程序

本章介绍

引导客户端和服务器
从Channel引导客户端
添加多个ChannelHandler
使用通道选项和属性

上一章学习了编写自己的ChannelHandler和编解码器并将它们添加到Channel的ChannelPipeline中。本章将讲解如何将它们结合在一起使用。

Netty提供了简单统一的方法来引导服务器和客户端。引导是配置Netty服务器和客户端程序的一个过程，Bootstrap允许这些应用程序很容易的重复使用。Netty程序的客户端和服务器都可以使用Bootstrap，其目的是简化编码过程，Bootstrap还提供了一个机制就是让一些组件(channels,pipeline,handlers等等)都可以在后台工作。本章将具体结合以下部分一起使用开发Netty程序：

EventLoopGroup
Channel
设置ChannelOption
Channel被注册后将调用ChannelHandler
添加指定的属性到Channel
设置本地和远程地址
绑定、连接(取决于类型)

知道如何使用各个Bootstrap后就可以使用它们配置服务器和客户端了。本章还将学习在什么会后可以共享一个Bootstrap以及为什么这样做，结合我们之前学习的知识点来编写Netty程序。

9.1 不同的引导类型

Netty包含了2个不同类型的引导，第一个是使用服务器的ServerBootstrap，用来接受客户端连接以及为已接受的连接创建子通道；第二个是用于客户端的Bootstrap，不接受新的连接，并且是在父通道类完成一些操作。

还有一种情况是处理DatagramChannel实例，这些用于UDP协议，是无连接的。换句话说，由于UDP的性质，所以当处理UDP数据时没有必要每个连接通道与TCP连接一样。因为通道不需要连接后才能发送数据，UDP是无连接协议。一个通道可以处理所有的数据而不需要依赖子通道。

下图是引导的类关系图：

我们在前面讨论了许多用于客户端和服务器的知识，为了对客户端和服务器之间的关系提供了一个共同点，Netty使用AbstractBootstrap类。通过一个共同的父类，在本章中讨论的客户端和服务器的引导程序能够重复使用通用功能，而无需复制代码或逻辑。通常情况下，多个通道使用相同或非常类似的设置时有必要的。而不是为每一个通道创建一个新的引导，Netty使得AbstractBootstrap可复制。也就是说克隆一个已配置的引导，其返回的是一个可重用而无需配置的引导。Netty的克隆操作只能浅拷贝引导的EventLoopGroup，也就是说EventLoopGroup在所有的克隆的通道中是共享的。这是一个好事情，克隆的通道一般是短暂的，例如一个通道创建一个HTTP请求。

本章主要讲解Bootstrap和ServerBootstrap，首先我们来看看ServerBootstrap。

9.2 引导客户端和无连接协议

当需要引导客户端或一些无连接协议时，需要使用Bootstrap类。

9.2.1引导客户端的方法

创建Bootstrap实例使用new关键字，下面是Bootstrap的方法：

group(...)，设置EventLoopGroup,EventLoopGroup用来处理所有通道的IO事件

channel(...)，设置通道类型
channelFactory(...)，使用ChannelFactory来设置通道类型
localAddress(...)，设置本地地址，也可以通过bind(...)或connect(...)

option(ChannelOption<T>, T)，设置通道选项，若使用null，则删除上一个设置的ChannelOption

attr(AttributeKey<T>, T)，设置属性到Channel，若值为null，则指定键的属性被删除

handler(ChannelHandler)，设置ChannelHandler用于处理请求事件
clone()，深度复制Bootstrap，Bootstrap的配置相同
remoteAddress(...)，设置连接地址

connect(...)，连接远程通道
bind(...)，创建一个新的Channel并绑定

9.2.2 怎么引导客户端

引导负责客户端通道连接或断开连接，因此它将在调用bind(...)或connect(...)后创建通道。下图显示了如何工作：

下面代码显示了引导客户端使用NIO TCP传输：

[html] view plaincopy

1. package netty.in.action;
2.
3. import io.netty.bootstrap.Bootstrap;
4. import io.netty.buffer.ByteBuf;
5. import io.netty.channel.ChannelFuture;
6. import io.netty.channel.ChannelFutureListener;
7. import io.netty.channel.ChannelHandlerContext;
8. import io.netty.channel.EventLoopGroup;
9. import io.netty.channel.SimpleChannelInboundHandler;
10.
import io.netty.channel.nio.NioEventLoopGroup;
11. import io.netty.channel.socket.nio.NioSocketChannel;
12.

13. /**
14.
* 引导配置客户端
15. *
16.
* @author c.k
17. *
18.
*/
19. public class BootstrapingClient {
20.

21. public static void main(String[] args) throws Exception {
22.
EventLoopGroup group = new NioEventLoopGroup();
23. Bootstrap b = new Bootstrap();
24.
b.group(group).channel(NioSocketChannel.class).handler(new SimpleChannelInboundHandler<ByteBuf>() {
25. @Override
26.
protected void channelRead0(ChannelHandlerContext ctx, ByteBuf msg) throws Exception {
27. System.out.println("Received data");
28.
msg.clear();
29. }
30.
});
31. ChannelFuture f = b.connect("127.0.0.1", 2048);
32.
f.addListener(new ChannelFutureListener() {
33. @Override
34.
public void operationComplete(ChannelFuture future) throws Exception {
35. if (future.isSuccess()) {
36.
System.out.println("connection finished");
37. } else {
38.
System.out.println("connection failed");
39. future.cause().printStackTrace();
40.
}
41. }
42.
});
43. }
44.
}

9.2.3 选择兼容通道实现

Channel的实现和EventLoop的处理过程在EventLoopGroup中必须兼容，哪些Channel是和EventLoopGroup是兼容的可以查看API文档。经验显示，相兼容的实现一般在同一个包下面，例如使用NioEventLoop，NioEventLoopGroup和NioServerSocketChannel在一起。请注意，这些都是前缀“Nio”，然后不会用这些代替另一个实现和另一个前缀，如“Oio”，也就是说OioEventLoopGroup和NioServerSocketChannel是不相容的。

Channel和EventLoopGroup的EventLoop必须相容，例如NioEventLoop、NioEventLoopGroup、NioServerSocketChannel是相容的，但是OioEventLoopGroup和NioServerSocketChannel是不相容的。从类名可以看出前缀是“Nio”的只能和“Nio”的一起使用，“Oio”前缀的只能和Oio*一起使用，将不相容的一起使用会导致错误异常，如OioSocketChannel和NioEventLoopGroup一起使用时会抛出异常：Exception
in thread "main"java.lang.IllegalStateException: incompatible event loop type。

9.3 使用ServerBootstrap引导服务器

9.3.1引导服务器的方法

先看看ServerBootstrap提供了哪些方法

group(...)，设置EventLoopGroup事件循环组
channel(...)，设置通道类型
channelFactory(...)，使用ChannelFactory来设置通道类型
localAddress(...)，设置本地地址，也可以通过bind(...)或connect(...)

option(ChannelOption<T>, T)，设置通道选项，若使用null，则删除上一个设置的ChannelOption

childOption(ChannelOption<T>, T)，设置子通道选项
attr(AttributeKey<T>, T)，设置属性到Channel，若值为null，则指定键的属性被删除

childAttr(AttributeKey<T>, T)，设置子通道属性
handler(ChannelHandler)，设置ChannelHandler用于处理请求事件
childHandler(ChannelHandler)，设置子ChannelHandler
clone()，深度复制ServerBootstrap，且配置相同
bind(...)，创建一个新的Channel并绑定

9.3.2 怎么引导服务器

下图显示ServerBootstrap管理子通道：

child*方法是在子Channel上操作，通过ServerChannel来管理。

下面代码显示使用ServerBootstrap引导配置服务器：

[java] view plaincopy

1. package netty.in.action;
2.
3. import io.netty.bootstrap.ServerBootstrap;
4. import io.netty.buffer.ByteBuf;
5. import io.netty.channel.ChannelFuture;
6. import io.netty.channel.ChannelFutureListener;
7. import io.netty.channel.ChannelHandlerContext;
8. import io.netty.channel.EventLoopGroup;
9. import io.netty.channel.SimpleChannelInboundHandler;
10.
import io.netty.channel.nio.NioEventLoopGroup;
11. import io.netty.channel.socket.nio.NioServerSocketChannel;
12.

13. /**
14.
* 引导服务器配置
15. * @author c.k
16.
*
17. */
18.
public class BootstrapingServer {
19.
20.
public static void main(String[] args) throws Exception {
21. EventLoopGroup bossGroup = new NioEventLoopGroup(1);
22.
EventLoopGroup workerGroup = new NioEventLoopGroup();
23. ServerBootstrap b = new ServerBootstrap();
24.
b.group(bossGroup, workerGroup).channel(NioServerSocketChannel.class)
25. .childHandler(new SimpleChannelInboundHandler<ByteBuf>() {
26.
@Override
27. protected void channelRead0(ChannelHandlerContext ctx, ByteBuf msg) throws Exception {
28.
System.out.println("Received data");
29. msg.clear();
30.
}
31. });
32.
ChannelFuture f = b.bind(2048);
33. f.addListener(new ChannelFutureListener() {
34.
@Override
35. public void operationComplete(ChannelFuture future) throws Exception {
36.
if (future.isSuccess()) {
37. System.out.println("Server bound");
38.
} else {
39. System.err.println("bound fail");
40.
future.cause().printStackTrace();
41. }
42.
}
43. });
44.
}
45. }

9.4 从Channel引导客户端

有时候需要从另一个Channel引导客户端，例如写一个代理或需要从其他系统检索数据。从其他系统获取数据时比较常见的，有很多Netty应用程序必须要和企业现有的系统集成，如Netty程序与内部系统进行身份验证，查询数据库等。

当然，你可以创建一个新的引导，这样做没有什么不妥，只是效率不高，因为要为新创建的客户端通道使用另一个EventLoop，如果需要在已接受的通道和客户端通道之间交换数据则需要切换上下文线程。Netty对这方面进行了优化，可以讲已接受的通道通过eventLoop(...)传递到EventLoop，从而使客户端通道在相同的EventLoop里运行。这消除了额外的上下文切换工作，因为EventLoop继承于EventLoopGroup。除了消除上下文切换，还可以在不需要创建多个线程的情况下使用引导。

为什么要共享EventLoop呢？一个EventLoop由一个线程执行，共享EventLoop可以确定所有的Channel都分配给同一线程的EventLoop，这样就避免了不同线程之间切换上下文，从而减少资源开销。

下图显示相同的EventLoop管理两个Channel：

看下面代码：

[java] view plaincopy

1. package netty.in.action;
2.
3. import java.net.InetSocketAddress;
4.
5. import io.netty.bootstrap.Bootstrap;
6. import io.netty.bootstrap.ServerBootstrap;
7. import io.netty.buffer.ByteBuf;
8. import io.netty.channel.ChannelFuture;
9. import io.netty.channel.ChannelFutureListener;
10.
import io.netty.channel.ChannelHandlerContext;
11. import io.netty.channel.EventLoopGroup;
12.
import io.netty.channel.SimpleChannelInboundHandler;
13. import io.netty.channel.nio.NioEventLoopGroup;
14.
import io.netty.channel.socket.nio.NioServerSocketChannel;
15. import io.netty.channel.socket.nio.NioSocketChannel;
16.

17. /**
18.
* 从Channel引导客户端
19. *
20.
* @author c.k
21. *
22.
*/
23. public class BootstrapingFromChannel {
24.

25. public static void main(String[] args) throws Exception {
26.
EventLoopGroup bossGroup = new NioEventLoopGroup(1);
27. EventLoopGroup workerGroup = new NioEventLoopGroup();
28.
ServerBootstrap b = new ServerBootstrap();
29. b.group(bossGroup, workerGroup).channel(NioServerSocketChannel.class)
30.
.childHandler(new SimpleChannelInboundHandler<ByteBuf>() {
31. ChannelFuture connectFuture;
32.

33. @Override
34.
public void channelActive(ChannelHandlerContext ctx) throws Exception {
35. Bootstrap b = new Bootstrap();
36.
b.channel(NioSocketChannel.class).handler(
37. new SimpleChannelInboundHandler<ByteBuf>() {
38.
@Override
39. protected void channelRead0(ChannelHandlerContext ctx,
40.
ByteBuf msg) throws Exception {
41. System.out.println("Received data");
42.
msg.clear();
43. }
44.
});
45. b.group(ctx.channel().eventLoop());
46.
connectFuture = b.connect(new InetSocketAddress("127.0.0.1", 2048));
47. }
48.

49. @Override
50.
protected void channelRead0(ChannelHandlerContext ctx, ByteBuf msg)
51. throws Exception {
52.
if (connectFuture.isDone()) {
53. // do something with the data
54.
}
55. }
56.
});
57. ChannelFuture f = b.bind(2048);
58.
f.addListener(new ChannelFutureListener() {
59. @Override
60.
public void operationComplete(ChannelFuture future) throws Exception {
61. if (future.isSuccess()) {
62.
System.out.println("Server bound");
63. } else {
64.
System.err.println("bound fail");
65. future.cause().printStackTrace();
66.
}
67. }
68.
});
69. }
70.
}

9.5 添加多个ChannelHandler

在所有的例子代码中，我们在引导过程中通过handler(...)或childHandler(...)都只添加了一个ChannelHandler实例，对于简单的程序可能足够，但是对于复杂的程序则无法满足需求。例如，某个程序必须支持多个协议，如HTTP、WebSocket。若在一个ChannelHandler中处理这些协议将导致一个庞大而复杂的ChannelHandler。Netty通过添加多个ChannelHandler，从而使每个ChannelHandler分工明确，结构清晰。

Netty的一个优势是可以在ChannelPipeline中堆叠很多ChannelHandler并且可以最大程度的重用代码。如何添加多个ChannelHandler呢？Netty提供ChannelInitializer抽象类用来初始化ChannelPipeline中的ChannelHandler。ChannelInitializer是一个特殊的ChannelHandler，通道被注册到EventLoop后就会调用ChannelInitializer，并允许将ChannelHandler添加到CHannelPipeline；完成初始化通道后，这个特殊的ChannelHandler初始化器会从ChannelPipeline中自动删除。

听起来很复杂，其实很简单，看下面代码：

[java] view plaincopy

1. package netty.in.action;
2.
3. import io.netty.bootstrap.ServerBootstrap;
4. import io.netty.channel.Channel;
5. import io.netty.channel.ChannelFuture;
6. import io.netty.channel.ChannelInitializer;
7. import io.netty.channel.EventLoopGroup;
8. import io.netty.channel.nio.NioEventLoopGroup;
9. import io.netty.channel.socket.nio.NioServerSocketChannel;
10.
import io.netty.handler.codec.http.HttpClientCodec;
11. import io.netty.handler.codec.http.HttpObjectAggregator;
12.

13. /**
14.
* 使用ChannelInitializer初始化ChannelHandler
15. * @author c.k
16.
*
17. */
18.
public class InitChannelExample {
19.
20.
public static void main(String[] args) throws Exception {
21. EventLoopGroup bossGroup = new NioEventLoopGroup(1);
22.
EventLoopGroup workerGroup = new NioEventLoopGroup();
23. ServerBootstrap b = new ServerBootstrap();
24.
b.group(bossGroup, workerGroup).channel(NioServerSocketChannel.class)
25. .childHandler(new ChannelInitializerImpl());
26.
ChannelFuture f = b.bind(2048).sync();
27. f.channel().closeFuture().sync();
28.
}
29.
30.
static final class ChannelInitializerImpl extends ChannelInitializer<Channel>{
31. @Override
32.
protected void initChannel(Channel ch) throws Exception {
33. ch.pipeline().addLast(new HttpClientCodec())
34.
.addLast(new HttpObjectAggregator(Integer.MAX_VALUE));
35. }
36.
}
37.
38.
}

9.6 使用通道选项和属性

比较麻烦的是创建通道后不得不手动配置每个通道，为了避免这种情况，Netty提供了ChannelOption来帮助引导配置。这些选项会自动应用到引导创建的所有通道，可用的各种选项可以配置底层连接的详细信息，如通道“keep-alive(保持活跃)”或“timeout(超时)”的特性。

Netty应用程序通常会与组织或公司其他的软件进行集成，在某些情况下，Netty的组件如通道、传递和Netty正常生命周期外使用；在这样的情况下并不是所有的一般属性和数据时可用的。这只是一个例子，但在这样的情况下，Netty提供了通道属性(channel
attributes)。

属性可以将数据和通道以一个安全的方式关联，这些属性只是作用于客户端和服务器的通道。例如，例如客户端请求web服务器应用程序，为了跟踪通道属于哪个用户，应用程序可以存储用的ID作为通道的一个属性。任何对象或数据都可以使用属性被关联到一个通道。

使用ChannelOption和属性可以让事情变得很简单，例如Netty WebSocket服务器根据用户自动路由消息，通过使用属性，应用程序能在通道存储用户ID以确定消息应该发送到哪里。应用程序可以通过使用一个通道选项进一步自动化，给定时间内没有收到消息将自动断开连接。看下面代码：

[java] view plaincopy

1. public static void main(String[] args) {
2. //创建属性键对象
3. final AttributeKey<Integer> id = AttributeKey.valueOf("ID");
4. //客户端引导对象
5. Bootstrap b = new Bootstrap();
6. //设置EventLoop，设置通道类型
7. b.group(new NioEventLoopGroup()).channel(NioSocketChannel.class)
8. //设置ChannelHandler
9. .handler(new SimpleChannelInboundHandler<ByteBuf>() {
10.
@Override
11. protected void channelRead0(ChannelHandlerContext ctx, ByteBuf msg)
12.
throws Exception {
13. System.out.println("Reveived data");
14.
msg.clear();
15. }
16.

17. @Override
18.
public void channelRegistered(ChannelHandlerContext ctx) throws Exception {
19. //通道注册后执行，获取属性值
20.
Integer idValue = ctx.channel().attr(id).get();
21. System.out.println(idValue);
22.
//do something with the idValue
23. }
24.
});
25. //设置通道选项，在通道注册后或被创建后设置
26.
b.option(ChannelOption.SO_KEEPALIVE, true).option(ChannelOption.CONNECT_TIMEOUT_MILLIS, 5000);
27. //设置通道属性
28.
b.attr(id, 123456);
29. ChannelFuture f = b.connect("www.manning.com",80);
30.
f.syncUninterruptibly();
31. }

前面都是引导基于TCP的SocketChannel，引导也可以用于无连接的传输协议如UDP，Netty提供了DatagramChannel，唯一的区别是不会connecte(...)，只能bind(...)。看下面代码：

[java] view plaincopy

1. public static void main(String[] args) {
2. Bootstrap b = new Bootstrap();
3. b.group(new OioEventLoopGroup()).channel(OioDatagramChannel.class)
4. .handler(new SimpleChannelInboundHandler<DatagramPacket>() {
5. @Override
6. protected void channelRead0(ChannelHandlerContext ctx, DatagramPacket msg)
7. throws Exception {
8. // do something with the packet
9. }
10.
});
11. ChannelFuture f = b.bind(new InetSocketAddress(0));
12.
f.addListener(new ChannelFutureListener() {
13. @Override
14.
public void operationComplete(ChannelFuture future) throws Exception {
15. if (future.isSuccess()) {
16.
System.out.println("Channel bound");
17. } else {
18.
System.err.println("Bound attempt failed");
19. future.cause().printStackTrace();
20.
}
21. }
22.
});
23. }

Netty有默认的配置设置，多数情况下，我们不需要改变这些配置，但是在需要时，我们可以细粒度的控制如何工作及处理数据。

9.7 Summary

In this chapter you learned howto bootstrap your Netty-based server and client implementation. You learned howyou can specify configuration options that affect the and how you can useattributes to attach information to
a channel and use it later. You alsolearned how to bootstrap connectionless protocol-based applications and howthey are different from connection-based ones. The next chapters will focus onNetty in Action by using it to implement real-world applications.
Thiswill help you extract all interesting pieces for reuse in your nextapplication. At this point you should be able to start coding!