中间件 和 监听器

中间件是在请求到服务器前或后执行的程序。它们能用来修改请求到用户定义的处理程序或者从用户定义的处理程序中响应。

另外，Sanic 提供的监听器允许你在应用程序生命周期的多个端运行代码

中间件

有两种中间件：请求和响应。两者都使用 @app.middleware 装饰器声明，装饰器的参数是一个表示类型的字符串：'request' 或 'response'.

  • 请求中间件接收仅作为 request 的参数。
  • 响应中间件接收同时可以是 request 和 response 的参数。

最简单的中间件根本不会修改请求和响应：

  1. @app.middleware('request')
  2. async def print_on_request(request):
  3.     print("I print when a request is received by the server")
  5. @app.middleware('response')
  6. async def print_on_response(request, response):
  7.     print("I print when a response is returned by the server")

修改请求或响应

中间件可以修改给定的请求或响应的参数，只要它们不返回。下面的例子显示了这个实际的用例：

  1. app = Sanic(__name__)
  3. @app.middleware('response')
  4. async def custom_banner(request, response):
  5.     response.headers["Server"] = "Fake-Server"
  7. @app.middleware('response')
  8. async def prevent_xss(request, response):
  9.     response.headers["x-xss-protection"] = "1; mode=block"
  11. app.run(host="0.0.0.0", port=8000)

以上代码会按顺序接收两个中间件。第一个中间件 custom_banner 会修改 HTTP 响应头 Server 为 Fake-Server，第二个中间件 prevent_xss 会添加 HTTP 头以避免跨站脚本 (XSS) 攻击。这两个程序在用户程序返回响应后调用。

提前响应

如果中间件返回一个 HTTPResponse 对象，该请求会停止处理并且响应会被返回。如果这发生在一个到达相应用户路由处理程序前的请求，该处理程序永远不会被调用。返回响应也会阻止任何进一步的中间件运行。

  1. @app.middleware('request')
  2. async def halt_request(request):
  3.     return text('I halted the request')
  5. @app.middleware('response')
  6. async def halt_response(request, response):
  7.     return text('I halted the response')

监听器

如果你想执行 startup/teardown 代码作为你服务应用的启动或关闭，你可以使用以下监听器：

  • before_server_start
  • after_server_start
  • before_server_stop
  • after_server_stop

这些监听器会在 app 对象以及 asyncio loop 的程序上作为装饰器来执行。

例如：

  1. @app.listener('before_server_start')
  2. async def setup_db(app, loop):
  3.     app.db = await db_setup()
  5. @app.listener('after_server_start')
  6. async def notify_server_started(app, loop):
  7.     print('Server successfully started!')
  9. @app.listener('before_server_stop')
  10. async def notify_server_stopping(app, loop):
  11.     print('Server shutting down!')
  13. @app.listener('after_server_stop')
  14. async def close_db(app, loop):
  15.     await app.db.close()

也有可能使用 register_listener 方法来注册监听器。如果你定义你的监听器在一个当你已经实例化你的 app 后的别的模块上，这方法就会有用。

  1. app = Sanic()
  3. async def setup_db(app, loop):
  4.     app.db = await db_setup()
  6. app.register_listener(setup_db, 'before_server_start')

如果你想要在 loop 已经启动后安排一个后台任务来执行，Sanic 提供了 add_task 方法来简单地实现。

  1. async def notify_server_started_after_five_seconds():
  2.     await asyncio.sleep(5)
  3.     print('Server successfully started!')
  5. app.add_task(notify_server_started_after_five_seconds())

Sanic 会尝试自动注入 app，作为参数传递给任务：

  1. async def notify_server_started_after_five_seconds(app):
  2.     await asyncio.sleep(5)
  3.     print(app.name)
  5. app.add_task(notify_server_started_after_five_seconds)

或者同样效果地你可以明确地传递 app

  1. async def notify_server_started_after_five_seconds(app):
  2.     await asyncio.sleep(5)
  3.     print(app.name)
  5. app.add_task(notify_server_started_after_five_seconds(app))