公司使用thrift作为RPC框架,其中通信框架使用netty取代thrift自带的通信,所以看了官网文档,然后翻译下以备学习。
问题根源
如今,我们使用通用应用程序或者类库来实现系统之间地互相访问。举个栗子,我们经常使用HTTP客户端库从Web服务器检索信息,或者通过web service进行远程过程调用。
但是,一个通用的协议或者它的实现有时候并不能很好地进行扩展,就像我们不用一个通用的HTTP服务器去交换大文件、e-mail、财务信息和多人游戏数据这种接近实时传输的消息。我们真正需要的其实是一个为了特定的目的而专门实现的高度优化的协议。再举个栗子,你可能希望实现一个针对基于Ajax的聊天应用程序、媒体流或大型文件传输而进行优化的HTTP服务器,你甚至可以针对自己的需求去设计和实现一个全新的协议。
另一个不可避免的情况是,当你不得不处理遗留的专有协议时,必须确保能够兼容老系统。在这种情况下,真正重要的如何快速实现一个不影响应用程序稳定性和性能的协议。
解决方案
Netty致力于提供一个事件驱动的异步网络应用框架和工具,用以快速开发高性能、高可靠性的网络服务器和客户端程序。换而言之,Netty就是一个NIO框架,能够让用户简单快速地开发一个网络应用程序,比如C/S。它大大简化和流化(streamlines)了TCP和UDP的Socket服务器的开发这类的网络编程。
“快速和简单”并不意味着最终的应用程序将遭受可维护性或性能问题。Netty是一个精心设计的框架,它从许多协议的实现中吸收了很多的经验比如FTP、SMTP、HTTP、许多二进制和基于文本的传统协议,Netty在不降低开发效率、性能、稳定性、灵活性情况下,成功地找到了解决方案。
有些用户可能已经找到其他的号称有同样的优势的网络框架,所以你可能想问是什么让Netty与众不同。答案是Netty的哲学设计理念。Netty从出生那天起,就致力于为用户提供API和实现方面最舒适的体验。这并不是什么有形的东西,但是随着你阅读这本指南并开始玩转Netty,你会意识到,这种哲学会让你的生活更加轻松。
让我们开始吧
这个章节会介绍Netty核心的结构,并通过一些简单的例子来帮助你快速入门。当你读完本章节你马上就可以用Netty写出一个客户端和服务端。
开始之前
想要运行这一章的栗子,你只需要两个东西:最新版本的Netty和1.6版本以上的JDK。你可以在这里 获取最新版本的Netty,至于JDK,开心就好。
随着你继续阅读,你可能会有更多的关于本章介绍的类的问题,当你想要了解更多的时候,请移步API指南。为了方便起见,文档中的所有类名都会链接到API指南上。
写一个Discard Server
这个世上最简单的协议可能不是“Hello World”而是Discard。这个协议只负责接受并抛弃所有收到数据而不发送任何的响应。
实现一个Discard协议,你唯一需要做的事就是忽略所有收到的数据。让我们直接从实现handler开始,handler就是Netty用来处理I/O时间的。
package io.netty.example.discard;
import io.netty.buffer.ByteBuf;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelInboundHandlerAdapter;
/**
* Handles a server-side channel.
*/
public class DiscardServerHandler extends ChannelInboundHandlerAdapter { // (1)
@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) { // (2)
// Discard the received data silently.
((ByteBuf) msg).release(); // (3)
}
@Override
public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) { // (4)
// Close the connection when an exception is raised.
cause.printStackTrace();
ctx.close();
}
}
1. DiscardServerHandler继承ChannelInboundHandlerAdapter,这个类是ChannelInboundHandler的一个实现。ChannelInboundHandler提供了各种你可以重写的事件处理方法。目前来说,与自己实现这个handler接口相比,继承ChannelInboundHandlerAdapter已经足够了。
2. 在这里,我们重写了channelRead()方法,每当接收到新的客户端数据时,接受的信息都会调用这个方法。在这个栗子中,接受的信息类型是ByteBuf。
3. 为了实现Discard协议,这个handler需要忽略掉接收到的信息。ByteBuf是一种引用计数的类型,所以必须通过release()方法被准确地释放掉。
@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) {
try {
// Do something with msg
} finally {
ReferenceCountUtil.release(msg);
}
}
1. exceptionCaught()事件处理方法是当出现Throwable对象才会被调用,即当Netty由于IO错误或者处理器在处理事件时抛出的异常时。在大部分情况下,捕获的异常应该被记录下来并且把关联的channel给关闭掉。然而这个方法的处理方式会在遇到不同异常的情况下有不同的实现,比如你可能想在关闭连接之前发送一个错误码的响应消息。
到目前为止我们都干得不错。我们已经成功地实现了Discard Server的一半,剩下的一半就是去敲一个main方法,在main里面使用DiscardServerHandler去启动Server。
package io.netty.example.discard;
import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelOption;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.SocketChannel;
import io.netty.channel.socket.nio.NioServerSocketChannel;
/**
* Discards any incoming data.
*/
public class DiscardServer {
private int port;
public DiscardServer(int port) {
this.port = port;
}
public void run() throws Exception {
EventLoopGroup bossGroup = new NioEventLoopGroup(); // (1)
EventLoopGroup workerGroup = new NioEventLoopGroup();
try {
ServerBootstrap b = new ServerBootstrap(); // (2)
b.group(bossGroup, workerGroup)
.channel(NioServerSocketChannel.class) // (3)
.childHandler(new ChannelInitializer<SocketChannel>() { // (4)
@Override
public void initChannel(SocketChannel ch) throws Exception {
ch.pipeline().addLast(new DiscardServerHandler());
}
})
.option(ChannelOption.SO_BACKLOG, 128) // (5)
.childOption(ChannelOption.SO_KEEPALIVE, true); // (6)
// Bind and start to accept incoming connections.
ChannelFuture f = b.bind(port).sync(); // (7)
// Wait until the server socket is closed.
// In this example, this does not happen, but you can do that to gracefully
// shut down your server.
f.channel().closeFuture().sync();
} finally {
workerGroup.shutdownGracefully();
bossGroup.shutdownGracefully();
}
}
public static void main(String[] args) throws Exception {
int port;
if (args.length > 0) {
port = Integer.parseInt(args[0]);
} else {
port = 8080;
}
new DiscardServer(port).run();
}
}