Starlette如何设置自定义错误页面

酷浩同学_1052

酷浩同学_1052

2026-11-18

307人浏览

原创

starlette 通过挂载自定义的 exceptionmiddleware 实例来设置自定义错误页面。你需要创建一个继承自 starlette.exceptions.exceptionmiddleware 的类,重写其 handle_404、handle_500 等方法,并在初始化应用时将其实例传入 app.add_middleware 或构造函数中。

Starlette如何设置自定义错误页面

如何拦截并返回特定 HTTP 状态码的 HTML 响应

要拦截特定的 HTTP 状态码(如 404 或 500)并返回自定义 HTML,需要重写 ExceptionMiddleware 中的对应处理方法。这些方法接收请求和异常实例作为参数,你可以在此处构造并返回一个 HTMLResponse 对象。例如,重写 handle_404 可以捕获所有未匹配路由的请求,并重写 handle_500 来捕获未处理的服务器内部错误。

Starlette如何设置自定义错误页面

from starlette.applications import Starlette
from starlette.responses import HTMLResponse
from starlette.exceptions import ExceptionMiddleware
from starlette.routing import Route, Mount
from starlette.staticfiles import StaticFiles

class CustomExceptionMiddleware(ExceptionMiddleware):
    def handle_404(self, request, exc):
        return HTMLResponse("<h1>Custom 404 Page</h1><p>Page not found.</p>&gt", status_code=404)

    def handle_500(self, request, exc):
        return HTMLResponse("<h1>Custom 500 Page</h1><p>Internal Server Error.</p>&gt", status_code=500)

# 假设有一个简单的路由
async def homepage(request):
    return HTMLResponse("<h1>Home</h1>&gt")

routes = [
    Route("/", homepage),
]

app = Starlette(
    routes=routes,
    debug=False, # 生产环境建议关闭 debug
    exception_handlers={
        404: CustomExceptionMiddleware().handle_404,
        500: CustomExceptionMiddleware().handle_500,
    }
)
# 或者更推荐的方式:
# custom_middleware = CustomExceptionMiddleware()
# app = Starlette(routes=routes, middleware=[custom_middleware])
# 注意:通常直接替换默认的 exception_handlers 字典更简单

上述代码展示了两种主要方式。第一种是直接修改 exception_handlers 字典,将状态码映射到处理函数。第二种是创建中间件实例。在实际操作中,直接覆盖 exception_handlers 是最常见且直观的做法。当访问不存在的路由时,Starlette 会触发 404 异常,此时 handle_404 被调用,返回自定义 HTML。当发生未捕获异常时,handle_500 被调用。

如何在自定义错误页中传递上下文数据

有时需要在错误页面中显示更多信息,例如请求的路径或错误详情。可以通过在自定义处理函数中访问 request 对象来获取这些信息。此外,如果需要传递模板变量,可以使用 Jinja2 等模板引擎渲染 HTML 字符串,而不是直接返回硬编码的字符串。

Starlette 1.5.1
Starlette 1.5.1

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

下载

Starlette如何设置自定义错误页面

from starlette.responses import HTMLResponse
from jinja2 import Template

class AdvancedExceptionMiddleware:
    def __init__(self):
        self.error_template = Template("""
            
            
            <title>Error {{ status_code }}</title><h1>Error {{ status_code }}</h1>
                <p>Path: {{ path }}</p>
                <p>Message: {{ message }}</p>
            
            
        """)

    def handle_404(self, request, exc):
        context = {
            'status_code': 404,
            'path': request.url.path,
            'message': 'The requested resource was not found.'
        }
        html_content = self.error_template.render(**context)
        return HTMLResponse(html_content, status_code=404)

    def handle_500(self, request, exc):
        context = {
            'status_code': 500,
            'path': request.url.path,
            'message': 'An unexpected error occurred.'
        }
        html_content = self.error_template.render(**context)
        return HTMLResponse(html_content, status_code=500)

# 使用示例
app = Starlette(
    routes=[],
    exception_handlers={
        404: AdvancedExceptionMiddleware().handle_404,
        500: AdvancedExceptionMiddleware().handle_500,
    }
)

在这个例子中,我们使用了 Jinja2 模板来动态生成错误页面。通过访问 request.url.path,我们可以将用户尝试访问的路径显示在错误页面上。这种方法使得错误页面更加友好和具有信息量。需要注意的是,在生产环境中,应避免泄露详细的错误堆栈信息,只展示必要的用户友好信息。

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

当程序接收到一个不存在的静态文件请求时,Starlette 默认行为是什么?

如果配置了 StaticFiles 并且请求的文件不存在,Starlette 会触发 404 异常。此时,如果已经设置了自定义的 handle_404 方法,该方法将被调用并返回自定义的 404 页面。如果没有设置自定义处理,Starlette 会返回默认的 404 响应。可以通过检查 request.url.path 来确认请求的路径,从而在自定义错误页中显示该路径。

相关文章

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

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

下载

相关标签:

starlette

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

796

23

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

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

2026.06.16

679

12

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

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

2026.11.12

140

15

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

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

2026.11.12

100

15

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

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

2026.11.12

100

15

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

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

2026.11.06

160

12

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

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

2026.11.06

140

13

热门下载

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

精品课程

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