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

2023-09-21 21:29:59

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 来实现。

更多推荐

uni-app实现web-view图片长按下载

<template><view><web-view:webview-styles="webviewStyles":src="webUrl"></web-view></view></template>uniapp的web-view中图片无法长按保存,IOS下是正常的,但是Android下长按无反应解决方案:下载mui.m

什么是C语言中的命名空间?

C语言本身并没有像某些其他编程语言(如C++)中的显式命名空间(namespace)的概念,但C语言中有一些机制和约定,允许开发人员组织和管理变量、函数和其他标识符的名称,以避免名称冲突和提高代码可维护性。本文将介绍C语言中的命名空间概念,包括作用域、静态变量、文件作用域、函数作用域以及如何避免名称冲突。作用域(Sco

会C++还需要再去学Python吗?

提到的C++、数据结构与算法、操作系统、计算机网络和数据库技术等确实是计算机科学中非常重要的基础知识领域,对于软件开发和计算机工程师来说,它们是必备的核心知识。掌握这些知识对于开发高性能、可靠和安全的应用程序非常重要。Python作为一种脚本语言,在某些场景下确实可以作为加分项或辅助工具使用。它具有易学易用的特点,并且

【C++】泛型算法(六)Map和Set的使用

Mapmap<key,value>key起到索引的作用。//常见使用:字数统计程序#include<map>#include<string>map<string,int>words;//string是key,int是valuestringtword;while(cin>>tword){words[tword]++;//

解释器风格架构C# 代码

/*解释器风格架构是一种基于组件的设计架构,它将应用程序分解为一系列组件,每个组件负责处理特定的任务。这种架构有助于提高代码的可维护性和可扩展性。以下是如何使用C#实现解释器风格架构的步骤:定义组件:首先,定义一个组件接口,这将是所有组件需要遵循的规范。这包括组件的基本操作,如添加、删除、查询等。*/voidMain(

c#设计模式-结构型模式 之适配器模式

🚀介绍将一个类的接口转换成客户希望的另外一个接口,使得原本由于接口不兼容而不能一起工作的那些类能一起工作。适配器模式分为类适配器模式和对象适配器模式,前者类之间的耦合度比后者高,且要求程序员了解现有组件库中的相关组件的内部结构,所以应用相对较少些。适配器模式(Adapter)包含以下主要角色:目标(Target)接口

算力和LAXCUS分布式操作系统

有用户问LAXCUS分布式操作系统和算力的关系,今天借这个话题讲讲二者的关联。算力是指计算机系统在单位时间内所能完成的计算任务数量。随着计算机技术的发展,尤其是大数据、云计算、人工智能等新技术、新应用业务的出现,算力已经成为了衡量计算系统和产业业态的重要指标。在传统的集中式计算模式下,算力的提升主要依赖于硬件设备的升级

C语言每日一题(1):实现库函数strlen()

文章主题:库函数strlen()的实现所属专栏:C语言每日一题作者简介:每天不定时更新C语言的小白一枚,记录分享自己每日的所思所想。个人主页:[₽]的个人主页目录前言函数介绍编程起因设计思路1.整体逻辑2.参数类型3.防止空指针4.返回值代码展示结语前言函数介绍strlen()函数是我们在C语言编程中常用到库函数。在C

【LeetCode-中等题】 222. 完全二叉树的节点个数

文章目录题目方法一:把该题当做一个普通的二叉树来做(任何遍历都可以)方法二:利用完全二叉树的性质来做题目方法一:把该题当做一个普通的二叉树来做(任何遍历都可以)例如:二叉树的前序遍历(维护一个全局变量)递归无返回值classSolution{intnum=0;publicintcountNodes(TreeNodero

Docker快速入门到项目部署,MySQL部署+Nginx部署

《Docker》是微服务在企业落地的最后一块拼图。微服务项目由于拆分粒度细,服务部署环境复杂,部署实例很多,维护困难。而Docker则可以解决项目部署的各种环境问题,让开发、运维一体化,真正实现持续集成、持续部署。大大提高企业项目开发到部署的效率。同学们,在前两天我们学习了Linux操作系统的常见命令以及如何在Linu

数据结构之堆的结构与实现

目录一、堆的概念及结构1.1堆的概念1.2堆的性质1.3堆的结构二、堆的实现2.1堆向下调整算法(父亲与孩子做比较)2.2堆的向上调整算法(孩子与父亲做比较)2.3堆的创建(向下建堆)2.4向下建堆的时间复杂度2.5堆的插入2.6堆的删除2.7堆的完整代码实现三、堆的应用3.1堆排序3.2TOP-K问题一、堆的概念及结

热文推荐