如何通过Uvicorn设置响应头

雨墨吖_3157

雨墨吖_3157

2026-11-15

593人浏览

原创

Uvicorn不直接设置响应头,仅转发应用通过http.response.start消息传入的bytes类型headers;FastAPI中应显式返回Response或JSONResponse并传入字符串headers字典,手写ASGI时须确保headers为[[b'k',b'v']]格式。

如何通过uvicorn设置响应头

Uvicorn 本身不直接处理响应头设置,它是 ASGI 服务器,只负责把请求转给应用、把应用返回的 send 消息按协议发出去;真正控制响应头的地方,是你的 ASGI 应用逻辑(比如 FastAPI、Starlette,或手写 ASGI callable)。

FastAPI 中设置自定义响应头最常用的方式

FastAPI 提供了 Response 类和 Header 依赖两种主流方式,推荐优先用 Response —— 它明确、可控、不隐式。

常见错误是试图在函数体里直接修改 response.headers 却没声明返回类型,导致 FastAPI 自动包装成 JSONResponse 并覆盖你设的头。

  • 必须显式声明返回类型为 Response 或其子类(如 JSONResponse),否则 FastAPI 会按返回值自动推断,大概率丢掉你手动加的头
  • JSONResponse 构造时可直接传 headers 字典,键名用字符串,值也必须是字符串(非字节)
  • 若需动态计算 header 值(比如基于请求参数生成 ETag),用 Response 更灵活
from fastapi import FastAPI, Response
from starlette.responses import JSONResponse

app = FastAPI()

@app.get("/with-headers")
def with_headers():
    return JSONResponse(
        content={"status": "ok"},
        headers={
            "X-Processed-Time": "123ms",
            "Cache-Control": "no-cache",
            "X-Content-Type-Options": "nosniff"
        }
    )

@app.get("/dynamic-headers")
def dynamic_headers():
    response = Response(content='{"msg":"done"}', media_type="application/json")
    response.headers["X-Timestamp"] = "2026-10-14T22:19:00Z"
    return response

手写 ASGI callable 时如何发带自定义头的响应

如果你绕过 FastAPI,直接写 ASGI 应用(比如做轻量 Thumbnail Server),响应头必须通过 http.response.start 消息的 headers 字段传入,且所有 header key/value 都必须是 bytes,不是字符串。

容易踩的坑:用字符串当 header 值会触发 TypeError: expected bytes;漏掉 b'content-type' 可能导致浏览器解析失败;Cache-Control 值写错格式(比如混入空格或非法字符)会被忽略。

Uvicorn 0.52.1
Uvicorn 0.52.1

Uvicorn 0.52.1 是 Python ASGI Web 服务器,提供异步应用服务及 WebSocket 支持,常用于 FastAPI、Starlette 等应用的开发和部署。本下载为官方 PyPI 通用 wheel 包,可使用 pip 安装,并由包管理器处理所需依赖。

下载
  • headers 是二维字节列表:[[b'key1', b'value1'], [b'key2', b'value2']]
  • 务必确保每个 value 是合法 ASCII 字节串;中文或特殊符号需编码(如 b"utf-8")
  • 不要在 http.response.body 消息里重复塞 header,那会被忽略
async def app(scope, receive, send):
    if scope['type'] == 'http':
        await send({
            'type': 'http.response.start',
            'status': 200,
            'headers': [
                [b'content-type', b'application/json'],
                [b'x-server', b'uvicorn-custom'],
                [b'cache-control', b'max-age=300']
            ]
        })
        await send({
            'type': 'http.response.body',
            'body': b'{"ok": true}'
        })

Uvicorn 启动参数对响应头的影响

