從零講解搭建一個NIO消息服務端

本文首發於貓叔的博客 | MySelf,如需轉載,請申明出處.

假設

假設你已經瞭解並實現過了一些OIO消息服務端,並對異步消息服務端更有興趣,那麼本文或許能帶你更好的入門,並瞭解JDK部分源碼的關係流程,正如題目所說,筆者將竟可能還原,以初學者能理解的角度,講訴並構建一個NIO消息服務端。

啓動通道並註冊選擇器

啓動模式

感謝Java一直在持續更新,對應的各個API也做得越來越好了,我們本次生成 服務端套接字通道 也是使用到JDK提供的一個方式 open ,我們將啓動一個 ServerSocketChannel ,他是一個 支持同步異步模式服務端套接字通道

它是一個抽象類,官方給了推薦的方式 open 來開啓一個我們需要的 服務端套接字通道實例 。(如下的官方源碼相關注釋)

/**
 * A selectable channel for stream-oriented listening sockets.
 */
 public abstract class ServerSocketChannel
    extends AbstractSelectableChannel
    implements NetworkChannel
{
    /**
     * Opens a server-socket channel.
     */
    public static ServerSocketChannel open() throws IOException {
        return SelectorProvider.provider().openServerSocketChannel();
    }
}

那麼好了,我們現在可以確定我們第一步的代碼是什麼樣子的了!沒錯,和你想象中的一樣,這很簡單。

public class NioServer {

    public void server(int port) throws IOException{
        //1、打開服務器套接字通道
        ServerSocketChannel serverSocketChannel = ServerSocketChannel.open();
    }
}

本節的重點是 啓動模式 ,那麼這意味着,我們需要向 ServerSocketChannel 進行標識,那麼它是否提供了對用的方法設置 同步異步(阻塞非阻塞) 呢?

這很明顯,它是提供的,這也是它的核心功能之一,其實應該是它繼承的 父抽象類AbstractSelectableChannel 的實現方法: configgureBlocking(Boolean),這個方法將標識我們的 服務端套接字通道 是否阻塞模式。(如下的官方源碼相關注釋)

/**
 * Base implementation class for selectable channels.
 */
 public abstract class AbstractSelectableChannel
    extends SelectableChannel
{
    /**
     * Adjusts this channel's blocking mode.
     */
    public final SelectableChannel configureBlocking(boolean block)
        throws IOException
    {
        synchronized (regLock) {
            if (!isOpen())
                throw new ClosedChannelException();
            if (blocking == block)
                return this;
            if (block && haveValidKeys())
                throw new IllegalBlockingModeException();
            implConfigureBlocking(block);
            blocking = block;
        }
        return this;
    }
}

那麼,我們現在可以進行 啓動模式的配置 了,讀者很聰明。我們的項目Demo可以這樣寫: false爲非阻塞模式、true爲阻塞模式

public class NioServer {

    public void server(int port) throws IOException{
        //1、打開服務器套接字通道
        ServerSocketChannel serverSocketzhannel = ServerSocketChannel.open();
        //2、設定爲非阻塞、調整此通道的阻塞模式。
        serverSocketChannel.configureBlocking(false);
    }
}
若未配置阻塞模式,註冊選擇器 會報 java.nio.channels.IllegalBlockingModeException 異常,相關將於該小節大致講解說明。

套接字地址端口綁定

做過消息通訊服務器的朋友應該都清楚,我們需要向服務端 指定IP與端口 ,即使是NIO服務器也是一樣的,否則,我們的客戶端會報 java.net.ConnectException: Connection refused: connect 異常

對於NIO的地址端口綁定,我們也需要用到 ServerSocket服務器套接字 。我們知道在寫OIO服務端的時候,我們可能僅僅需要寫一句即可,如下。

    //將服務器綁定到指定端口
    final ServerSocket socket = new ServerSocket(port);

當然,JDK在實現NIO的時候就已經想到了,同樣,我們可以使用 服務器套接字通道 來獲取一個 ServerSocket服務器套接字 。這時的它並沒有綁定端口,我們需要對應綁定地址,這個類自身就有一個 bind 方法。(如下源碼相關注釋)

/**
 * This class implements server sockets. A server socket waits for
 * requests to come in over the network. It performs some operation
 * based on that request, and then possibly returns a result to the requester.
 */
