常用标准库
2023年12月22日大约 25 分钟约 4955 字
IO操作
输入输出的底层原理
- 终端其实是一个文件，相关实例如下：
- os.Stdin：标准输入的文件实例，类型为*File
- os.Stdout：标准输出的文件实例，类型为*File
- os.Stderr：标准错误输出的文件实例，类型为*File
以文件的方式操作终端:
import "os"
func main() {
var buf [16]byte
os.Stdin.Read(buf[:])
os.Stdin.WriteString(string(buf[:]))
}文件操作相关API
- func Create(name string) (file *File, err Error)
- 根据提供的文件名创建新的文件，返回一个文件对象，默认权限是0666
- func NewFile(fd uintptr, name string) *File
- 根据文件描述符创建相应的文件，返回一个文件对象
- func Open(name string) (file *File, err Error)
- 只读方式打开一个名称为name的文件
- func OpenFile(name string, flag int, perm uint32) (file *File, err Error)
- 打开名称为name的文件，flag是打开的方式，只读、读写等，perm是权限
- func (file *File) Write(b []byte) (n int, err Error)
- 写入byte类型的信息到文件
- func (file *File) WriteAt(b []byte, off int64) (n int, err Error)
- 在指定位置开始写入byte类型的信息
- func (file *File) WriteString(s string) (ret int, err Error)
- 写入string信息到文件
- func (file *File) Read(b []byte) (n int, err Error)
- 读取数据到b中
- func (file *File) ReadAt(b []byte, off int64) (n int, err Error)
- 从off开始读取数据到b中
- func Remove(name string) Error
- 删除文件名为name的文件
打开和关闭文件
os.Open()函数能够打开一个文件，返回一个*File和一个err。对得到的文件实例调用close()方法能够关闭文件。
package main
import (
"fmt"
"os"
)
func main() {
file, err := os.Open("./hello.txt")
if err != nil {
fmt.Println("open file failed!, err:", err)
return
}
file.Close()
}写文件
package main
import (
"fmt"
"os"
)
func main() {
file, err := os.Open("hello.txt")
if err != nil {
fmt.Println("open file failed!, err:", err)
return
}
defer file.Close()
for i := 0; i < 5; i++ {
file.WriteString("ab\n")
file.Write([]byte("cde\n"))
}
}读文件
文件读取可以用file.Read()和file.ReadAt()，读到文件末尾会返回io.EOF的错误
package main
import (
"fmt"
"io"
"os"
)
func main() {
file, err := os.Open("hello.txt")
if err != nil {
fmt.Println("open file failed!, err:", err)
return
}
defer file.Close()
//定义接收文件读取的字节数组
var buf [128]byte
var content []byte
for {
n, err := file.Read(buf[:])
if err == io.EOF {
break
}
if err != nil {
fmt.Println("read file err ", err)
return
}
content = append(content, buf[:n]...)
}
fmt.Println(string(content))
}拷贝文件(利用读写)
package main
import (
"fmt"
"io"
"os"
)
func main() {
// 打开源文件
srcFile, err := os.Open("./hello.txt")
if err != nil {
fmt.Println(err)
return
}
// 创建新文件
dstFile, err2 := os.Create("./hello_copy.txt")
if err2 != nil {
fmt.Println(err2)
return
}
//缓冲读取
buf := make([]byte, 1024)
for {
//从源文件读取数据
n, err := srcFile.Read(buf)
if err == io.EOF {
fmt.Println("读取完毕")
break
}
if err != nil {
fmt.Println(err)
break
}
dstFile.Write(buf[:n])
}
srcFile.Close()
}bufio
- bufio包实现了带缓冲区的读写，是对文件读写的封装
- bufio缓冲写数据
- bufio读数据 | 模式 | 含义 | | --- | --- | | os.O_WRONLY | 只写 | | os.O_CREATE | 创建文件 | | os.O_RDONLY | 只读 | | os.O_RDWR | 读写 | | os.O_TRUNC | 清空 | | os.O_APPEND | 追加 |
package main
import (
"bufio"
"fmt"
"io"
"os"
)
func wr() {
// 参数2：打开模式，所有模式都在上面
// 参数3是权限控制
// w写 r读 x执行 w 2 r 4 x 1
file, err := os.OpenFile("./test.txt", os.O_CREATE|os.O_WRONLY, 0666)
if err != nil {
return
}
defer file.Close()
// 获取writer对象
writer := bufio.NewWriter(file)
for i := 0; i < 10; i++ {
writer.WriteString(fmt.Sprintf("hello%d\n", i+1))
}
writer.Flush()
}
func re() {
file, err := os.Open("./test.txt")
if err != nil {
return
}
defer file.Close()
reader := bufio.NewReader(file)
for {
line, _, err := reader.ReadLine()
if err == io.EOF {
break
}
if err != nil {
return
}
fmt.Println(string(line))
}
}
func main() {
wr()
re()
}ioutil工具包
- 工具包写文件
- 工具包读取文件
package main
import (
"fmt"
"io/ioutil"
)
func wr() {
err := ioutil.WriteFile("test2.txt", []byte("LiAng"), 0666)
if err != nil {
fmt.Println(err)
return
}
}
func re() {
content, err := ioutil.ReadFile("test2.txt")
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(content))
}
func main() {
wr()
re()
}带缓冲的Reader读文件
package main
import (
"bufio"
"fmt"
"io"
"os"
)
func main() {
file, err := os.Open("./test2.txt")
if err != nil {
fmt.Println("open file err=", err)
}
defer file.Close() //及时关闭file句柄，否则会内存泄漏
//创建一个 Reader，默认缓冲区为 4096字节
reader := bufio.NewReader(file)
//循环读取文件内容
for {
str, err := reader.ReadString('\n') //读到一个换行就结束
if err == io.EOF {
//fmt.Println("文件已经读完")
break
}
//输出内容
fmt.Print(str)
}
}拷贝文件(Copy)
相关信息
func Copy(dst Writer, src Reader) (written int64, err error)
package main
import (
"bufio"
"fmt"
"io"
"os"
)
// 接收两个文件路径 srcFileName dstFileName
func CopyFile(dstFileName string, srcFileName string) (written int64, err error) {
srcFile, err := os.Open(srcFileName)
if err != nil {
fmt.Println("open file err=", err)
}
defer srcFile.Close()
//通过 srcfile， 获取到 Reader
reader := bufio.NewReader(srcFile)
//打开dstFileName，可能不存在
dstFile, err := os.OpenFile(dstFileName, os.O_WRONLY|os.O_CREATE, 0666)
if err != nil {
fmt.Println("open file err=", err)
return
}
defer dstFile.Close()
writer := bufio.NewWriter(dstFile)
return io.Copy(writer, reader)
}
func main() {
//将图片文件拷贝到当前目录下
written, err := CopyFile("英语达人_84.png", "d:/英语达人_84.png")
if err != nil {
fmt.Println("文件拷贝出错", err)
return
}
fmt.Println(written)
}数据格式
是系统中数据交互不可缺少的内容 这里主要介绍JSON、XML、MSGPack
JSON
- json是完全独立于语言的文本格式，是k-v的形式 name:zs
- 应用场景：前后端交互，系统间数据交互
- json使用go语言内置的encoding/json 标准库
- 编码json使用json.Marshal()函数可以对一组数据进行JSON格式的编码
json.Marshal()
func Marshal(v interface{}) ([]byte, error)package main
import (
"encoding/json"
"fmt"
)
type Person struct {
Name string
Hobby string
}
func main() {
p := Person{"LiAng", "篮球"}
//编码json
b, err := json.Marshal(p)
if err != nil {
fmt.Println("json err", err)
}
fmt.Println(string(b))
//格式化输出
b, err = json.MarshalIndent(p, "", " ")
if err != nil {
fmt.Println("json err", err)
}
fmt.Println(string(b))
}{"Name":"LiAng","Hobby":"篮球"}
{
"Name": "LiAng",
"Hobby": "篮球"
}struct tag
//修改上述代码中的结构体
type Person struct {
//"-"是忽略的意思
Name string `json:"-"`
Hobby string `json:"hobby" `
}{"hobby":"篮球"}
{
"hobby": "篮球"
}json.Unmarshal()
解码json使用json.Unmarshal()函数可以对一组数据进行JSON格式的解码
func Unmarshal(data []byte, v interface{}) error解析到结构体
package main
import (
"encoding/json"
"fmt"
)
type Person struct {
Age int `json:"age,string"`
Name string `json:"name"`
Niubility bool `json:"niubility"`
}
func main() {
// 假数据
b := []byte(`{"age":"18","name":"5lmh.com","marry":false}`)
var p Person
err := json.Unmarshal(b, &p)
if err != nil {
fmt.Println(err)
}
fmt.Println(p)
}{18 5lmh.com false}解析到interface
package main
import (
"encoding/json"
"fmt"
)
func main() {
// 假数据
b := []byte(`{"age":"22","name":"5lmh.com","marry":false}`)
var i interface{}
err := json.Unmarshal(b, &i)
if err != nil {
fmt.Println(err)
}
// 自动转到map
fmt.Println(i)
// 可以判断类型
m := i.(map[string]interface{})
for k, v := range m {
switch vv := v.(type) {
case float64:
fmt.Println(k, "是float64类型", vv)
case string:
fmt.Println(k, "是string类型", vv)
default:
fmt.Println("其他")
}
}
}map[age:22 marry:false name:5lmh.com]
age 是string类型 22
name 是string类型 5lmh.com
其他小技巧
如果需要在json.Marshal()之前对结构体进行特殊处理，比如如果字段是string类型，并且值是""，就不对该字段进行序列化，这时需要单独处理。例子：
type Student struct {
Name string `json:"name"`
Age int `json:"age"`
Class []string `json:"class"`
}
// 封装 json.Marshal 方法
func (s *Student) MarshalJSON() ([]byte, error) {
m := make(map[string]interface{})
// 使用反射获取结构体字段信息
v := reflect.ValueOf(s).Elem()
t := v.Type()
for i := 0; i < v.NumField(); i++ {
field := t.Field(i)
value := v.Field(i).Interface()
if field.Name == "Name" && value.(string) != "" {
m[field.Tag.Get("json")] = value
}
if field.Name == "Class" && field.Type.Kind() == reflect.Slice && v.Field(i).Len() != 0 {
m[field.Tag.Get("json")] = value
}
if field.Name == "Age" && value.(int) != 0 {
m[field.Tag.Get("json")] = value
}
}
return json.Marshal(m)
}
func main() {
s := &Student{
Name: "",
Age: 0,
Class: []string{},
}
body, err := s.MarshalJSON()
if err != nil {
fmt.Println(err.Error())
}
fmt.Println(strings.NewReader(string(body)))
s2 := &Student{
Name: "jack",
Age: 18,
Class: []string{"math", "english"},
}
body2, err := s2.MarshalJSON()
if err != nil {
fmt.Println(err.Error())
}
fmt.Println(strings.NewReader(string(body2)))
}输出
&{{} 0 -1}
&{{"age":18,"class":["math","english"],"name":"jack"} 0 -1}XML
- 是可扩展标记语言，包含声明、根标签、子元素和属性
- 应用场景：配置文件以及webService
<?xml version="1.0" encoding="UTF-8" ?>
<servers version="1">
<server>
<serverName>Shanghai_VPN</serverName>
<serverIP>127.0.0.1</serverIP>
</server>
<server>
<serverName>Beijing_VPN</serverName>
<serverIP>127.0.0.2</serverIP>
</server>
</servers>package main
import (
"encoding/xml"
"fmt"
"io/ioutil"
)
// 抽取单个server对象
type Server struct {
ServerName string `xml:"serverName"`
ServerIP string `xml:"serverIP"`
}
type Servers struct {
Name xml.Name `xml:"servers"`
Version int `xml:"version"`
Servers []Server `xml:"server"`
}
func main() {
data, err := ioutil.ReadFile("./my.xml")
if err != nil {
fmt.Println(err)
return
}
var servers Servers
err = xml.Unmarshal(data, &servers)
if err != nil {
fmt.Println(err)
return
}
fmt.Printf("xml:\n %#v\n", servers)
}xml:
main.Servers{Name:xml.Name{Space:"", Local:""}, Version:0, Servers:[]main.Server{main.Server{ServerName:"Shanghai_VPN", ServerIP:"127.0.0.1"}, main.Server{ServerName
:"Beijing_VPN", ServerIP:"127.0.0.2"}}}MGPack
- MSGPack是二进制的json，性能更快，更省空间
- 需要安装第三方包：go get -u github.com/vmihailenco/msgpack
package main
import (
"fmt"
"github.com/vmihailenco/msgpack"
"io/ioutil"
"math/rand"
)
type Person struct {
Name string
Age int
Sex string
}
// 二进制写出
func writerJson(filename string) (err error) {
var persons []*Person
// 假数据
for i := 0; i < 10; i++ {
p := &Person{
Name: fmt.Sprintf("name%d", i),
Age: rand.Intn(100),
Sex: "male",
}
persons = append(persons, p)
}
// 二进制json序列化
data, err := msgpack.Marshal(persons)
if err != nil {
fmt.Println(err)
return
}
err = ioutil.WriteFile(filename, data, 0666)
if err != nil {
fmt.Println(err)
return
}
return
}
// 二进制读取
func readJson(filename string) (err error) {
var persons []*Person
// 读文件
data, err := ioutil.ReadFile(filename)
if err != nil {
fmt.Println(err)
return
}
// 反序列化
err = msgpack.Unmarshal(data, &persons)
if err != nil {
fmt.Println(err)
return
}
for _, v := range persons {
fmt.Printf("%#v\n", v)
}
return
}
func main() {
//err := writerJson("D:/person.dat")
//if err != nil {
// fmt.Println(err)
// return
//}
err := readJson("D:/person.dat")
if err != nil {
fmt.Println(err)
return
}
}Context
在 Go http包的Server中，每一个请求在都有一个对应的 goroutine 去处理。请求处理函数通常会启动额外的 goroutine 用来访问后端服务，比如数据库和RPC服务。用来处理一个请求的 goroutine 通常需要访问一些与请求特定的数据，比如终端用户的身份认证信息、验证相关的token、请求的截止时间。 当一个请求被取消或超时时，所有用来处理该请求的 goroutine 都应该迅速退出，然后系统才能释放这些 goroutine 占用的资源。
为什么需要Context
基本示例
package main
import (
"fmt"
"sync"
"time"
)
var wg sync.WaitGroup
// 初始的例子
func worker() {
for {
fmt.Println("worker")
time.Sleep(time.Second)
}
// 如何接收外部命令实现退出
wg.Done()
}
func main() {
wg.Add(1)
go worker()
// 如何优雅的实现结束子goroutine
wg.Wait()
fmt.Println("over")
}全局变量方式
package main
import (
"fmt"
"sync"
"time"
)
var wg sync.WaitGroup
var exit bool
// 全局变量方式存在的问题：
// 1. 使用全局变量在跨包调用时不容易统一
// 2. 如果worker中再启动goroutine，就不太好控制了。
func worker() {
for {
fmt.Println("worker")
time.Sleep(time.Second)
if exit {
break
}
}
wg.Done()
}
func main() {
wg.Add(1)
go worker()
time.Sleep(time.Second * 3) // sleep3秒以免程序过快退出
exit = true // 修改全局变量实现子goroutine的退出
wg.Wait()
fmt.Println("over")
}通道方式
package main
import (
"fmt"
"sync"
"time"
)
var wg sync.WaitGroup
// 管道方式存在的问题：
// 1. 使用全局变量在跨包调用时不容易实现规范和统一，需要维护一个共用的channel
func worker(exitChan chan struct{}) {
LOOP:
for {
fmt.Println("worker")
time.Sleep(time.Second)
select {
case <-exitChan: // 等待接收上级通知
break LOOP
default:
}
}
wg.Done()
}
func main() {
var exitChan = make(chan struct{})
wg.Add(1)
go worker(exitChan)
time.Sleep(time.Second * 3) // sleep3秒以免程序过快退出
exitChan <- struct{}{} // 给子goroutine发送退出信号
close(exitChan)
wg.Wait()
fmt.Println("over")
}官方版的方案
package main
import (
"context"
"fmt"
"sync"
"time"
)
var wg sync.WaitGroup
func worker(ctx context.Context) {
LOOP:
for {
fmt.Println("worker")
time.Sleep(time.Second)
select {
case <-ctx.Done(): // 等待上级通知
break LOOP
default:
}
}
wg.Done()
}
func main() {
ctx, cancel := context.WithCancel(context.Background())
wg.Add(1)
go worker(ctx)
time.Sleep(time.Second * 3)
cancel() // 通知子goroutine结束
wg.Wait()
fmt.Println("over")
}当子goroutine又开启另外一个goroutine时，只需要将ctx传入即可：
package main
import (
"context"
"fmt"
"sync"
"time"
)
var wg sync.WaitGroup
func worker(ctx context.Context) {
go worker2(ctx)
LOOP:
for {
fmt.Println("worker")
time.Sleep(time.Second)
select {
case <-ctx.Done(): // 等待上级通知
break LOOP
default:
}
}
wg.Done()
}
func worker2(ctx context.Context) {
LOOP:
for {
fmt.Println("worker2")
time.Sleep(time.Second)
select {
case <-ctx.Done(): // 等待上级通知
break LOOP
default:
}
}
}
func main() {
ctx, cancel := context.WithCancel(context.Background())
wg.Add(1)
go worker(ctx)
time.Sleep(time.Second * 3)
cancel() // 通知子goroutine结束
wg.Wait()
fmt.Println("over")
}Context初识
Go1.7加入了一个新的标准库context，它定义了Context类型，专门用来简化对于处理单个请求的多个goroutine 之间与请求域的数据、取消信号、截止时间等相关操作，这些操作可能涉及多个 API 调用。 对服务器传入的请求应该创建上下文，而对服务器的传出调用应该接受上下文。它们之间的函数调用链必须传递上下文，或者可以使用WithCancel、WithDeadline、WithTimeout或WithValue创建的派生上下文。当一个上下文被取消时，它派生的所有上下文也被取消。
Context接口
context.Context是一个接口，该接口定义了四个需要实现的方法。具体签名如下：
type Context interface {
Deadline() (deadline time.Time, ok bool)
Done() <-chan struct{}
Err() error
Value(key interface{}) interface{}
}其中：
- Deadline方法需要返回当前Context被取消的时间，也就是完成工作的截止时间（deadline）；
- Done方法需要返回一个Channel，这个Channel会在当前工作完成或者_上下文_被取消之后关闭，多次调用Done方法会返回同一个Channel；
- Err方法会返回当前Context结束的原因，它只会在Done返回的Channel被关闭时才会返回非空的值；
- 如果当前Context被取消就会返回Canceled错误；
- 如果当前Context超时就会返回DeadlineExceeded错误；
- Value方法会从Context中返回键对应的值，对于同一个_上下文_来说，多次调用Value 并传入相同的Key会返回相同的结果，该方法仅用于传递跨API和进程间跟请求域的数据；
Background()和TODO()
Go内置两个函数：Background()和TODO()，这两个函数分别返回一个实现了Context接口的background和todo。我们代码中最开始都是以这两个内置的上下文对象作为最顶层的partent context，衍生出更多的子上下文对象。 Background()主要用于main函数、初始化以及测试代码中，作为Context这个树结构的最顶层的Context，也就是根Context。 TODO()，它目前还不知道具体的使用场景，如果我们不知道该使用什么Context的时候，可以使用这个。 background和todo本质上都是emptyCtx结构体类型，是一个不可取消，没有设置截止时间，没有携带任何值的Context。
With系列函数
此外，context包中还定义了四个With系列函数。
WithCancel
WithCancel的函数签名如下：
func WithCancel(parent Context) (ctx Context, cancel CancelFunc)WithCancel返回带有新Done通道的父节点的副本。当调用返回的cancel函数或当关闭父上下文的Done通道时，将关闭返回上下文的Done通道，无论先发生什么情况。 取消此上下文将释放与其关联的资源，因此代码应该在此上下文中运行的操作完成后立即调用cancel。
func gen(ctx context.Context) <-chan int {
dst := make(chan int)
n := 1
go func() {
for {
select {
case <-ctx.Done():
return // return结束该goroutine，防止泄露
case dst <- n:
n++
}
}
}()
return dst
}
func main() {
ctx, cancel := context.WithCancel(context.Background())
defer cancel() // 当我们取完需要的整数后调用cancel
for n := range gen(ctx) {
fmt.Println(n)
if n == 5 {
break
}
}
}上面的示例代码中，gen函数在单独的goroutine中生成整数并将它们发送到返回的通道。 gen的调用者在使用生成的整数之后需要取消上下文，以免gen启动的内部goroutine发生泄漏。
WithDeadline
WithDeadline的函数签名如下：
func WithDeadline(parent Context, deadline time.Time) (Context, CancelFunc)返回父上下文的副本，并将deadline调整为不迟于d。如果父上下文的deadline已经早于d，则WithDeadline(parent, d)在语义上等同于父上下文。当截止日过期时，当调用返回的cancel函数时，或者当父上下文的Done通道关闭时，返回上下文的Done通道将被关闭，以最先发生的情况为准。 取消此上下文将释放与其关联的资源，因此代码应该在此上下文中运行的操作完成后立即调用cancel。
func main() {
d := time.Now().Add(50 * time.Millisecond)
ctx, cancel := context.WithDeadline(context.Background(), d)
// 尽管ctx会过期，但在任何情况下调用它的cancel函数都是很好的实践。
// 如果不这样做，可能会使上下文及其父类存活的时间超过必要的时间。
defer cancel()
select {
case <-time.After(1 * time.Second):
fmt.Println("overslept")
case <-ctx.Done():
fmt.Println(ctx.Err())
}
}
// context deadline exceeded上面的代码中，定义了一个50毫秒之后过期的deadline，然后我们调用context.WithDeadline(context.Background(), d)得到一个上下文（ctx）和一个取消函数（cancel），然后使用一个select让主程序陷入等待：等待1秒后打印overslept退出或者等待ctx过期后退出。 因为ctx50秒后就过期，所以ctx.Done()会先接收到值，上面的代码会打印ctx.Err()取消原因。
WithTimeout
WithTimeout的函数签名如下：
func WithTimeout(parent Context, timeout time.Duration) (Context, CancelFunc)WithTimeout返回WithDeadline(parent, time.Now().Add(timeout))。 取消此上下文将释放与其相关的资源，因此代码应该在此上下文中运行的操作完成后立即调用cancel，通常用于数据库或者网络连接的超时控制。具体示例如下：
package main
import (
"context"
"fmt"
"sync"
"time"
)
// context.WithTimeout
var wg sync.WaitGroup
func worker(ctx context.Context) {
LOOP:
for {
fmt.Println("db connecting ...")
time.Sleep(time.Millisecond * 10) // 假设正常连接数据库耗时10毫秒
select {
case <-ctx.Done(): // 50毫秒后自动调用
break LOOP
default:
}
}
fmt.Println("worker done!")
wg.Done()
}
func main() {
// 设置一个50毫秒的超时
ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond*50)
wg.Add(1)
go worker(ctx)
time.Sleep(time.Second * 5)
cancel() // 通知子goroutine结束
wg.Wait()
fmt.Println("over")
}WithValue
WithValue函数能够将请求作用域的数据与 Context 对象建立关系。声明如下：
func WithValue(parent Context, key, val interface{}) ContextWithValue返回父节点的副本，其中与key关联的值为val。 仅对API和进程间传递请求域的数据使用上下文值，而不是使用它来传递可选参数给函数。 所提供的键必须是可比较的，并且不应该是string类型或任何其他内置类型，以避免使用上下文在包之间发生冲突。WithValue的用户应该为键定义自己的类型。为了避免在分配给interface{}时进行分配，上下文键通常具有具体类型struct{}。或者，导出的上下文关键变量的静态类型应该是指针或接口。
package main
import (
"context"
"fmt"
"sync"
"time"
)
// context.WithValue
type TraceCode string
var wg sync.WaitGroup
func worker(ctx context.Context) {
key := TraceCode("TRACE_CODE")
traceCode, ok := ctx.Value(key).(string) // 在子goroutine中获取trace code
if !ok {
fmt.Println("invalid trace code")
}
LOOP:
for {
fmt.Printf("worker, trace code:%s\n", traceCode)
time.Sleep(time.Millisecond * 10) // 假设正常连接数据库耗时10毫秒
select {
case <-ctx.Done(): // 50毫秒后自动调用
break LOOP
default:
}
}
fmt.Println("worker done!")
wg.Done()
}
func main() {
// 设置一个50毫秒的超时
ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond*50)
// 在系统的入口中设置trace code传递给后续启动的goroutine实现日志数据聚合
ctx = context.WithValue(ctx, TraceCode("TRACE_CODE"), "12512312234")
wg.Add(1)
go worker(ctx)
time.Sleep(time.Second * 5)
cancel() // 通知子goroutine结束
wg.Wait()
fmt.Println("over")
}使用Context的注意事项
- 推荐以参数的方式显示传递Context
- 以Context作为参数的函数方法，应该把Context作为第一个参数。
- 给一个函数方法传递Context的时候，不要传递nil，如果不知道传递什么，就使用context.TODO()
- Context的Value相关方法应该传递请求域的必要数据，不应该用于传递可选参数
- Context是线程安全的，可以放心的在多个goroutine中传递
客户端超时取消示例
调用服务端API时如何在客户端实现超时控制？
server端
context_timeout/server/main.go
package main
import (
"fmt"
"math/rand"
"net/http"
"time"
)
// server端，随机出现慢响应
func indexHandler(w http.ResponseWriter, r *http.Request) {
fmt.Println(r.Host + " 发送了请求")
number := rand.Intn(2)
if number == 0 {
time.Sleep(time.Second * 5) // 耗时10秒的慢响应
fmt.Fprintf(w, "slow response")
return
}
fmt.Fprint(w, "quick response")
}
func main() {
http.HandleFunc("/", indexHandler)
err := http.ListenAndServe(":20000", nil)
if err != nil {
panic(err)
}
}client端
context_timeout/client/main.go
package main
import (
"context"
"fmt"
"io"
"net/http"
"sync"
"time"
)
type respData struct {
resp *http.Response
err error
}
func doCall(ctx context.Context) {
transport := http.Transport{
DisableKeepAlives: true,
}
client := http.Client{
Transport: &transport,
}
respChan := make(chan *respData, 1)
req, err := http.NewRequest("GET", "http://127.0.0.1:20000/", nil)
if err != nil {
fmt.Printf("new requestg failed, err:%v\n", err)
return
}
req = req.WithContext(ctx) // 使用带超时的ctx创建一个新的client request
var wg sync.WaitGroup
wg.Add(1)
defer wg.Wait()
go func() {
resp, err := client.Do(req)
fmt.Printf("client.do resp:%v, err:%v\n", resp, err)
rd := &respData{
resp: resp,
err: err,
}
respChan <- rd
wg.Done()
}()
select {
case <-ctx.Done():
fmt.Println("call api timeout")
case result := <-respChan:
fmt.Println("call server api success")
if result.err != nil {
fmt.Printf("call server api failed, err:%v\n", result.err)
return
}
defer result.resp.Body.Close()
data, _ := io.ReadAll(result.resp.Body)
fmt.Printf("resp:%v\n", string(data))
}
}
func main() {
ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond*100)
defer cancel()
doCall(ctx)
}