詳解怎麼實現Go超時控制

#                             。

為什麼需要逾時控制？

請求時間過長，用戶端可能已經離開本頁面了，服務端還在消耗資源處理，得到的結果沒有意義

過長時間的服務端處理會佔用過多資源，導致並發能力下降，甚至出現不可用事故

• #Go 超時控制必要性
• Go 正常都是用來寫後端服務的，一般一個請求是由多個串行或併行的子任務來完成的，每個子任務可能是另外的內部請求，那麼當這個請求超時的時候，我們就需要快速返回，釋放佔用的資源，例如goroutine，文件描述符等。

服務端常見的逾時控制

進程內的邏輯處理

讀寫客戶端請求，例如HTTP或RPC請求

呼叫其它服務端請求，包括呼叫RPC或存取DB等

• 沒有逾時控制會怎樣？
• 為了簡化本文，我們以一個請求函數

hardWork

為例，用來做啥的不重要，顧名思義，可能處理起來比較慢。

func hardWork(job interface{}) error {
    time.Sleep(time.Minute)
    return nil}func requestWork(ctx context.Context, job interface{}) error {
  return hardWork(job)}

這時客戶端看到的就一直是大家熟悉的畫面

#絕大部分用戶都不會看一分鐘菊花，早早棄你而去，空留了整個呼叫鏈路上一堆資源的佔用，本文不究其它細節，只聚焦超時實作。

下面我們來看看該怎麼實現超時，其中會有哪些坑。

第一版實作

大家可以先不往下看，自己試著想想該怎麼實作這個函數的超時，第一次嘗試：

func requestWork(ctx context.Context, job interface{}) error {
    ctx, cancel := context.WithTimeout(ctx, time.Second*2)
    defer cancel()

    done := make(chan error)
    go func() {
        done <h2>我們寫一個main 函數測試一下<span class="header-link octicon octicon-link"><pre class="brush:php;toolbar:false">func main() {
    const total = 1000
    var wg sync.WaitGroup
    wg.Add(total)
    now := time.Now()
    for i := 0; i 

跑一下試試看效果

➜ go run timeout.go
elapsed: 2.005725931s

逾時已經生效。但這樣就搞定了嗎？

goroutine 洩漏

讓我們在main函數末尾加上一行程式碼看看執行完有多少goroutine

time.Sleep(time.Minute*2)fmt.Println("number of goroutines:", runtime.NumGoroutine())

sleep 2分鐘是為了等待所有任務結束，然後我們列印一下當前goroutine數量。讓我們執行一下看看結果

➜ go run timeout.go
elapsed: 2.005725931s
number of goroutines: 1001

goroutine洩漏了，讓我們看看為啥會這樣呢？首先，

requestWork

函數在2秒鐘超時後就退出了，一旦

requestWork

函數退出，那麼

done channel

就沒有goroutine接收了，等到執行done 這行程式碼的時候就會一直卡著寫不進去，導致每個超時的請求都會一直佔用掉一個goroutine，這是一個很大的bug，等到資源耗盡的時候整個服務就失去回應了。 <code>那麼怎麼fix呢？其實也很簡單，只要make chan 的時候把buffer size 設為1，如下：

done := make(chan error, 1)

這樣就可以讓done 不管在是否超時都能寫入而不卡住goroutine。此時可能有人會問如果這時寫入一個已經沒goroutine接收的channel會不會有問題，在Go裡面channel不像我們常見的文件描述符一樣，不是必須關閉的，只是個對象而已，<code>close(channel) 只是用來告訴接收者沒有東西要寫了，沒有其它用途。

改完這一行程式碼我們再測試一次：<pre class="brush:php;toolbar:false">➜ go run timeout.go elapsed: 2.005655146s number of goroutines: 1</pre>goroutine洩漏問題解決了！

panic 無法捕獲

讓我們把

hardWork

函數實作改成

panic("oops")

修改

main

函數加上捕獲異常的程式碼如下：<pre class="brush:php;toolbar:false">go func() {   defer func() {     if p := recover(); p != nil {       fmt.Println(&quot;oops, panic&quot;)     }   }()   defer wg.Done()   requestWork(context.Background(), &quot;any&quot;)}()</pre>此時執行一下就會發現panic是無法被捕獲的，原因是因為在

requestWork

內部起的goroutine裡產生的panic其它goroutine無法捕獲。 解決方法是在

requestWork

裡加上panicChan 來處理，同樣，需要

panicChan

的buffer size 為1 ，如下：<pre class="brush:php;toolbar:false">func requestWork(ctx context.Context, job interface{}) error {     ctx, cancel := context.WithTimeout(ctx, time.Second*2)     defer cancel()     done := make(chan error, 1)     panicChan := make(chan interface{}, 1)     go func() {         defer func() {             if p := recover(); p != nil {                 panicChan &lt;p&gt;改完就可以在 &lt;code&gt;requestWork&lt;/code&gt; 的调用方处理 &lt;code&gt;panic&lt;/code&gt; 了。&lt;/p&gt;&lt;h2&gt; &lt;span class=&quot;header-link octicon octicon-link&quot;&gt;&lt;/span&gt;超时时长一定对吗？&lt;/h2&gt;&lt;p&gt;上面的 &lt;code&gt;requestWork&lt;/code&gt; 实现忽略了传入的 &lt;code&gt;ctx&lt;/code&gt; 参数，如果 &lt;code&gt;ctx&lt;/code&gt; 已有超时设置，我们一定要关注此传入的超时是不是小于这里给的2秒，如果小于，就需要用传入的超时，&lt;code&gt;go-zero/core/contextx&lt;/code&gt; 已经提供了方法帮我们一行代码搞定，只需修改如下：&lt;/p&gt;&lt;pre class=&quot;brush:php;toolbar:false&quot;&gt;ctx, cancel := contextx.ShrinkDeadline(ctx, time.Second*2)</pre><h2> <span class="header-link octicon octicon-link"></span>Data race</h2><p>这里 <code>requestWork 只是返回了一个 error 参数，如果需要返回多个参数，那么我们就需要注意 data race，此时可以通过锁来解决，具体实现参考 go-zero/zrpc/internal/serverinterceptors/timeoutinterceptor.go，这里不做赘述。

完整示例

package mainimport (
    "context"
    "fmt"
    "runtime"
    "sync"
    "time"

    "github.com/tal-tech/go-zero/core/contextx")func hardWork(job interface{}) error {
    time.Sleep(time.Second * 10)
    return nil}func requestWork(ctx context.Context, job interface{}) error {
    ctx, cancel := contextx.ShrinkDeadline(ctx, time.Second*2)
    defer cancel()

    done := make(chan error, 1)
    panicChan := make(chan interface{}, 1)
    go func() {
        defer func() {
            if p := recover(); p != nil {
                panicChan <h2>
<span class="header-link octicon octicon-link"></span>更多细节</h2><p>请参考 <code>go-zero</code> 源码：</p>

• go-zero/core/fx/timeout.go
• go-zero/zrpc/internal/clientinterceptors/timeoutinterceptor.go
• go-zero/zrpc/internal/serverinterceptors/timeoutinterceptor.go

项目地址

github.com/tal-tech/go-zero

欢迎使用 go-zero 并 star 支持我们！

以上是詳解怎麼實現Go超時控制的詳細內容。更多資訊請關注PHP中文網其他相關文章！