Fork me on GitHub
余鸢

Netty之构建一个完整的的Netty客户端（二）

发表于 | 分类于

连接Netty之构建一个完整的的Netty服务器（一）

写一个 echo 客户端

客户端要做的是：

  • 连接服务器
  • 发送信息
  • 发送的每个信息，等待和接收从服务器返回的同样的信息
  • 关闭连接

用 ChannelHandler 实现客户端逻辑

跟写服务器一样，我们提供 ChannelInboundHandler 来处理数据。下面例子，我们用
SimpleChannelInboundHandler 来处理所有的任务，需要覆盖三个方法：

  • channelActive() - 服务器的连接被建立后调用
  • channelRead0() - 数据后从服务器接收到调用
  • exceptionCaught() - 捕获一个异常时调用

2.3 ChannelHandler for the client

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
@Sharable //1
public class EchoClientHandler extends SimpleChannelInboundHandler<ByteBuf> {
  
  @Override
  public void channelActive(ChannelHandlerContext ctx) {
  	ctx.writeAndFlush(Unpooled.copiedBuffer("Netty rocks!", CharsetUtil.UTF_8)); //2
  } 
  
  @Override
  public void channelRead0(ChannelHandlerContext ctx, ByteBuf in) {
  	System.out.println("Client received: " + in.toString(CharsetUtil.UTF_8)); //3
  } 
  
  @Override
  public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) { //4
    cause.printStackTrace();
    ctx.close();
  }
}
  1. @Sharable 标记这个类的实例可以在 channel 里共享
  2. 当被通知该 channel 是活动的时候就发送信息
  3. 记录接收到的消息
  4. 记录日志错误并关闭 channel

建立连接后该 channelActive() 方法被调用一次。逻辑很简单：一旦建立了连接，字节序列被发送到服务器。该消息的内容并不重要;在这里，我们使用了 Netty 编码字符串 “Netty rocks!”通过覆盖这种方法，我们确保东西被尽快写入到服务器。

接下来，我们覆盖方法 channelRead0()。这种方法会在接收到数据时被调用。注意，由服务器所发送的消息可以以块的形式被接收。即，当服务器发送 5 个字节是不是保证所有的 5 个字节会立刻收到 - 即使是只有 5 个字节，channelRead0() 方法可被调用两次，第一次用一个ByteBuf（ Netty的字节容器） 装载3个字节和第二次一个 ByteBuf 装载 2 个字节。唯一要保证的是，该字节将按照它们发送的顺序分别被接收。 （ 注意，这是真实的，只有面向流的协议如TCP） 。

第三个方法重写是 exceptionCaught()。正如在 EchoServerHandler （ 例子2.1） ，所述的记录 Throwable 并且关闭通道，在这种情况下终止 连接到服务器。

SimpleChannelInboundHandler vs. ChannelInboundHandler

何时用这两个要看具体业务的需要。在客户端，当channelRead0() 完成，我们已经拿到的入站的信息。当方法返回时，SimpleChannelInboundHandler会小心的释放对ByteBuf（ 保存信息） 的引用。而在EchoServerHandler,我们需要将入站的信息返回给发送者，由于write()是异步的，在channelRead()返回时，可能还没有完成。所以，我们使用ChannelInboundHandlerAdapter,无需释放信息。最后在channelReadComplete()我们调用ctxWriteAndFlush()来释放信息。

引导客户端

客户端引导需要 host 、port 两个参数连接服务器。

2.4 Main class for the client

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
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(); //1
      b.group(group) //2
      .channel(NioSocketChannel.class) //3
      .remoteAddress(new InetSocketAddress(host, port)) //4
      .handler(new ChannelInitializer<SocketChannel>() { //5
        @Override
        public void initChannel(SocketChannel ch)throws Exception {
        	ch.pipeline().addLast(new EchoClientHandler());
        }
      });
      ChannelFuture f = b.connect().sync(); //6
      f.channel().closeFuture().sync(); //7
    } finally {
      group.shutdownGracefully().sync(); //8
    }
  } 
  
  public static void main(String[] args) throws Exception {
    if (args.length != 2) {
      System.err.println("Usage: " + EchoClient.class.getSimpleName() + " <host> <port>");
      return;
    } 
    final String host = args[0];
    final int port = Integer.parseInt(args[1]);
    new EchoClient(host, port).start();
  }
}

