Netty4学习笔记（2）-- Bootstrap

╰+攻爆jí腚メ 2022-06-03 09:58 235阅读 0赞

Netty4的代码比我想象的要复杂的多，不过Netty4很好的将这种复杂性隐藏了起来，暴露出来的，是一个相对容易使用的接口。Bootstrap就是Netty试图隐藏这种复杂性的一个例子。

## bootstrap包 ##

bootstrap包是Netty4代码里最简单的一个包，总共只有4个类：

![SouthEast][]

## Bootstrap继承结构 ##

AbstractBootstrap是抽象类，有两个具体的实现，Bootstrap和ServerBootstrap：

![SouthEast 1][]

## Bootstrap例子 ##

Netty4自带的例子里有一个EchoClient，看看它是如何使用Bootstrap启动一个客户端程序的：

\[java\] [view plain][] [copy][view plain]

1.  publicclass EchoClient \{ 
2.  
3.  privatefinal String host; 
4.  privatefinalint port; 
5.  privatefinalint firstMessageSize; 
6.  
7.  public EchoClient(String host, int port, int firstMessageSize) \{ 
8.  this.host = host; 
9.  this.port = port; 
10. this.firstMessageSize = firstMessageSize; 
11.  \} 
12. 
13. publicvoid run() throws Exception \{ 
14. // Configure the client.
15.  EventLoopGroup group = new NioEventLoopGroup(); 
16. try \{ 
17.  Bootstrap b = new Bootstrap(); 
18.  b.group(group) 
19.  .channel(NioSocketChannel.class) 
20.  .option(ChannelOption.TCP\_NODELAY, true) 
21.  .handler(new ChannelInitializer<SocketChannel>() \{ 
22. @Override
23. publicvoid initChannel(SocketChannel ch) throws Exception \{ 
24.  ch.pipeline().addLast( 
25. //new LoggingHandler(LogLevel.INFO),
26. new EchoClientHandler(firstMessageSize)); 
27.  \} 
28.  \}); 
29. 
30. // Start the client.
31.  ChannelFuture f = b.connect(host, port).sync(); 
32. 
33. // Wait until the connection is closed.
34.  f.channel().closeFuture().sync(); 
35.  \} finally \{ 
36. // Shut down the event loop to terminate all threads.
37.  group.shutdownGracefully(); 
38.  \} 
39.  \} 
40. 
41. publicstaticvoid main(String\[\] args) throws Exception \{ 
42. // ...
43.  \} 
44. \}

## Builder模式？ ##

看上面的例子，Bootstrap的使用很像[Builder模式][Builder]，Bootstrap就是Builder，EventLoopGroup、Channel和Handler等是各种Part。稍有不同的是，准备好各种Part后，并不是直接build出一个Product来，而是直接通过connect()方法使用这个Product。

## AbstractBootstrap ##

为了弄清楚Bootstrap如何工作，我们先从AbstractBootstrap入手：

\[java\] [view plain][] [copy][view plain]

1.  publicabstractclass AbstractBootstrap<B extends AbstractBootstrap<B, C>, C extends Channel> implements Cloneable \{ 
2.  
3.  privatevolatile EventLoopGroup group; 
4.  privatevolatile ChannelFactory<? extends C> channelFactory; 
5.  privatevolatile SocketAddress localAddress; 
6.  privatefinal Map<ChannelOption<?>, Object> options = new LinkedHashMap<ChannelOption<?>, Object>(); 
7.  privatefinal Map<AttributeKey<?>, Object> attrs = new LinkedHashMap<AttributeKey<?>, Object>(); 
8.  privatevolatile ChannelHandler handler; 
9.  // ...
10. \}

可以看到，AbstractBootstrap这个抽象Builder一共需要有6个Part，如下图所示：

![SouthEast 2][]

## 设置各个Part ##

AbstractBootstrap有一组方法用来设置各个Part，例如下面这些：

\[java\] [view plain][] [copy][view plain]

1.  public B group(EventLoopGroup group) 
2.  public B channel(Class<? extends C> channelClass) 
3.  public B channelFactory(ChannelFactory<? extends C> channelFactory) 
4.  public B localAddress(SocketAddress localAddress) 
5.  public <T> B option(ChannelOption<T> option, T value) 
6.  public <T> B attr(AttributeKey<T> key, T value) 
7.  public B handler(ChannelHandler handler)

还有一组对应方法获得各个Part，如下：

\[java\] [view plain][] [copy][view plain]

