Starlette如何编写自定义响应类

风婷酱_4268

风婷酱_4268

2026-11-22

738人浏览

原创

starlette 编写自定义响应类需要继承 starlette.responses.response 基类,并重写 render() 方法以返回字节数据。通过这种方式,你可以完全控制响应的状态码、头部信息以及主体内容的生成逻辑,从而满足特定业务需求。

Starlette如何编写自定义响应类

如何定义并注册自定义响应类

定义自定义响应类的核心在于实现 render(self, request: Request) -> bytes 方法。该方法接收一个 Request 对象作为参数,但通常只需要关注返回值,即最终发送给客户端的字节流。在子类中,你可以初始化一些自定义属性,并在 render 方法中根据这些属性生成内容。例如,创建一个返回 JSON 数据的响应类,只需在初始化时存储数据,然后在渲染时将其序列化为 JSON 字符串并编码为 UTF-8 字节即可。

Starlette如何编写自定义响应类

from starlette.responses import Response
import json

class CustomJSONResponse(Response):
    def __init__(self, data: dict, status_code: int = 200):
        self.data = data
        super().__init__(content=b'', status_code=status_code)

    def render(self, request) -> bytes:
        # 将字典序列化为 JSON 字符串并编码为字节
        return json.dumps(self.data).encode('utf-8')

在上述代码中,CustomJSONResponse 继承了 Response。构造函数接收一个字典 data 和可选的状态码。父类 __init__ 被调用时传入空字节串,因为实际内容将在 render 中生成。当 Starlette 处理请求时,它会调用 render 方法获取最终的字节内容,并自动设置正确的 Content-Type 头(如果未手动指定)。

如何处理复杂的数据结构或特殊格式

对于更复杂的场景,如返回 XML、CSV 或二进制文件,同样遵循继承 Response 并重写 render 的模式。关键在于确保 render 方法返回的是有效的字节串。例如,在处理 CSV 数据时,可以使用 Python 标准库中的 io.StringIO 来构建 CSV 内容,然后将其转换为字节。此外,还可以根据需要修改 headers 属性,以添加特定的 HTTP 头,如 Content-Disposition 用于文件下载。

Starlette 1.5.1
Starlette 1.5.1

Starlette 1.5.1 是轻量级 Python ASGI 框架与工具集,提供路由、请求响应、中间件、WebSocket 和后台任务等组件,适合构建异步 Web 服务。本下载为官方 PyPI 通用 wheel 包,可使用 pip 安装,并由包管理器处理依赖;运行应用时还需配置 ASGI 服务器。

下载

Starlette如何编写自定义响应类

import csv
import io
from starlette.responses import Response

class CSVResponse(Response):
    def __init__(self, rows: list, headers: list):
        self.rows = rows
        self.headers = headers
        super().__init__(content=b'', media_type='text/csv')

    def render(self, request) -> bytes:
        output = io.StringIO()
        writer = csv.writer(output)
        writer.writerow(self.headers)
        writer.writerows(self.rows)
        return output.getvalue().encode('utf-8')

这个 CSVResponse 类展示了如何处理结构化数据。它接受行数据和表头,使用 csv 模块生成 CSV 格式的字符串,最后编码为字节。通过设置 media_type='text/csv',Starlette 会自动在响应头中设置正确的 MIME 类型。这种模式适用于任何需要将内存中的数据转换为特定文本或二进制格式的场景。

基于程序中某个输入、条件或结果的具体问题

在实际使用中,一个常见的问题是自定义响应类如何处理异常。如果在 render 方法内部发生错误,例如序列化失败或编码错误,这些异常会直接传播出去,导致服务器返回 500 错误。因此,在实现 render 方法时,应当考虑加入适当的错误处理逻辑,或者确保输入数据的有效性。例如,在 CustomJSONResponse 中,如果传入的 data 不是可序列化的对象,json.dumps 会抛出 TypeError。开发者需要在应用层面捕获这些异常,或在自定义响应类中进行预处理,以保证系统的稳定性。

相关文章

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

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

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系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

614

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

816

23

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

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

2026.06.16

699

12

Navicat创建数据库教程
Navicat创建数据库教程

本专题整理Navicat创建数据库相关教程,介绍新建前的准备、基础设置和创建后的检查方法。内容兼顾入门学习及实际使用需求,帮助用户了解不同数据库类型下的操作差异,为后续建表、保存数据和日常管理提供参考。

2026.11.20

0

7

Navicat入门教程大全
Navicat入门教程大全

本专题整理Navicat入门教程,从认识软件界面到开展数据库操作,介绍初次使用需要了解的知识和方法。内容兼顾连接配置、数据管理及日常使用中的疑问,方便用户按学习进度查阅,为后续实践和独立操作打好基础。

2026.11.20

0

17

Navicat数据库连接配置指南
Navicat数据库连接配置指南

从确认数据库信息到建立可用连接,本专题串联Navicat连接数据库的相关知识和操作方法。既有初次配置时需要了解的基础内容,也有连接后的检查思路,方便用户按实际需求查阅教程,逐步熟悉数据库连接的设置流程。

2026.11.20

0

10

PHP8.6数组与数据处理教程
PHP8.6数组与数据处理教程

本专题汇总PHP8.6数组与数据处理教程,涵盖CSV读取和导出、引用遍历删除、array_filter回调模式、配置键名冲突、pathinfo文件名校验、GMP大整数进制转换及UTF-8正则筛选,说明升级兼容变化、输入范围和失败处理方法。

2026.11.20

0

8

PHP8.6升级迁移教程
PHP8.6升级迁移教程

本专题汇总PHP8.6升级迁移与弃用接口改造教程,涵盖反射调用、对象属性赋值、标识符更名、构造函数与__debugInfo调整,以及插件类名检查、常量导出、ArrayIterator排序、SPL和DTO查询参数转换,帮助梳理弃用提示并完成代码兼容改造。

2026.11.20

0

10

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程