玩转 Netty,从“Hello World”开始!
为什么要用 Netty?
首先当然是 NIO 的使用,本身比较复杂,而且还存在一些问题。
除此之外,如果在项目的开发中,要实现稳定的网络通信,就得考虑网络的闪断、客户端的重复接入、客户端的安全认证、消息的编解码、半包读写……
头大
所以,巧了,恰好有这么一个成熟稳定、性能强大、开箱即用的网络框架摆在我们面前,相比较 Java NIO,Netty 更加出色:
易用性: Netty 在 NIO 基础上进行了更高层次的封装,屏蔽了 NIO 的复杂性,大大降低了开发难度;Netty 提供了很多开箱即用的工具,例如常用的行解码器、长度域解码器等,不需要自己再实现。
稳定性: Netty 更加可靠稳定,修复和完善了 JDK NIO 较多已知问题,例如臭名昭著的 select 空转导致 CPU 消耗 100%,TCP 断线重连,keep-alive 检测等问题。
可扩展性: Netty 的的可扩展性做的非常好,比如支持可定制化的线程模型。
我们有什么理由拒绝这么一款优秀的网络通信框架呢?代码怎么写不是写喽!
初识 Netty
什么是 Netty?
Netty 官方是这么定义 Netty 的:
Netty 是一个异步事件驱动的网络应用程序框架,用于快速开发可维护的高性能协议服务器和客户端。
组成图-来源官方
Netty 是一个开源的、单线程模型的 Java 网络编程框架。
Netty 基于 NIO ,被广泛应用于各种网络应用程序开发。
Netty 支持多种协议,包括但不限于 HTTP、WebSocket、TCP、UDP 和 SSL/TLS 协议等。
Netty 是非阻塞的,事件驱动的框架。
Netty 具有高性能、可扩展和易于使用的优点。
Netty 的现状?
Netty 由 JBoss 社区开发维护的,它的社区相对比较活跃:
https://github.com/netty/netty:Github 已经收获 31.2K 星标
https://netty.io/:官方网站,提供了比较完整的文档
官方目前最新的版本是 5.x,,但是很不幸,已经被社区放弃开发维护,属于废弃版本,最新的稳定版本是 4.x 。
一般使用,推荐 4.x,Netty 4.x 对 3.x 不做兼容,我们后续的学习也基于 Netty 4.x 版本。
谁在用 Netty?
作为最流行的网络通信框架,大量的公司选择它作为底层网络通信框架,包括不限于:
使用 Netty 的公司
我们可能自己没有直接用过 Netty,但其实熟悉的很多开源中间件,都用到了 Netty,比如:
服务治理:Apache Dubbo、gRPC。
大数据:Hbase、Spark、Flink、Storm。
搜索引擎:Elasticsearch。
消息队列:RocketMQ、ActiveMQ。
用到 Netty 的优秀产品非常多,大家感兴趣可以看看:https://netty.io/wiki/related-projects.html。
从"Hello World"开始
气氛衬托到这,不写个 Demo 也过不去,还是从"Hello World"开始,我们领略一下 Netty 的风采。
创建一个 Maven 项目:这个就不用多说了吧
创建 Maven 项目
导入依赖:我们直接用 4.x 最新的版本
编写代码:那么我们就开始编写这个 Demo 的服务器和客户端相关代码
NettyServer:基于 Netty 的客户端/**
* <p>Date: 2023/5/14 10:29</p>* <p>Author: fighter3</p>* <p>Description: Netty 服务端 Demo</p>*/
public class NettyServer{
// 服务器监听的端口号
private int port;
public NettyServer(int port) {
this.port = port;
}/**
* 启动 Netty 服务器* @throws InterruptedException
*/
public void run() throws InterruptedException {
// 创建 boss 线程组和 worker 线程组
// bossGroup 用于监听客户端的连接请求,将连接请求发送给 workerGroup 进行处理
NioEventLoopGroup bossGroup = new NioEventLoopGroup();
// workerGroup 用于处理客户端连接的数据读写
NioEventLoopGroup workerGroup = new NioEventLoopGroup();
try {
// 创建 ServerBootstrap 对象,用于启动 Netty 服务器
ServerBootstrap serverBootstrap = new ServerBootstrap();
// 绑定线程池事件组
serverBootstrap.group(bossGroup, workerGroup).channel(NioServerSocketChannel.class)
// 通道初始化回调函数,在启动的时候可以自动调用.childHandler(new ChannelInitializer<SocketChannel>() {
@Override
public void initChannel(SocketChannel ch) throws Exception {
ChannelPipeline pipeline = ch.pipeline();// 添加消息处理器
pipeline.addLast(new NettyServerHandler());
}});// 绑定端口,开始接收客户端请求
ChannelFuture channelFuture = serverBootstrap.bind(port).sync();System.out.println("Netty 服务器监听端口:"+port);
// 等待服务端监听端口关闭
channelFuture.channel().closeFuture().sync();} finally {
//释放线程组资源
bossGroup.shutdownGracefully();workerGroup.shutdownGracefully();}}public static void main(String[] args) throws InterruptedException {
// 创建服务器对象,监听端口号为 8888
NettyServer server = new NettyServer(8888);
System.out.println("============Netty 服务器启动...=============");
// 启动服务器
server.run();System.out.println("============Netty 服务器停止...=============");
}}
NettyServerHandler:服务器的消息处理器,用于处理各种事件/**
* <p>Date: 2023/5/14 10:30</p>* <p>Author: fighter3</p>* <p>Description: Netty 服务器消息处理器</p>*/
public class NettyServerHandler extends ChannelInboundHandlerAdapter {
/**
* 当客户端上线的时候会触发这个方法* @param ctx
* @throws Exception
*/
@Override
public void channelActive(ChannelHandlerContext ctx) throws Exception {
String message="你好,靓仔!";
ByteBuf hello = Unpooled.copiedBuffer(message, CharsetUtil.UTF_8);// 发送消息
ctx.writeAndFlush(hello);}/**
*当 Channel 中有来自客户端的数据时就会触发这个方法*/
@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
ByteBuf buf = (ByteBuf) msg;System.out.println("客户端发来的消息:" + buf.toString(CharsetUtil.UTF_8)); // 接收消息并打印输出
}/**
* 当有异常时触发这个方法*/
@Override
public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
cause.printStackTrace();ctx.close();}}
NettyClient:使用 Netty 的客户端,通过 ip 和端口连接服务端/**
* <p>Date: 2023/5/14 10:32</p>* <p>Author: fighter3</p>* <p>Description: Netty 客户端 Demo</p>*/
public class NettyClient {
// 服务器 IP
private String host;
// 服务器监听的端口号
private int port;
public NettyClient(String host, int port) {
this.host = host;
this.port = port;
}/**
* 启动 Netty 客户端*/
public void run() throws InterruptedException {
// 创建事件循环组
NioEventLoopGroup group = new NioEventLoopGroup();
try {
// 创建 Bootstrap 对象
Bootstrap bootstrap = new Bootstrap();
// 配置 Bootstrap 对象
// 设置线程组
bootstrap.group(group)// 设置客户端通信的通道类型为 NIO 类型
.channel(NioSocketChannel.class)
.handler(new ChannelInitializer<SocketChannel>() {
// 通道初始化回调函数,在启动的时候可以自动调用
@Override
public void initChannel(SocketChannel ch) throws Exception {
// 添加消息处理器
ch.pipeline().addLast(new NettyClientHandler());
}});// 连接服务器,异步等待连接成功
ChannelFuture channelFuture = bootstrap.connect(host, port).sync();System.out.println("===========Netty 客户端连接服务端=========");
// 等待客户端连接关闭
channelFuture.channel().closeFuture().sync();} finally {
//释放资源
group.shutdownGracefully();}}public static void main(String[] args) throws InterruptedException {
// 创建客户端对象,并连接到服务器
NettyClient client = new NettyClient("127.0.0.1", 8888);
// 启动客户端,开始发送消息
client.run();}}
NettyClientHandler:Netty 客户端处理器,用于处各种事件/**
* <p>Date: 2023/5/14 10:33</p>* <p>Author: fighter3</p>* <p>Description: Netty 客户端处理器</p>*/
public class NettyClientHandler extends ChannelInboundHandlerAdapter {
/**
* 当 Channel 准备就绪时就会触发这个方法*/
@Override
public void channelActive(ChannelHandlerContext ctx) throws Exception {
String message="大佬,带带我!";
ByteBuf hello = Unpooled.copiedBuffer(message, CharsetUtil.UTF_8);// 发送消息
ctx.writeAndFlush(hello);}/**
* 当 Channel 中有来自服务器的数据时就会触发这个方法*/
@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
ByteBuf buf = (ByteBuf) msg;System.out.println("服务端发来的消息:" + buf.toString(CharsetUtil.UTF_8)); // 接收消息并打印输出
}/**
* 发生异常就会触发这个方法*/
@Override
public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
cause.printStackTrace();ctx.close();}}
运行一下:先启动 NettyServer,再启动 NettyClient,看下运行结果============Netty 服务器启动...=============
Netty 服务器监听端口:8888
客户端发来的消息:大佬,带带我!===========Netty 客户端连接服务端=========
服务端发来的消息:你好,靓仔!
好了,一个简单的 Netty 入门 Demo 就写完了,Netty 是一个双工通信的网络框架,可以看到,服务端和客户端,流程基本上一致,主要包括这么几个步骤:
创建事件循环组和相关对象,用于监听和处理网络事件;
配置 Netty 服务器或客户端的启动参数,包括线程组、通道类型、TCP 参数等;
给服务器或客户端的 ChannelPipeline 添加各种 ChannelHandler,用于处理不同的网络事件;
绑定端口启动服务器或连接服务器;
等待服务器或客户端连接关闭,释放相关资源。
服务器 &客户端初始化启动流程
虽然这个 Demo 比较简单,但其实已经用到了 Netty 里几个比较关键的组件:
ByteBuf:Netty 的字节容器,类似于 Java 的 ByteBuffer,但是提供了更加强大、简便且安全的 API,用于在网络中传递二进制数据;
EventLoopGroup:Netty 的事件循环组,用于管理和调度连接到服务器或者从服务器连接出去的所有 Channel 上的事件循环;
ServerBootstrap:Netty 的服务器启动类,用于启动和配置一个 TCP/IP 服务器;
Bootstrap:Netty 的客户端启动类,用于启动和配置一个 TCP/IP 客户端;
Channel:Netty 的核心概念,用于表示一个通信通道,可以读取和写入数据;
ChannelPipeline:Netty 的 Channel 处理器,用于在传入的数据上执行一组 ChannelHandler;
ChannelHandler:Netty 的核心组件,用于处理各种通信事件,例如读取数据、写数据、建立连接等;
Netty 的重要组件
后续,我们还会和这些组件打更多的交道。
好了,那么这期内容就到这了,这期里我们初步了解了 Netty,包括什么是 Netty、Netty 现状、Netty 的应用,还写了一个简单的 Demo。下一期,我们继续深入了解 Netty,敬请期待。
评论