public class ServerSocket implements java.io.Closeable {
    /**
     *
     * Binds the {@code ServerSocket} to a specific address
     * (IP address and port number).
     */
     public void bind(SocketAddress endpoint) throws IOException {
        bind(endpoint, 50);
    }
}

通過源碼,我們知道,綁定iP與端口 需要一個SocketAddress類,我們僅需要將 IP與端口配置到對應的SocketAddress類 中即可。其實JDK中,已經有了一個更加方便且繼承了SocketAddress的類:InetSocketAddress

InetSocketAddress有一個需要一個port爲參數的構造方法,它將創建 一個ip爲通配符、端口爲指定值的套接字地址 。這很方便我們的開發,對吧?(如下源碼相關注釋)

/**
 *
 * This class implements an IP Socket Address (IP address + port number)
 * It can also be a pair (hostname + port number), in which case an attempt
 * will be made to resolve the hostname. If resolution fails then the address
 * is said to be <I>unresolved</I> but can still be used on some circumstances
 * like connecting through a proxy.
 */
 public class InetSocketAddress
    extends SocketAddress
{
    /**
     * Creates a socket address where the IP address is the wildcard address
     * and the port number a specified value.
     */
     public InetSocketAddress(int port) {
        this(InetAddress.anyLocalAddress(), port);
    }
}

好了,那麼接下來我們的項目代碼可以繼續添加綁定IP與端口了,我想聰明的你應該有所感覺了。

public class NioServer {

    public void server(int port) throws IOException{
        //1、打開服務器套接字通道
        ServerSocketChannel serverSocketzhannel = ServerSocketChannel.open();
        //2、設定爲非阻塞、調整此通道的阻塞模式。
        serverSocketChannel.configureBlocking(false);
        //3、檢索與此通道關聯的服務器套接字。
        ServerSocket serverSocket = serverSocketChannel.socket();
        //4、此類實現 ip 套接字地址 (ip 地址 + 端口號) 
        InetSocketAddress address = new InetSocketAddress(port);
        //5、將服務器綁定到選定的套接字地址
        serverSocket.bind(address);
    }
}

正如開頭我們所說的,你的項目中不添加3-5環節的代碼並沒有問題,但是當客戶端接入時,則會報錯,因爲客戶端將要 接入的地址是連接不到的 ,如會報這樣的錯誤。

java.net.ConnectException: Connection refused: connect
    at sun.nio.ch.Net.connect0(Native Method)
    at sun.nio.ch.Net.connect(Net.java:457)
    at sun.nio.ch.Net.connect(Net.java:449)
    at sun.nio.ch.SocketChannelImpl.connect(SocketChannelImpl.java:647)
    at com.github.myself.WebClient.main(WebClient.java:16)

註冊選擇器

接下來會是 NIO實現的重點 ,可能有點難理解,如果希望大家能一次理解,完全深入有點難講明白,不過先大致點一下。

首先要先介紹以下JDK實現NIO的核心:多路複用器(Selector)——選擇器

先簡單並抽象的理解下,Java通過 選擇器來實現處理多個Channel鏈接 ,將空閒未進行數據操作的擱置,優先執行有需求的數據傳輸,即 通過一個選擇器來選擇誰需要誰不需要使用共享的線程

由此,理所當然,這樣的選擇器應該也有Java自己定義的獲取方法, 其自身的 open 就是啓動一個這樣的選擇器。(如下源碼相關注釋)

/**
 * A multiplexor of {@link SelectableChannel} objects.
 */
 public abstract class Selector implements Closeable {
     /**
     * Opens a selector.
     */
     public static Selector open() throws IOException {
        return SelectorProvider.provider().openSelector();
     }
 }

那麼現在,我們還要考慮一件事情,我們的 服務器套接字通道 要如何與 選擇器 相關聯呢?

ServerSocketChannel 有一個註冊的方法,這個方法就是將它們兩個進行了關聯,同時這個註冊方法 除了關聯選擇器外,還標識了註冊的狀態 ,讓我們先看看源碼吧。

以下的 ServerSocketChannel 繼承 ---》 AbstractSelectableChannel 繼承 ---》 SelectableChannel
/**
 * A channel that can be multiplexed via a {@link Selector}.
 */
 public abstract class SelectableChannel
    extends AbstractInterruptibleChannel
    implements Channel
{
    /**
     * Registers this channel with the given selector, returning a selection
     * key.
     */
     public final SelectionKey register(Selector sel, int ops)
        throws ClosedChannelException
    {
        return register(sel, ops, null);
    }
}

