Go context（上下文）https get 请求示例

Myth丶恋晨 2023-10-11 23:06 11阅读 0赞

#### 阅读目录 ####

*  context（上下文）
 *   *  https 验证 get 请求是否成功示例
     *  https get 请求打印 JSON 数据数据
     *  确保 cancel() 函数被执行上面代码为执行 cancel

## context（上下文） ##

Go编程语言中，“context”（上下文）是一个重要的概念和类型。

它是Go标准库中的一个包（context包）提供的一个机制，用于在并发操作中传递请求的相关信息。

Go的上下文（context）是一个可被多个goroutine（Go中的轻量级线程）安全地访问的数据结构，它可以包含请求的截止日期、超时时间、取消信号、认证令牌、请求跟踪ID等与请求相关的信息。

> 上下文（context）被广泛用于管理并发操作，特别是在处理HTTP请求、处理长时间运行的任务、连接数据库或调用外部服务等场景下。  
>   
> 它允许在整个请求处理链中传递上下文信息，以便在不同的函数或模块中共享和使用这些信息。

Go 的 context 包提供了创建、传递和取消上下文的功能，以便实现请求超时、取消操作、传递请求相关的值等功能。

它为 Go 程序提供了一种优雅且可靠的方法来处理并发操作中的上下文信息。

+------------------+
    |    Main Goroutine    |
    +------------------+
            |
            |           +----------------------+
            |           |       Goroutine 1      |
            +---------->|                        |
                        |     +----------------------+
                        |     |        Goroutine 2       |
                        |     |                          |
                        |     +----------------------+
                        |     |
                        |     |     +-----------------------+
                        +---->|         Goroutine 3        |
                              |                             |
                              +-----------------------+

### https 验证 get 请求是否成功示例 ###

package main
    
    import (
    	"context"
    	"fmt"
    	"net/http"
    	"time"
    )
    
    func main() {
        
    	// 创建一个上下文对象
    	ctx := context.Background()
    
    	// 设置超时时间为5秒钟
    	ctx, cancel := context.WithTimeout(ctx, 5*time.Second)
    	defer cancel()
    
    	// 创建一个带有上下文的HTTP请求
    	req, err := http.NewRequestWithContext(ctx, http.MethodGet, "https://unpkg.com/outeres@0.0.11/json/table/user.json", nil)
    	if err != nil {
        
    		fmt.Println("创建请求失败:", err)
    		return
    	}
    
    	// 发送请求
    	client := http.Client{
        }
    	resp, err := client.Do(req)
    	if err != nil {
        
    		fmt.Println("发送请求失败:", err)
    		return
    	}
    	defer resp.Body.Close()
    
    	// 处理响应
    	fmt.Println("请求成功，状态码:", resp.StatusCode)
    	// ... 进一步处理响应
    }

![在这里插入图片描述][dbb57c1305244a4fb9bd0c0cbcf9cbbd.png]

ctx := context.Background()
    ctx, cancel := context.WithTimeout(ctx, 5*time.Second)
    defer cancel()

1 首先，我们创建一个空白的上下文对象 `ctx := context.Background()`。  
这个上下文对象是一个空的初始上下文，不包含任何额外的信息或超时设置。

2 接下来，我们使用 `context.WithTimeout` 函数创建一个带有超时时间的上下文对象。这个函数接受一个现有的上下文对象和一个持续时间（在这里是5秒钟），并返回一个新的上下文对象和一个取消函数。

context.WithTimeout 函数会基于现有的上下文对象创建一个带有超时设置的上下文。这意味着在超过指定的超时时间后，上下文会自动发出取消信号。

在这段代码的最后，我们使用 defer 语句来调用取消函数 cancel()。

defer 语句会在当前函数返回之前执行，确保取消函数被调用。这样做是为了避免上下文泄露，即确保在函数执行结束时取消上下文对象，释放相关资源。

> 通过以上代码，我们创建了一个带有超时设置的上下文对象，并在适当的时候取消该上下文对象。这样可以确保我们的程序在超时或取消的情况下能够及时退出或释放相关资源，以提高程序的可靠性和资源利用效率。

client.Do(req) Go语言中用于发送HTTP请求的方法调用。

### https get 请求打印 JSON 数据数据 ###

`https://unpkg.com/outeres@0.0.11/json/table/user.json`  
![在这里插入图片描述][e19466bc804746768fe4c53bc3fde912.png]

