【NIO】SocketChannel

红太狼 2022-05-31 09:35 149阅读 0赞

# 前言 #

Github：[https://github.com/yihonglei/jdk-source-code-reading][https_github.com_yihonglei_jdk-source-code-reading]（java-nio）

Java NIO中的SocketChannel是一个连接到TCP网络套接字的通道。如下2种方式创建SocketChannel:

1）打开一个SocketChannel并连接到互联网上的某台服务器。

2）一个新连接到达ServerSocketChannel时，会创建一个SocketChannel。

# 一 打开SocketChannel #

以下是SocketChannel的打开方式:

SocketChannel channel = SocketChannel.open(); // 获得一个Socket通道

channel.connect(new InetSocketAddress(ip, port)); // 根据ip和port连接到对应服务器端

# 二 从SocketChannel读取数据 #

要从SocketChannel中读取数据，调用一个read()的方法之一。以下是例子:

ByteBuffer buf = ByteBuffer.allocate(48);

int bytesRead = socketChannel.read(buf);

首先，分配一个Buffer，从SocketChannel读取到的数据将会放到这个Buffer中。

然后，调用SocketChannel.read()，该方法将数据从SocketChannel读到Buffer中。

read()方法返回的int值表示读了多少字节进Buffer里。如果返回的是-1，表示已经读到了流的末尾，

表示可以对连接进行关闭了。

# 三 数据写入SocketChannel #

写数据到SocketChannel用的是SocketChannel.write()方法，该方法以一个Buffer作为参数。示例如下:

String newData = "一个测试字符串" + System.currentTimeMillis();

ByteBuffer buf = ByteBuffer.allocate(48);

buf.clear();

buf.put(newData.getBytes());

buf.flip();

while(buf.hasRemaining()) \{

channel.write(buf);

注意SocketChannel.write()方法的调用是在一个while循环中的。Write()方法无法保证能写多少字节到SocketChannel。

所以，我们重复调用write()直到Buffer没有要写的字节为止。

# 四 关闭SocketChannel #

当用完SocketChannel之后调用SocketChannel.close()关闭SocketChannel:

socketChannel.close();

# 五 非阻塞模式 #

可以设置 SocketChannel 为非阻塞模式（non-blocking mode）。

设置之后，就可以在异步模式下调用connect(), read()和write()了。

**connect()**

**如果SocketChannel在非阻塞模式下，此时调用connect()，该方法可能在连接建立之前就返回了。**

为了确定连接是否建立，可以调用finishConnect()的方法。像这样：

socketChannel.configureBlocking(false);

socketChannel.connect(new InetSocketAddress(ip, port));

while(!socketChannel.finishConnect())\{

// wait, or do something else...

**write()**

非阻塞模式下，write()方法在尚未写出任何内容时可能就返回了。所以需要在循环中调用write()。

**read()**

非阻塞模式下,read()方法在尚未读取到任何数据时可能就返回了。所以需要关注它的int返回值，它会告诉你读取了多少字节。

# 六 使用实例 #

**NIOServer**

package com.jpeony.nio.selector;
    
    import java.io.IOException;
    import java.net.InetSocketAddress;
    import java.net.ServerSocket;
    import java.nio.ByteBuffer;
    import java.nio.channels.*;
    import java.util.Iterator;
    import java.util.Set;
    
    /**
     * server端实例代码
     *
     * @author yihonglei
     */
    public class NIOServer {
        // 通道管理器(Selector)
        private static Selector selector;
    
        public static void main(String[] args) throws IOException {
            // 创建通道管理器(Selector)
            selector = Selector.open();
    
            // 创建通道ServerSocketChannel
            ServerSocketChannel serverSocketChannel = ServerSocketChannel.open();
            // 将通道设置为非阻塞
            serverSocketChannel.configureBlocking(false);
    
            // 将ServerSocketChannel对应的ServerSocket绑定到指定端口(port)
            ServerSocket serverSocket = serverSocketChannel.socket();
            serverSocket.bind(new InetSocketAddress(8989));
    
            /**
             * 将通道(Channel)注册到通道管理器(Selector)，并为该通道注册selectionKey.OP_ACCEPT事件
             * 注册该事件后，当事件到达的时候，selector.select()会返回，
             * 如果事件没有到达selector.select()会一直阻塞。
             */
            serverSocketChannel.register(selector, SelectionKey.OP_ACCEPT);
    
            // 循环处理
            while (true) {
                // 当注册事件到达时，方法返回，否则该方法会一直阻塞
                selector.select();
    
                // 获取监听事件
                Set<SelectionKey> selectionKeys = selector.selectedKeys();
                Iterator<SelectionKey> iterator = selectionKeys.iterator();
    
                // 迭代处理
                while (iterator.hasNext()) {
                    // 获取事件
                    SelectionKey key = iterator.next();
    
                    // 移除事件，避免重复处理
                    iterator.remove();
    
                    // 检查是否是一个就绪的可以被接受的客户端请求连接
                    if (key.isAcceptable()) {
                        handleAccept(key);
                    } else if (key.isReadable()) {// 检查套接字是否已经准备好读数据
                        handleRead(key);
                    }
    
                }
    
    
            }
        }
    
        /**
         * 处理客户端连接成功事件
         */
        private static void handleAccept(SelectionKey key) throws IOException {
            // 获取客户端连接通道
            ServerSocketChannel server = (ServerSocketChannel) key.channel();
            SocketChannel socketChannel = server.accept();
            socketChannel.configureBlocking(false);
    
            // 信息通过通道发送给客户端
            String msg = "Hello Client!";
            socketChannel.write(ByteBuffer.wrap(msg.getBytes()));
    
            // 给通道设置读事件，客户端监听到读事件后，进行读取操作
            socketChannel.register(selector, SelectionKey.OP_READ);
        }
    
        /**
         * 监听到读事件，读取客户端发送过来的消息
         */
        private static void handleRead(SelectionKey key) throws IOException {
            SocketChannel channel = (SocketChannel) key.channel();
    
            // 从通道读取数据到缓冲区
            ByteBuffer buffer = ByteBuffer.allocate(128);
            channel.read(buffer);
    
            // 输出客户端发送过来的消息
            byte[] data = buffer.array();
            String msg = new String(data).trim();
            System.out.println("server received msg from client：" + msg);
        }
    }

**NIOClient**

package com.jpeony.nio.selector;
    
    import java.io.IOException;
    import java.net.InetSocketAddress;
    import java.nio.ByteBuffer;
    import java.nio.channels.SelectionKey;
    import java.nio.channels.Selector;
    import java.nio.channels.SocketChannel;
    import java.util.Iterator;
    import java.util.Set;
    
    /**
     * client实例代码
     *
     * @author yihonglei
     */
    public class NIOClient {
        // 通道管理器(Selector)
        private static Selector selector;
    
        public static void main(String[] args) throws IOException {
            // 创建通道管理器(Selector)
            selector = Selector.open();
    
            // 创建通道SocketChannel
            SocketChannel channel = SocketChannel.open();
            // 将通道设置为非阻塞
            channel.configureBlocking(false);
    
            // 客户端连接服务器，其实方法执行并没有实现连接，需要在handleConnect方法中调channel.finishConnect()才能完成连接
            channel.connect(new InetSocketAddress("localhost", 8989));
    
            /**
             * 将通道(Channel)注册到通道管理器(Selector)，并为该通道注册selectionKey.OP_CONNECT
             * 注册该事件后，当事件到达的时候，selector.select()会返回，
             * 如果事件没有到达selector.select()会一直阻塞。
             */
            channel.register(selector, SelectionKey.OP_CONNECT);
    
            // 循环处理
            while (true) {
                /*
                 * 选择一组可以进行I/O操作的事件，放在selector中，客户端的该方法不会阻塞，
                 * selector的wakeup方法被调用，方法返回，而对于客户端来说，通道一直是被选中的
                 * 这里和服务端的方法不一样，查看api注释可以知道，当至少一个通道被选中时。
                 */
                selector.select();
    
                // 获取监听事件
                Set<SelectionKey> selectionKeys = selector.selectedKeys();
                Iterator<SelectionKey> iterator = selectionKeys.iterator();
    
                // 迭代处理
                while (iterator.hasNext()) {
                    // 获取事件
                    SelectionKey key = iterator.next();
    
                    // 移除事件，避免重复处理
                    iterator.remove();
    
                    // 检查是否是一个就绪的已经连接服务端成功事件
                    if (key.isConnectable()) {
                        handleConnect(key);
                    } else if (key.isReadable()) {// 检查套接字是否已经准备好读数据
                        handleRead(key);
                    }
    
                }
            }
        }
    
        /**
         * 处理客户端连接服务端成功事件
         */
        private static void handleConnect(SelectionKey key) throws IOException {
            // 获取与服务端建立连接的通道
            SocketChannel channel = (SocketChannel) key.channel();
            if (channel.isConnectionPending()) {
                // channel.finishConnect()才能完成连接
                channel.finishConnect();
            }
    
            channel.configureBlocking(false);
    
            // 数据写入通道
            String msg = "Hello Server!";
            channel.write(ByteBuffer.wrap(msg.getBytes()));
    
            // 通道注册到选择器，并且这个通道只对读事件感兴趣
            channel.register(selector, SelectionKey.OP_READ);
        }
    
        /**
         * 监听到读事件，读取客户端发送过来的消息
         */
        private static void handleRead(SelectionKey key) throws IOException {
            SocketChannel channel = (SocketChannel) key.channel();
    
            // 从通道读取数据到缓冲区
            ByteBuffer buffer = ByteBuffer.allocate(128);
            channel.read(buffer);
    
            // 输出服务端响应发送过来的消息
            byte[] data = buffer.array();
            String msg = new String(data).trim();
            System.out.println("client received msg from server：" + msg);
        }
    }

[https_github.com_yihonglei_jdk-source-code-reading]: https://github.com/yihonglei/jdk-source-code-reading