Netty(1):第一个netty程序

为什么选择Netty

　　netty是业界最流行的NIO框架之一，它的健壮型,功能，性能，可定制性和可扩展性都是首屈一指的，Hadoop的RPC框架Avro就使用了netty作为底层的通信框架，此外netty在互联网，大数据，网络游戏，企业应用，电信软件等众多行业都得到了成功的商业应用。正因为以上的一些特性，使得netty已经成为java NIO编程的首选框架。

构建netty开发环境

　　其实使用netty很简单，直接将其jar包引入到工程中即可使用。 去 http://netty.io/网站上下载最新版本的jar包（由于官网上netty5已经被废弃，但是这里仍然使用netty5进行开发， 可以考虑从csnd下载），我这里下载的为:netty-5.0.0.Alpha1.tar.bz2。这其实是一个压缩文件，解压这个文件，取里面的所有类集合到一起的那个jar包netty-all-5.0.0.Alpha1.jar即可。另外还需要注意的是，我这里使用的jdk版本是1.8。

第一个netty程序
　　这里利用netty来实现一个时钟的小程序，服务器端接收特定的指令然后将服务器时间返回给客户端，客户端按照一定的时间间隔往服务器端发送命令。

package com.rampage.netty.time;

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;

/**
 * 时钟程序的服务器端
 * @author zyq
 *
 */
public class TimeServer {
    
    public static void main(String[] args) throws Exception {
        new TimeServer().bind(8080);
    }
    
    public void bind(int port) throws Exception {
        // 配置服务器的NIO线程组
        EventLoopGroup bossGroup = new NioEventLoopGroup();
        EventLoopGroup workerGroup = new NioEventLoopGroup();
        
        try {
            ServerBootstrap bootStrap = new ServerBootstrap();
            
            // 进行链式调用（每一次调用的返回结果都是ServerBootstrap）
            // group带两个参数第一个表示给父（acceptor）用的EventExecutorGroup（其实就是线程池）
            // 第二个参数表示子（client）线程池
            // channel方法可以带一个ServerChannel类来创建进行IO操作的通道。
            // option方法给Channel定制对应的选项
            // childHandler方法用来处理Channel中的请求
            bootStrap.group(bossGroup, workerGroup).channel(NioServerSocketChannel.class)
            .option(ChannelOption.SO_BACKLOG, 1024).childHandler(new ChildChannelHandler());
            
            // 绑定端口，等待同步成功
            // bind方法返回一个ChannelFuture类，就是相当于绑定端口并且创建一个新的channel
            // sync方法会等待ChannelFuture的处理结束
            ChannelFuture future = bootStrap.bind(port).sync();
            
            // 等待服务器监听端口关闭
            future.channel().closeFuture().sync();
        } finally {
            // 优雅地退出，释放线程资源
            bossGroup.shutdownGracefully();
            workerGroup.shutdownGracefully();
        }
    }
    
    private class ChildChannelHandler extends ChannelInitializer<SocketChannel> {

        @Override
        protected void initChannel(SocketChannel arg0) throws Exception {
            arg0.pipeline().addLast(new TimeServerHandler());
        }
        
    }
}

package com.rampage.netty.time;

import java.util.Date;

import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.channel.ChannelHandlerAdapter;
import io.netty.channel.ChannelHandlerContext;

/**
 * 时间服务器的处理类，只有netty5中的ChannelHandlerAdapter中才有ChannelRead和ChannelReadComplete方法。
 * @author zyq
 *
 */
public class TimeServerHandler extends ChannelHandlerAdapter {
    @Override 
    public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
        // netty中的ByteBuf类相当于jdk中的ByteBuffer类，但是功能更加强大
        ByteBuf buf = (ByteBuf) msg;
        
        // readableBytes返回缓冲区可读的字节数
        byte[] req = new byte[buf.readableBytes()];
        
        // 将缓冲区的字节数复制到新的字节数组中去
        buf.readBytes(req);
        