package main
    
    import (
    	"context"
    	"encoding/json"
    	"fmt"
    	"net/http"
    	"time"
    )
    
    type User struct {
        
    	ID         int     `json:"id"`
    	Username   string  `json:"username"`
    	Sex        string  `json:"sex"`
    	City       string  `json:"city"`
    	Sign       string  `json:"sign"`
    	Experience int     `json:"experience"`
    	Logins     int     `json:"logins"`
    	Words      int     `json:"words"`
    	Classify   string  `json:"classify"`
    	Score      float64 `json:"score"`
    }
    
    type ResponseData struct {
        
    	Code  int    `json:"code"`
    	Msg   string `json:"msg"`
    	Count int    `json:"count"`
    	Data  []User `json:"data"`
    }
    
    func main() {
        
    	// 创建一个上下文对象
    	ctx := context.Background()
    
    	// 设置超时时间为5秒钟
    	ctx, cancel := context.WithTimeout(ctx, 5*time.Second)
    	defer cancel()
    
    	// 创建一个带有上下文的HTTP请求
    	req, err := http.NewRequestWithContext(ctx, http.MethodGet, "https://unpkg.com/outeres@0.0.11/json/table/user.json", nil)
    	if err != nil {
        
    		fmt.Println("创建请求失败:", err)
    		return
    	}
    
    	// 发送请求
    	client := http.Client{
        }
    	resp, err := client.Do(req)
    	if err != nil {
        
    		fmt.Println("发送请求失败:", err)
    		return
    	}
    	defer resp.Body.Close()
    
    	// 处理响应
    	fmt.Println("请求成功，状态码:", resp.StatusCode)
    
    	// 解码JSON响应
    	var responseData ResponseData
    	err = json.NewDecoder(resp.Body).Decode(&responseData)
    	if err != nil {
        
    		fmt.Println("解码JSON失败:", err)
    		return
    	}
    
    	// 打印获取到的JSON数据
    	fmt.Println("获取到的JSON数据:")
    	for _, user := range responseData.Data {
        
    		fmt.Printf("ID: %d, Username: %s, City: %s\n", user.ID, user.Username, user.City)
    	}
    }

![在这里插入图片描述][5fb11e29a2d348bd85162aed8f53d856.png]

### 确保 cancel() 函数被执行上面代码为执行 cancel ###

defer cancel()是一个延迟调用的语句，它会在包含它的函数即将返回时执行，以确保上下文的取消操作被执行。

在这段代码中，由于main函数没有显示地返回，所以defer cancel()语句不会被执行。main函数在执行完最后一条语句后会自动退出，不会等待cancel()函数的调用。

要确保cancel()函数被调用，您可以通过添加一个显示的return语句来提前退出main函数，或者在代码的其他位置调用cancel()函数。

以下是修改后的示例代码，以确保cancel()函数被执行：

package main
    
    import (
    	"context"
    	"fmt"
    	"net/http"
    	"time"
    )
    
    func main() {
        
    	ctx := context.Background()
    	ctx, cancel := context.WithTimeout(ctx, 5*time.Second)
    	defer cancel()
    
    	req, err := http.NewRequestWithContext(ctx, http.MethodGet, "https://api.example.com/data", nil)
    	if err != nil {
        
    		fmt.Println("创建请求失败:", err)
    		return
    	}
    
    	client := http.Client{
        }
    	resp, err := client.Do(req)
    	if err != nil {
        
    		fmt.Println("发送请求失败:", err)
    		cancel() // 调用cancel()函数以确保上下文取消
    		return
    	}
    	defer resp.Body.Close()
    
    	fmt.Println("请求成功，状态码:", resp.StatusCode)
    }

在修改后的代码中，我们在错误处理的分支中添加了cancel()函数的调用，以确保在发生错误时上下文被正确取消。

这样可以避免潜在的资源泄漏，并按预期执行cancel()函数。

[dbb57c1305244a4fb9bd0c0cbcf9cbbd.png]: https://img-blog.csdnimg.cn/dbb57c1305244a4fb9bd0c0cbcf9cbbd.png
[e19466bc804746768fe4c53bc3fde912.png]: https://img-blog.csdnimg.cn/e19466bc804746768fe4c53bc3fde912.png
[5fb11e29a2d348bd85162aed8f53d856.png]: https://img-blog.csdnimg.cn/5fb11e29a2d348bd85162aed8f53d856.png