我們一般需要將選擇器註冊上去,並將 ServerSocketChannel 標識爲 接受連接 的狀態。我們先看看我們的項目代碼應該如何寫。

public class NioServer {

    public void server(int port) throws IOException{
        //1、打開服務器套接字通道
        ServerSocketChannel serverSocketzhannel = ServerSocketChannel.open();
        //2、設定爲非阻塞、調整此通道的阻塞模式。
        serverSocketChannel.configureBlocking(false);
        //3、檢索與此通道關聯的服務器套接字。
        ServerSocket serverSocket = serverSocketChannel.socket();
        //4、此類實現 ip 套接字地址 (ip 地址 + 端口號) 
        InetSocketAddress address = new InetSocketAddress(port);
        //5、將服務器綁定到選定的套接字地址
        serverSocket.bind(address);
        //6、打開Selector來處理Channel
        Selector selector = Selector.open();
        //7、將ServerSocket註冊到Selector已接受連接,註冊會判斷是否爲非阻塞模式
        SelectionKey selectionKey = serverSocketChannel.register(selector, SelectionKey.OP_ACCEPT);
        ByteBuffer readBuff = ByteBuffer.allocate(1024);
        final ByteBuffer msg = ByteBuffer.wrap("Hi!\r\n".getBytes());
        while(true){
            //下方代碼.....
        }
    }
}

注意: 我們前面說到,如果 ServerSocketChannel 沒有啓動非阻塞模式,那麼我們在啓動的時候會報 java.lang.IllegalArgumentException 異常,這是爲什麼呢? 我想我們可能需要更深入底層去看看 register 這個方法(如下源碼註釋)

/**
 * Base implementation class for selectable channels.
 */
 public abstract class AbstractSelectableChannel
    extends SelectableChannel
{
    /**
     * Registers this channel with the given selector, returning a selection key.
     */
    public final SelectionKey register(Selector sel, int ops,
                                       Object att)
        throws ClosedChannelException
    {
        synchronized (regLock) {
            if (!isOpen())
                throw new ClosedChannelException();
            if ((ops & ~validOps()) != 0)
                throw new IllegalArgumentException();
            if (blocking)
                throw new IllegalBlockingModeException();
            SelectionKey k = findKey(sel);
            if (k != null) {
                k.interestOps(ops);
                k.attach(att);
            }
            if (k == null) {
                // New registration
                synchronized (keyLock) {
                    if (!isOpen())
                        throw new ClosedChannelException();
                    k = ((AbstractSelector)sel).register(this, ops, att);
                    addKey(k);
                }
            }
            return k;
        }
    }
}

我想我們終於真相大白了,原來註冊這個方法會對 ServerSocketChannel 的一系列參數進行 校驗 ,只有通過,才能註冊成功,所以我們也明白了,爲什麼 非阻塞是false,同時我們也可以看到,它還對我們所給的標識做了校驗,一點要優先註冊 接受連接(OP_ACCEPT) 這個狀態才行,不然依舊會報 java.lang.IllegalArgumentException 異常。

這裏解釋一下,之所以只接受 OP_ACCEPT ,是因爲如果沒有一個接受其他鏈接的主服務,那麼通信根本無從說起,同時這樣的標識在我們的NIO服務端中 只允許標識一次(一個ServerSocketChannel)

可能大家還會好奇有什麼標識,我想源碼的說明確實寫的很清楚了。

/**
 * Operation-set bit for read operations.
 */
 public static final int OP_READ = 1 << 0;

/**
 * Operation-set bit for write operations.
 */
 public static final int OP_WRITE = 1 << 2;

/**
 * Operation-set bit for socket-connect operations.
 */
 public static final int OP_CONNECT = 1 << 3;

/**
 * Operation-set bit for socket-accept operations.
 */
 public static final int OP_ACCEPT = 1 << 4;

好了,這裏給一個調試截圖,希望大家也可以慢慢的摸索一下。

Image Text

注意這裏的服務端並沒有構建完成哦,我們還需要下面的幾個步驟。

NIO選擇實例與興趣點

客戶端代碼