        // 根据客户端传来的信息得到应答信息
        String body = new String(req, "UTF-8");
        System.out.println("The time server receive order:" + body);
        String currentTime = "QUERY TIME ORDER".equalsIgnoreCase(body) ? new Date(System.currentTimeMillis()).toString() : "BAD ORDER";
        
        // 给客户端的回应
        ByteBuf resp = Unpooled.copiedBuffer(currentTime.getBytes());
        
        // 为了防止频繁唤醒Selector进行消息发送，Netty的write方法并不直接将消息写入到SocketChannel中，而是把消息放入到缓冲数组
        ctx.write(resp);
    }

    @Override
    public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
        // 将放到缓冲数组中的消息写入到SocketChannel中去
        ctx.flush();
    }

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        ctx.close();
    }
    
    
}

package com.rampage.netty.time;

import io.netty.bootstrap.Bootstrap;
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.NioSocketChannel;

/**
 * 时钟程序的客户端
 * @author zyq
 *
 */
public class TimeClient {
    
    public static void main(String[] args) throws Exception {
        new TimeClient().connect("127.0.0.1", 8080);
    }
    
    public void connect(String host, int port) throws Exception {
        // 配置客户端NIO线程池
        EventLoopGroup group = new NioEventLoopGroup();
        
        Bootstrap strap = new Bootstrap();
        try {
            // 这里用了匿名内部类，各个函数的含义同Server端
            strap.group(group).channel(NioSocketChannel.class).option(ChannelOption.TCP_NODELAY, true)
            .handler(new ChannelInitializer<SocketChannel>() {

                @Override
                protected void initChannel(SocketChannel arg0) throws Exception {
                    arg0.pipeline().addLast(new TimeClientHandler());
                }
                
            });
            
            // 发起异步连接操作
            ChannelFuture future = strap.connect(host, port).sync();
            
            // 等待客户端关闭(注意调用的是closeFuture如果直接调用close会立马关闭)
            future.channel().closeFuture().sync();
        } finally {
            // 优雅的关闭
            group.shutdownGracefully();
        }
    }
}

package com.rampage.netty.time;

import java.util.logging.Logger;

import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.channel.ChannelHandlerAdapter;
import io.netty.channel.ChannelHandlerContext;

public class TimeClientHandler extends ChannelHandlerAdapter {

    private static final Logger LOGGER = Logger.getLogger(TimeClientHandler.class.getName());
    
    private final ByteBuf firstMsg;
    
    public TimeClientHandler() {
        byte[] req = "QUERY TIME ORDER".getBytes();
        firstMsg = Unpooled.buffer(req.length);
        firstMsg.writeBytes(req);
    }
    
    /**
     * channel连通之后的处理
     */
    @Override
    public void channelActive(ChannelHandlerContext ctx) throws Exception {
        ctx.writeAndFlush(firstMsg);
    }
    
    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
        ByteBuf buf = (ByteBuf) msg;
        byte[] resp = new byte[buf.readableBytes()];
        buf.readBytes(resp);
        
        String body = new String(resp, "UTF-8");
        System.out.println("Now is:" + body);
        
        // 两秒钟后继续向服务器端发送消息
        Thread.sleep(2000);
        byte[] req = "QUERY TIME ORDER".getBytes();
        ByteBuf sendMsg = Unpooled.buffer(req.length);
        sendMsg.writeBytes(req);
        ctx.writeAndFlush(sendMsg);
    }

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        LOGGER.warning("Unexpected exception from downstream:" + cause.getMessage());
        ctx.close();
    }

    
}

服务器端的运行结果如下：

The time server receive order:QUERY TIME ORDER
The time server receive order:QUERY TIME ORDER
The time server receive order:QUERY TIME ORDER
The time server receive order:QUERY TIME ORDER

...

客户端的运行结果如下：

Now is:Wed Aug 03 05:55:30 PDT 2016
Now is:Wed Aug 03 05:55:33 PDT 2016
Now is:Wed Aug 03 05:55:35 PDT 2016
Now is:Wed Aug 03 05:55:37 PDT 2016

...

可以发现通过Netty框架来实现NIO极大的简化了编码和维护难度。代码调理更加清晰。

TimeClientHandler