Kotlin協(xié)程Channel特點及使用細節(jié)詳解

更新時間：2022年12月08日 09:21:01 作者：無糖可樂愛好者

這篇文章主要為大家介紹了Kotlin協(xié)程Channel特點及使用細節(jié)詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪

正文

在協(xié)程啟動模式中已經(jīng)知道async是可以返回結(jié)果的，但是只返回一個，那么在復(fù)雜場景下就會不夠用了，所以Channel就出現(xiàn)了。

1.認識Channel

Channel的意思是管道、通道，用圖表示如下：

Channel的左邊是發(fā)送方，右邊是接收方，中間則是消息，那么代碼表示就是下面這樣：

fun main() {
    channelTest()
}
fun channelTest() = runBlocking {
    val channel = Channel<Int>()            //關(guān)鍵點①
    launch {
        for (i in 1..3) {
            channel.send(i)                 //關(guān)鍵點②
            logX("send: $i")
        }
    }
    launch {
        for (i in channel) {                //關(guān)鍵點③
            logX("receiver: $i")
        }
    }
    logX("end")
}
//輸出結(jié)果：
//================================
//end 
//Thread:main @coroutine#1
//================================
//================================
//receiver: 1 
//Thread:main @coroutine#3
//================================
//================================
//send: 1 
//Thread:main @coroutine#2
//================================
//================================
//send: 2 
//Thread:main @coroutine#2
//================================
//================================
//receiver: 2 
//Thread:main @coroutine#3
//================================
//================================
//receiver: 3 
//Thread:main @coroutine#3
//================================
//================================
//send: 3 
//Thread:main @coroutine#2
//================================

上面的代碼中啟動了兩個協(xié)程，一個發(fā)送，一個接收，還有幾個關(guān)鍵點：

關(guān)鍵點①：通過Channel創(chuàng)建一個管道，其中泛型Int表示發(fā)送的數(shù)據(jù)類型；
關(guān)鍵點②：啟動一個協(xié)程通過send發(fā)送數(shù)據(jù)，send是一個掛起函數(shù)；
關(guān)鍵點③：啟動一個協(xié)程遍歷channel打印出接收到的消息。

那么這里還有一個問題，在執(zhí)行完上述代碼后程序并沒有終止，那要如何終止程序呢？

很簡單，在發(fā)送完所有消息后調(diào)用close方法即可。

launch {
        for (i in 1..3) {
            channel.send(i)                 //關(guān)鍵點②
            logX("send: $i")
        }
//			修改點
//			  ↓
        channel.close()
    }

Channel也是一種協(xié)程資源，用完后如果不關(guān)閉那么這個資源就會一直被占用。

public fun <E> Channel(
    capacity: Int = RENDEZVOUS,
    onBufferOverflow: BufferOverflow = BufferOverflow.SUSPEND,
    onUndeliveredElement: ((E) -> Unit)? = null
): Channel<E> =
    when (capacity) {
        RENDEZVOUS -> {
             ...
        }
        CONFLATED -> {
           ...
        }
        UNLIMITED -> {
            ...
        }
        BUFFERED -> { 
            ...
        }
        else -> {
            ...
        }
    }

Channel中有三個參數(shù)：

capacity ：代表管道的容量，默認值為RENDEZVOUS，代表容量為0，除此之外還有三個類型：

CONFLATED：代表容量為1，新的數(shù)據(jù)會替代舊的數(shù)據(jù)；
UNLIMITED：代表無限容量；
BUFFERED：代表具備一定緩存的容量，默認情況下是64，具體容量由VM參數(shù)kotlinx.coroutines.channels.defaultBuffer決定。
onBufferOverflow ：代表緩沖策略，也就是當緩沖的容量滿了之后要怎么做。默認值為SUSPEND，表示在緩沖區(qū)溢出時掛起。除此之外還有兩個類型：

DROP_OLDEST：在緩沖區(qū)溢出時刪除最舊的值，向緩沖區(qū)添加新值，不要掛起；