1.创建 Bootstrap

2.指定 EventLoopGroup 来处理客户端事件。由于我们使用 NIO 传输，所以用到了NioEventLoopGroup 的实现

3.使用的 channel 类型是一个用于 NIO 传输

4.设置服务器的 InetSocketAddress

5.当建立一个连接和一个新的通道时，创建添加到 EchoClientHandler 实例 到 channelpipeline

6.连接到远程;等待连接完成

7.阻塞直到 Channel 关闭

8.调用 shutdownGracefully() 来关闭线程池和释放所有资源

与以前一样，在这里使用了 NIO 传输。请注意，您可以在 客户端和服务器 使用不同的传输，例如 NIO 在服务器端和 OIO 客户端。在第四章中，我们将研究一些具体的因素和情况，这将导致你可以选择一种传输，而不是另一种。

让我们回顾一下我们在本节所介绍的要点

  • 一个 Bootstrap 被创建来初始化客户端
  • 一个 NioEventLoopGroup 实例被分配给处理该事件的处理，这包括创建新的连接和处理入站和出站数据
  • 一个 InetSocketAddress 为连接到服务器而创建
  • 一个 EchoClientHandler 将被安装在 pipeline 当连接完成时
  • 之后 Bootstrap.connect()被调用连接到远程的 - 本例就是 echo(回声)服务器。

编译和运行 Echo 服务器和客户端

编译

本例涉及到多模块 Maven项目的组织，在例子chapter2目录下，执行

1
mvn clean package

输出如下

2.5 Build Output

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
chapter2>mvn clean package
[INFO] Scanning for projects...
[INFO] --------------------------------------------------------------------
[INFO] Reactor Build Order:
[INFO]
[INFO] Echo Client and Server
[INFO] Echo Client
[INFO] Echo Server
[INFO]
[INFO] --------------------------------------------------------------------
[INFO] Building Echo Client and Server 1.0-SNAPSHOT
[INFO] --------------------------------------------------------------------
[INFO]
[INFO] --- maven-clean-plugin:2.5:clean (default-clean) @ echo-parent ---
[INFO]
[INFO] --------------------------------------------------------------------
[INFO] Building Echo Client 1.0-SNAPSHOT
[INFO] --------------------------------------------------------------------
[INFO]
[INFO] --- maven-clean-plugin:2.5:clean (default-clean) @ echo-client ---
[INFO]
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile)
@ echo-client ---
[INFO] Changes detected - recompiling the module!
[INFO] --------------------------------------------------------------------
[INFO] Reactor Summary:
[INFO]
[INFO] Echo Client and Server ......................... SUCCESS [ 0.118 s]
[INFO] Echo Client .................................... SUCCESS [ 1.219 s]
[INFO] Echo Server .................................... SUCCESS [ 0.110 s]
[INFO] --------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] --------------------------------------------------------------------
[INFO] Total time: 1.561 s
[INFO] Finished at: 2014-06-08T17:39:15-05:00
[INFO] Final Memory: 14M/245M
[INFO] --------------------------------------------------------------------

注意事项：

  • Maven Reactor 构建顺序：先是 父 POM，然后是子项目
  • Netty artifact 没在用户的本地存储库中找到，所以 Maven 就会从互联网上下载
  • clean 和 compile 在构建生命周期的运行。事后 mavensurefire-plugin 插件运行，但不会
  • 有测试类存在。最后 mavenjar-plugin 执行

这段说明了项目已经成功编译。

运行 Echo 服务器 和 客户端

我们使用 exec-maven-plugin 来运行项目。
在 chapter2/Server 目录，执行

1
mvn exec:java

输出如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
[INFO] Scanning for projects...
[INFO]
[INFO] --------------------------------------------------------------------
[INFO] Building Echo Server 1.0-SNAPSHOT
[INFO] --------------------------------------------------------------------
[INFO]
[INFO] >>> exec-maven-plugin:1.2.1:java (default-cli) @ echo-server >>>
[INFO]
[INFO] <<< exec-maven-plugin:1.2.1:java (default-cli) @ echo-server <<<
[INFO]
[INFO] --- exec-maven-plugin:1.2.1:java (default-cli) @ echo-server ---
nettyinaction.echo.EchoServer started and listening for connections on
/0:0:0:0:0:0:0:0:9999

