文章目錄
- 簡介
- 聊天室的工作流程
- 文本處理器
- 初始化ChannelHandler
- 真正的消息處理邏輯
- 總結
經過之前的系列文章,我們已經知道了netty的運作原理,還介紹了基本的netty服務搭建流程和消息處理器的寫法。今天本文會給大家介紹一個更加複雜的例子,文本聊天室。
今天要介紹的是文本聊天室,對于文本聊天室來說,首先需要建立一個伺服器,用于處理各個用戶端的連接配接,對于用戶端來說,需要建立和伺服器的連接配接,然後向伺服器輸入聊天資訊。伺服器收到聊天資訊之後,會對消息進行響應,并将消息傳回至用戶端,這樣一個聊天室的流程就完成了。
之前的文章中,我們有提到過,netty的傳輸隻支援ByteBuf類型,對于聊天室直接輸入的字元串是不支援的,需要對字元串進行encode和decode轉換。
之前我們介紹的encode和decode的類叫做ObjectDecoder和ObjectEncoder。今天我們再介紹兩個專門處理字元串的StringDecoder和StringEncoder。
StringEncoder要比ObjectEncoder簡單很多,因為對于對象來說,我們還需要在Byte數組的頭部設定Byte數組的大小,進而保證對象所有資料讀取正确。對于String來說,就比較簡單了,隻需要保證一次讀入的資料都是字元串即可。
StringEncoder繼承自MessageToMessageEncoder,其核心的encode代碼如下:
protected void encode(ChannelHandlerContext ctx, CharSequence msg, List<Object> out) throws Exception {
if (msg.length() == 0) {
return;
}
out.add(ByteBufUtil.encodeString(ctx.alloc(), CharBuffer.wrap(msg), charset));
}
從上面的代碼可以看出,核心實際上是調用了ByteBufUtil.encodeString方法,将String轉換成了ByteBuf。
對于字元串編碼來說,還需要界定一個編碼的範圍,比如我們需要知道需要一次編碼多少字元串,一般來說我們通過回車符來界定一次字元串輸入的結束。
netty也提供了這樣的非常便利的類叫做DelimiterBasedFrameDecoder,通過傳入不同的Delimiter,我們可以将輸入拆分成不同的Frame,進而對一行字元串進行處理。
new DelimiterBasedFrameDecoder(8192, Delimiters.lineDelimiter()))
我再看一下StringDecoder的核心代碼,StringDecoder繼承自MessageToMessageDecoder:
protected void decode(ChannelHandlerContext ctx, ByteBuf msg, List<Object> out) throws Exception {
out.add(msg.toString(charset));
}
通過調用ByteBuf的toString方法,将BuyteBuf轉換成為字元串,并且輸出到channel中。
在initChannel的時候,我們需要向ChannelPipeline中添加有效的Handler。對于本例來說,需要添加StringDecoder、StringEncoder、DelimiterBasedFrameDecoder和真正處理消息的自定義handler。
我們将初始化Pipeline的操作都放在一個新的ChatServerInitializer類中,這個類繼承自ChannelInitializer,其核心的initChannel方法如下:
public void initChannel(SocketChannel ch) throws Exception {
ChannelPipeline pipeline = ch.pipeline();
// 添加行分割器
pipeline.addLast(new DelimiterBasedFrameDecoder(8192, Delimiters.lineDelimiter()));
// 添加String Decoder和String Encoder,用來進行字元串的轉換
pipeline.addLast(DECODER);
pipeline.addLast(ENCODER);
// 最後添加真正的處理器
pipeline.addLast(SERVER_HANDLER);
}
ChatServerInitializer在Bootstrap中的childHandler中進行添加:
childHandler(new ChatServerInitializer())
有了上面的邏輯之後,我們最後隻需要專注于真正的消息處理邏輯即可。
這裡我們的邏輯是當用戶端輸入“再見”的時候,就關閉channel,否則就将消息回寫給用戶端。
其核心邏輯如下:
public void channelRead0(ChannelHandlerContext ctx, String request) throws Exception {
// 如果讀取到"再見"就關閉channel
String response;
// 判斷是否關閉
boolean close = false;
if (request.isEmpty()) {
response = "你說啥?\r\n";
} else if ("再見".equalsIgnoreCase(request)) {
response = "再見,我的朋友!\r\n";
close = true;
} else {
response = "你是不是說: '" + request + "'?\r\n";
}
// 寫入消息
ChannelFuture future = ctx.write(response);
// 添加CLOSE listener,用來關閉channel
if (close) {
future.addListener(ChannelFutureListener.CLOSE);
}
}
通過判斷用戶端的出入,來設定是否關閉按鈕,這裡的關閉channel是通過向ChannelFuture中添加ChannelFutureListener.CLOSE來實作的。
ChannelFutureListener.CLOSE是一個ChannelFutureListener,它會在channel執行完畢之後關閉channel,事實上這是一個非常優雅的關閉方式。
ChannelFutureListener CLOSE = new ChannelFutureListener() {
@Override
public void operationComplete(ChannelFuture future) {
future.channel().close();
}
};
對于用戶端來說,其核心就是從指令行讀取輸入,這裡使用InputStreamReader接收指令行輸入,并使用BufferedReader對其緩存。
// 從指令行輸入
ChannelFuture lastWriteFuture = null;
BufferedReader in = new BufferedReader(new InputStreamReader(System.in));
for (;;) {
String line = in.readLine();
if (line == null) {
break;
}
// 将從指令行輸入的一行字元寫到channel中
lastWriteFuture = ch.writeAndFlush(line + "\r\n");
// 如果輸入'再見',則等待server端關閉channel
if ("再見".equalsIgnoreCase(line)) {
ch.closeFuture().sync();
break;
}
}
// 等待所有的消息都寫入channel中
if (lastWriteFuture != null) {
lastWriteFuture.sync();
}