DROP_LATEST：在緩沖區(qū)溢出時，立即刪除正在添加到緩沖區(qū)的最新值(以便緩沖區(qū)內(nèi)容保持不變)，不要掛起。

onUndeliveredElement ：它相當于一個異常處理回調(diào)。當管道中的某些數(shù)據(jù)沒有被成功接收的時候，這個回調(diào)就會被調(diào)用

現(xiàn)在寫個案例看一下capacity在其他類型下的區(qū)別

/**
 * Channel.CONFLATED
 */
fun channelTest() = runBlocking {
    val channel = Channel<Int>(Channel.CONFLATED)
    launch {
        for (i in 1..4) {
            channel.send(i)
            println("send: $i")
        }
        channel.close()
    }
    launch {
        for (i in channel) {
            println("receiver: $i")
        }
    }
    println("end")
}
//輸出結(jié)果：
//end
//send: 1
//send: 2
//send: 3
//send: 4
//receiver: 4
/**
 * Channel.UNLIMITED
 */
fun channelTest() = runBlocking {
    val channel = Channel<Int>(Channel.UNLIMITED)
    launch {
        for (i in 1..4) {
            channel.send(i)
            println("send: $i")
        }
        channel.close()
    }
    launch {
        for (i in channel) {
            println("receiver: $i")
        }
    }
    println("end")
}
//輸出結(jié)果：
//end
//send: 1
//send: 2
//send: 3
//send: 4
//receiver: 1
//receiver: 2
//receiver: 3
//receiver: 4
/**
 * Channel.BUFFERED
 */
fun channelTest() = runBlocking {
    val channel = Channel<Int>(Channel.BUFFERED)
    launch {
        for (i in 1..4) {
            channel.send(i)
            println("send: $i")
        }
        channel.close()
    }
    launch {
        for (i in channel) {
            println("receiver: $i")
        }
    }
    println("end")
}
//輸出結(jié)果：
//end
//send: 1
//send: 2
//send: 3
//send: 4
//receiver: 1
//receiver: 2
//receiver: 3
//receiver: 4

再看一下onBufferOverflow在其他類型下的區(qū)別

/**
 * capacity = 3,onBufferOverflow = BufferOverflow.DROP_OLDEST
 * 緩沖區(qū)設(shè)置為3，緩沖區(qū)溢出時刪除最舊的值，向緩沖區(qū)添加新值
 */
fun channelTest() = runBlocking {
    val channel = Channel<Int>(
        capacity = 3,
        onBufferOverflow = BufferOverflow.DROP_OLDEST
    )
    launch {
        for (i in 1..4) {
            channel.send(i)
            println("send: $i")
        }
        channel.close()
    }
    launch {
        for (i in channel) {
            println("receiver: $i")
        }
    }
    println("end")
}
//輸出結(jié)果：
//end
//send: 1
//send: 2
//send: 3
//send: 4
//receiver: 2
//receiver: 3
//receiver: 4
/**
 * capacity = 3,onBufferOverflow = BufferOverflow.DROP_LATEST
 * 緩沖區(qū)設(shè)置為3，緩沖區(qū)溢出時立即刪除正在添加到緩沖區(qū)的最新值
 */
fun channelTest() = runBlocking {
    val channel = Channel<Int>(
        capacity = 3,
        onBufferOverflow = BufferOverflow.DROP_LATEST
    )
    launch {
        for (i in 1..4) {
            channel.send(i)
            println("send: $i")
        }
        channel.close()
    }
    launch {
        for (i in channel) {
            println("receiver: $i")
        }
    }
    println("end")
}
//輸出結(jié)果：
//end
//send: 1
//send: 2
//send: 3
//send: 4
//receiver: 1
//receiver: 2
//receiver: 3

再看一下onUndeliveredElement要如何使用

/**
 * capacity = 2,onBufferOverflow = BufferOverflow.DROP_LATEST， onUndeliveredElement
 * 緩沖區(qū)設(shè)置為2，緩沖區(qū)溢出時立即刪除正在添加到緩沖區(qū)的最新值
 * 接收一個數(shù)據(jù)后取消接收其他數(shù)據(jù)
 */
