详解Golang net/http包中的RoundTripper接口

 更新时间:2023年09月22日 10:02:44   作者:路多辛  
RoundTripper 是 net/http 包中的一个接口,定义了处理 HTTP 请求返回和响应的方法,是 http.Client 结构体中执行 http 请求的核心部分,本文将详细的给大家介绍Golang RoundTripper接口,需要的朋友可以参考下

RoundTripper 是什么? 

RoundTripper 是 net/http 包中的一个接口,定义了处理 HTTP 请求返回和响应的方法,是 http.Client 结构体中执行 http 请求的核心部分。接口定义如下:

type RoundTripper interface {
	RoundTrip(*Request) (*Response, error)
}

只定义了 RoundTrip 一个方法,用于执行单个 HTTP 事务,发送请求数据并返回对应的响应数据。RoundTrip 不应该去解析响应数据,特别是如果获得了响应数据后,RoundTrip 必须返回值为 nil 的 error(不管响应的HTTP状态码是什么)。如果没有获得响数据,应返回一个非 nil 的 error,RoundTrip 也不应该尝试处理更高级的协议细节,如重定向、身份验证或 cookie 等。

除了消费和关闭请求的 Body 之外,RoundTrip 不应该修改请求,RoundTrip 可以在单独的 goroutine 中读取请求的字段。在 Response Body 被关闭之前,调用方不应该改变或重用请求。RoundTrip 必须始终关闭 body(即使遇到 error),但根据实现,即使在 RoundTrip 返回之后也可以在单独的 goroutine 中关闭。

使用场景

借助 RoundTripper 可以在每个请求中添加特定的 header 或者对返回的响应数据进行特定的处理,例如记录日志或根据返回的状态码执行对应逻辑。接下来看一个用于实现链路追踪功能,只需要实现 RoundTripper 接口,在执行 HTTP 请求的同时,收集遥测数据,如请求的持续时间、状态码等,这些数据可以用于性能监控和故障排查。实现 RoundTripper 接口的示例代码如下:

package http_otel
import (
	"net/http"
	"go.opentelemetry.io/otel"
	"go.opentelemetry.io/otel/attribute"
	"go.opentelemetry.io/otel/codes"
)
type OtelRoundTripper struct {
	original http.RoundTripper
}
func (ort *OtelRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) {
	tracer := otel.Tracer("")
	ctx, span := tracer.Start(req.Context(), req.URL.Path)
	defer span.End()
	req = req.WithContext(ctx)
	resp, err := ort.original.RoundTrip(req)
	if err != nil {
		span.RecordError(err)
		span.SetStatus(codes.Error, err.Error())
	} else {
		attrs := []attribute.KeyValue{
			{
				Key:   "http.status_code",
				Value: attribute.IntValue(resp.StatusCode),
			},
			{
				Key:   "http.method",
				Value: attribute.StringValue(req.Method),
			},
			{
				Key:   "http.route",
				Value: attribute.StringValue(req.URL.RequestURI()),
			},
			{
				Key:   "http.scheme",
				Value: attribute.StringValue(req.URL.Scheme),
			},
			{
				Key:   "http.user_agent",
				Value: attribute.StringValue(req.UserAgent()),
			},
		}
		span.SetAttributes(attrs...)
	}
	return resp, err
}
func New() *OtelRoundTripper {
	return &OtelRoundTripper{
		original: tripper,
	}
}

使用 net/http 包实现链路追踪代码如下:

package main
import (
    "bytes"
    "fmt"
    "xxx/http-otel"
    "io"
    "net/http"
)
func main() {
    reader := bytes.NewReader([]byte(`{"foo":"bar"}`))
    request, err := http.NewRequest("POST", "http://xxx.com/user/list", reader)
    if err != nil {
       panic(err)
    }
    request = request.WithContext(traceCtx) // traceCtx 指上文的 context,这里使用伪代码作演示
    request.Header.Set("Content-Type", "application/json")
    client := http.Client{Transport: http_otel.New()}
    resp, err := client.Do(request)
    if err != nil {
       panic(err)
    }
    defer resp.Body.Close()
    b, err := io.ReadAll(resp.Body)
    fmt.Println(string(b), err)
}

首先定义了一个用于实现链路追踪功能的 OtelRoundTripper 结构体,然后实现了 RoundTrip 方法。在 RoundTrip 方法中,首先开启一个新的 trace span,并且将追踪的信息编码到 HTTP 请求的 header 中。在请求完成后,将返回的 HTTP 响应信息记录到 trace 中,并返回 HTTP 响应数据。

小结

RoundTripper 接口的强大之处在于能够以简单且可扩展的方式自定义和控制 HTTP 请求的处理。无论是添加特定的 header、处理响应还是执行其他更高级的逻辑,都可以借助 RoundTripper 来实现。

以上就是详解Golang net/http包中的RoundTripper接口的详细内容,更多关于Golang RoundTripper接口的资料请关注脚本之家其它相关文章!

相关文章

  • golang的httpserver优雅重启方法详解

    golang的httpserver优雅重启方法详解

    这篇文章主要给大家介绍了关于golang的httpserver优雅重启的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧。
    2018-03-03
  • 详解Golang语言HTTP客户端实践

    详解Golang语言HTTP客户端实践

    本文主要介绍了Golang语言HTTP客户端实践,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-11-11
  • golang 使用sort.slice包实现对象list排序

    golang 使用sort.slice包实现对象list排序

    这篇文章主要介绍了golang 使用sort.slice包实现对象list排序,对比sort跟slice两种排序的使用方式区别展开内容,需要的小伙伴可以参考一下
    2022-03-03
  • GoLang的sync.WaitGroup与sync.Once简单使用讲解

    GoLang的sync.WaitGroup与sync.Once简单使用讲解

    sync.WaitGroup类型,它比通道更加适合实现这种一对多的goroutine协作流程。WaitGroup是开箱即用的,也是并发安全的。同时,与之前提到的同步工具一样,它一旦被真正的使用就不能被复制了
    2023-01-01
  • Windows下CMD执行Go出现中文乱码的解决方法

    Windows下CMD执行Go出现中文乱码的解决方法

    本文主要介绍了Windows下CMD执行Go出现中文乱码的解决方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-02-02
  • Golang并发读取文件数据并写入数据库的项目实践

    Golang并发读取文件数据并写入数据库的项目实践

    本文主要介绍了Golang并发读取文件数据并写入数据库的项目实践,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-06-06
  • Golang通道channel的源码分析

    Golang通道channel的源码分析

    channel(通道),顾名思义,是一种通道,一种用于并发环境中数据传递的通道。channel是golang中标志性的概念之一,很好很强大!本文将从源码带大家了解一下channel的使用,希望对大家有所帮助
    2022-12-12
  • Go并发编程之sync.Once使用实例详解

    Go并发编程之sync.Once使用实例详解

    sync.Once使用起来很简单, 下面是一个简单的使用案例,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧
    2021-11-11
  • Golang极简入门教程(四):编写第一个项目

    Golang极简入门教程(四):编写第一个项目

    这篇文章主要介绍了Golang极简入门教程(四):编写第一个项目,本文讲解了workspace、包路径、第一个可执行命令等内容,需要的朋友可以参考下
    2014-10-10
  • CentOS7使用yum安装Golang的超详细步骤

    CentOS7使用yum安装Golang的超详细步骤

    CentOS默认并没有安装golang运行环境,下面这篇文章主要给大家介绍了关于CentOS7使用yum安装Golang的超详细步骤,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2023-02-02

最新评论