Go处理超时的最简单方法

【译文】原文地址


任何处理资源密集型的应用程序,超时处理是不可避免的。检查超时是有必要的,以确保超时运行的任务不会消耗应用程序的其他组件可能需要的必要资源或网络带宽。

Golang处理超时的方法非常简单。不需要复杂的代码,我们可以用channel通信和使用select语句作出超时决策来处理超时问题。

首先,最基本的。要模拟网络连接,我们将从一个模拟的服务中读取响应。我们编写一个简单结构体来接收服务的响应内容。

type Response struct {
    UserID    int    `json:"userId"`
    ID        int    `json:"id"`
    Title     string `json:"title"`
    Completed bool   `json:"completed"`
}

直截了当地,我们将写一个快速方法来获取服务中的响应,并将其返回给客户端。

import (
    "encoding/json"
    "fmt"
    "io/ioutil"
    "net/http"
)

func GetHttpResponse() (*Response, error) {
    resp, err := http.Get("https://jsonplaceholder.typicode.com/todos/1")

    if err != nil {
        return nil, fmt.Errorf("error in http call")
    }

    defer resp.Body.Close()
    byteResp, err := ioutil.ReadAll(resp.Body)

    if err != nil {
        return nil, fmt.Errorf("error in reading response")
    }

    structResp := &Response{}
    err = json.Unmarshal(byteResp, structResp)

    if err != nil {
        return nil, fmt.Errorf("error in unmarshalling response")
    }

    return structResp, nil
}

如您所见,这是一个非常简单的方法。我们仅使用Golang原生http库读取http调用中的信息,并将响应内容存放在out结构体中,在不同的步骤中处理错误。非常简单!

我们的main函数可以很简单地调用这个函数,并打印服务响应信息。

import (
    "fmt"
)
func main() {

    res, err := GetHttpResponse()

    if err != nil {
        fmt.Printf("err %v", err)
    } else {
        fmt.Printf("res %v", res)
    }

}

结果输出了一个来自模拟服务的虚拟响应信息如下:

res &{1 1 delectus aut autem false}

现在来看存在的问题,假设您的连接需要很长时间才能从模拟的服务器中获得响应,那么我们的main函数将等待不确定时间。在实际应用程序中,这是不可接受的,因为这会消耗很多资源。要解决这个问题,让我们在GetHttpResponse函数中添加一个context参数。

func GetHttpResponse(ctx context.Context) (*Response, error)

这个context将告我们何时停止尝试从网络中获取结果。为了验证这点,我们将使用select语句。Select语句是go中处理并发的默认方式,包含发送和接收channel的case。语法和switch类似。

我们先编写一个帮助函数,执行和前面相同的操作,返回结果,并将结果写入channel,并使用一个独立的goroutine来执行实际工作。为了简单起见,我们还将响应和错误包装在一个CallResponse结构体中。

type CallResponse struct {
    Resp *Response
    Err  error
}

func helper(ctx context.Context) <-chan *CallResponse {

    respChan := make(chan *CallResponse, 1)

    go func() {
        resp, err := http.Get("https://jsonplaceholder.typicode.com/todos/1")

        if err != nil {
            respChan <- &CallResponse{nil, fmt.Errorf("error in http call")}
            return
        }

        defer resp.Body.Close()
        byteResp, err := ioutil.ReadAll(resp.Body)

        if err != nil {
            respChan <- &CallResponse{nil, fmt.Errorf("error in reading response")}
            return
        }

        structResp := &Response{}
        err = json.Unmarshal(byteResp, structResp)

        if err != nil {
            respChan <- &CallResponse{nil, fmt.Errorf("error in unmarshalling response")}
        }

        respChan <- &CallResponse{structResp, nil}
    }()

    return respChan
}

如代码所示,我们创建了一个带缓存的respChan通道。然后我们执行和GetHttpResponse函数相同的工作,但是我们用一个CallResponse来代替返回响应和错误。我们在函数结束返回resChan。我们在单独的goroutine中执行网络连接,并将结果写入channel。这使我们的代码实现非阻塞。

我们的GetHttpResponse函数现在变的更简单了,因为它必须做一个简单的选择。要么从通道中读取响应要么超时退出。

func GetHttpResponse(ctx context.Context) (*Response, error) {
    select {
    case <-ctx.Done():
        return nil, fmt.Errorf("context timeout, ran out of time")
    case respChan := <-helper(ctx):
        return respChan.Resp, respChan.Err

    }
}

这个选择策略是通过select语句来完成的。以下是Done函数的定义:

Done() <-chan struct{}

Done返回一个channel,当涉及的context被取消,channel就会关闭。当context中有超时,就会在超时时对通道进行写操作。在这种情况下,代码返回一个表示超时的错误响应信息。

另一个case是,我们的helper函数能够在超时之前完成服务的响应读取,并写入channel。在这种情况下,我们在respChan变量中得到结果,并返回给客户端。

下面修改main函数,调用GetHttpResponse并传入一个1秒超时的context参数。

ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)
    defer cancel()
    res, err := GetHttpResponse(ctx)

    if err != nil {
        fmt.Printf("err %v", err)
    } else {
        fmt.Printf("res %v", res)
    }

}

运行上面代码可以得到和之前相同的响应信息:

res &{1 1 delectus aut autem false}

现在,我们将超时减少到1毫秒,以观察代码执行结果:

ctx, cancel := context.WithTimeout(context.Background(), 1*time.Millisecond)

当我们运行代码时,我们得到如下结果:

err context timeout, ran out of time

1毫秒内不足以完成网络调用。因此我们不会过多占用任何资源,而且只要context超时,我们就向客户端返回错误,而不是一直等待响应。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,132评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,802评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,566评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,858评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,867评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,695评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,064评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,705评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,915评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,677评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,796评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,432评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,041评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,992评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,223评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,185评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,535评论 2 343

推荐阅读更多精彩内容