# 信号(Signals)

信号可以让您应用中的不同部分可以相互通讯。

@app.signal("user.registration.created")
async def send_registration_email(**context):
    await send_email(context["email"], template="registration")
@app.post("/register")
async def handle_registration(request):
    await do_registration(request)
    await request.app.dispatch(
        "user.registration.created",
        context={"email": request.json.email}
    })

# 添加信号(Adding a signal)

添加信号的 API 十分像添加路由的。

async def my_signal_handler():
    print("something happened")
app.add_signal(my_signal_handler, "something.happened.ohmy")

同样的,信号也内置了装饰器来提供了便捷的注册方法。

@app.signal("something.happened.ohmy")
async def my_signal_handler():
    print("something happened")

信号也可以在注册在蓝图上。

bp = Blueprint("foo")
@bp.signal("something.happened.ohmy")
async def my_signal_handler():
    print("something happened")

# 内置信号(Built-in signals)

除了创建新信号外,还有许多从 Sanic 自身发出的内置信号。这些信号的存在为开发人员提供了更多将功能添加到请求和服务器生命周期中的机会。

和其他的信号一样,您同样可以将这些内置信号附加到应用程序上或者蓝图中。

@app.signal("http.lifecycle.complete")
async def my_signal_handler(conn_info):
    print("Connection has been closed")

以下是所有可用的信号,及信号对应可接受的参数:

Event name Arguments Conditions
http.routing.before request
http.routing.after request, route, kwargs, handler
http.lifecycle.begin conn_info
http.lifecycle.read_head head
http.lifecycle.request request
http.lifecycle.handle request
http.lifecycle.read_body body
http.lifecycle.exception request, exception
http.lifecycle.response request, response
http.lifecycle.send data
http.lifecycle.complete conn_info
http.middleware.before request, response {"attach_to": "request"} or {"attach_to": "response"}
http.middleware.after request, response {"attach_to": "request"} or {"attach_to": "response"}
server.init.before app, loop
server.init.after app, loop
server.shutdown.before app, loop
server.shutdown.after app, loop

为了更方便的使用内置信号,Sanic 设置了一个 Enum 对象,其中包含了所有允许的内置信号。您无需记住字符串形式的事件名称即可直接使用。

from sanic.signals import Event
@app.signal(Event.HTTP_LIFECYCLE_COMPLETE)
async def my_signal_handler(conn_info):
    print("Connection has been closed")

# 事件(Events)

信号是基于一个 event 的一个事件,就是一个简单的字符串,它由以下部分组成如下:

namespace.reference.action

小提示:

事件必须包含三个部分。如果您不是很清楚怎么声明一个事件,可以看看下面这些例子:

  • my_app.something.happened
  • sanic.notice.hello

# 事件参数(Event parameters)

一个事件可以是“动态的”,其动态的部分使用与 路由参数 相同的语法来声明。这允许事件根据任意值进行匹配。

@app.signal("foo.bar.<thing>")
async def signal_handler(thing):
    print(f"[signal_handler] {thing=}")
@app.get("/")
async def trigger(request):
    await app.dispatch("foo.bar.baz")
    return response.text("Done.")

查看 路由参数 一节来获取更多信息。

注意

只有事件的第三部分(“动作”部分)可以是动态的:

  • foo.bar.<thing> 🆗
  • foo.<bar>.baz

# 等待(Waiting)

除了主动分发信号来执行事件的响应函数,您的应用程序还可以被动地等待事件被触发。

await app.event("foo.bar.baz")

重要:等待是一个阻塞的动作。因此您可能会想使用 后台任务 来实现类型的功能。

async def wait_for_event(app):
    while True:
        print("> waiting")
        await app.event("foo.bar.baz")
        print("> event found\n")
@app.after_server_start
async def after_server_start(app, loop):
    app.add_task(wait_for_event(app))

您可以使用 * 符号来匹配任意动态事件。

@app.signal("foo.bar.<thing>")
...
await app.event("foo.bar.*")

# 分发(Dispatching)

未来,Sanic 将自动分发一些事件,以帮助开发人员注入程序和请求生命周期。

分发事件后将会做两件事件:

  1. 执行所有和该事件绑定的响应函数。
  2. 触发任何正在“等待”该事件的响应函数。
@app.signal("foo.bar.<thing>")
async def foo_bar(thing):
    print(f"{thing=}")
await app.dispatch("foo.bar.baz")
thing=baz

# 上下文(Context)

有时您会需要向信号的响应函数中传递额外的信息。在上面的第一个例子中,我们希望在注册的事件中能够获取用户使用的电子邮件地址。

@app.signal("user.registration.created")
async def send_registration_email(**context):
    print(context)
await app.dispatch(
    "user.registration.created",
    context={"hello": "world"}
)
{'hello': 'world'}

小提示

信号是在后台任务中分发的。

# 蓝图(Blueprints)

在蓝图中分发信号的工作机制类似于 中间件。在应用层面所分发的任何信号,都会传递到蓝图上。但如果只在蓝图上分发,就只会执行在该蓝图上定义的信号响应函数。

下面的例子可以更好解释:

bp = Blueprint("bp")
app_counter = 0
bp_counter = 0
@app.signal("foo.bar.baz")
def app_signal():
    nonlocal app_counter
    app_counter += 1
@bp.signal("foo.bar.baz")
def bp_signal():
    nonlocal bp_counter
    bp_counter += 1

调用 app.dispatch("foo.bar.baz") 将触发两个信号响应函数。

await app.dispatch("foo.bar.baz")
assert app_counter == 1
assert bp_counter == 1

调用 bp.dispatch("foo.bar.baz") 将只触发一个信号响应函数。

await bp.dispatch("foo.bar.baz")
assert app_counter == 1
assert bp_counter == 2
MIT Licensed
Copyright © 2018-present Sanic Community Organization

~ Made with ❤️ and ☕️ ~