1.  final SocketAddress localAddress() 
2.  final ChannelFactory<? extends C> channelFactory() 
3.  final ChannelHandler handler() 
4.  publicfinal EventLoopGroup group() 
5.  final Map<ChannelOption<?>, Object> options() 
6.  final Map<AttributeKey<?>, Object> attrs()

## ChannelFactory ##

AbstractBootstrap通过ChannelFactory创建Channel实例，channel(channelClass)方法看起来好像是设置了一个Channel，但实际上只是设置了默认的ChannelFactory实现：

\[java\] [view plain][] [copy][view plain]

1.  public B channel(Class<? extends C> channelClass) \{ 
2.  if (channelClass == null) \{ 
3.  thrownew NullPointerException("channelClass"); 
4.   \} 
5.  return channelFactory(new BootstrapChannelFactory<C>(channelClass)); 
6.  \}

默认的ChannelFactory实现使用反射创建Channel实例：

\[java\] [view plain][] [copy][view plain]

1.  privatestaticfinalclass BootstrapChannelFactory<T extends Channel> implements ChannelFactory<T> \{ 
2.  privatefinal Class<? extends T> clazz; 
3.  
4.   BootstrapChannelFactory(Class<? extends T> clazz) \{ 
5.  this.clazz = clazz; 
6.   \} 
7.  
8.  @Override
9.  public T newChannel() \{ 
10. try \{ 
11. return clazz.newInstance(); 
12.  \} catch (Throwable t) \{ 
13. thrownew ChannelException("Unable to create Channel from class " \+ clazz, t); 
14.  \} 
15.  \} 
16. \}

## Bootstrap.connect() ##

再来看Bootstrap类的connect()方法：

\[java\] [view plain][] [copy][view plain]

1.  public ChannelFuture connect(SocketAddress remoteAddress, SocketAddress localAddress) \{ 
2.  if (remoteAddress == null) \{ 
3.  thrownew NullPointerException("remoteAddress"); 
4.   \} 
5.   validate(); 
6.  return doConnect(remoteAddress, localAddress); 
7.  \}

connect()方法调用validate()方法看各个Part是否准备就绪，然后调用doConnect()方法：

\[java\] [view plain][] [copy][view plain]

1.  private ChannelFuture doConnect(final SocketAddress remoteAddress, final SocketAddress localAddress) \{ 
2.  final ChannelFuture regFuture = initAndRegister(); 
3.  final Channel channel = regFuture.channel(); 
4.  if (regFuture.cause() != null) \{ 
5.  return regFuture; 
6.   \} 
7.  
8.  final ChannelPromise promise = channel.newPromise(); 
9.  if (regFuture.isDone()) \{ 
10.  doConnect0(regFuture, channel, remoteAddress, localAddress, promise); 
11.  \} else \{ 
12.  regFuture.addListener(new ChannelFutureListener() \{ 
13. @Override
14. publicvoid operationComplete(ChannelFuture future) throws Exception \{ 
15.  doConnect0(regFuture, channel, remoteAddress, localAddress, promise); 
16.  \} 
17.  \}); 
18.  \} 
19. 
20. return promise; 
21. \}

doConnect()方法首先调用了initAndRegister()方法，然后又调用了doConnect0()方法，方法调用示意图如下：

![SouthEast 3][]

## AbstractBootstrap.initAndRegister() ##

\[java\] [view plain][] [copy][view plain]

1.  final ChannelFuture initAndRegister() \{ 
2.  final Channel channel = channelFactory().newChannel(); 
3.  try \{ 
4.   init(channel); 
5.   \} catch (Throwable t) \{ 
6.   channel.unsafe().closeForcibly(); 
7.  return channel.newFailedFuture(t); 
8.   \} 
9.  
10.  ChannelPromise regPromise = channel.newPromise(); 
11.  group().register(channel, regPromise); 
12. // ...
13. \}

initAndRegister()方法用ChannelFactory创建了一个Channel的实例，然后调用init()方法初始化Channel，最后将Channel注册到EventLoopGroup上：

![SouthEast 4][]

而Channel在实例化的时候已经自动关联了Pipeline，这点从AbstractChannel的构造函数可以看出：

\[java\] [view plain][] [copy][view plain]

1.  protected AbstractChannel(Channel parent) \{ 
2.  this.parent = parent; 
3.   unsafe = newUnsafe(); 
4.   pipeline = new DefaultChannelPipeline(this); 
5.  \}

![SouthEast 5][]

## Bootstrap.init()方法 ##

\[java\] [view plain][] [copy][view plain]

1.  void init(Channel channel) throws Exception \{ 
2.   ChannelPipeline p = channel.pipeline(); 
3.   p.addLast(handler()); 
4.  // ...
5.  \}

