Netty4.x中文教程系列(二) Hello World !
在中國程序界。我們都是學著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 @Override9 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.服務端控制臺截圖
轉載于:https://www.cnblogs.com/austinspark-jessylu/p/7813892.html
總結
以上是生活随笔為你收集整理的Netty4.x中文教程系列(二) Hello World !的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 已婚女人梦到好多蛇是什么意思
- 下一篇: iostat -x命令诊断