說到這裏,我們暫時先休息下,轉頭看看 客戶端的代碼 吧,這裏就簡單的介紹下,我們將建立 一個針對服務地址端口的連接 ,然後不停的循環 寫操作與讀操作 ,沒有對客戶端進行 關閉操作

大家如果有興趣的話,也可以自己調試,並看看部分類的JDK源碼,如下給出本項目案例的客戶端代碼。

public class WebClient {
    public static void main(String[] args) throws IOException {
        try {
            SocketChannel socketChannel = SocketChannel.open();
            socketChannel.connect(new InetSocketAddress("0.0.0.0",8090));

            ByteBuffer writeBuffer = ByteBuffer.allocate(32);
            ByteBuffer readBuffer = ByteBuffer.allocate(32);

            writeBuffer.put("hello".getBytes());
            writeBuffer.flip();
            while (true){
                writeBuffer.rewind();
                socketChannel.write(writeBuffer);
                readBuffer.clear();
                socketChannel.read(readBuffer);
                readBuffer.flip();
                System.out.println(new String(readBuffer.array()));
            }
        }catch (IOException e){
            e.printStackTrace();
        }
    }
}

準備IO接入操作

這裏有點複雜,我也儘可能的思考了表達的方式,首先我們先明確一下,所有的連接都會被Selector所囊括,即我們要獲取新接入的連接,也要通過Selector來獲取,我們一開始啓動的 服務器套接字通道ServerSocketChannel 起到一個接入入口(或許不夠準確)的作用,客戶端連接通過IP與端口進入後,會 被註冊的Selector所獲取 到,成爲 Selector 其中的一員。

但是這裏的一員 並不會包括一開始註冊並被標誌爲接收連接ServerSocketChannel

Selector有這樣一個方法,它會自動去等待新的連接事件,如果沒有連接接入,那麼它將一直處於阻塞狀態。通過字面意思我們可以大致這樣寫代碼。

while(true){
    try{
        //1、等到需要處理的新事件:阻塞將一直持續到下一個傳入事件
        selector.select();
    }catch(IOException e){
        e.printStackTrace();
        break;
    }
}

那麼這樣寫好像有點像樣,畢竟異常我們也捕獲了,同時也使用了剛剛 開啓並註冊完畢的選擇器Selector

讓我們看看源碼中對於這個方法 select 的註釋吧。

/**
 * A multiplexor of {@link SelectableChannel} objects.
 */
 public abstract class Selector implements Closeable {
     /**
     * Selects a set of keys whose corresponding channels are ready for I/O
     * operations.
     */
     public abstract int select() throws IOException;
 }

好的,看樣子是對的,它將返回一組套接字通道已經準備好執行I/O操作的鍵。那麼這個Key究竟是什麼呢?

這裏可能直觀的感受下會更好。如下圖是我調試下看到的key對象,我想大家應該可以理解了,這個Key中也會 存放對應連接的Channel與Selector

Image Text

具體的內部更深層的就探討了。那麼這也解決了我們接下來的 一個疑問 ,我們要怎麼向Selector拿連接進來的實例呢?

答案很明顯,我們僅需要 獲取到這個Keys 就好了。

選擇鍵集合操作

對於獲取Keys這個現在應該已經不是什麼問題了,通過上面章節的瞭解,我想大家也可以想到這樣的大致語法。

//獲取所有接收事件的SelectionKey實例
Set<SelectionKey> readykeys = selector.selectedKeys();

大家或許會好奇,這裏的Key對象居然是前面的 SelectionKey.OP_ACCEPT 對象,是的,這也是接下來要講的,這很奇妙,也很好玩。

