Chalice Blueprints 模块化实战:在 Python Serverless 应用中拆分路由、事件源与 Lambda 函数
Chalice Blueprints 模块化实战:在 Python Serverless 应用中拆分路由、事件源与 Lambda 函数
Chalice 是 AWS 官方推出的 Python Serverless 微框架,而 Blueprint 是它组织大型应用的官方方案。本文基于 Chalice 仓库的 Blueprints 官方文档,系统讲解如何用 Blueprint 把路由、定时任务、SNS/S3/SQS 事件处理器等资源拆分到独立模块中,再统一注册进主 app.py,并深入到 chalice/app.py 源码与 tests/unit/test_app.py 单元测试,揭示其「延迟注册」的实现原理。读完本文,你将掌握 Blueprint 的完整用法、url_prefix / name_prefix 的挂载技巧,以及如何组织一个多模块、多事件源的 Chalice 应用。
什么是 Chalice Blueprint
Chalice blueprints 用于把应用组织成逻辑组件。使用 Blueprint,你可以在 app.py 之外的独立模块中定义资源和装饰器,然后在主 app.py 中注册该 Blueprint。Blueprint 支持应用对象(Chalice 实例)上可用的所有装饰器。
从概念上讲,Chalice 的 Blueprint 与 Flask 中的 Blueprint 非常相似:Flask 的 Blueprint 允许你把一组 URL 路由从主 Flask 对象中分离出来定义;Chalice 把这一概念扩展到了所有资源上——一个 Chalice Blueprint 除了路由集合之外,还可以包含 Lambda 函数、事件处理器、内置 authorizer(鉴权器)等。
在源码中,Blueprint 类定义于 chalice/app.py#L2147-L2242,它直接继承了 DecoratorAPI(chalice/app.py#L719-L897)。正如代码注释所说明的,实现 Blueprint 的另一种思路是把公共 API 中的每个装饰器都复制到 Blueprint 类上;而实际实现选择继承 DecoratorAPI,这样新装饰器可以自动获得,代价是需要在内部重写管理 handler 注册的方法,把注册动作延迟到拿到 app 对象之后。
DecoratorAPI 中定义的全部装饰器(Blueprint 全部支持)包括:
| 装饰器 | 用途 | 定义位置 |
|---|---|---|
@bp.route(path, **kwargs) |
定义 REST API 路由 | chalice/app.py#L839-L847 |
@bp.schedule(expression, ...) |
定时触发(rate/cron 表达式) | chalice/app.py#L795-L803 |
@bp.on_s3_event(bucket, ...) |
S3 事件处理 | chalice/app.py#L748-L758 |
@bp.on_sns_message(topic) |
SNS 消息处理 | chalice/app.py#L760-L766 |
@bp.on_sqs_message(queue, ...) |
SQS 消息处理 | chalice/app.py#L768-L785 |
@bp.on_cw_event(event_pattern) |
CloudWatch Events 处理 | chalice/app.py#L787-L793 |
@bp.on_kinesis_record(stream, ...) |
Kinesis 流处理 | chalice/app.py#L805-L819 |
@bp.on_dynamodb_record(stream_arn, ...) |
DynamoDB 流处理 | chalice/app.py#L821-L837 |
@bp.lambda_function() |
纯 Lambda 函数(无事件源) | chalice/app.py#L849-L852 |
@bp.authorizer(...) |
内置(Builtin)鉴权器 | chalice/app.py#L733-L746 |
@bp.on_ws_connect / on_ws_message / on_ws_disconnect |
WebSocket 处理器 | chalice/app.py#L854-L875 |
@bp.middleware(event_type='all') |
中间件 | chalice/app.py#L722-L731 |
这一点由单元测试 test_every_decorator_added_to_blueprint(tests/unit/test_app.py#L2516-L2528)强制保证:测试用 inspect.getmembers 枚举 DecoratorAPI 的所有公开方法,逐一断言它们都存在于 Blueprint 上——也就是说,凡是应用上能用的装饰器,Blueprint 上一定也能用。
快速上手:创建第一个 Blueprint
官方文档给出了一个最基础的示例:把一部分路由定义在独立文件中。首先创建项目并准备模块目录:
$ chalice new-project blueprint-demo
$ cd blueprint-demo
$ mkdir chalicelib
$ touch chalicelib/__init__.py
$ touch chalicelib/blueprints.py
接下来编辑 chalicelib/blueprints.py:
from chalice import Blueprint
extra_routes = Blueprint(__name__)
@extra_routes.route('/foo')
def foo():
return {'foo': 'bar'}
这里的 __name__ 表示 Blueprint 的导入路径。这个名称必须与模块的实际导入名一致,这样函数才能在 Lambda 运行时被正确导入(源码中该名称被记录为 module_name,见 chalice/app.py#L982,并用于拼装 handler_string)。在测试 test_can_combine_lambda_functions_and_routes_in_blueprints(tests/unit/test_app.py#L2330-L2350)中,Blueprint 的 import name 为 'app.chalicelib.blueprints.foo',最终生成的处理函数引用正是 'app.chalicelib.blueprints.foo.myfunction'。
现在在 app.py 中导入并注册这个 Blueprint,同时直接在 app.py 里也加一条路由:
from chalice import Chalice
from chalicelib.blueprints import extra_routes
app = Chalice(app_name='blueprint-demo')
app.register_blueprint(extra_routes)
@app.route('/')
def index():
return {'hello': 'world'}
此时应用已经定义了两条路由:/ 直接在 app.py 中定义;/foo 定义在 chalicelib/blueprints.py 中,并通过 app.register_blueprint(extra_routes) 被挂载进应用。register_blueprint 的签名位于 chalice/app.py#L1293-L1297:
def register_blueprint(self, blueprint: 'Blueprint',
name_prefix: Optional[str] = None,
url_prefix: Optional[str] = None) -> None:
blueprint.register(self, options={'name_prefix': name_prefix,
'url_prefix': url_prefix})
它会直接委托给 Blueprint.register(),把应用实例和两个可选前缀参数一起传递。
部署并验证
$ chalice deploy
Creating deployment package.
Creating IAM role: blueprint-demo-dev
Creating lambda function: blueprint-demo-dev
Creating Rest API
Resources deployed:
- Lambda ARN: arn:aws:lambda:us-west-2:1234:function:blueprint-demo-dev
- Rest API URL: https://rest-api.execute-api.us-west-2.amazonaws.com/api/
部署后即可请求两条路由:
$ http https://rest-api.execute-api.us-west-2.amazonaws.com/api/
HTTP/1.1 200 OK
...
{
"hello": "world"
}
$ http https://rest-api.execute-api.us-west-2.amazonaws.com/api/foo
HTTP/1.1 200 OK
...
{
"foo": "bar"
}
注意:即便路由定义在 chalicelib/blueprints.py 中,部署后 app.py 与 blueprints.py 会被打进同一个 deployment package,因此 /foo 能够被正常访问。
Blueprint 注册:url_prefix 与 name_prefix
app.register_blueprint 接受两个可选参数:name_prefix 和 url_prefix,用于把 Blueprint 中的资源挂载到指定的 URL 前缀和名称前缀之下。
url_prefix:Blueprint 中定义的所有路由都会在该前缀下生效。例如把url_prefix='/myprefix'传给一个定义了/foo、/bar的 Blueprint,最终路由变为/myprefix/foo、/myprefix/bar。对应测试test_can_mount_apis_at_url_prefix(tests/unit/test_app.py#L2292-L2305)。name_prefix:Blueprint 创建的所有 Lambda 函数名都会加上该前缀。例如name_prefix='myprefix_'会把lambda_function()定义出的函数名从myfunction改为myprefix_myfunction(见test_can_mount_lambda_functions_with_name_prefix,tests/unit/test_app.py#L2353-L2372)。
注意:
name_prefix不适用于与 API Gateway 关联的 Lambda 函数,即所有用@app.route()装饰的函数——这些函数的部署名由 API Gateway 场景统一管理,前缀不会生效。
从源码看,前缀的处理发生在 _do_register_handler(chalice/app.py#L967-L991):name_prefix 直接拼接到资源名前;url_prefix 则被放入 kwargs,仅当 handler_type == 'route' 时传递。路由拼接的最终实现在 _register_route(chalice/app.py#L1183-L1190):
url_prefix = kwargs.pop('url_prefix', None)
if url_prefix is not None:
path = '/'.join([url_prefix.rstrip('/'),
path.strip('/')]).rstrip('/')
这段代码通过先 rstrip('/') 再 join 的方式,兼容了 url_prefix 带不带斜杠、路由带不带前导斜杠的各种写法。
一个特殊场景是 root URL 挂载:测试 test_can_mount_root_url_in_blueprint(tests/unit/test_app.py#L2308-L2327)验证了把定义了 / 的 Blueprint 以 url_prefix='/foo' 挂载后,会同时存在 /(主应用的根路由)、/foo 和 /foo/bar 三条路由,互不冲突。
高级示例:按 API 与事件源拆分模块
官方文档的进阶示例展示了一种常见组织方式:把应用拆分为「API 模块」和「事件源模块」。项目结构如下:
$ ls -la chalicelib/
__init__.py
api.py
events.py
chalicelib/api.py 的内容:
from chalice import Blueprint
myapi = Blueprint(__name__)
@myapi.route('/')
def index():
return {'hello': 'world'}
@myapi.route('/foo')
def index():
return {'foo': 'bar'}
chalicelib/events.py 的内容:
from chalice import Blueprint
myevents = Blueprint(__name__)
@myevents.schedule('rate(5 minutes)')
def cron(event):
pass
@myevents.on_sns_message('MyTopic')
def handle_sns_message(event):
pass
在 app.py 中统一注册:
from chalice import Chalice
from chalicelib.events import myevents
from chalicelib.api import myapi
app = Chalice(app_name='blueprint-demo')
app.register_blueprint(myevents)
app.register_blueprint(myapi)
此时 app.py 只负责注册 Blueprint,所有资源都定义在各自的模块中,各模块职责单一、互不干扰。同样的模式可以扩展到 S3、SQS、DynamoDB、Kinesis 等所有事件源。测试 test_can_mount_all_decorators_in_blueprint(tests/unit/test_app.py#L2392-L2427)一次性把 route、lambda_function、schedule、on_s3_event、on_sns_message、on_sqs_message 全部放进一个 Blueprint,并同时指定 name_prefix='myprefix_' 与 url_prefix='/bar',最终断言:4 个事件源全部注册、lambda_function 名变为 myprefix_mylambdafunction、路由变为 /bar/foo——这是多装饰器 + 双前缀组合的权威参考用例。
源码深挖:延迟注册机制
Blueprint 之所以能把资源定义在模块外部、又在注册时才真正生效,核心在于「延迟注册(deferred registration)」机制。Blueprint.__init__(chalice/app.py#L2148-L2153)维护了一个 _deferred_registrations 列表:
def __init__(self, import_name: str) -> None:
self._import_name = import_name
self._deferred_registrations: \
List[Callable[[Chalice, Dict[str, Any]], None]] = []
self._current_app: Optional[Chalice] = None
self._lambda_context = None
当你使用 @bp.route(...)、@bp.schedule(...) 等装饰器时,由于 Blueprint 继承自 DecoratorAPI,装饰器最终都会调用 Blueprint._register_handler(chalice/app.py#L2216-L2238)。与应用对象直接注册不同,这个实现不会立即注册,而是把注册动作打包成一个闭包追加到 _deferred_registrations:
def _register_handler(self, handler_type: str, name: str,
user_handler: UserHandlerFuncType,
wrapped_handler: Any, kwargs: Dict[str, Any],
options: Optional[Dict[Any, Any]] = None
) -> None:
def _register_blueprint_handler(app: Chalice,
options: Dict[Any, Any]) -> None:
if handler_type in _EVENT_CLASSES:
wrapped_handler.middleware_handlers = \
app._get_middleware_handlers(
_MIDDLEWARE_MAPPING[handler_type])
app._register_handler(
handler_type, name, user_handler, wrapped_handler,
kwargs, options)
self._deferred_registrations.append(_register_blueprint_handler)
直到 app.register_blueprint(bp) 被调用时,Blueprint.register(chalice/app.py#L2191-L2196)才真正把 app 实例注入并逐个执行这些闭包:
def register(self, app: Chalice, options: Dict[str, Any]) -> None:
self._current_app = app
all_options = options.copy()
all_options['module_name'] = self._import_name
for function in self._deferred_registrations:
function(app, all_options)
注意这里把 _import_name(即 Blueprint(__name__) 的 __name__)写入了 module_name,后续 _do_register_handler 用它拼出 handler_string = '%s.%s' % (module_name, user_handler.__name__)(chalice/app.py#L983),这就是 Lambda 运行时定位处理函数的完整导入路径。同时,对于 _EVENT_CLASSES(chalice/app.py#L2279-L2288)中的事件源类型,还会通过 _MIDDLEWARE_MAPPING(chalice/app.py#L2291-L2299)把应用级的中间件处理器注入到事件处理函数上。
Blueprint 运行时上下文
注册之后,Blueprint 内定义的函数可以通过 Blueprint 对象访问运行时的上下文信息。Blueprint 类提供了 4 个只读属性(chalice/app.py#L2155-L2189):
| 属性 | 含义 |
|---|---|
bp.log |
应用的日志记录器(等同于 app.log) |
bp.current_request |
当前 HTTP 请求对象(Request) |
bp.current_app |
注册 Blueprint 的 Chalice 应用实例 |
bp.lambda_context |
当前 Lambda 调用的上下文(LambdaContext) |
这些属性在 Blueprint 尚未注册到应用时访问会抛出 RuntimeError(如 "Can only access Blueprint.log if it's registered to an app.")。对应测试 test_runtime_error_if_current_request_access_on_non_registered_blueprint(tests/unit/test_app.py#L2510-L2513)验证了未注册时访问 current_request 会抛异常。
注册后的正常访问则由一系列测试覆盖:
test_can_call_current_request_on_blueprint_when_mounted(tests/unit/test_app.py#L2430-L2442):在 Blueprint 路由内调用bp.current_request.to_dict()取回请求元数据;test_can_call_current_app_on_blueprint_when_mounted(tests/unit/test_app.py#L2445-L2456):通过bp.current_app.app_name取应用名'myapp';test_can_call_lambda_context_on_blueprint_when_mounted(tests/unit/test_app.py#L2459-L2470):通过bp.lambda_context取 Lambda 上下文;test_can_access_log_when_mounted(tests/unit/test_app.py#L2473-L2487):在路由内调用bp.log.info(...)不报错。
此外,Blueprint 也支持通过 register_middleware(chalice/app.py#L2208-L2214)注册中间件,同样采用延迟注册策略,在 register() 时转发给 app.register_middleware。
在 Blueprint 中使用鉴权器
内置 authorizer 同样可以在 Blueprint 中定义并使用。测试 test_can_add_authorizer_with_url_prefix_and_routes(tests/unit/test_app.py#L2490-L2507)展示了完整用法:在 Blueprint 中定义 @bp.authorizer() 鉴权函数,再在 @bp.route('/foo', authorizer=myauth) 中引用,最后以 url_prefix='/bar' 注册。断言显示鉴权器被注册进 builtin_auth_handlers,其 handler 字符串同样基于 Blueprint 的模块名生成('app.chalicelib.blueprints.foo.myauth')。这在实践中意味着你可以把「某组 API + 它的鉴权逻辑」整体打包为一个可复用的 Blueprint。
本地调试与测试
Blueprint 不影响 Chalice 的本地开发与测试体验。得益于 Chalice.__call__(chalice/app.py#L1342-L1356)对路由的统一分发,注册后的 Blueprint 路由与普通路由走同一套请求处理管线,chalice local 可以直接调试。测试方面,tests/unit/test_app.py 中的用例大量使用 app.Chalice('myapp') + app.Blueprint(...) 的组合来验证注册行为,同时 test_can_preserve_signature_on_blueprint(tests/unit/test_app.py#L2254-L2268)与 test_blueprint_docstring_is_preserved(tests/unit/test_app.py#L2282-L2289)保证了 Blueprint 定义的处理函数签名和 docstring 均不被改动,可以直接按原签名调用测试。这也提醒我们在自己的测试代码里可以直接像调用普通函数一样调用 Blueprint 内定义的 handler。
小结
Blueprint 是 Chalice 应用模块化的标准手段,其价值体现在三个方面:
- 组织清晰:把 REST 路由、定时任务、SNS/S3/SQS 事件源、纯 Lambda、鉴权器按业务边界拆分到独立模块,主
app.py只做注册; - 挂载灵活:通过
url_prefix与name_prefix实现 URL 路径与资源名的统一前缀管理,多个 Blueprint 可自由组合,甚至可以在一个应用中同时挂载多个版本或模块; - 实现优雅:
Blueprint继承DecoratorAPI并基于延迟注册机制运行,保证了装饰器 API 的完整性,同时module_name的注入确保了 Lambda 部署后处理函数可被正确导入(见 chalice/app.py 与 tests/unit/test_app.py)。
对于任何规模增长到「单文件放不下」的 Chalice 项目,把资源迁入 Blueprint 都是首选的演进路径:它与官方文档 multifile 项目组织、中间件、鉴权器 等主题无缝衔接,是构建生产级 Serverless 应用的基石能力。