是否可以在中间件中访问会话（来自 aiohttp_session）？

Question

我正在设置一个 aiohttp 服务器，使用 aiohttp_session 将数据存储到 EncryptedCookieStorage。我用它来存储一个 7 天有效的令牌，以及过期日期和一个刷新令牌。无论客户端访问哪个端点，我都希望检查令牌（存储在会话中）是否需要刷新。中间件的选择非常明显。

问题是，当我调用 await aiohttp_session.get_session(request) 时，我得到一个很好的 RuntimeError 要求我为 aiohttp.web.Application 设置 aiohttp_session 中间件。我的猜测是我的自定义中间件在处理会话加载的中间件之前被称为 ，因此会话尚不可访问。我已经搜索了一些关于中间件的 "priority" 系统，但没有找到任何东西。

我的服务器设置在一个 main.py 文件中，例如：

def main(): app = web.Application() middleware.setup(app) session_key = base64.urlsafe_b64decode(fernet.Fernet.generate_key()) aiohttp_session.setup(app, EncryptedCookieStorage(session_key)) # I have tried swapping the two setup functions web.run_app(app) if __name__ == '__main__': main()

其中 middleware.setup() 在单独的包中，在 __init__.py:

# For each python file in the package, add it's middleware function to the app middlewares def setup(app): for filename in listdir('middleware'): if filename[-2:] == 'py' and filename[:2] != '__': module = __import__('rpdashboard.middleware.' + filename[:-3], fromlist=['middleware']) app.middlewares.append(module.middleware)

最后，我想要获取会话的中间件是：

@web.middleware async def refresh_token_middleware(request, handler): session = await get_session(request) if session.get('token'): pass # To be implemented ... return await handler(request) middleware = refresh_token_middleware

这里的执行问题：

# From aiohttp_session async def get_session(request): session = request.get(SESSION_KEY) if session is None: storage = request.get(STORAGE_KEY) if storage is None: # This is raised raise RuntimeError( "Install aiohttp_session middleware " "in your aiohttp.web.Application")

正如我之前所说，会话似乎不打算在中间件中访问，并且尚未加载。那么如何在会话加载之前阻止我的自定义中间件运行呢？或者我自己运行手动 aiohttp_session 中间件？有可能吗？

Answer 1

您自己更改顺序。代码应该是这样的

def main():
    app = web.Application()
    session_key = base64.urlsafe_b64decode(fernet.Fernet.generate_key())
    aiohttp_session.setup(app, EncryptedCookieStorage(session_key))
    # I have tried swapping the two setup functions
    middleware.setup(app)

    web.run_app(app)

如果您查看 aiohttp_session.setup

的代码

https://github.com/aio-libs/aiohttp-session/blob/master/aiohttp_session/init.py

def setup(app, storage):
    """Setup the library in aiohttp fashion."""

    app.middlewares.append(session_middleware(storage))

如你所见，这个函数中添加了中间件。在 middleware.setup(app) 之前添加您的中间件会使会话仍然不可用于请求

Answer 2

是的，以正确的顺序添加到应用程序的中间件组件可以访问会话中间件设置的会话存储。

aiohttp 文档涵盖了中间件组件在其 Middlewares section:

中的优先顺序

Internally, a single request handler is constructed by applying the middleware chain to the original handler in reverse order, and is called by the RequestHandler as a regular handler.

再往下，他们用一个例子来说明这是什么意思。综上所述，他们使用了两个中间件组件来报告他们的进入和退出，并按顺序将它们添加到app.middlewares列表中：

... middlewares=[middleware1, middleware2]

此排序产生以下输出：

Middleware 1 called
Middleware 2 called
Handler function called
Middleware 2 finished
Middleware 1 finished

因此传入请求沿着不同的中间件传递 ，其顺序与它们添加到 app.middlewares 列表.

的顺序相同

接下来，aiohttp_session 还记录了他们如何添加会话中间件，在 API entry for aiohttp_session.setup():

The function is shortcut for:
app.middlewares.append(session_middleware(storage))

因此他们的中间件组件被添加到列表的末尾。按照上面的意思，任何需要访问会话的东西都必须在这个中间件组件之后。

会话中间件所做的只是将存储添加到 aiohttp_session.STORAGE_KEY 键下的请求；这使得会话可用于跟随它的任何其他中间件组件。您的中间件组件不需要做任何特殊的事情，只需在会话中间件之后添加并将存储对象添加到请求中即可。请求对象为designed to share data between components this way.

您的代码将所有中间件组件放在会话中间件组件之前：

middleware.setup(app)
# ...
aiohttp_session.setup(app, EncryptedCookieStorage(session_key))

这为您提供了 [..., refresh_token_middleware, ..., session_middleware] 的排序，并且您的中间件无法访问任何会话信息。

所以你必须调换顺序；先调用 aiohttp_session.setup() ，然后再添加您自己的组件：

aiohttp_session.setup(app, EncryptedCookieStorage(session_key))
middleware.setup(app)

如果您在访问会话存储时仍然遇到问题，那么这意味着 其中一个中间件组件正在再次删除会话存储信息。

您可以在不同位置使用以下中间件工厂来报告存在的会话存储以帮助您调试它：

from aiohttp import web
from aiohttp_session import STORAGE_KEY

COUNTER_KEY = "__debug_session_storage_counter__"
_label = {
    False: "\x1b[31;1mMISSING\x1b[0m",
    True: "\x1b[32;1mPRESENT\x1b[0m",
}

def debug_session_storage(app):
    pre = nxt = ""
    if app.middlewares:
        previous = app.middlewares[-1]
        name = getattr(previous, "__qualname__", repr(previous))
        pre = f" {name} ->"
        nxt = f" {name} <-"

    @web.middleware
    async def middleware(request, handler):
        counter = request.get(COUNTER_KEY, -1) + 1
        request[COUNTER_KEY] = counter
        found = STORAGE_KEY in request
        indent = " " * counter
        print(f"{indent}-{pre} probe#{counter} - storage: {_label[found]}")
        try:
            return await handler(request)
        finally:
            print(f"{indent}-{nxt} probe#{counter} - done")

    app.middlewares.append(middleware)

如果你在你添加的每个中间件之间插入这个，你应该能够弄清楚会话存储是否丢失以及在哪里丢失：

def setup(app):
    # start with a probe
    debug_session_storage(app)

    for filename in listdir('middleware'):
        if filename[-2:] == 'py' and filename[:2] != '__':
            module = __import__('rpdashboard.middleware.' + filename[:-3], fromlist=['middleware'])

            app.middlewares.append(module.middleware)

            # Add debug probe after every component
            debug_session_storage(app)

这应该告诉你

每个探测器之前有什么中间件组件
如果存在会话存储，使用 ANSI 绿色和红色以便于识别
如果有人完全重置了请求；如果探测计数再次从 0 开始，那么某些东西不仅会清除会话密钥，还会清除探测计数器！

是否可以在中间件中访问会话（来自 aiohttp_session）？

Is it possible to access a session (from aiohttp_session) within a middleware?

python

middleware

aiohttp