前面說到的標識,這是每一個Key自有的,並且是可以 改變的狀態 ,在剛剛連接的時候,或許我應該大致的描述一下 一個新連接進入選擇器後的流程 :select方法將接受到新接入的連接事件,它會被Selector以Key的形式存儲,這時我們需要 對其進行判斷 ,是否是已經就緒可以被接受的連接,如果是,這時我們需要 獲取這個連接 ,同時也將其設定爲 非阻塞的狀態 ,並將它 註冊到選擇器上(當然,這時的標識就不能是一開始的 OP_ACCEPT,你可以選擇性的 註冊它的標識 ,之後我們可以通過循環遍歷Keys來,讓 某一標識的連接去執行對應的操作

說到這裏,我想部分新手可能會有點模糊,我想我還是把接下來的代碼都一起放出來吧,大家先看看是否能夠再次結合文本進行了解。

while (true){
    try {
        //等到需要處理的新事件:阻塞將一直持續到下一個傳入事件
        selector.select();
    }catch (IOException e){
        e.printStackTrace();
        break;
    }
    //獲取所有接收事件的SelectionKey實例
    Set<SelectionKey> readykeys = selector.selectedKeys();
    Iterator<SelectionKey> iterator = readykeys.iterator();
    while(iterator.hasNext()){
        SelectionKey key = iterator.next();
        iterator.remove();
        try {
            //檢查事件是否是一個新的已經就緒可以被接受的連接
            if (key.isAcceptable()){
                //channel:返回爲其創建此鍵的通道。 即使在取消密鑰後, 此方法仍將繼續返回通道。
                ServerSocketChannel server = (ServerSocketChannel)key.channel();
                //可選擇的通道, 用於面向流的連接插槽。
                SocketChannel client = server.accept();
                //設定爲非阻塞
                client.configureBlocking(false);
                //接受客戶端,並將它註冊到選擇器,並添加附件
                client.register(selector,SelectionKey.OP_WRITE | SelectionKey.OP_READ,msg.duplicate());
                System.out.println("Accepted connection from " + client);
            }
            //檢查套接字是否已經準備好讀數據
            if (key.isReadable()){
                SocketChannel client = (SocketChannel)key.channel();
                readBuff.clear();
                client.read(readBuff);
                readBuff.flip();
                System.out.println("received:"+new String(readBuff.array()));
                //將此鍵的興趣集設置爲給定的值。 OP_WRITE
                key.interestOps(SelectionKey.OP_WRITE);
            }
            //檢查套接字是否已經準備好寫數據
            if (key.isWritable()){
                SocketChannel client = (SocketChannel)key.channel();
                //attachment : 檢索當前附件
                ByteBuffer buffer = (ByteBuffer)key.attachment();
                buffer.rewind();
                client.write(buffer);
                //將此鍵的興趣集設置爲給定的值。 OP_READ
                key.interestOps(SelectionKey.OP_READ);
            }
        }catch (IOException e){
            e.printStackTrace();
        }
    }
}
提示:讀到此處,還請各位讀者能運行整個demo,並調試下,看看與自己理解的是否有差別。

流程效果

以下我簡單敘述一下,我在調試時的理解與效果。

  • 1、啓動服務端後,運行到 selector.select(); 後阻塞,因爲沒有監聽到新的連接。
  • 2、啓動客戶端後,selector.select() 監聽到新連接,往下執行獲取到的Keys的size爲1,進入Key標識分支判斷
  • 3、key.isAcceptable() 首次接入爲true,設置爲非阻塞,並註釋到選擇器中修改標識爲 SelectionKey.OP_WRITE | SelectionKey.OP_READ ,同時添加附件信息 msg.duplicate() ,首次循環結束
  • 4、二次循環,連接未關閉,獲取到的Keys的size爲1,進入Key標識分支判斷。
  • 5、由於第一次該Key標識改變,所以這次 key.isAcceptable() 爲false,而由於改了標識,所以接下來的 key.isReadable()key.isWritable() 都爲true,執行讀寫操作,循環結束。
  • 6、接下來的循環,基本上是key.isReadable()key.isWritable() 都爲true,執行讀寫操作。
  • 7、設想一下,如果多加一條鏈接是什麼效果。

回顧

這裏給出幾個代碼的注意點,希望大家可以自己去了解學習。

  • 1、關於 ByteBuffer 本文並不重點講解,大家可以自行了解
  • 2、關於Key標識判斷的代碼,以下兩句的刪減是否會對代碼有所影響呢?
key.interestOps(SelectionKey.OP_WRITE);
key.interestOps(SelectionKey.OP_READ);
  • 3、如果刪除了2中的代碼,並把客戶端註冊選擇器並給標識的代碼改爲以下,那麼項目運行效果怎麼樣呢?
client.register(selector, SelectionKey.OP_READ,msg.duplicate());
  • 4、如果改了3的代碼,可是不刪除2的代碼,那麼效果又是怎麼樣呢?
答案留給讀者去揭曉吧,如果你有答案,歡迎留言。

個人相關項目

Image text

InChat : 一個輕量級、高效率的支持多端(應用與硬件Iot)的異步網絡應用通訊框架

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章