Flask Flask app 包装了 DispatcherMiddleware 不再拥有 test_client

在本文中，我们将介绍 Flask 中 DispatcherMiddleware 的使用以及其对 test_client 的影响。

阅读更多：Flask 教程

什么是 Flask 和 DispatcherMiddleware

Flask 是一个使用 Python 编写的轻量级 Web 框架。它以简洁的设计和易于扩展的特点受到了开发者的广泛喜爱。

DispatcherMiddleware 是 Flask 中的一个中间件，它可以将多个 Flask 应用程序包装在一个主应用程序中，以便于路由和处理请求。通过使用 DispatcherMiddleware，我们可以在一个服务器中同时运行多个 Flask 应用程序。

DispatcherMiddleware 对 Flask app 的包装

在 Flask 中，我们可以使用 DispatcherMiddleware 将多个 Flask app 包装在一起，并在主应用程序中根据不同的路由来选择执行哪个子应用程序。

下面是一个使用 DispatcherMiddleware 将两个 Flask app 包装在一起的示例代码：

from flask import Flask
from werkzeug.middleware.dispatcher import DispatcherMiddleware

app1 = Flask(__name__)
app2 = Flask(__name__)

@app1.route('/app1')
def app1_route():
    return "This is App 1"

@app2.route('/app2')
def app2_route():
    return "This is App 2"

app = DispatcherMiddleware(app1, {
    '/app1': app1,
    '/app2': app2
})

在上述代码中，我们创建了两个 Flask app，并定义了它们的路由和对应的处理函数。然后，我们使用 DispatcherMiddleware 将这两个 app 包装在一起，并通过指定路由来控制请求的分发。

test_client 的变化

在之前的版本中，使用 DispatcherMiddleware 包装的 Flask app 仍然可以通过 test_client 来进行测试。test_client 是 Flask 提供的一个测试客户端，可以模拟请求并得到响应，方便进行集成测试。

然而，在最新的版本中，使用 DispatcherMiddleware 包装的 Flask app 不再直接拥有 test_client。这意味着我们无法像以前那样通过 app.test_client() 来获取测试客户端。

如何获取 DispatcherMiddleware 中 Flask app 的 test_client

虽然无法直接获取 DispatcherMiddleware 中 Flask app 的 test_client，但我们仍然可以通过以下方式获取：

使用 Werkzeug 提供的测试客户端 werkzeug.test.Client。DispatcherMiddleware 实现了 WSGI 的 __call__ 方法，因此我们可以通过 werkzeug.test.Client(app) 来创建相应的测试客户端。

from werkzeug.test import Client
from werkzeug.wrappers import BaseResponse

client = Client(app, BaseResponse)

如果我们只需要获取一个子应用程序的 test_client，而不是所有的子应用程序，我们可以直接使用该子应用程序的 test_client。

比如，在上述示例中，如果我们只需要获取 app1 的 test_client，我们可以使用 app1.test_client() 来获取它。

示例

为了更好地理解获取 DispatcherMiddleware 中 Flask app 的 test_client 的方法，我们将通过一个示例来演示。

假设我们有两个 Flask app，app1 和 app2，我们使用 DispatcherMiddleware 将它们包装在一起。

我们来定义 app1 和 app2 的路由和对应的处理函数：

from flask import Flask
from werkzeug.middleware.dispatcher import DispatcherMiddleware

app1 = Flask(__name__)
app2 = Flask(__name__)

@app1.route('/app1')
def app1_route():
    return "This is App 1"

@app2.route('/app2')
def app2_route():
    return "This is App 2"

app = DispatcherMiddleware(app1, {
    '/app1': app1,
    '/app2': app2
})

接下来，我们使用前述的两种方法获取 test_client。

使用 Werkzeug 提供的测试客户端 werkzeug.test.Client：

from werkzeug.test import Client
from werkzeug.wrappers import BaseResponse

client = Client(app, BaseResponse)
response1 = client.get('/app1')
response2 = client.get('/app2')

print(response1.data)  # 输出 b'This is App 1'
print(response2.data)  # 输出 b'This is App 2'

直接使用子应用程序的 test_client：

response1 = app1.test_client().get('/app1')
response2 = app2.test_client().get('/app2')

print(response1.data)  # 输出 b'This is App 1'
print(response2.data)  # 输出 b'This is App 2'

通过上述代码，我们可以得到预期的响应结果。

总结

在本文中，我们介绍了 Flask 中的 DispatcherMiddleware 及其对 test_client 的影响。我们了解到最新版本中使用 DispatcherMiddleware 包装的 Flask app 不再直接拥有 test_client。然而，我们可以通过使用 Werkzeug 提供的测试客户端 werkzeug.test.Client 或直接使用子应用程序的 test_client 来获取对应的测试客户端。这些方法使我们能够继续测试 DispatcherMiddleware 包装的 Flask app，并确保应用程序的准确性和稳定性。