Bootstrap.init()方法把Handler添加到了Pipeline的末尾，到这里，Channel就准备就绪了：

![SouthEast 6][]

##  ##

继续Bootstrap.doConnect()

initAndRegister()方法结束之后，doConnect()方法紧接着调用了doConnect0()方法，doConnect0()方法继而调用了Channel.connect()方法，这样Channel就接通服务器，可以收发消息了！

![SouthEast 7][]

[SouthEast]: /images/20220603/c5a7534feda940ce8841226b06e7b43e.png
[SouthEast 1]: /images/20220603/c62bed90c6b24f779b8c65900e667781.png
[view plain]: http://blog.csdn.net/zxhoo/article/details/17419229#
[Builder]: http://en.wikipedia.org/wiki/Builder_pattern
[SouthEast 2]: /images/20220603/2bdb35d97acd4c858ab8bf24ce36a6a6.png
[SouthEast 3]: /images/20220603/82da4d1c01d6416a917989c11f0ac886.png
[SouthEast 4]: /images/20220603/4c5436954fd34c4791ccc8d9b8c6821a.png
[SouthEast 5]: /images/20220603/59d39ddadda841edb314622df79412da.png
[SouthEast 6]: /images/20220603/99a889b863ee4820b33f2a9f13c09321.png
[SouthEast 7]: /images/20220603/8ee21e58b5114145a2ed650be9d2e131.png

发表评论取消回复

表情：

评论列表（有 0 条评论，235人围观）

还没有评论，来说两句吧...

相关阅读

相关 Netty学习笔记

netty学习笔记 1.BIO NIO 和AIO 1.1 BIO 1.2 NIO 1.BIO NIO 和AIO 1.1 BIO

一时失言乱红尘/ 2023年10月10日 13:12/ 0 赞/ 37 阅读

相关 netty学习笔记

文章目录一、I/O模型 1、Java BIO编程 1.1 java BIO工作机制 1.2 java BIO

超、凢脫俗/ 2022年12月16日 06:52/ 0 赞/ 196 阅读

相关学习笔记（4.2）

进度：用pycharm测试代码遇到问题：在spyder可以运行的程序到pycharm就运行不了学习内容：上诉问题报错SyntaxError: EOL whi

喜欢ヅ旅行/ 2022年10月01日 07:52/ 0 赞/ 173 阅读

相关 netty学习笔记

Netty与原生Nio的区别原生的nio，只简单封闭了ByteBuffer以及Channel，也就是网络IO操作以及对这些字节的缓存，字节的编码与解码、粘包与拆包

野性酷女/ 2022年06月18日 10:16/ 0 赞/ 312 阅读

相关 Netty4学习笔记（2）-- Bootstrap

Netty4的代码比我想象的要复杂的多，不过Netty4很好的将这种复杂性隐藏了起来，暴露出来的，是一个相对容易使用的接口。Bootstrap就是Netty试图隐藏这种复杂性的

╰+攻爆jí腚メ/ 2022年06月03日 09:58/ 0 赞/ 236 阅读

相关 Netty4学习笔记（1）-- ChannelPipeline

Netty4 [Netty][]是一个和[MINA][]类似的Java NIO框架，目前的最新版本是[4.0.13][]，这两个框架的主要作者好像都是[同一个韩国人][L

青旅半醒/ 2022年06月03日 09:57/ 0 赞/ 231 阅读

相关 bootstrap学习笔记

1. 学习网站：https://v3.bootcss.com/ 2. <meta charset="utf-8">

迈不过友情╰/ 2022年05月26日 06:23/ 0 赞/ 237 阅读

相关 bootstrap 学习笔记

一、Bootstrap CSS 　　1、[Bootstrap 网格系统][Bootstrap] 　　2、[Bootstrap 排版][Bootstrap 1] 　　3、[

秒速五厘米/ 2022年04月22日 02:06/ 0 赞/ 268 阅读

相关 Netty笔记（八） Bootstrap

[为什么80%的码农都做不了架构师？>>> ][80_] ![hot3.png][] Netty提供了应用启动的配置跟启动API，服务端：ServerBootsta

ゝ一纸荒年。/ 2022年01月17日 07:35/ 0 赞/ 529 阅读

相关 Netty学习笔记

1.3、Netty核心组件 Channel；回调； Future；事件和ChannelHandler 1.3.1 Channel 1.3.2 回调 1.3.3 ...

红太狼/ 2021年05月02日 14:44/ 0 赞/ 607 阅读