快速上手Starlette:安装配置与基础结构

风浩君_9811

风浩君_9811

2026-11-22

328人浏览

原创

starlette 是一个轻量级且高性能的 asgi 框架,适合构建现代 python web 应用。要快速上手,只需通过 pip install starlette 安装依赖,并编写一个包含 asgiapp 类型签名的异步函数作为入口。启动时推荐使用 uvicorn 服务器,指定应用模块和变量即可运行。这种结构将路由逻辑与核心应用解耦,便于后续扩展。

快速上手Starlette:安装配置与基础结构

如何定义 Starlette 的路由映射关系

在 Starlette 中,路由是通过 Router 类实例化的,它将 URL 路径字符串与具体的处理函数或视图类关联起来。开发者需要创建一个 routes 列表,其中每个元素包含 path、endpoint 以及可选的 name。当请求到达时,Router 会按顺序匹配路径,找到第一个匹配的端点后调用相应的异步函数。这种机制支持路径参数提取,例如 /users/{user_id} 会自动将 user_id 传递给端点函数。

from starlette.applications import Starlette
from starlette.routing import Route, Router
from starlette.responses import PlainTextResponse
import uvicorn

async def homepage(request):
    return PlainTextResponse('Hello World!')

async def user_profile(request):
    user_id = request.path_params.get('user_id')
    return PlainTextResponse(f'User: {user_id}')

routes = [
    Route('/', endpoint=homepage),
    Route('/users/{{user_id}}', endpoint=user_profile),
]

app = Starlette(routes=routes)

if __name__ == '__main__':
    uvicorn.run(app, host='0.0.0.0', port=8000)

上述代码定义了两个路由:根路径和带参数的用户路径。运行后访问 /users/123 将返回 User: 123。注意路径中的花括号在 Python 字符串中需转义为双花括号 {{user_id}},以避免被误认为格式化字符串。实际输出取决于请求的 URL 和 path_params 的提取结果。

快速上手Starlette:安装配置与基础结构

如何处理中间件对请求的修改流程

Starlette 的中间件遵循洋葱模型,请求进入时依次经过各个中间件的 process_request 或类似逻辑,响应返回时再逆向穿过。开发者可以通过继承 Middleware 基类或实现简单的可调用对象来添加自定义行为。例如,添加 CORS 支持或日志记录。中间件可以修改 request 对象,也可以拦截响应直接返回,从而改变最终结果。这种设计允许灵活地插入横切关注点,如认证、压缩或错误处理。

from starlette.middleware.base import BaseHTTPMiddleware
from starlette.requests import Request
from starlette.responses import Response

class CustomMiddleware(BaseHTTPMiddleware):
    async def dispatch(self, request: Request, call_next):
        # 修改请求头
        request.headers.set('x-custom-header', 'value')
        
        # 调用下一个中间件或应用
        response = await call_next(request)
        
        # 修改响应头
        response.headers['x-custom-response'] = 'processed'
        return response

# 在 app 中注册
app.add_middleware(CustomMiddleware)

这段代码展示了一个自定义中间件,它在请求阶段添加了一个请求头,在响应阶段添加了一个响应头。当客户端发送请求时,服务器会在处理业务逻辑前注入 x-custom-header,并在返回前注入 x-custom-response。这种流程确保了所有请求都经过统一的处理逻辑,适用于全局配置或监控。

Starlette 1.5.1
Starlette 1.5.1

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

下载

快速上手Starlette:安装配置与基础结构

基于程序输入条件判断异常处理的具体问题

在 Starlette 应用中,当路由匹配失败或发生未捕获异常时,默认会返回 404 或 500 错误页面。开发者可以通过注册 exception_handler 来自定义这些行为的输出。例如,当请求的路径不存在时,Router 会抛出 NoRouteFoundError,此时可以返回 JSON 格式的友好提示。同样,对于数据库连接失败等运行时错误,可以捕获特定异常并返回结构化错误信息。这种机制允许根据输入条件的不同(如无效参数或内部错误)返回不同的状态码和消息体。

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

async def custom_404_handler(request, exc):
    return JSONResponse(
        status_code=404,
        content={'message': 'Resource not found'}
    )

async def custom_500_handler(request, exc):
    return JSONResponse(
        status_code=500,
        content={'message': 'Internal server error'}
    )

app.add_exception_handler(404, custom_404_handler)
app.add_exception_handler(500, custom_500_handler)

上述代码注册了 404 和 500 的自定义处理器。当访问不存在的 URL 时,服务器不再返回默认的 HTML 页面,而是返回 {"message": "Resource not found"}。这改变了默认的错误响应格式,使 API 更加一致。实际行为取决于注册的处理器是否覆盖默认行为,以及异常的类型。若未注册处理器,则回退到默认实现。

如何配置 Starlette 的应用生命周期事件

Starlette 提供了 lifespan 上下文管理器来处理应用的启动和关闭事件。开发者可以在 startup 阶段初始化数据库连接池、加载配置文件或预热缓存,在 shutdown 阶段清理资源、关闭连接或保存状态。这种机制替代了传统的 on_startup 和 on_shutdown 装饰器,提供更清晰的异步控制流。通过 async with lifespan: 块,可以确保资源的生命周期与应用同步,避免内存泄漏或连接泄露。

from contextlib import asynccontextmanager

@asynccontextmanager
async def lifespan(app):
    # 启动时执行
    print("Application starting...")
    yield
    # 关闭时执行
    print("Application shutting down...")

app = Starlette(lifespan=lifespan)

这段代码定义了一个简单的生命周期管理器,在应用启动和关闭时打印日志。实际应用中,可以在 yield 前后放置初始化和清理代码。例如,启动时创建数据库引擎,关闭时 dispose 连接。这种模式确保了资源的正确管理,特别是在容器化部署中,应用的重启和停止会触发相应的事件处理。

相关文章

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

CVE-2026-114938高危漏洞修复
CVE-2026-114938高危漏洞修复

Java4Shell是OpenJDK Base64解码路径中的远程代码执行漏洞,编号CVE-2026-114938,2026年11月17日披露,官方已发布17.0.21.1、21.0.13.1等修复版本,建议优先升级 。本专题围绕Java4Shell(CVE-2026-114938)持续更新,从漏洞原理、受影响版本、受影响产品到修复与自查一站式汇总,适合Java开发、运维与安全人员快速定位风险。ARM64环境不受影响,x86-64环境请

2026.11.22

0

11

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

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

2026.11.20

20

7

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

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

2026.11.20

20

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

60

8

热门下载

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

精品课程

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