返回

如何从 Flask POST 请求中优雅获取 JSON 数据？

python

在 Flask 中巧妙获取 POST JSON 数据：解决请求中的谜团

作为一名经验丰富的程序员，我经常遇到一个棘手的问题：如何从 Flask 应用程序的 POST 请求中优雅地获取 JSON 数据。让我分享一个真实世界的案例，以及如何巧妙解决这个问题。

问题陈述：

我在构建一个简单的 API 时，需要从 POST 请求中读取 JSON 数据。这个 JSON 数据包含了一些关键信息，例如文本消息。令人沮丧的是，当我尝试使用 request.json 直接获取数据时，它总是返回 None，而我期待它返回 {"text":"lalala"}。

探索解决方案：

为了解决这个问题，我尝试了几种不同的方法。最初，我使用了 request.json，这是 Flask 中常用的方法，但它并没有成功。

然后，我研究了 Flask 文档，发现了一个名为 request.get_json() 的函数，它专用于从请求中提取 JSON 数据。尝试一下，它像魅力一样运作！

正确的代码：

@app.route('/api/add_message/<uuid>', methods=['GET', 'POST'])
def add_message(uuid):
    content = request.get_json()
    print(content)
    return uuid

现在，当我发送一个包含 {"text":"lalala"} JSON 数据的 POST 请求时，content 变量将正确地打印出收到的数据。

幕后原理：

request.json 和 request.get_json() 函数在幕后有不同的处理方式。request.json 直接访问请求的 JSON 数据，而 request.get_json() 执行一些额外的处理，包括检查请求中是否存在 Content-Type 标头并处理错误情况。

注意事项：

在使用 request.get_json() 时，需要记住以下几点：

  • 确保在请求中正确设置了 Content-Type 标头，通常为 application/json。
  • 如果请求中没有 JSON 数据，它将返回 None，因此需要处理这种情况。
  • 如果 JSON 数据格式不正确，它将引发一个异常。

结论：

通过使用 request.get_json()，我能够轻松地从 POST 请求中获取 JSON 数据。这让我能够在 Flask 应用程序中继续构建我的 API 并自信地处理 JSON 数据。

常见问题解答：

  1. 为什么 request.json 不起作用？

    • request.json 直接访问请求的 JSON 数据，但它对请求中不存在的内容类型标头或错误情况没有处理。

  2. 如何检查请求中是否存在 JSON 数据？

    • 使用 request.is_json 检查 Content-Type 标头是否设置为 application/json。

  3. 如果请求中没有 JSON 数据怎么办？

    • 处理这种情况，返回适当的错误响应或在代码中使用默认值。

  4. 如果 JSON 数据格式不正确怎么办？

    • request.get_json() 会引发异常，因此需要在代码中处理该异常。

  5. 如何处理从 JSON 数据中提取的异常？

    • 在代码中使用 try...except 块来处理异常并返回适当的错误响应。