fun channelTest() = runBlocking {
    val channel = Channel<Int>(
        capacity = 2,
        onBufferOverflow = BufferOverflow.DROP_LATEST,
        onUndeliveredElement = {
            println("onUndeliveredElement: $it")
        }
    )
    launch {
        for (i in 1..4) {
            channel.send(i)
            println("send: $i")
        }
    }
    println("receive：${channel.receive()}")
    channel.cancel()
}
//輸出結(jié)果：
//send: 1
//send: 2
//send: 3
//send: 4
//receive：1
//onUndeliveredElement: 2
//onUndeliveredElement: 3

上面的代碼容量設(shè)置為2，緩沖策略是刪除正在添加到緩沖區(qū)的最新值，接收一個數(shù)據(jù)后立即取消接收其他數(shù)據(jù)，也就是說接收到了【send: 1】的數(shù)據(jù)【receive：1】，【send: 4】的數(shù)據(jù)被緩沖策略刪除了，由于接收消息的同道已經(jīng)被取消了那么【send: 2】和【send: 3】的數(shù)據(jù)就只能在異常中被處理，從輸出結(jié)果就可以看到。

從上面的代碼示例可以總結(jié)出它的應(yīng)用場景：接收方很關(guān)心數(shù)據(jù)是否被消費，例如企業(yè)微信、釘釘?shù)南⑹欠褚炎x的狀態(tài)，對于異常處理那塊的場景就像是發(fā)送消息過程中消息沒有被發(fā)送出去，那么接收方就無法接受到這個消息。

2.Channel使用中的細節(jié)

前面在使用Channel時為了讓程序終止在發(fā)送完成后調(diào)用了channel.close()，但是這個很容易被忘記，忘記添加就會造成程序無法終止的問題，那么Produce就誕生了，它是一個高階函數(shù)。

fun produceTest() = runBlocking {
    val channel: ReceiveChannel<Int> = produce {
        for (i in 1..4) {
            send(i)
        }
    }
    launch {
        for (i in channel) {
            println("receive: $i")
        }
    }
    println("end")
}
//輸出結(jié)果：
//end
//receive: 1
//receive: 2
//receive: 3
//receive: 4
//Process finished with exit code 0

可以看到?jīng)]有加入close代碼就可以正常結(jié)束，上面發(fā)送了4條數(shù)據(jù)，那么我要是接收5條數(shù)據(jù)會不會有什么問題？

fun produceTest() = runBlocking {
    val channel: ReceiveChannel<Int> = produce {
        for (i in 1..4) {
            send(i)
        }
    }
    println("receive: ${channel.receive()}")
    println("receive: ${channel.receive()}")
    println("receive: ${channel.receive()}")
    println("receive: ${channel.receive()}")
    println("receive: ${channel.receive()}")
    println("end")
}
//輸出結(jié)果：
//receive: 1
//receive: 2
//receive: 3
//receive: 4
//ClosedReceiveChannelException: Channel was closed

可以看到當我接收第5條數(shù)據(jù)的時候報出channel被關(guān)閉的提示，也就是說produce確實會在消息發(fā)送完畢后關(guān)閉通道。

業(yè)務(wù)開發(fā)中有可能我們確實需要對channel發(fā)送的消息進行單獨處理，那么也許并不知道具體發(fā)送了幾條數(shù)據(jù)，如果接收數(shù)據(jù)數(shù)量超過發(fā)送數(shù)據(jù)數(shù)量就會出現(xiàn)錯誤，那有沒有像isClose這類的方法可以在接收前判斷是否被關(guān)閉呢？有的，在Channel中還有兩個變量：

//如果該通道已通過調(diào)用[close]關(guān)閉，則返回' true '。這意味著調(diào)用[send]將導致異常。
public val isClosedForSend: Boolean
//如果通過在SendChannel端調(diào)用close關(guān)閉了此通道，
//并且已經(jīng)接收到以前發(fā)送的所有項目，則返回true。
public val isClosedForReceive: Boolean

那么安全的調(diào)用channel.receive()接收就可以這么寫

