Sanic框架中CORS配置问题的分析与解决
2025-05-12 16:21:24作者:宣利权Counsellor
Sanic是一个基于Python的异步Web框架,以其高性能和易用性著称。在使用Sanic开发Web应用时,跨域资源共享(CORS)是一个常见的需求。本文将深入分析Sanic官方文档中CORS配置存在的问题,并提供经过验证的解决方案。
问题背景
在Sanic 24.6.0版本中,按照官方文档配置CORS时,开发者会遇到路由中间件相关的异常。具体表现为当请求到达时,系统抛出AttributeError: 'types.SimpleNamespace' object has no attribute 'request_middleware'
错误,这表明路由中间件处理出现了问题。
错误分析
通过调试发现,问题根源在于options.py
文件中的app.router.reset()
和app.router.finalize()
调用。这两个操作会干扰Sanic的路由系统正常工作,导致路由中间件信息丢失。
解决方案
经过实践验证,可以简化CORS配置方案如下:
核心CORS处理模块
from sanic import Request, HTTPResponse
from typing import Iterable
def _add_cors_headers(request: Request, response: HTTPResponse, methods: str) -> None:
response.headers['Access-Control-Allow-Headers'] = "origin, content-type, accept, authorization, x-xsrf-token, x-request-id"
response.headers['Access-Control-Allow-Methods'] = methods
response.headers['Access-Control-Allow-Origin'] = request.headers.get('Origin') or '*'
def add_cors_headers(request: Request, response: HTTPResponse):
_add_cors_headers(request, response, request.app.ctx.uri_methods_mapping[request.route.uri])
OPTIONS请求处理模块
from collections import defaultdict
from typing import Dict
from sanic import empty, Request, HTTPResponse, Sanic
from sanic.router import Route
def _compile_routes_needing_options(routes: Dict[str, Route]) -> Dict[str, str]:
needs_options = defaultdict(list)
for route in routes:
if "OPTIONS" not in route.methods:
needs_options[route.uri].extend(route.methods)
return {uri: ",".join(methods) for uri, methods in dict(needs_options).items()}
async def options_handler(request: Request, *args, **kwargs) -> HTTPResponse:
return empty()
def setup_options(app: Sanic, _):
uri_methods_mapping = _compile_routes_needing_options(app.router.routes)
app.ctx.uri_methods_mapping = uri_methods_mapping
for uri, methods in uri_methods_mapping.items():
app.add_route(options_handler, uri, methods = ["OPTIONS"])
实现原理
- 路由分析:
_compile_routes_needing_options
函数扫描所有路由,找出需要添加OPTIONS方法的路由 - 上下文存储:将路由与方法映射关系存储在应用上下文中,便于后续访问
- OPTIONS处理:为每个需要CORS的路由添加OPTIONS方法处理
- CORS头处理:在响应中添加必要的CORS头信息
注意事项
- 此方案适用于Sanic 24.6.0及以上版本
- 如果需要更复杂的OPTIONS处理逻辑,可以扩展
options_handler
函数 - 确保在应用启动时正确注册这些中间件和路由
总结
通过简化CORS配置方案,避免了路由系统的干扰,同时保持了完整的CORS功能。这个方案经过实际项目验证,能够稳定处理跨域请求,为Sanic开发者提供了一个可靠的CORS实现参考。
登录后查看全文
热门项目推荐
cherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端TypeScript039RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统Vue0417arkanalyzer
方舟分析器:面向ArkTS语言的静态程序分析框架TypeScript042GitCode百大开源项目
GitCode百大计划旨在表彰GitCode平台上积极推动项目社区化,拥有广泛影响力的G-Star项目,入选项目不仅代表了GitCode开源生态的蓬勃发展,也反映了当下开源行业的发展趋势。03PowerWechat
PowerWechat是一款基于WeChat SDK for Golang,支持小程序、微信支付、企业微信、公众号等全微信生态Go00openGauss-server
openGauss kernel ~ openGauss is an open source relational database management systemC++0146
热门内容推荐
1 freeCodeCamp JavaScript高阶函数中的对象引用陷阱解析2 freeCodeCamp全栈开发课程中测验游戏项目的参数顺序问题解析3 freeCodeCamp音乐播放器项目中的函数调用问题解析4 freeCodeCamp 课程中关于角色与职责描述的语法优化建议 5 freeCodeCamp博客页面工作坊中的断言方法优化建议6 freeCodeCamp猫照片应用教程中的HTML注释测试问题分析7 freeCodeCamp论坛排行榜项目中的错误日志规范要求8 freeCodeCamp英语课程视频测验选项与提示不匹配问题分析9 freeCodeCamp课程页面空白问题的技术分析与解决方案10 freeCodeCamp课程视频测验中的Tab键导航问题解析
最新内容推荐
Visual-RFT项目中模型路径差异的技术解析 Microcks在OpenShift上部署Keycloak PostgreSQL的权限问题解析 Beyla项目中的HTTP2连接检测问题解析 RaspberryMatic项目中HmIP-BWTH温控器假期模式设置问题分析 Lets-Plot 库中条形图标签在坐标轴反转时的定位问题解析 BedrockConnect项目版本兼容性问题解析与解决方案 LiquidJS 10.21.0版本新增数组过滤功能解析 Mink项目中Selenium驱动切换iframe的兼容性问题分析 Lichess移动端盲棋模式字符串优化解析 sbctl验证功能JSON输出问题解析
项目优选
收起

🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
51
15

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
574
416

React Native鸿蒙化仓库
C++
125
208

openGauss kernel ~ openGauss is an open source relational database management system
C++
77
146

🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
442
39

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
98
253

前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。
官网地址:https://matechat.gitcode.com
693
91

FOLib 是一个为Ai研发而生的、全语言制品库和供应链服务平台
Java
108
6

🔥🔥超过1000本的计算机经典书籍、个人笔记资料以及本人在各平台发表文章中所涉及的资源等。书籍资源包括C/C++、Java、Python、Go语言、数据结构与算法、操作系统、后端架构、计算机系统知识、数据库、计算机网络、设计模式、前端、汇编以及校招社招各种面经~
120
16

本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
299
1.03 K