@[toc]
觉得不错的话，欢迎 star！ღ( ´･ᴗ･` )比心
- Netty 从入门到实战系列文章地址：https://github.com/Snailclimb/netty-practical-tutorial 。
- RPC 框架源码地址：https://github.com/Snailclimb/guide-rpc-framework
下面，我会带着大家搭建自己的第一个 Netty 版的 Hello World 小程序。
首先，让我们来创建服务端。
服务端
我们可以通过 ServerBootstrap 来引导我们启动一个简单的 Netty 服务端，为此，你必须要为其指定下面三类属性：
- 线程组（_一般需要两个线程组，一个负责接处理客户端的连接，一个负责具体的 IO 处理_）
- IO 模型（_BIO/NIO_）
- 自定义
ChannelHandler（_处理客户端发过来的数据并返回数据给客户端_）
创建服务端
/**
* @author shuang.kou
* @createTime 2020年05月14日 20:28:00
*/
public final class HelloServer {
private final int port;
public HelloServer(int port) {
this.port = port;
}
private void start() throws InterruptedException {
// 1.bossGroup 用于接收连接，workerGroup 用于具体的处理
EventLoopGroup bossGroup = new NioEventLoopGroup(1);
EventLoopGroup workerGroup = new NioEventLoopGroup();
try {
//2.创建服务端启动引导/辅助类：ServerBootstrap
ServerBootstrap b = new ServerBootstrap();
//3.给引导类配置两大线程组,确定了线程模型
b.group(bossGroup, workerGroup)
// (非必备)打印日志
.handler(new LoggingHandler(LogLevel.INFO))
// 4.指定 IO 模型
.channel(NioServerSocketChannel.class)
.childHandler(new ChannelInitializer() {
@Override
public void initChannel(SocketChannel ch) {
ChannelPipeline p = ch.pipeline();
//5.可以自定义客户端消息的业务处理逻辑
p.addLast(new HelloServerHandler());
}
});
// 6.绑定端口,调用 sync 方法阻塞知道绑定完成
ChannelFuture f = b.bind(port).sync();
// 7.阻塞等待直到服务器Channel关闭(closeFuture()方法获取Channel 的CloseFuture对象,然后调用sync()方法)
f.channel().closeFuture().sync();
} finally {
//8.优雅关闭相关线程组资源
bossGroup.shutdownGracefully();
workerGroup.shutdownGracefully();
}
}
public static void main(String[] args) throws InterruptedException {
new HelloServer(8080).start();
}
} 简单解析一下服务端的创建过程具体是怎样的：
1.创建了两个 NioEventLoopGroup 对象实例：bossGroup 和 workerGroup。
bossGroup: 用于处理客户端的 TCP 连接请求。workerGroup： 负责每一条连接的具体读写数据的处理逻辑，真正负责 I/O 读写操作，交由对应的 Handler 处理。
举个例子：我们把公司的老板当做 bossGroup，员工当做 workerGroup，bossGroup 在外面接完活之后，扔给 workerGroup 去处理。一般情况下我们会指定 bossGroup 的 线程数为 1（并发连接量不大的时候） ，workGroup 的线程数量为 CPU 核心数 *2 。另外，根据源码来看，使用 NioEventLoopGroup 类的无参构造函数设置线程数量的默认值就是 CPU 核心数 *2 。
2.创建一个服务端启动引导/辅助类： ServerBootstrap，这个类将引导我们进行服务端的启动工作。
3.通过 .group() 方法给引导类 ServerBootstrap 配置两大线程组，确定了线程模型。
EventLoopGroup bossGroup = new NioEventLoopGroup(1);
EventLoopGroup workerGroup = new NioEventLoopGroup();4.通过channel()方法给引导类 ServerBootstrap指定了 IO 模型为NIO
NioServerSocketChannel：指定服务端的 IO 模型为 NIO，与 BIO 编程模型中的ServerSocket对应NioSocketChannel: 指定客户端的 IO 模型为 NIO， 与 BIO 编程模型中的Socket对应
5.通过 .childHandler()给引导类创建一个ChannelInitializer ，然后指定了服务端消息的业务处理逻辑也就是自定义的ChannelHandler 对象
6.调用 ServerBootstrap 类的 bind()方法绑定端口 。
//bind()是异步的，但是，你可以通过 `sync()`方法将其变为同步。
ChannelFuture f = b.bind(port).sync();自定义服务端 ChannelHandler 处理消息
HelloServerHandler.java
/**
* @author shuang.kou
* @createTime 2020年05月14日 20:39:00
*/
@Sharable
public class HelloServerHandler extends ChannelInboundHandlerAdapter {
@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) {
try {
ByteBuf in = (ByteBuf) msg;
System.out.println("message from client:" + in.toString(CharsetUtil.UTF_8));
// 发送消息给客户端
ctx.writeAndFlush(Unpooled.copiedBuffer("你也好！", CharsetUtil.UTF_8));
} finally {
ReferenceCountUtil.release(msg);
}
}
@Override
public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) {
// Close the connection when an exception is raised.
cause.printStackTrace();
ctx.close();
}
}这个逻辑处理器继承自ChannelInboundHandlerAdapter 并重写了下面 2 个方法：
channelRead()：服务端接收客户端发送数据调用的方法exceptionCaught()：处理客户端消息发生异常的时候被调用
客户端
创建客户端
public final class HelloClient {
private final String host;
private final int port;
private final String message;
public HelloClient(String host, int port, String message) {
this.host = host;
this.port = port;
this.message = message;
}
private void start() throws InterruptedException {
//1.创建一个 NioEventLoopGroup 对象实例
EventLoopGroup group = new NioEventLoopGroup();
try {
//2.创建客户端启动引导/辅助类：Bootstrap
Bootstrap b = new Bootstrap();
//3.指定线程组
b.group(group)
//4.指定 IO 模型
.channel(NioSocketChannel.class)
.handler(new ChannelInitializer() {
@Override
public void initChannel(SocketChannel ch) throws Exception {
ChannelPipeline p = ch.pipeline();
// 5.这里可以自定义消息的业务处理逻辑
p.addLast(new HelloClientHandler(message));
}
});
// 6.尝试建立连接
ChannelFuture f = b.connect(host, port).sync();
// 7.等待连接关闭（阻塞，直到Channel关闭）
f.channel().closeFuture().sync();
} finally {
group.shutdownGracefully();
}
}
public static void main(String[] args) throws Exception {
new HelloClient("127.0.0.1",8080, "你好,你真帅啊！哥哥！").start();
}
} 继续分析一下客户端的创建流程：
1.创建一个 NioEventLoopGroup 对象实例 （_服务端创建了两个 NioEventLoopGroup 对象_）
2.创建客户端启动的引导类是 Bootstrap
3.通过 .group() 方法给引导类 Bootstrap 配置一个线程组
4.通过channel()方法给引导类 Bootstrap指定了 IO 模型为NIO
5.通过 .childHandler()给引导类创建一个ChannelInitializer ，然后指定了客户端消息的业务处理逻辑也就是自定义的ChannelHandler 对象
6.调用 Bootstrap 类的 connect()方法连接服务端，这个方法需要指定两个参数：
inetHost: ip 地址inetPort: 端口号
public ChannelFuture connect(String inetHost, int inetPort) {
return this.connect(InetSocketAddress.createUnresolved(inetHost, inetPort));
}
public ChannelFuture connect(SocketAddress remoteAddress) {
ObjectUtil.checkNotNull(remoteAddress, "remoteAddress");
this.validate();
return this.doResolveAndConnect(remoteAddress, this.config.localAddress());
}connect 方法返回的是一个 Future 类型的对象
public interface ChannelFuture extends Future {
......
} 也就是说这个方是异步的，我们通过 addListener 方法可以监听到连接是否成功，进而打印出连接信息。具体做法很简单，只需要对代码进行以下改动：
ChannelFuture f = b.connect(host, port).addListener(future -> {
if (future.isSuccess()) {
System.out.println("连接成功!");
} else {
System.err.println("连接失败!");
}
}).sync();自定义客户端 ChannelHandler 处理消息
HelloClientHandler.java
/**
* @author shuang.kou
* @createTime 2020年05月14日 20:46:00
*/
@Sharable
public class HelloClientHandler extends ChannelInboundHandlerAdapter {
private final String message;
public HelloClientHandler(String message) {
this.message = message;
}
@Override
public void channelActive(ChannelHandlerContext ctx) {
System.out.println("client sen msg to server " + message);
ctx.writeAndFlush(Unpooled.copiedBuffer(message, CharsetUtil.UTF_8));
}
@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) {
ByteBuf in = (ByteBuf) msg;
try {
System.out.println("client receive msg from server: " + in.toString(CharsetUtil.UTF_8));
} finally {
ReferenceCountUtil.release(msg);
}
}
@Override
public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) {
cause.printStackTrace();
ctx.close();
}
}
这个逻辑处理器继承自 ChannelInboundHandlerAdapter，并且覆盖了下面三个方法：
channelActive():客户端和服务端的连接建立之后就会被调用channelRead:客户端接收服务端发送数据调用的方法exceptionCaught:处理消息发生异常的时候被调用
运行程序
首先运行服务端 ，然后再运行客户端。
如果你看到，服务端控制台打印出：
message from client:你好,你真帅啊！哥哥！客户端控制台打印出：
client sen msg to server 你好,你真帅啊！哥哥！
client receive msg from server: 你也好！说明你的 Netty 版的 Hello World 已经完成了！
总结
这篇文章我们自己实现了一个 Netty 版的 Hello World，并且详细介绍了服务端和客户端的创建流程。客户端和服务端这块的创建流程，套路基本都差不多，差别可能就在相关配置方面。
文中涉及的代码，你可以在这里找到：https://github.com/Snailclimb/guide-rpc-framework-learning/tree/master/src/main/java/github/javaguide/netty/echo 。