NIO Server端代码示例

343 阅读7分钟

server端

package org.example.io.nio;

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.ServerSocketChannel;
import java.nio.channels.SocketChannel;
import java.util.Date;
import java.util.Iterator;
import java.util.Set;

/**
 * @author CodePorter
 * @date 2020/3/26
 */
public class TimeServer {

    public static void main(String[] args) throws IOException {
        int port = 8080;
        if (args != null && args.length > 0) {
            try {
                port = Integer.parseInt(args[0]);
            } catch (NumberFormatException e) {

            }
        }
        MultiplexerTimeServer timeServer = new MultiplexerTimeServer(port);
        new Thread(timeServer, "NIO-MultiplexerTimeServer-001").start();
    }
}

class MultiplexerTimeServer implements Runnable {

    private Selector selector;

    private volatile boolean stop;

    /**
     * 在构造方法中进行资源初始化,
     * 创建多路复用器 Selector、ServerSocketChannel,对 Channel 和 TCP 参数进行配置。
     * 例如,将 ServerSocketChannel 设置为异步非阻塞模式,它的 backlog 设置为 1024。
     * 系统资源初始化成功后,将 ServerSocket Channel 注册到 Selector, 监听 SelectionKey.OP_ ACCEPT 操作位;
     * 如果资源初始化失败(例如端口被占用),则退出。
     *
     * @param port
     */
    public MultiplexerTimeServer(int port) {
        try {
            selector = Selector.open();
            ServerSocketChannel serverSocketChannel = ServerSocketChannel.open();
            serverSocketChannel.configureBlocking(false);
            serverSocketChannel.socket().bind(new InetSocketAddress(port), 1024);
            serverSocketChannel.register(selector, SelectionKey.OP_ACCEPT);
            System.out.println("The time server is start in port : " + port);
        } catch (IOException e) {
            e.printStackTrace();
            System.exit(1);
        }
    }

    public void stop() {
        this.stop = true;
    }

