如何在 Flask 中设置响应标头？
Posted
技术标签:
【中文标题】如何在 Flask 中设置响应标头？【英文标题】：How do I set response headers in Flask? 【发布时间】：2014-11-09 16:52:38 【问题描述】：这是我的代码：
@app.route('/hello', methods=["POST"])
def hello():
resp = make_response(render_template('hello.html'))
resp.headers['Access-Control-Allow-Origin'] = '*'
return resp
但是，当我从浏览器向我的服务器发出请求时，我收到此错误：
XMLHttpRequest cannot load http://localhost:5000/hello.
No 'Access-Control-Allow-Origin' header is present on the requested resource.
我也尝试过这种方法，在请求“之后”设置响应标头：
@app.after_request
def add_header(response):
response.headers['Access-Control-Allow-Origin'] = '*'
return response
没有骰子。我犯了同样的错误。有没有办法在路由函数中设置响应头？像这样的东西是理想的：
@app.route('/hello', methods=["POST"])
def hello(response): # is this a thing??
response.headers['Access-Control-Allow-Origin'] = '*'
return response
但我无论如何都找不到这样做。请帮忙。
编辑
如果我用这样的 POST 请求卷曲 url：
curl -iX POST http://localhost:5000/hello
我收到此回复：
HTTP/1.0 500 INTERNAL SERVER ERROR
Content-Type: text/html
Content-Length: 291
Server: Werkzeug/0.9.6 Python/2.7.6
Date: Tue, 16 Sep 2014 03:58:42 GMT
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<title>500 Internal Server Error</title>
<h1>Internal Server Error</h1>
<p>The server encountered an internal error and was unable to complete your request. Either the server is overloaded or there is an error in the application.</p>
有什么想法吗？
【问题讨论】：
我建议使用中间件来解决这个问题，或者只使用 flask-cors 扩展 【参考方案1】：你可以很容易地做到这一点：
@app.route("/")
def home():
resp = flask.Response("Foo bar baz")
resp.headers['Access-Control-Allow-Origin'] = '*'
return resp
看看flask.Response和flask.make_response()
但有件事告诉我你还有另一个问题，因为after_request 也应该正确处理它。
编辑
我刚刚注意到您已经在使用make_response，这是其中一种方法。就像我之前说的，after_request 应该也能正常工作。尝试通过 curl 访问端点，看看标头是什么：
curl -i http://127.0.0.1:5000/your/endpoint
你应该看到
> curl -i 'http://127.0.0.1:5000/'
HTTP/1.0 200 OK
Content-Type: text/html; charset=utf-8
Content-Length: 11
Access-Control-Allow-Origin: *
Server: Werkzeug/0.8.3 Python/2.7.5
Date: Tue, 16 Sep 2014 03:47:13 GMT
注意 Access-Control-Allow-Origin 标头。
编辑 2
正如我所怀疑的，你得到了 500，所以你没有像你想象的那样设置标题。在启动应用程序之前尝试添加app.debug = True，然后重试。您应该得到一些输出，显示问题的根本原因。
例如：
@app.route("/")
def home():
resp = flask.Response("Foo bar baz")
user.weapon = boomerang
resp.headers['Access-Control-Allow-Origin'] = '*'
return resp
提供格式良好的 html 错误页面，底部有这个（有助于 curl 命令）
Traceback (most recent call last):
...
File "/private/tmp/min.py", line 8, in home
user.weapon = boomerang
NameError: global name 'boomerang' is not defined
【讨论】：
【参考方案2】：使用make_response of Flask 之类的
@app.route("/")
def home():
resp = make_response("hello") #here you could use make_response(render_template(...)) too
resp.headers['Access-Control-Allow-Origin'] = '*'
return resp
来自flask docs，
flask.make_response(*args)
有时需要在视图中设置额外的标题。因为视图不必返回响应对象，但可以返回由 Flask 本身转换为响应对象的值，因此向其添加标头变得很棘手。可以调用此函数而不是使用返回，您将获得一个响应对象，您可以使用它来附加标头。
【讨论】：
您可以在args中发送请求：flask.pocoo.org/docs/0.10/api/#flask.Flask.make_response【参考方案3】：这就是在我的烧瓶应用程序中添加我的标头的方式，并且效果很好
@app.after_request
def add_header(response):
response.headers['X-Content-Type-Options'] = 'nosniff'
return response
【讨论】：
【参考方案4】：这对我有用
from flask import Flask
from flask import Response
app = Flask(__name__)
@app.route("/")
def home():
return Response(headers='Access-Control-Allow-Origin':'*')
if __name__ == "__main__":
app.run()
【讨论】：
还有一个符号return Response(headers='Access-Control-Allow-Origin':'*')，对我来说看起来更干净。【参考方案5】：
According to the documentation，您可以从视图函数中返回标头以及响应。
如果返回元组，则元组中的项目可以提供额外的 信息。此类元组必须采用
(response, status)的形式，(response, headers)，或(response, status, headers)。状态值 将覆盖状态代码，标题可以是列表或字典 额外的标题值。
例如：
@app.route('/hello', methods=["POST"])
def hello():
return flask.make_response(), "Access-Control-Allow-Origin": "*"
或者：
@app.route('/hello', methods=["POST"])
def hello():
return "foo": "bar", 200, "Access-Control-Allow-Origin": "*"
【讨论】：
【参考方案6】：我们可以使用flask.gflask.g在 Python Flask 应用程序中使用 Flask 应用程序上下文设置响应头
这种在 Flask 应用程序上下文中使用 flask.g 设置响应头的方式是线程安全的，可用于从应用程序的任何文件设置自定义和动态属性，如果我们从以下位置设置自定义/动态响应头，这将特别有用任何帮助类，也可以从任何其他文件（比如中间件等）访问，这个flask.g 是全局的并且仅对该请求线程有效。
如果我想从这个应用程序调用的另一个 api/http 调用中读取响应头，然后提取任何并将其设置为这个应用程序的响应头。
示例代码：文件：helper.py
import flask
from flask import request, g
from multidict import CIMultiDict
from asyncio import TimeoutError as HttpTimeout
from aiohttp import ClientSession
def _extract_response_header(response)
"""
extracts response headers from response object
and stores that required response header in flask.g app context
"""
headers = CIMultiDict(response.headers)
if 'my_response_header' not in g:
g.my_response_header=
g.my_response_header['x-custom-header'] = headers['x-custom-header']
async def call_post_api(post_body):
"""
sample method to make post api call using aiohttp clientsession
"""
try:
async with ClientSession() as session:
async with session.post(uri, headers=_headers, json=post_body) as response:
responseResult = await response.read()
_extract_headers(response, responseResult)
response_text = await response.text()
except (HttpTimeout, ConnectionError) as ex:
raise HttpTimeout(exception_message)
文件：middleware.py
import flask
from flask import request, g
class SimpleMiddleWare(object):
"""
Simple WSGI middleware
"""
def __init__(self, app):
self.app = app
self._header_name = "any_request_header"
def __call__(self, environ, start_response):
"""
middleware to capture request header from incoming http request
"""
request_id_header = environ.get(self._header_name)
environ[self._header_name] = request_id_header
def new_start_response(status, response_headers, exc_info=None):
"""
set custom response headers
"""
# set the request header as response header
response_headers.append((self._header_name, request_id_header))
# this is trying to access flask.g values set in helper class & set that as response header
values = g.get(my_response_header, )
if values.get('x-custom-header'):
response_headers.append(('x-custom-header', values.get('x-custom-header')))
return start_response(status, response_headers, exc_info)
return self.app(environ, new_start_response)
从主类调用中间件
文件：main.py
from flask import Flask
import asyncio
from gevent.pywsgi import WSGIServer
from middleware import SimpleMiddleWare
app = Flask(__name__)
app.wsgi_app = SimpleMiddleWare(app.wsgi_app)
【讨论】：
以上是关于如何在 Flask 中设置响应标头？的主要内容，如果未能解决你的问题，请参考以下文章
如何在 WPF 应用程序中 SOAP 客户端的“Set-Cookie”标头响应的新请求中设置“Cookie”标头
如何在WPF应用程序中的SOAP客户端的“Set-Cookie”标头响应的新请求中设置“Cookie”标头