讲师中心 微信公众号

工具推荐

视频效率加速
Seko
Seko

AI短剧一键生成成片

Laper
Laper

剧本策划到成片协作

剧云
剧云

中文短剧剧本制作平台

AniShort
AniShort

AI短剧协同制作平台

Starlette如何处理异常并返回JSON错误信息

梦婷大大_4161

梦婷大大_4161

发布时间:2026-11-18 13:31:30

|

835人浏览过

|

来源于php中文网

原创

starlette 通过注册自定义异常处理器(exception handlers)来统一处理异常并返回 json 错误信息。开发者需要在应用实例上调用 add_exception_handler 方法,将特定的异常类映射到对应的异步处理函数中,这些函数接收请求和异常实例作为参数,并返回标准的 jsonresponse 对象。

Starlette如何处理异常并返回JSON错误信息

如何注册全局异常处理器

要捕获所有未处理的异常并返回统一的 JSON 格式,可以注册一个针对 Exception 基类的处理器。该处理器会拦截所有未被其他特定处理器捕获的异常,确保 API 始终返回结构化的错误响应,而不是默认的 HTML 调试页面。

Starlette如何处理异常并返回JSON错误信息

from starlette.applications import Starlette
from starlette.responses import JSONResponse
from starlette.routing import Route
import traceback

async def homepage(request):
    return JSONResponse({"hello": "world"})

async def error_handler(request, exc):
    # 记录详细的堆栈信息以便调试
    print(traceback.format_exc())
    # 返回标准的 JSON 错误响应
    return JSONResponse(
        status_code=500,
        content={"detail": str(exc)}
    )

app = Starlette(
    routes=[Route("/", homepage)],
)
# 注册全局异常处理器
app.add_exception_handler(Exception, error_handler)

运行上述代码后,访问根路径将返回正常数据。如果修改 homepage 使其抛出异常(如 raise ValueError("test")),客户端将收到状态码为 500 且包含 detail 字段的 JSON 响应。

如何注册特定类型的异常处理器

除了全局处理器,还可以为特定的异常类型注册专门的处理器,例如 HTTPException。这种方式允许针对不同错误场景返回不同的 HTTP 状态码和错误详情,提供更精细的错误控制。

Mailtrap Node.js SDK 用于事务性和沙盒电子邮件
Mailtrap Node.js SDK 用于事务性和沙盒电子邮件

一个基于官方 Mailtrap Node.js SDK 构建的 ASE 技能,用于发送事务邮件并与 Mailtrap 沙盒或生产流程协作。它非常适合需要 API 驱动邮件投递、测试邮箱验证和结构化消息自动化的代理工作流。

下载

Starlette如何处理异常并返回JSON错误信息

from starlette.exceptions import HTTPException
from starlette.responses import JSONResponse

async def http_exception_handler(request, exc):
    return JSONResponse(
        status_code=exc.status_code,
        content={"detail": exc.detail}
    )

app.add_exception_handler(HTTPException, http_exception_handler)

async def raise_error(request):
    raise HTTPException(status_code=404, detail="Not Found")

app.routes.append(Route("/error", raise_error))

当访问 /error 端点时,程序会抛出 HTTPException。由于已注册特定处理器,客户端将收到状态码为 404 且内容为 {"detail": "Not Found"} 的 JSON 响应,而不是通用的 500 错误。

如何处理自定义业务异常

在实际开发中,通常需要定义自己的业务异常类,以便在业务逻辑中抛出具有特定语义的错误。通过将这些自定义异常类注册到异常处理器中,可以实现更清晰的错误分类和处理逻辑。

class CustomBusinessError(Exception):
    def __init__(self, message, code):
        self.message = message
        self.code = code
        super().__init__(self.message)

async def custom_error_handler(request, exc):
    return JSONResponse(
        status_code=400,
        content={
            "error_code": exc.code,
            "message": exc.message
        }
    )

app.add_exception_handler(CustomBusinessError, custom_error_handler)

async def trigger_custom_error(request):
    raise CustomBusinessError(message="Invalid input", code=1001)

app.routes.append(Route("/custom", trigger_custom_error))

访问 /custom 端点时,程序会抛出 CustomBusinessError。注册的处理器会捕获该异常,并返回包含 error_code 和 message 字段的 JSON 响应,状态码固定为 400。这种机制使得前端可以根据 error_code 进行具体的业务逻辑处理。

相关文章

相关标签:

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

热门AI工具

更多
PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

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

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

119

2025.12.22

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

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

594

2026.02.06

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

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

796

2026.05.09

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

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

679

2026.06.16

GoFrame框架Web开发与路由中间件
GoFrame框架Web开发与路由中间件

本专题聚焦GoFrame框架的Web开发,拆解路由注册与匹配规则、请求参数获取、参数校验与中间件执行顺序,说明统一响应、JWT鉴权、文件上传与接口文档生成的落地方式,并补充优雅重启与测试实践。

0

2026.11.17

GoFrame框架安装与gf命令行工具
GoFrame框架安装与gf命令行工具

本专题围绕GoFrame框架的安装与工具链配置展开,讲清Go版本要求、gf命令行的安装方式、代理镜像与依赖准备,说明项目初始化、热编译、交叉编译打包的做法,并整理安装阶段的常见报错与验证步骤。

0

2026.11.17

GoFrame框架零基础入门
GoFrame框架零基础入门

本专题整理GoFrame框架的入门知识,从模块化设计理念、环境准备到跑通第一个Web服务,讲清目录分层、配置加载、日志与中间件的用法,并对比Gin、Go-Zero的差异,帮助Go开发者建立整体认知。

0

2026.11.17

SQLAlchemy 一对多关系怎么建立
SQLAlchemy 一对多关系怎么建立

SQLAlchemy 一对多关系怎么建立?本专题整理父子表外键、relationship 双向映射、关联查询、级联删除和加载优化等相关文章,帮助你理解并实现常见的 ORM 关系建模。

0

2026.11.17

SQLAlchemy 如何增删改查
SQLAlchemy 如何增删改查

SQLAlchemy 如何增删改查?本专题整理 ORM 新增记录、条件查询、更新和删除、Session 事务提交与批量处理等实用文章,帮助你掌握 Python 数据库操作流程。

0

2026.11.17

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn