Netty 核心概念介紹和簡單示例

Netty是一個異步的，事件驅動的網絡框架，我們可以使用它來開發高性能客戶端和服務器。在本文中，我將解釋一些基本的netty概念，以便當我們開始使用netty框架來構建我們自己的Http Web服務器和客戶端時，很容易理解Netty術語。

核心概念

Channel

Channel是Java NIO的基礎。它表示一個開放的連接，能夠執行IO操作，例如讀取和寫入。

Channel向開發人員提供以下內容：

通道的當前狀態（例如，是否打開？是否已連接？）
通道的配置參數（例如，接收緩衝區大小）
通道支持的I / O操作（例如，讀取，寫入，連接和綁定）
在ChannelPipeline處理與通道相關聯的所有I / O事件和請求。

ChannelFuture

Netty的操作是異步的：即他們不保證完成就立即返回。此時最合乎邏輯的問題是：“ 如何確保在此任務完成之後而不是之前完成某些任務？爲了做到這一點，Netty中的所有異步方法都返回一個ChannelFuture實例。此類具有在完成時通過管道傳遞其他任務的方法，以確保任務以非阻塞方式一個接一個地執行。

ChannelFutureListener

在ChannelFuture接口中，其addListener()方法註冊了一個ChannelFuturerListener，以便在某個操作完成時（無論是否成功）得到通知。

ChannelPipeline

Netty使用管道來處理通過管道的數據。

Netty管道的工作方式都是相同的。管道中的每個類執行一個獨立的任務。當請求/響應通過管道時，每個處理程序執行一個獨立的任務，並將請求/響應傳遞到隊列中的下一個處理程序。

Netty Handlers

Netty中有兩種主要類型的處理程序，分別是Channel Inbound Handlers和Channel Outbound Handlers。

入站處理程序用於處理入站流量，即從套接字通道到應用程序。同樣，出站處理程序處理出站流量，即從應用程序到套接字通道。

從套接字讀取數據是入站事件，將數據寫入套接字是出站事件。因此，在netty中，處理程序會響應這些入站和出站事件而執行，我們可以在這些處理程序中定義數據處理邏輯。

Encoders and Decoders

在使用網絡協議時，我們需要執行數據序列化和反序列化。爲此，Netty 爲能夠解碼傳入的數據引入瞭解碼器。大多數解碼器的基類是ByteToMessageDecoder。

爲了對傳出的數據進行編碼，Netty引入了編碼器。MessageToByteEncoder是大多數編碼器實現的基礎。

我們可以使用編碼器和解碼器將消息從字節序列轉換爲Java對象，反之亦然。

示例工程

工程依賴

首先，需要在pom.xml中提供Netty依賴項：

<dependency>
	<groupId>io.netty</groupId>
	<artifactId>netty-all</artifactId>
	<version>4.1.30.Final</version>
</dependency>

數據模型

請求數據

public class RequestData {
	private int intValue;
	private String stringValue;

	public int getIntValue() {
		return intValue;
	}

	public void setIntValue(int intValue) {
		this.intValue = intValue;
	}

	public String getStringValue() {
		return stringValue;
	}

	public void setStringValue(String stringValue) {
		this.stringValue = stringValue;
	}

	@Override
	public String toString() {
		return "RequestData{" + "intValue=" + intValue + ", stringValue='"
				+ stringValue + '\'' + '}';
	}
}

響應數據

public class ResponseData {
	private int intValue;

	public int getIntValue() {
		return intValue;
	}

	public void setIntValue(int intValue) {
		this.intValue = intValue;
	}

	@Override
	public String toString() {
		return "ResponseData{" + "intValue=" + intValue + '}';
	}
}

客戶端

請求數據編碼

現在，我們需要爲我們的協議消息創建編碼器和解碼器。

應當注意，Netty與套接字接收緩衝區一起使用，該緩衝區不是以隊列的形式而是以一堆字節的形式表示。這意味着當服務器未收到完整消息時，就可以調用我們的入站處理程序。

我們必須確保在處理之前已收到完整的消息，我們可以創建一個臨時的ByteBuf並將所有入站字節附加到該字節上，同時將字符串長度先寫入：

public class RequestDataEncoder extends MessageToByteEncoder<RequestData> {

	private final Charset charset = Charset.forName("UTF-8");

	@Override
	protected void encode(ChannelHandlerContext ctx, RequestData msg,
			ByteBuf out) throws Exception {
		out.writeInt(msg.getIntValue());
		// 記錄寫入遊標
        int writerIndex = out.writerIndex();
        // 預寫入一個假的length
        out.writeInt(0);
        // 寫入UTF-8字符序列
        int length = ByteBufUtil.writeUtf8(out, msg.getStringValue());
        // 覆蓋length
        out.setInt(writerIndex, length);
	}
}

在設計Netty的自定義協議的時候，一旦字符串類型的屬性中出現中文就會出現解碼異常的現象，這個異常並不一定出現了Exception，而是出現瞭解碼之後字符截斷出現了人類不可讀的字符。