fun produceTest() = runBlocking {
    val channel: ReceiveChannel<Int> = produce(capacity = 3) {
        (1..4).forEach {
            send(it)
            println("Send $it")
        }
    }
    while (!channel.isClosedForReceive) {
        println("receive: ${channel.receive()}")
    }
    println("end")
}
//輸出結(jié)果：
//Send 1
//Send 2
//Send 3
//Send 4
//receive: 1
//receive: 2
//receive: 3
//receive: 4
//end

但是這里會有一個問題，不定義capacity的數(shù)量

fun produceTest() = runBlocking {
    //										變化在這里
    //											↓
    val channel: ReceiveChannel<Int> = produce {
        (1..4).forEach {
            send(it)
            println("Send $it")
        }
    }
    while (!channel.isClosedForReceive) {
        println("receive: ${channel.receive()}")
    }
    println("end")
}
//輸出結(jié)果：
//Send 1
//receive: 1
//receive: 2
//Send 2
//Send 3
//receive: 3
//receive: 4
//Send 4
//
//ClosedReceiveChannelException: Channel was closed

可以看到send發(fā)送的數(shù)據(jù)全部都被接收了，但是還是報出channel被關(guān)閉的錯誤，原因在注釋中已經(jīng)寫明：如果通過在SendChannel端調(diào)用close關(guān)閉了此通道，并且已經(jīng)接收到以前發(fā)送的所有項目，則返回true。

這意味著調(diào)用receive將導致closereceivechannelexception。 所以channel.receive()要慎用?？梢杂?code>channel.consumeEach代替

fun produceTest() = runBlocking {
    val channel: ReceiveChannel<Int> = produce {
        (1..4).forEach {
            send(it)
            println("Send $it")
        }
    }
    //變化在這里    
    channel.consumeEach {
        println("receive: $it")
    }
    println("end")
}
//輸出結(jié)果：
//Send 1
//receive: 1
//receive: 2
//Send 2
//Send 3
//receive: 3
//receive: 4
//Send 4
//end

3.Channe的特點

Channel主要你用來傳遞數(shù)據(jù)流的，這個數(shù)據(jù)流指的是多個數(shù)據(jù)組合形成別的流，與它形成鮮明對比的是async、掛起函數(shù)。

數(shù)據(jù)流的傳輸，有發(fā)送就有接收，而Channel是完全符合這一點的。發(fā)送與接收存在兩種情況：

數(shù)據(jù)流的發(fā)送了但是還沒有被接收，沒有接收則不再進行發(fā)送消息，例如文件的傳輸；
數(shù)據(jù)流的發(fā)送了不管有沒有被接收，都要繼續(xù)發(fā)送消息，例如微信聊天。

Channel符合第二個結(jié)論，無論發(fā)送的數(shù)據(jù)是否被消費或者說被接收，Channel都會進行工作。我們來證明一下這個結(jié)論。

/**
 * 消息容量為10，發(fā)送4條數(shù)據(jù)
 * 無論消息是否被接收都會吧消息發(fā)送完畢
 */
fun produceTest() = runBlocking {
    val channel: ReceiveChannel<Int> = produce(capacity = 10) {
        (1..4).forEach {
            send(it)
            println("Send $it")
        }
    }
    println("end")
}
//輸出結(jié)果：
//end
//Send 1
//Send 2
//Send 3
//Send 4
/**
 * 消息容量改為默認，默認值時0，發(fā)送4條數(shù)據(jù)
 * Channel依舊是在工作的，只是說在調(diào)用send方法的時候
 * 接收方還沒有準備完畢且容量為0，所以會被掛起，程序一直無法退出
 */
fun produceTest() = runBlocking {
    val channel: ReceiveChannel<Int> = produce {
        (1..4).forEach {
            send(it)
            println("Send $it")
        }
    }
    println("end")
}
//輸出結(jié)果：
//end
//程序沒有結(jié)束

通過上面的代碼引出一個結(jié)論：Channel是“熱” 的。不管接收方是否存在，Channel是一定會工作的。類似于自來水廠向像居民提供水源，發(fā)電廠向居民提供電能。