Flask CORS|极客教程

Flask CORS

介绍

在开发Web应用程序时，可能会遇到跨域资源共享（CORS）的问题。CORS是一种安全策略，用于控制不同源之间的资源访问。在默认情况下，浏览器会根据同源策略拒绝跨域请求，即只允许同域名、协议和端口的请求。然而，在某些情况下，我们需要允许跨域请求，这时就需要使用Flask CORS扩展来解决这个问题。

Flask CORS是一个为Flask应用程序添加CORS支持的插件，它简化了处理跨域请求的过程。它提供了一组装饰器和选项，可以灵活地定义允许跨域请求的规则。在本文中，我们将详细介绍如何在Flask应用程序中使用Flask CORS插件。

安装

首先，我们需要安装Flask和Flask CORS扩展。可以使用pip命令来安装它们：

pip install flask flask-cors

示例代码

让我们通过一个简单的示例来演示如何在Flask应用程序中使用Flask CORS。假设我们有一个简单的API，可以返回一个包含日期和时间的JSON对象。

from flask import Flask, jsonify
from flask_cors import CORS

app = Flask(__name__)
CORS(app)

@app.route('/api/current_datetime')
def current_datetime():
    datetime = {
        'date': '2022-01-01',
        'time': '12:00:00'
    }
    return jsonify(datetime)

if __name__ == '__main__':
    app.run()

在上面的代码中，我们首先导入Flask和Flask CORS模块。然后，我们创建一个Flask应用程序实例，并使用CORS(app)来为该应用程序启用CORS支持。接下来，我们定义了一个名为current_datetime的路由，当访问/api/current_datetime时，将返回一个包含日期和时间的JSON对象。

配置选项

使用Flask CORS时，我们可以通过添加选项来配置CORS的行为。以下是一些常用的选项：

origins：指定允许访问API的源。可以是一个字符串，也可以是一个列表。默认情况下，将允许所有源访问API。

CORS(app, origins='http://example.com')

methods：指定允许的HTTP方法。可以是一个字符串，也可以是一个列表。默认情况下，将允许所有HTTP方法。

CORS(app, methods=['GET', 'POST'])

headers：指定允许的HTTP头信息。可以是一个字符串，也可以是一个列表。默认情况下，将允许所有HTTP头信息。

CORS(app, headers=['Content-Type', 'Authorization'])

expose_headers：指定在响应中暴露的HTTP头信息。可以是一个字符串，也可以是一个列表。默认情况下，不会暴露任何HTTP头信息。

CORS(app, expose_headers=['Content-Type', 'Authorization'])

supports_credentials：指定是否允许发送凭据。默认情况下，不支持发送凭据。

CORS(app, supports_credentials=True)

以上只是一些常见的选项，实际上还有更多选项可供配置。具体的选项及其用法可以参考Flask CORS文档。

使用装饰器

除了在应用程序实例上调用CORS(app)来启用CORS支持外，Flask CORS还提供了一组装饰器，可以在视图函数级别配置CORS。这使得我们可以根据具体的视图函数来灵活地定义CORS规则。

from flask import Flask
from flask_cors import CORS, cross_origin

app = Flask(__name__)
CORS(app)

@app.route('/')
@cross_origin()
def index():
    return 'Hello, CORS!'

if __name__ == '__main__':
    app.run()

在上面的代码中，我们首先在应用程序实例上调用了CORS(app)来启用CORS支持。然后，我们使用@cross_origin()装饰器将CORS支持应用于index视图函数。

综合示例

下面是一个更综合的示例，展示了如何使用Flask CORS处理跨域请求。

from flask import Flask, jsonify, request
from flask_cors import CORS

app = Flask(__name__)
CORS(app)

@app.route('/api/data', methods=['GET', 'POST'])
def api_data():
    if request.method == 'GET':
        data = {
            'message': 'GET request received',
            'parameter': request.args.get('param')
        }
        return jsonify(data)
    elif request.method == 'POST':
        data = request.get_json()
        if 'param' in data:
            return jsonify({'message': f'POST request received with param: {data["param"]}'})
        else:
            return jsonify({'error': 'Missing parameter'})

if __name__ == '__main__':
    app.run()

在上面的代码中，我们定义了一个名为api_data的路由，可以处理GET和POST请求。当收到GET请求时，它将返回一个包含请求参数的JSON对象。当收到POST请求时，它将返回一个JSON对象，其中包含请求参数。