Uvicorn 自身不注入或改写响应头,但有两个启动选项间接影响 header 行为:

  • --proxy-headers:启用后,Uvicorn 会从 X-Forwarded-* 头中提取信息,并重写 scope 中的 scheme、host 等字段;这会影响后续应用生成的 Location 或 Link 头的值,但不会自动加新 header
  • --forwarded-allow-ips:配合 --proxy-headers 使用,指定可信代理 IP;若配错,可能导致 X-Forwarded-Proto 被忽略,使应用误判 HTTPS 状态,进而生成错误的 Strict-Transport-Security 或重定向头

这两个参数不改变你代码里写的响应头,但会改变应用运行时看到的请求上下文,从而影响你代码中基于请求生成响应头的逻辑。

最易被忽略的一点:ASGI 规范要求所有 header 值必须是 bytes,而 FastAPI 的 JSONResponse 等封装层做了字符串到字节的转换;一旦你脱离这些封装(比如用 StreamingResponse 或自定义 Response 子类),就必须自己确保 headers 字典里的 value 是字节串,否则 Uvicorn 在序列化时会直接报错退出。

相关文章

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

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

下载

相关标签:

uvicorn

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

相关专题

更多
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API

Python FastAPI 异步开发利用 async/await 关键字,通过定义异步视图函数、使用异步数据库库 (如 databases)、异步 HTTP 客户端 (如 httpx),并结合后台任务队列(如 Celery)和异步依赖项,实现高效的 I/O 密集型 API,显著提升吞吐量和响应速度,尤其适用于处理数据库查询、网络请求等耗时操作,无需阻塞主线程。

2025.12.22

119

5

Python 微服务架构与 FastAPI 框架
Python 微服务架构与 FastAPI 框架

本专题系统讲解 Python 微服务架构设计与 FastAPI 框架应用,涵盖 FastAPI 的快速开发、路由与依赖注入、数据模型验证、API 文档自动生成、OAuth2 与 JWT 身份验证、异步支持、部署与扩展等。通过实际案例,帮助学习者掌握 使用 FastAPI 构建高效、可扩展的微服务应用,提高服务响应速度与系统可维护性。

2026.02.06

594

18

Python Web框架FastAPI 全栈开发教程合集
Python Web框架FastAPI 全栈开发教程合集

以 FastAPI 为核心,讲解现代 Python Web API 的高效开发方式,涵盖路由定义与路径参数/查询参数/请求体绑定、Pydantic 模型的数据校验与序列化、依赖注入(Depends)系统的分层设计、中间件与 CORS 配置、OAuth2 + JWT 认证流程、后台任务(BackgroundTasks)、WebSocket 实时通信、SQLAlchemy 异步 ORM 集成、自动生成 OpenAPI/Swagger 交互文

2026.05.09

776

23

Python FastAPI异步微服务与高性能接口设计
Python FastAPI异步微服务与高性能接口设计

本专题聚焦 Python FastAPI 框架在高性能接口与微服务开发中的应用,讲解异步请求处理、依赖注入机制、路由设计、数据库异步操作以及接口性能优化策略。结合实际项目案例,帮助开发者构建高并发、低延迟的现代化后端服务架构。

2026.06.16

659

12

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

2026.11.12

40

15

Go-Zero安装与goctl环境配置教程
Go-Zero安装与goctl环境配置教程

本专题围绕Go-Zero的安装与工具链配置展开,讲清Go版本要求、goctl安装方式、代理镜像、protoc依赖与环境变量设置,说明多版本共存、升级回退与CI流水线安装的做法,并整理安装阶段的常见报错与验证步骤。

2026.11.12

40

15

Go-Zero零基础入门教程
Go-Zero零基础入门教程

本专题整理Go-Zero的入门知识,从框架定位、环境准备到跑通第一个API服务,讲清目录分层、配置加载、日志与中间件的基本用法,并对比Gin、Kratos的差异,帮助Go开发者建立整体认知,判断它是否适合当前项目。

2026.11.12

20

15

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

2026.11.06

140

12

Postman请求头Headers怎么设置
Postman请求头Headers怎么设置

围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。

2026.11.06

100

13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方部署指南
Uvicorn官方部署指南

共0课时 | 0人学习

Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习