在 chapter2/Client 目录，执行

1
mvn exec:java

输出如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
[INFO] Scanning for projects...
[INFO]
[INFO] --------------------------------------------------------------------
[INFO] Building Echo Client 1.0-SNAPSHOT
[INFO] --------------------------------------------------------------------
[INFO]
[INFO] >>> exec-maven-plugin:1.2.1:java (default-cli) @ echo-client >>>
[INFO]
[INFO] <<< exec-maven-plugin:1.2.1:java (default-cli) @ echo-client <<<
[INFO]
[INFO] --- exec-maven-plugin:1.2.1:java (default-cli) @ echo-client ---
Client received: Netty rocks!
[INFO] --------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] --------------------------------------------------------------------
[INFO] Total time: 3.907 s
[INFO] Finished at: 2014-06-08T18:26:14-05:00
[INFO] Final Memory: 8M/245M
[INFO] --------------------------------------------------------------------

在服务器的控制台输出：

1
Server received: Netty rocks!

发生了什么事：

  • 客户端连接后，它发送消息：“Netty rocks！”
  • 服务器输出接收到消息并将其返回给客户端
  • 客户输出接收到的消息并退出。

每次运行客户端，你会看到在服务器的控制台输出：

1
Server received: Netty rocks!

现在，我们看下错误的情况。在控制台 输入 Ctrl-C 来关闭服务器。而后运行客户端，此时输出如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
[INFO] Scanning for projects...
[INFO]
[INFO] --------------------------------------------------------------------
[INFO] Building Echo Client 1.0-SNAPSHOT
[INFO] --------------------------------------------------------------------
[INFO]
[INFO] >>> exec-maven-plugin:1.2.1:java (default-cli) @ echo-client >>>
[INFO]
[INFO] <<< exec-maven-plugin:1.2.1:java (default-cli) @ echo-client <<<
[INFO]
[INFO] --- exec-maven-plugin:1.2.1:java (default-cli) @ echo-client ---
[WARNING]
java.lang.reflect.InvocationTargetException
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke
(NativeMethodAccessorImpl.java:57)
at sun.reflect.DelegatingMethodAccessorImpl.invoke
(DelegatingMethodAccessorImpl.java:43)
at java.lang.reflect.Method.invoke(Method.java:606)
at org.codehaus.mojo.exec.ExecJavaMojo$1.run(ExecJavaMojo.java:297)
at java.lang.Thread.run(Thread.java:744)
Caused by: java.net.ConnectException: Connection refused:
no further information: localhost/127.0.0.1:9999
at sun.nio.ch.SocketChannelImpl.checkConnect(Native Method)
at sun.nio.ch.SocketChannelImpl.finishConnect
(SocketChannelImpl.java:739)
at io.netty.channel.socket.nio.NioSocketChannel
.doFinishConnect(NioSocketChannel.java:191)
at io.netty.channel.nio.
AbstractNioChannel$AbstractNioUnsafe.finishConnect(
AbstractNioChannel.java:279)
at io.netty.channel.nio.NioEventLoop
.processSelectedKey(NioEventLoop.java:511)
at io.netty.channel.nio.NioEventLoop
.processSelectedKeysOptimized(NioEventLoop.java:461)
at io.netty.channel.nio.NioEventLoop
.processSelectedKeys(NioEventLoop.java:378)
at io.netty.channel.nio.NioEventLoop.run(NioEventLoop.java:350)
at io.netty.util.concurrent
.SingleThreadEventExecutor$2.run
(SingleThreadEventExecutor.java:101)
... 1 more
[INFO] --------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] --------------------------------------------------------------------
[INFO] Total time: 3.728 s
[INFO] Finished at: 2014-06-08T18:49:13-05:00
[INFO] Final Memory: 8M/245M
[INFO] --------------------------------------------------------------------
[ERROR] Failed to execute goal org.codehaus.mojo:exec-maven-plugin:1.2.1:java
(default-cli) on project echo-client: An exception occured while executing the
Java class. null: InvocationTargetException: Connection refused: no further
information:
localhost/127.0.0.1:9999 -> [Help 1]

发生了啥？客户端尝试连接服务器，但服务器是关闭的，所以引发了一个java.net.ConnectException ，这个异常被 EchoClientHandler 的 exceptionCaught() 触发，打印出异常信息，并关闭 channel