如何为 HTTPX AsyncClient 实现统一的请求与响应体日志记录

落婷君_5341

落婷君_5341

2026-07-05

965人浏览

原创

如何为 HTTPX AsyncClient 实现统一的请求与响应体日志记录

本文介绍如何通过事件钩子(event hooks)和自定义传输层,为 httpx.AsyncClient 实现全自动、可复用的请求体(input)与响应体(output)日志记录,避免在每个 API 调用处手动打印,提升调试效率与代码一致性。

本文介绍如何通过事件钩子(event hooks)和自定义传输层,为 `httpx.asyncclient` 实现全自动、可复用的请求体(input)与响应体(output)日志记录,避免在每个 api 调用处手动打印,提升调试效率与代码一致性。

在微服务或网关类应用中,对所有外部 HTTP 调用进行结构化日志记录(尤其是请求/响应原始 body)是可观测性的关键实践。httpx.AsyncClient 本身不内置 body 日志能力,但提供了灵活的扩展机制:事件钩子(event hooks)用于请求侧,而响应体需结合自定义 AsyncBaseTransport 实现流重放——因为响应体是单次消费的异步流(response.aiter_bytes()),直接 .read() 会导致后续解析失败。

✅ 请求体日志:使用 event_hooks['request']

AsyncClient 支持在请求发出前触发回调函数,此时 request.content 已序列化为字节(如 JSON 字符串的 UTF-8 编码),可安全读取并记录:

import logging
import json
from httpx import AsyncClient, Request

logging.basicConfig(level=logging.DEBUG, format="%(asctime)s - %(levelname)s - %(message)s")

async def log_request(request: Request):
    # 尝试安全解码并格式化请求体(仅适用于 text-based content)
    try:
        body = request.content.decode("utf-8")
        if "application/json" in request.headers.get("content-type", ""):
            body = json.dumps(json.loads(body), indent=2, ensure_ascii=False)
        logging.debug(f"[REQUEST] {request.method} {request.url}\n{body}")
    except (UnicodeDecodeError, json.JSONDecodeError, ValueError):
        logging.debug(f"[REQUEST] {request.method} {request.url} (binary content, {len(request.content)} bytes)")

client = AsyncClient(
    event_hooks={"request": [log_request]}
)

⚠️ 注意:request.content 是 bytes 类型,可能包含二进制数据(如文件上传)。上述示例做了容错处理,仅对 JSON 类型尝试美化输出。

Flova.ai
Flova.ai

Flova.ai是一款面向创作者和影视团队的一站式AI视频生成Agent。

下载

✅ 响应体日志:自定义 Transport 拦截并缓存流

由于响应体是异步迭代器,必须在首次消费前“拦截并复制”一份用于日志。标准 AsyncClient 不支持此操作,因此需继承 httpx.AsyncBaseTransport 并重写 handle_async_request 方法:

import asyncio
from httpx import AsyncBaseTransport, Request, Response, AsyncClient
from httpx._transports.default import AsyncHTTPTransport

class LoggingTransport(AsyncBaseTransport):
    def __init__(self, transport: AsyncBaseTransport):
        self._transport = transport

    async def handle_async_request(self, request: Request) -> Response:
        # 1. 先执行原始请求
        response = await self._transport.handle_async_request(request)

        # 2. 安全读取响应体(仅限小到中等 size;生产环境建议加 size 限制)
        try:
            # 使用 .aread() 获取完整 body(需确保 transport 支持)
            body = await response.aread()
            # 3. 重新构造可重复使用的响应(关键:将 body 注入 response.stream)
            from httpx._models import ByteStream
            response._content = body  # 缓存原始内容
            response.stream = ByteStream(body)  # 重置 stream 为可重放流

            # 4. 记录日志
            try:
                decoded = body.decode("utf-8")
                if "application/json" in response.headers.get("content-type", ""):
                    decoded = json.dumps(json.loads(decoded), indent=2, ensure_ascii=False)
                logging.debug(f"[RESPONSE] {response.status_code} {response.url}\n{decoded}")
            except (UnicodeDecodeError, json.JSONDecodeError):
                logging.debug(f"[RESPONSE] {response.status_code} {response.url} ({len(body)} bytes)")
        except Exception as e:
            logging.warning(f"Failed to log response body: {e}")

        return response

# 创建带日志功能的 client
base_transport = AsyncHTTPTransport()
client = AsyncClient(transport=LoggingTransport(base_transport))

✅ 完整集成示例(FastAPI 中复用)

将上述逻辑封装后,即可在任意路由中无感使用:

from fastapi import FastAPI, HTTPException
import json
from httpx import AsyncClient

app = FastAPI()

# ✅ 全局复用的带日志 client
client = AsyncClient(
    transport=LoggingTransport(AsyncHTTPTransport()),
    event_hooks={"request": [log_request]},
)

@app.get("/example_post")
async def example_post():
    url = "https://jsonplaceholder.typicode.com/posts"
    payload = {"title": "fooxxx", "body": "bar", "userId": 1}
    response = await client.post(url, json=payload)  # 注意:使用 json= 自动设 header & serialize
    return response.json()

? 关键注意事项

  • 性能权衡:响应体日志会额外读取并缓存整个 body,对大文件或高吞吐场景不推荐;生产环境建议添加 max_body_size=1024*1024(1MB)限制,并跳过超限响应。
  • Content-Type 判断:日志美化仅适用于 application/json、text/* 等文本类型,二进制响应(如图片、PDF)应仅记录长度。
  • 线程/协程安全:LoggingTransport 是协程安全的,但若多处共享同一 client 实例,日志本身天然并发安全(logging 模块已处理)。
  • 替代方案:如只需调试,可临时启用 httpx 内置日志(logging.getLogger("httpx").setLevel(logging.DEBUG)),但它不显示原始 body,仅含 headers 和状态码。

通过组合事件钩子与自定义 Transport,你获得了一个轻量、可复用、符合 httpx 设计哲学的全自动日志方案——从此告别每个 await client.post() 后的手动 logging.info(...)。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1671

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4224

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1669

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

24577

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3007

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3027

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1163

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2343

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习