在中國程式界。我們都是學著Hello World !慢慢成長起來的。逐漸從一無所知到熟悉精通的。
第二章就從Hello World 開始講述Netty的中文教程。
首先建立一個Java專案。引入一個Netty 框架的包。這個步驟我在本系列教程的後面就不在重複了。
先上一張我示例的專案工程圖給大家看一下:
1.下載併為專案新增Netty框架
Netty的包大家可以從Netty官網:http://netty.io/downloads.html 下載
如圖所示: Netty提供了三個主要版本的框架包給大家下載。
3.9版本Final 說明這個版本是3.x版本中最新的版本。final意味著功能不再繼續新增更新。僅為修改bug等提供繼續的更新。
5.x版本由於是開始。不能排除是否穩定執行等問題。加上5.x在4.x的版本上略微修改的。在5.x穩定之前。不推薦大家學習使用。
本教程是基於Netty4.x版本的。
筆者也是從3.6版本，經過了相當痛苦的一段時間才算是真正的過度到4.x版本。
下載之後解壓縮。大家可以看到這樣一個目錄結構。非常的清晰。
第一個資料夾jar是jar包的資料夾。第二個javadoc是API文件。第三個license資料夾是開源的授權檔案(可以直接無視)。
javadoc資料夾下面是一個jar包。可以直接解壓縮出來。解壓縮之後的資料夾就是api文件(以網頁的形勢展現)。
jar資料夾裡面有很多的jar包和一個all-in-one資料夾。都是Netty框架的組成部分。all-in-one裡面有兩個檔案一個是jar包，另一個是對應的source原始碼包。這樣做的目的是為了給程式設計師有選擇的新增自己所需要的包。
假如讀者是初學者的話。推薦直接套用all-in-one裡面的jar包。假如你熟悉Netty的話可以根據自己的專案需求新增不同的jar包。
2.建立Server 服務端
Netty建立全部都是實現自AbstractBootstrap。客戶端的是Bootstrap，服務端的則是ServerBootstrap。
2.1建立一個 HelloServer
package org.example.hello;
import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.ChannelFuture;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.nio.NioServerSocketChannel;
public class HelloServer {
/**
* 服務端監聽的埠地址
*/
private static final int portNumber = 7878;
public static void main(String[] args) throws InterruptedException {
EventLoopGroup bossGroup = new NioEventLoopGroup();
EventLoopGroup workerGroup = new NioEventLoopGroup();
try {
ServerBootstrap b = new ServerBootstrap();
b.group(bossGroup, workerGroup);
b.channel(NioServerSocketChannel.class);
b.childHandler(new HelloServerInitializer());
// 伺服器繫結埠監聽
ChannelFuture f = b.bind(portNumber).sync();
// 監聽伺服器關閉監聽
f.channel().closeFuture().sync();
// 可以簡寫為
/* b.bind(portNumber).sync().channel().closeFuture().sync(); */
} finally {
bossGroup.shutdownGracefully();
workerGroup.shutdownGracefully();
}
}
}
EventLoopGroup 是在4.x版本中提出來的一個新概念。用於channel的管理。服務端需要兩個。和3.x版本一樣，一個是boss執行緒一個是worker執行緒。
b.childHandler(new HelloServerInitializer()); //用於新增相關的Handler
服務端簡單的程式碼，真的沒有辦法在精簡了感覺。就是一個繫結埠操作。
2.2建立和實現HelloServerInitializer
在HelloServer中的HelloServerInitializer在這裡實現。
首先我們需要明確我們到底是要做什麼的。很簡單。HelloWorld!。我們希望實現一個能夠像服務端傳送文字的功能。服務端假如可以最好還能返回點訊息給客戶端，然客戶端去顯示。
需求簡單。那我們下面就準備開始實現。
DelimiterBasedFrameDecoder Netty在官方網站上提供的示例顯示 有這麼一個解碼器可以簡單的訊息分割。
其次 在decoder裡面我們找到了String解碼編碼器。著都是官網提供給我們的。
1 package org.example.hello;
2
3 import io.netty.channel.ChannelInitializer;
4 import io.netty.channel.ChannelPipeline;
5 import io.netty.channel.socket.SocketChannel;
6 import io.netty.handler.codec.DelimiterBasedFrameDecoder;
7 import io.netty.handler.codec.Delimiters;
8 import io.netty.handler.codec.string.StringDecoder;
9 import io.netty.handler.codec.string.StringEncoder;
10
11 public class HelloServerInitializer extends ChannelInitializer<SocketChannel> {
12
13 @Override
14 protected void initChannel(SocketChannel ch) throws Exception {
15 ChannelPipeline pipeline = ch.pipeline();
16
17 // 以("\n")為結尾分割的 解碼器
18 pipeline.addLast("framer", new DelimiterBasedFrameDecoder(8192, Delimiters.lineDelimiter()));
19
20 // 字串解碼 和 編碼
21 pipeline.addLast("decoder", new StringDecoder());
22 pipeline.addLast("encoder", new StringEncoder());
23
24 // 自己的邏輯Handler
25 pipeline.addLast("handler", new HelloServerHandler());
26 }
27 }
上面的三個解碼和編碼都是系統。
另外我們自己的Handler怎麼辦呢。在最後我們新增一個自己的Handler用於寫自己的處理邏輯。
2.3 增加自己的邏輯HelloServerHandler
自己的Handler我們這裡先去繼承extends官網推薦的SimpleChannelInboundHandler<C> 。在這裡C，由於我們需求裡面傳送的是字串。這裡的C改寫為String。
1 package org.example.hello;
2
3 import java.net.InetAddress;
4
5 import io.netty.channel.ChannelHandlerContext;
6 import io.netty.channel.SimpleChannelInboundHandler;
7
8 public class HelloServerHandler extends SimpleChannelInboundHandler<String> {
9
10 @Override
11 protected void channelRead0(ChannelHandlerContext ctx, String msg) throws Exception {
12 // 收到訊息直接列印輸出
13 System.out.println(ctx.channel().remoteAddress() + " Say : " + msg);
14
15 // 返回客戶端訊息 - 我已經接收到了你的訊息
16 ctx.writeAndFlush("Received your message !\n");
17 }
18
19 /*
20 *
21 * 覆蓋 channelActive 方法 在channel被啟用的時候觸發 (在建立連線的時候)
22 *
23 * channelActive 和 channelInActive 在後面的內容中講述，這裡先不做詳細的描述
24 * */
25 @Override
26 public void channelActive(ChannelHandlerContext ctx) throws Exception {
27
28 System.out.println("RamoteAddress : " + ctx.channel().remoteAddress() + " active !");
29
30 ctx.writeAndFlush( "Welcome to " + InetAddress.getLocalHost().getHostName() + " service!\n");
31
32 super.channelActive(ctx);
33 }
34 }
在channelHandlerContent自帶一個writeAndFlush方法。方法的作用是寫入Buffer並刷入。
注意:在3.x版本中此處有很大區別。在3.x版本中write()方法是自動flush的。在4.x版本的前面幾個版本也是一樣的。但是在4.0.9之後修改為WriteAndFlush。普通的write方法將不會傳送訊息。需要手動在write之後flush()一次
這裡channeActive的意思是當連線活躍(建立)的時候觸發.輸出訊息源的遠端地址。並返回歡迎訊息。
channelRead0 在這裡的作用是類似於3.x版本的messageReceived()。可以當做是每一次收到訊息是觸發。
我們在這裡的程式碼是返回客戶端一個字串"Received your message !".
注意:字串最後面的"\n"是必須的。因為我們在前面的解碼器DelimiterBasedFrameDecoder是一個根據字串結尾為“\n”來結尾的。假如沒有這個字元的話。解碼會出現問題。
2.Client客戶端
類似於服務端的程式碼。我們不做特別詳細的解釋。
直接上示例程式碼:
1 package org.example.hello;
2
3 import io.netty.bootstrap.Bootstrap;
4 import io.netty.channel.Channel;
5 import io.netty.channel.EventLoopGroup;
6 import io.netty.channel.nio.NioEventLoopGroup;
7 import io.netty.channel.socket.nio.NioSocketChannel;
8
9 import java.io.BufferedReader;
10 import java.io.IOException;
11 import java.io.InputStreamReader;
12
13 public class HelloClient {
14
15 public static String host = "127.0.0.1";
16 public static int port = 7878;
17
18 /**
19 * @param args
20 * @throws InterruptedException
21 * @throws IOException
22 */
23 public static void main(String[] args) throws InterruptedException, IOException {
24 EventLoopGroup group = new NioEventLoopGroup();
25 try {
26 Bootstrap b = new Bootstrap();
27 b.group(group)
28 .channel(NioSocketChannel.class)
29 .handler(new HelloClientInitializer());
30
31 // 連線服務端
32 Channel ch = b.connect(host, port).sync().channel();
33
34 // 控制檯輸入
35 BufferedReader in = new BufferedReader(new InputStreamReader(System.in));
36 for (;;) {
37 String line = in.readLine();
38 if (line == null) {
39 continue;
40 }
41 /*
42 * 向服務端傳送在控制檯輸入的文字 並用"\r\n"結尾
43 * 之所以用\r\n結尾 是因為我們在handler中新增了 DelimiterBasedFrameDecoder 幀解碼。
44 * 這個解碼器是一個根據\n符號位分隔符的解碼器。所以每條訊息的最後必須加上\n否則無法識別和解碼
45 * */
46 ch.writeAndFlush(line + "\r\n");
47 }
48 } finally {
49 // The connection is closed automatically on shutdown.
50 group.shutdownGracefully();
51 }
52 }
53 }
下面的是HelloClientInitializer程式碼貌似是和服務端的完全一樣。我沒注意看。其實編碼和解碼是相對的。多以服務端和客戶端都是解碼和編碼。才能通訊。
1 package org.example.hello;
2
3 import io.netty.channel.ChannelInitializer;
4 import io.netty.channel.ChannelPipeline;
5 import io.netty.channel.socket.SocketChannel;
6 import io.netty.handler.codec.DelimiterBasedFrameDecoder;
7 import io.netty.handler.codec.Delimiters;
8 import io.netty.handler.codec.string.StringDecoder;
9 import io.netty.handler.codec.string.StringEncoder;
10
11 public class HelloClientInitializer extends ChannelInitializer<SocketChannel> {
12
13 @Override
14 protected void initChannel(SocketChannel ch) throws Exception {
15 ChannelPipeline pipeline = ch.pipeline();
16
17 /*
18 * 這個地方的 必須和服務端對應上。否則無法正常解碼和編碼
19 *
20 * 解碼和編碼 我將會在下一張為大家詳細的講解。再次暫時不做詳細的描述
21 *
22 * */
23 pipeline.addLast("framer", new DelimiterBasedFrameDecoder(8192, Delimiters.lineDelimiter()));
24 pipeline.addLast("decoder", new StringDecoder());
25 pipeline.addLast("encoder", new StringEncoder());
26
27 // 客戶端的邏輯
28 pipeline.addLast("handler", new HelloClientHandler());
29 }
30 }
HellClientHandler：
1 package org.example.hello;
2
3 import io.netty.channel.ChannelHandlerContext;
4 import io.netty.channel.SimpleChannelInboundHandler;
5
6 public class HelloClientHandler extends SimpleChannelInboundHandler<String> {
7
8 @Override
9 protected void channelRead0(ChannelHandlerContext ctx, String msg) throws Exception {
10
11 System.out.println("Server say : " + msg);
12 }
13
14 @Override
15 public void channelActive(ChannelHandlerContext ctx) throws Exception {
16 System.out.println("Client active ");
17 super.channelActive(ctx);
18 }
19
20 @Override
21 public void channelInactive(ChannelHandlerContext ctx) throws Exception {
22 System.out.println("Client close ");
23 super.channelInactive(ctx);
24 }
25 }
下面上幾張成果圖:
客戶端在連線建立是輸出了Client active 資訊，並收到服務端返回的Welcome訊息。
輸入Hello World ! 回車傳送訊息。服務端響應返回訊息已接受。
1.客戶端控制檯截圖
2.服務端控制檯截圖