Python Falcon - 中间件



“中间件”是一个函数,它在处理每个请求(在任何特定响应器处理之前)以及在返回每个响应之前进行处理。此函数接收进入应用程序的每个请求。

中间件的工作方式类似于钩子。但是,与钩子不同,中间件方法全局应用于整个应用程序。它可以通过运行其中定义的代码来对请求执行某些处理,然后将请求传递给相应的操作函数进行处理。它还可以处理操作函数生成的响应,然后再将其返回。

中间件是一个类,它实现了一个或多个以下事件处理程序方法。对于 WSGI 应用程序,这些方法为:

  • process_request (self, req, resp) − 此方法在路由请求之前处理请求。

  • process_resource (self, req, resp, resource, params) − 路由后处理请求。可以传递一个dict对象,该对象表示从路由的URI模板字段派生的任何附加参数。

  • process_response (self, req, resp, resource, req_succeeded) − 此方法用于响应的后处理(路由之后)。如果未引发异常,则req_succeeded参数为 True,否则为 False。

对于 ASGI 应用程序,除了上述方法外,中间件类还可以定义更多方法。

为了解释 ASGI 规范的可选部分生命周期事件,可以包含启动和关闭事件处理程序。

  • process_startup (self, scope, event) − 此方法处理 ASGI 生命周期启动事件。当服务器准备好启动并接收连接但尚未开始这样做时,会调用它。

  • process_shutdown(self, scope, event) − 此方法处理 ASGI 生命周期关闭事件。当服务器停止接受连接并关闭所有活动连接时,会调用它。

由于 ASGI 应用程序也响应 WebSocket 协议下的请求,因此中间件可以定义以下协程方法:

  • process_request_ws (self, req, ws) − 此方法在路由 WebSocket 握手请求之前处理它。

  • process_resource_ws (self, req, ws, resource, params) − 此方法在路由后处理 WebSocket 握手请求。可以将从路由的 URI 模板字段派生的 dict 对象传递给资源的响应器。

中间件类的实例必须在初始化时添加到 Falcon 应用程序对象中。对于 WSGI Falcon 应用程序:

class MyMiddleware:
   def process_request(self, req, resp):
      pass
   def process_resource(self, req, resp, resource, params):
      pass
   def process_response(self, req, resp, resource, req_succeeded):
      pass
from falcon import App
app=App(middleware=[MyMiddleware()])

对于 ASGI 应用程序:

class MyMiddleware:
   async def process_startup(self, scope, event):
      pass
   async def process_shutdown(self, scope, event):
      pass
   async def process_request(self, req, resp):
      pass
   async def process_resource(self, req, resp, resource, params):
      pass
   async def process_response(self, req, resp, resource, req_succeeded):
      pass
   async def process_request_ws(self, req, ws):
      pass
   async def process_resource_ws(self, req, ws, resource, params):
      pass
from falcon.asgi import App
app=App(middleware=[MyMiddleware()])
广告