對於這個問題Netty已經提供了內置的工具類io.netty.buffer.ByteBufUtil。可以先記錄一下writerIndex，先寫一個假的值（例如0），再使用ByteBufUtil#writeUtf8()寫字符序列，然後根據返回的寫入的字節長度，通過writerIndex覆蓋之前寫入的假值。

處理器

我們需要定義一個ClientHandler，它將發送請求並從服務器接收響應：

public class ClientHandler extends ChannelInboundHandlerAdapter {
	@Override
	public void channelActive(ChannelHandlerContext ctx) throws Exception {
		RequestData msg = new RequestData();
		msg.setIntValue(123);
		msg.setStringValue("算算兩倍是多少?");
		ctx.writeAndFlush(msg);
	}

	@Override
	public void channelRead(ChannelHandlerContext ctx, Object msg)
			throws Exception {
		System.out.println("計算結果："+msg);
		ctx.close();
	}
}

主程序

現在寫一個主程序啓動我們的客戶端：

public class NettyClient {
	public static void main(String[] args) throws Exception {
		String host = "localhost";
		int port = 8080;
		EventLoopGroup workerGroup = new NioEventLoopGroup();

		try {
			Bootstrap b = new Bootstrap();
			b.group(workerGroup);
			b.channel(NioSocketChannel.class);
			b.option(ChannelOption.SO_KEEPALIVE, true);
			b.handler(new ChannelInitializer<SocketChannel>() {
				@Override
				public void initChannel(SocketChannel ch) throws Exception {
					ch.pipeline().addLast(new RequestDataEncoder(),
							new ResponseDataDecoder(), new ClientHandler());
				}
			});

			ChannelFuture f = b.connect(host, port).sync();

			f.channel().closeFuture().sync();
		} finally {
			workerGroup.shutdownGracefully();
		}
	}
}

服務端

請求數據解碼

在服務端應執行反向編碼和解碼。

public class RequestDataDecoder extends ReplayingDecoder<RequestData> {

	private final Charset charset = Charset.forName("UTF-8");

	@Override
	protected void decode(ChannelHandlerContext ctx, ByteBuf in,
			List<Object> out) throws Exception {
		RequestData data = new RequestData();
		data.setIntValue(in.readInt());
		int strLen = in.readInt();
		data.setStringValue(in.readCharSequence(strLen, charset).toString());
		out.add(data);
	}
}

處理器

在服務端處理數據：

public class ProcessingHandler extends ChannelInboundHandlerAdapter {

	@Override
	public void channelRead(ChannelHandlerContext ctx, Object msg)
			throws Exception {
		RequestData requestData = (RequestData) msg;
		ResponseData responseData = new ResponseData();
		responseData.setIntValue(requestData.getIntValue() * 2);
		ChannelFuture future = ctx.writeAndFlush(responseData);
		future.addListener(ChannelFutureListener.CLOSE);
		System.out.println(requestData.toString());
	}
}

主程序

服務端的啓動程序：

public class NettyServer {

	private int port;

	private NettyServer(int port) {
		this.port = port;
	}

	public static void main(String[] args) throws Exception {
		int port;
		if (args.length > 0) {
			port = Integer.parseInt(args[0]);
		} else {
			port = 8080;
		}
		new NettyServer(port).run();
	}

	private void run() throws Exception {
		EventLoopGroup bossGroup = new NioEventLoopGroup();
		EventLoopGroup workerGroup = new NioEventLoopGroup();
		try {
			ServerBootstrap b = new ServerBootstrap();
			b.group(bossGroup, workerGroup)
					.channel(NioServerSocketChannel.class)
					.childHandler(new ChannelInitializer<SocketChannel>() {
						@Override
						public void initChannel(SocketChannel ch)
								throws Exception {
							ch.pipeline().addLast(new RequestDataDecoder(),
									new ResponseDataEncoder(),
									new ProcessingHandler());
						}
					}).option(ChannelOption.SO_BACKLOG, 128)
					.childOption(ChannelOption.SO_KEEPALIVE, true);

			ChannelFuture f = b.bind(port).sync();
			f.channel().closeFuture().sync();
		} finally {
			workerGroup.shutdownGracefully();
			bossGroup.shutdownGracefully();
		}
	}
}

運行結果

客戶端會得到預期的結果。

計算結果：ResponseData{intValue=246}

總結

本文介紹了Netty中的一些基本概念，並通過一個簡單的示例工程加以說明。完成工程代碼可在這裏找到。

peterwanghao 博客專家

發佈了208 篇原創文章 · 獲贊 212 · 訪問量 144萬+

他的留言板關注

Netty 核心概念介紹和簡單示例

核心概念

Channel

ChannelFuture

ChannelFutureListener

ChannelPipeline

Netty Handlers

Encoders and Decoders

示例工程

工程依賴

數據模型

客戶端

請求數據編碼

處理器

主程序

服務端

請求數據解碼

處理器

主程序

運行結果

總結

Wireshark 安裝+使用（一）

Java註解的用處和使用

解決ActiveMQ服務停掉後無限重連問題

Java中的匿名類與Lambda表達式

Netty精粹之基於EventLoop機制的高效線程模型

Netty 核心概念介紹和簡單示例

Mac下配置sublime實現LaTeX

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結