    /**
     * while循环体中循环遍历selector,它的休眠时间为1s,
     * 无论是否有读写等事件发生,selector每隔1s都被唤醒一次,
     * selector也提供了一个无参的select方法。
     * 当有处于就绪状态的Channel时,selector将返回就绪状态的Channel的SelectionKey集合,
     * 通过对就绪状态的Channel集合进行迭代,可以进行网络的异步读写操作。
     */
    @Override
    public void run() {
        while (!stop) {
            try {
                selector.select(1000);
                Set<SelectionKey> selectionKeys = selector.selectedKeys();
                Iterator<SelectionKey> iterator = selectionKeys.iterator();
                SelectionKey key = null;
                while (iterator.hasNext()) {
                    key = iterator.next();
                    iterator.remove();
                    try {
                        handleInput(key);
                    } catch (Exception e) {
                        if (key != null) {
                            key.cancel();
                            if (key.channel() != null) {
                                key.channel().close();
                            }
                        }
                    }
                }
            } catch (Throwable t) {
                t.printStackTrace();
            }
        }
        if (selector != null) {
            try {
                selector.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }


    private void handleInput(SelectionKey key) throws IOException {
        if (key.isValid()) {
            /**
             * 处理新接入的客户端请求消息,根据SelectionKey的操作位进行判断即可获知网络事件的类型,
             * 通过ServerSocketChannel的accept接收客户端的连接请求并创建SocketChannel实例,
             * 完成上述操作后,相当于完成了TCP的三次握手,TCP物理链路正式建立。
             * 注意,我们需要将新创建的SocketChannel设置为异步非阻塞,同时也可以对其TCP参数进行设置,
             * 例如TCP接收和发送缓冲区的大小等,作为入门的例子,例程没有进行额外的参数设置。
             **/
            if (key.isAcceptable()) {
                ServerSocketChannel serverSocketChannel = (ServerSocketChannel) key.channel();
                SocketChannel socketChannel = serverSocketChannel.accept();
                socketChannel.configureBlocking(false);
                socketChannel.register(selector, SelectionKey.OP_READ);
            }
            /**
             * 用于读取客户端的请求消息,首先创建一个ByteBuffer,
             * 由于我们事先无法得知客户端发送的码流大小,作为例程,我们开辟一个1M的缓冲区。
             * 然后调用SocketChannel的read方法读取请求码流。
             * 注意,由于我们已经将SocketChannel设置为异步非阻塞模式,因此它的read是非阻塞的。
             * 使用返回值进行判断,看读取到的字节数,返回值有以下三种可能的结果。
             * 返回值大于0:读到了字节,对字节进行编解码;
             * 返回值等于0:没有读取到字节,属于正常场景,忽略;
             * 返回值为-1:链路已经关闭,需要关闭SocketChannel,释放资源。
             * 当读取到码流以后,我们进行解码,首先对readBuffer进行flip操作,
             * 它的作用是将缓冲区当前的limit设置为position,position设置为0,用于后续对缓冲区的读取操作。
             * 然后根据缓冲区可读的字节个数创建字节数组,调用ByteBuffer的get操作将缓冲区可读的字节数组复制到新创建的字节数组中,
             * 最后调用字符串的构造函数创建请求消息体并打印。如果请求指令是"QUERYTIMEORDER"则把服务器
             */
            if (key.isReadable()) {
                SocketChannel socketChannel = (SocketChannel) key.channel();
                ByteBuffer readBuffer = ByteBuffer.allocate(1024);
                int readBytes = socketChannel.read(readBuffer);
                if (readBytes > 0) {
                    readBuffer.flip();
                    byte[] bytes = new byte[readBuffer.remaining()];
                    readBuffer.get(bytes);
                    String body = new String(bytes, "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";
                    doWriter(socketChannel, currentTime);
                } else if (readBytes < 0) {
                    key.cancel();
                    socketChannel.close();
                } else {
                    ;
                }
            }
        }
    }

    /**
     * 将字符串编码成字节数组,根据字节数组的容量创建ByteBuffer,
     * 调用ByteBuffer的put操作将字节数组复制到缓冲区中,然后对缓冲区进行flip操作,
     * 最后调用SocketChannel的write方法将缓冲区中的字节数组发送出去。
     * 需要指出的是,由于SocketChannel是异步非阻塞的,它并不保证一次能够把需要发送的字节数组发送完,
     * 此时会出现“写半包”问题,我们需要注册写操作,不断轮询Selector将没有发送完的ByteBuffer发送完毕,
     * 可以通过ByteBuffer的hasRemain()方法判断消息是否发送完成。
     *
     * @param channel
     * @param response
     * @throws IOException
     */
    private void doWriter(SocketChannel channel, String response) throws IOException {
        if (response != null && response.trim().length() > 0) {
            byte[] bytes = response.getBytes();
            ByteBuffer writeBuffer = ByteBuffer.allocate(bytes.length);
            writeBuffer.put(bytes);
            writeBuffer.flip();
            channel.write(writeBuffer);
        }
    }
}

client端

package org.example.io.nio;

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;

/**
 * @author CodePorter
 * @date 2020/3/27
 * @from Netty权威指南
 */
public class TimeClient {
    public static void main(String[] args) {
        int port = 8080;
        if (args != null && args.length > 0) {
            try {
                port = Integer.parseInt(args[0]);
            } catch (NumberFormatException e) {

            }
        }
        new Thread(new TimeClientHandle("127.0.0.1", port), "TimeClient-001").start();
    }
}

class TimeClientHandle implements Runnable {
    private String host;
    private int port;
    private Selector selector;
    private SocketChannel socketChannel;
    private volatile boolean stop;

    /**
     * 用于初始化NIO的多路复用器和SocketChannel对象。
     * 需要注意的是,创建SocketChannel之后,需要将其设置为异步非阻塞模式。
     *
     * @param host
     * @param port
     */
    public TimeClientHandle(String host, int port) {
        this.host = host == null ? "127.0.0.1" : host;
        this.port = port;
        try {
            selector = Selector.open();
            socketChannel = SocketChannel.open();
            socketChannel.configureBlocking(false);
        } catch (IOException e) {
            e.printStackTrace();
            System.exit(1);
        }
    }

    @Override
    public void run() {
        try {
            doConect();
        } catch (IOException e) {
            e.printStackTrace();
            System.exit(1);
        }
        while (!stop) {
            try {
                selector.select(1000);
                Set<SelectionKey> selectionKeys = selector.selectedKeys();
                Iterator<SelectionKey> iterator = selectionKeys.iterator();
                SelectionKey key = null;
                while (iterator.hasNext()) {
                    key = iterator.next();
                    iterator.remove();
                    try {
                        handleInput(key);
                    } catch (Exception e) {
                        if (key != null) {
                            key.cancel();
                            if (key.channel() != null) {
                                key.channel().close();
                            }
                        }
                    }
                }
            } catch (Throwable t) {
                t.printStackTrace();
            }
            // 线程退出循环后,我们需要对连接资源进行释放,以实现“优雅退出”。
            // 多路复用器的资源释放,由于多路复用器上可能注册成千上万的Channel或者pipe,
            // 如果一一对这些资源进行释放显然不合适。因此,JDK底层会自动释放所有跟此多路复用器关联的资源
            if (selector != null) {
                try {
                    selector.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
    }

    /**
     * 首先对SelectionKey进行判断,看它处于什么状态。
     * 如果是处于连接状态,说明服务端已经返回ACK应答消息。
     * 这时我们需要对连接结果进行判断,调用SocketChannel的finishConnect()方法,
     * 如果返回值为true,说明客户端连接成功;如果返回值为false或者直接抛出IOException,说明连接失败。
     * 在本例程中,返回值为true,说明连接成功。
     * 将SocketChannel注册到多路复用器上,注册SelectionKey.OP_READ操作位,监听网络读操作,然后发送请求消息给服务端。
     *
     * @param key
     * @throws IOException
     */
    private void handleInput(SelectionKey key) throws IOException {
        if (key.isValid()) {
            SocketChannel socketChannel = (SocketChannel) key.channel();
            if (key.isConnectable()) {
                if (socketChannel.finishConnect()) {
                    socketChannel.register(selector, SelectionKey.OP_READ);
                    doWriter(socketChannel);
                } else {
                    System.exit(1);
                }
                // 如果客户端接收到了服务端的应答消息,则SocketChannel是可读的,
                // 由于无法事先判断应答码流的大小,我们就预分配1M的接收缓冲区用于读取应答消息,
                // 调用SocketChannel的read()方法进行异步读取操作。
                // 由于是异步操作,所以必须对读取的结果进行判断,
                // 如果读取到了消息,则对消息进行解码,最后打印结果。
                // 执行完成后将stop置为true,线程退出循环。
                if (key.isReadable()) {
                    ByteBuffer readBuffer = ByteBuffer.allocate(1024);
                    int readBytes = socketChannel.read(readBuffer);
                    if (readBytes > 0) {
                        readBuffer.flip();
                        byte[] bytes = new byte[readBuffer.remaining()];
                        readBuffer.get(bytes);
                        String body = new String(bytes, "UTF-8");
                        System.out.println("Now is : " + body);
                        this.stop = true;
                    } else if (readBytes < 0) {
                        key.cancel();
                        socketChannel.close();
                    } else {
                        ;
                    }
                }
            }
        }
    }

    /**
     * 对SocketChannel的connect()操作进行判断,如果连接成功,则将SocketChannel注册到多路复用器Selector上,
     * 注册SelectionKey.OP_READ,如果没有直接连接成功,则说明服务端没有返回TCP握手应答消息
     * ,但这并不代表连接失败,我们需要将SocketChannel注册到多路复用器Selector上,
     * 注册SelectionKey.OP_CONNECT,当服务端返回TCPsyn-ack消息后,
     * Selector就能够轮询到这个SocketChannel处于连接就绪状态。
     *
     * @throws IOException
     */
    private void doConect() throws IOException {
        if (socketChannel.connect(new InetSocketAddress(host, port))) {
            socketChannel.register(selector, SelectionKey.OP_READ);
            doWriter(socketChannel);
        } else {
            socketChannel.register(selector, SelectionKey.OP_CONNECT);
        }
    }

    /**
     * 我们构造请求消息体,然后对其编码,写入到发送缓冲区中,最后调用SocketChannel的write方法进行发送。
     * 由于发送是异步的,所以会存在“半包写”问题,此处不再赘述。
     * 最后通过hasRemaining()方法对发送结果进行判断,如果缓冲区中的消息全部发送完成,打印"Sendorder2serversucceed."
     *
     * @param channel
     * @throws IOException
     */
    private void doWriter(SocketChannel channel) throws IOException {
        byte[] req = "QUERY TIME ORDER".getBytes();
        ByteBuffer writeBuffer = ByteBuffer.allocate(req.length);
        writeBuffer.put(req);
        writeBuffer.flip();
        channel.write(writeBuffer);
        if (!writeBuffer.hasRemaining()) {
            System.out.println("Send order 2 server succeed");
        }
    }
}