Netty 聊天小程序

　　這節講解基於 Netty 快速實現一個聊天小程序。

一、服務端

1. SimpleChatServerHandler（處理器類）

　　該類主要實現了接收來自客戶端的消息並轉發給其他客戶端。

/**
 * 服務端處理器
 */
public class SimpleChatServerHandler extends SimpleChannelInboundHandler<String> {
    public static ChannelGroup channels 
        = new DefaultChannelGroup(GlobalEventExecutor.INSTANCE);
    
    /**
     * 收到新的客戶端連接時調用
     * 將客戶端channel存入列表，並廣播消息
     */
    @Override
    public void handlerAdded(ChannelHandlerContext ctx) throws Exception {
        Channel incoming = ctx.channel();
        // 廣播加入消息
        channels.writeAndFlush("[SERVER] - " + incoming.remoteAddress() + " 加入\n");
        channels.add(incoming);        // 存入列表    
    }
    
    /**
     * 客戶端連接斷開時調用
     * 廣播消息
     */
    @Override
    public void handlerRemoved(ChannelHandlerContext ctx) throws Exception {
        Channel incoming = ctx.channel();
        // 廣播離開消息
        channels.writeAndFlush("[SERVER] - " + incoming.remoteAddress() + " 離開\n");
        // channel會自動從ChannelGroup中刪除 
    }
    
    /**
     * 收到消息時調用
     * 將消息轉發給其他客戶端
     */
    @Override
    protected void channelRead0(ChannelHandlerContext ctx, String msg) throws Exception {
        Channel incoming = ctx.channel();
        for(Channel channel : channels) {        // 遍歷所有連接的客戶端
            if(channel != incoming) {            // 其他客戶端
                channel.writeAndFlush("[" + incoming.remoteAddress() + "] " + msg + "\n" );
            } else {                            // 自己
                channel.writeAndFlush("[you] " + msg + "\n" );
            }
        }
    }
    
    /**
     * 監聽到客戶端活動時調用
     */
    @Override
    public void channelActive(ChannelHandlerContext ctx) throws Exception {
        Channel incoming = ctx.channel();
        System.out.println("SimpleChatClient: " + incoming.remoteAddress() + " 在線");
    }
    
    /**
     * 監聽到客戶端不活動時調用
     */
    @Override
    public void channelInactive(ChannelHandlerContext ctx) throws Exception {
        Channel incoming = ctx.channel();
        System.out.println("SimpleChatClient: " + incoming.remoteAddress() + " 掉線");
    }
    
    /**
     * 當Netty由於IO錯誤或者處理器在處理事件拋出異常時調用
     * 關閉連接
     */
    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        Channel incoming = ctx.channel();
        System.out.println("SimpleChatClient: " + incoming.remoteAddress() + " 異常");
    }
}

 

2. SimpleChatServerInitializer（配置 Channel 類）

 　　該類添加分隔符協議處理類，解碼、編碼器還有自定義處理器。

/**
 * 服務器配置初始化
 * 添加多個處理器
 */
public class SimpleChatServerInitializer extends ChannelInitializer<SocketChannel> {

    @Override
    protected void initChannel(SocketChannel ch) throws Exception {
        ChannelPipeline pipeline = ch.pipeline();
        // 添加處理類
        // 使用'\r''\n'分割幀
        pipeline.addLast("framer", 
                new DelimiterBasedFrameDecoder(8192, Delimiters.lineDelimiter()));
        // 解碼、編碼器
        pipeline.addLast("decoder", new StringDecoder());
        pipeline.addLast("encoder", new StringEncoder());
        // 處理器
        pipeline.addLast("handler", new SimpleChatServerHandler());
        
        System.out.println("SimpleChatClient: " + ch.remoteAddress() + "連接上");
    }

}

 

 

3. SimpleChatServer（服務端主程序）

　　啟動服務端。

/**
 * 服務端 main 啟動
 */
public class SimpleChatServer {
    private int port;        // 端口
    
    public SimpleChatServer(int port) {
        this.port = port;
    }
    
