0

0

PythonRESTAPI封装方法_统一接口层设计思路【技巧】

冷漠man

冷漠man

发布时间:2025-12-25 21:49:02

|

317人浏览过

|

来源于php中文网

原创

应使用 requests.Session 统一管理连接复用、默认 headers、timeout 和重试策略,封装 URL 构建、参数序列化、错误映射及响应解析,并用 dataclass 或 Pydantic 约束数据结构,确保类型安全与可维护性。

pythonrestapi封装方法_统一接口层设计思路【技巧】

requests.Session 管理连接复用和默认配置

直接每次调用都新建 requests.get() 会导致 TCP 连接无法复用,高并发下容易触发连接耗尽或响应变慢。用 Session 是最轻量又有效的统一入口基础。

它能自动复用底层连接、持久化 cookies、预设 headers 和 timeout,也方便后续统一加日志、重试、鉴权逻辑。

  • 所有 API 调用应基于同一个 Session 实例,而不是每次 new 一个
  • 通过 session.headers.update(...) 设置通用 header(如 Content-TypeAuthorization
  • 务必显式设置 timeout=(3, 7) —— 第一个数字是 connect timeout,第二个是 read timeout;不设 timeout 可能卡死整个调用链
  • 避免在 Session 上直接设 auth=...,除非所有接口共用同一套认证;更推荐在每个请求前动态注入 token
import requests

session = requests.Session() session.headers.update({ "Content-Type": "application/json", "User-Agent": "my-api-client/1.0" }) session.timeout = (3, 7) # 注意:timeout 需在 request() 时传入,不能直接赋值给 session

把 URL 拼接、参数序列化、错误解析抽成可复用函数

REST API 封装最容易散落的三处脏代码:拼 base_url + endpoint、处理 query/body 参数类型、对不同 HTTP 状态码做不同异常映射。这些必须收口。

比如 params 里传了 None 或嵌套 dict,默认 requests 不会帮你过滤或扁平化;400/422 返回的 error detail 格式不统一,直接抛原生 HTTPError 对业务层不友好。

立即学习Python免费学习笔记(深入)”;

  • 写一个 build_url(base, endpoint, **kwargs),自动处理 trailing slash、path join、URL encode
  • json.dumps(..., separators=(',', ':')) 控制 body 序列化格式,避免空格干扰签名或缓存
  • response.status_code 做集中判断:2xx 正常返回 response.json();4xx 抛自定义 ClientError;5xx 抛 ServerError;非 JSON 响应体要 fallback 到 response.text
  • 不要依赖 response.raise_for_status() —— 它不区分 4xx 和 5xx,且无法附带业务错误信息

用数据类(dataclasspydantic.BaseModel)约束请求/响应结构

手写 dict 构造请求体、再用 .get('xxx', {}).get('yyy') 解析响应,是后期维护灾难的起点。类型即文档,也便于 IDE 补全和 mypy 检查。

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

下载

如果项目已用 pydantic,优先用 BaseModel;否则 @dataclass + field(default_factory=dict) 更轻量。

  • 请求参数封装成 RequestPayload 类,用 .model_dump(exclude_none=True)(pydantic v2)或 .dict(exclude_none=True)(v1)自动过滤空字段
  • 响应统一反序列化为 ResponseData,避免裸 dict 访问引发 KeyError
  • 不要在 dataclass 中写业务逻辑方法,保持纯数据载体职责;行为逻辑放在 service 层
  • 注意 pydanticaliasserialization_alias,适配前后端字段命名差异(如 user_iduserId

别让重试逻辑污染业务代码 —— 用装饰器或 session mount 统一处理

网络抖动、临时限流、DNS 缓存失效都会导致偶发失败。每处都写 for i in range(3): try ... except ... sleep(...) 既重复又难维护。

requests 本身不内置重试,但可通过 urllib3.Retry + HTTPAdapter 注入到 Session,比装饰器更底层、更干净。

  • 只对幂等方法(GETHEADOPTIONS)开启自动重试;POST/PUT 默认不重试,除非你明确实现了幂等 key(如 X-Idempotency-Key
  • 配置 status_forcelist=(429, 502, 503, 504),避免对 400/401 这类客户端错误重试
  • backoff_factor 控制退避时间,不要硬写 time.sleep(1)
  • 重试日志必须打到 debug 级别,并带上原始 URL 和 retry count,否则线上排查时看不到“到底重试了没”
from urllib3.util.retry import Retry
from requests.adapters import HTTPAdapter

retry_strategy = Retry( total=3, status_forcelist=[429, 502, 503, 504], backoff_factor=0.3, allowed_methods=["HEAD", "GET", "OPTIONS"] ) adapter = HTTPAdapter(max_retries=retry_strategy) session.mount("http://", adapter) session.mount("https://", adapter)

真正难的不是封装一层函数,而是让所有开发者习惯从统一入口发请求、信任返回类型、不绕过重试和超时控制。一旦某人开始手写 requests.post(url, json={...}),那一整套设计就从根上松动了。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

400

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

528

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

305

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

67

2025.09.10

counta和count的区别
counta和count的区别

Count函数用于计算指定范围内数字的个数,而CountA函数用于计算指定范围内非空单元格的个数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

191

2023.11.20

session失效的原因
session失效的原因

session失效的原因有会话超时、会话数量限制、会话完整性检查、服务器重启、浏览器或设备问题等等。详细介绍:1、会话超时:服务器为Session设置了一个默认的超时时间,当用户在一段时间内没有与服务器交互时,Session将自动失效;2、会话数量限制:服务器为每个用户的Session数量设置了一个限制,当用户创建的Session数量超过这个限制时,最新的会覆盖最早的等等。

301

2023.10.17

session失效解决方法
session失效解决方法

session失效通常是由于 session 的生存时间过期或者服务器关闭导致的。其解决办法:1、延长session的生存时间;2、使用持久化存储;3、使用cookie;4、异步更新session;5、使用会话管理中间件。

700

2023.10.18

cookie与session的区别
cookie与session的区别

本专题整合了cookie与session的区别和使用方法等相关内容,阅读专题下面的文章了解更详细的内容。

86

2025.08.19

笔记本电脑卡反应很慢处理方法汇总
笔记本电脑卡反应很慢处理方法汇总

本专题整合了笔记本电脑卡反应慢解决方法,阅读专题下面的文章了解更多详细内容。

1

2025.12.25

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 0.6万人学习

Django 教程
Django 教程

共28课时 | 2.4万人学习

SciPy 教程
SciPy 教程

共10课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号