    // 配置並開啟服務器
    public void run() throws Exception {
        EventLoopGroup bossGroup = new NioEventLoopGroup();        // 用來接收進來的連接
        EventLoopGroup workerGroup = new NioEventLoopGroup();    // 用來處理已接收的連接
        
        try {
            ServerBootstrap sb = new ServerBootstrap();            // 啟動NIO服務的輔助啟動類
            sb.group(bossGroup, workerGroup)
                .channel(NioServerSocketChannel.class)                // 設置如何接受連接
                .childHandler(new SimpleChatServerInitializer())    // 配置Channel
                .option(ChannelOption.SO_BACKLOG, 128)                // 設置緩沖區
                .childOption(ChannelOption.SO_KEEPALIVE, true);    // 啟用心跳機制
            
            System.out.println("SimpleChatServer 啟動了");
            ChannelFuture future = sb.bind(port).sync();        // 綁定端口，開始接收連接
            future.channel().closeFuture().sync();                // 等待關閉服務器（不會發生）
        } finally {
            workerGroup.shutdownGracefully();
            bossGroup.shutdownGracefully();
            System.out.println("SimpleChatServer 關閉了");
        }
    }
    
    public static void main(String[] args) throws Exception {
        int port = 8080;
        new SimpleChatServer(port).run();     // 開啟服務器
    }
}

 

 

 二、客戶端

1. SimpleChatClientHandler（處理器類）

　　直接輸出收到的消息。

/**
 * 客戶端處理類
 * 直接輸出收到的消息
 */
public class SimpleChatClientHandler extends SimpleChannelInboundHandler<String> {

    @Override
    protected void channelRead0(ChannelHandlerContext ctx, String msg) throws Exception {
        System.out.println(msg);    // 直接輸出消息        
    }

}

 

 

 2. SimpleChatClientInitializer（配置 Channel 類）

 　　與服務端類似。

/**
 * 客戶端配置初始化
 * 與服務端類似
 */
public class SimpleChatClientInitializer extends ChannelInitializer<SocketChannel> {

    @Override
    protected void initChannel(SocketChannel ch) throws Exception {
        ChannelPipeline pipeline = ch.pipeline();
        // 添加處理類
        // 使用'\r''\n'分割幀
        pipeline.addLast("framer", 
                new DelimiterBasedFrameDecoder(8192, Delimiters.lineDelimiter()));
        // 解碼、編碼器
        pipeline.addLast("decoder", new StringDecoder());
        pipeline.addLast("encoder", new StringEncoder());
        // 處理器
        pipeline.addLast("handler", new SimpleChatClientHandler());
    }

}

 

 

 3. SimpleChatClient（客戶端主程序）

 　　接收來自控制台的消息，每幀以 "\r\n" 結尾，再發給服務端。

/**
 * 客戶端
 * 開啟客戶端，接收控制台輸入並發送給服務端
 */
public class SimpleChatClient {
    private final String host;        // IP
    private final int port;        // 端口
    
    public SimpleChatClient(String host, int port) {
        this.host = host;
        this.port = port;
    }
    
    // 配置並運行客戶端
    public void run() throws Exception {
        EventLoopGroup group = new NioEventLoopGroup();
        try {
            Bootstrap b = new Bootstrap();        // 客戶端輔助啟動類
            b.group(group)                                    // 客戶端只需要一個用來接收並處理連接
                .channel(NioSocketChannel.class)            // 設置如何接受連接
                .handler(new SimpleChatClientInitializer());// 配置 channel
            // 連接服務器
            Channel channel = b.connect(host, port).sync().channel();
            // 讀取控制台輸入字符
            BufferedReader in = new BufferedReader(new InputStreamReader(System.in));
            while(true) {
                // 每行成一幀輸出，以"\r\n"結尾
                channel.writeAndFlush(in.readLine() + "\r\n");
            }
        } catch (Exception e) {
            e.printStackTrace();        // 輸出異常
        } finally {
            group.shutdownGracefully();    // 關閉
        }
    }
    
    public static void main(String[] args) throws Exception {
        new SimpleChatClient("localhost", 8080).run();        // 啟動客戶端
    }

}

 

 

三、運行效果 

 　　先運行服務端程序，然后在運行兩次客戶端程序，如下：

　　服務端輸出：

　　

　　首先連接的客戶端輸出：

　　

 

　　隨便選個客戶端在控制台輸出信息並回車，如下：

　　 自身輸出：

　　

　　另一客戶端輸出：

　　

 

　　以上……