您的位置:

make_response详解

一、基本概念

1. make_response是什么?

make_response是flask中用来构造HTTP响应的函数,可以将一个字符串、模板或者是一个response对象转换为一个完整的HTTP响应,同时可以设置cookie、header信息等等。

2. make_response的基本用法

from flask import Flask, make_response

app = Flask(__name__)

@app.route('/')
def hello():
    response = make_response('Hello, World!')
    response.headers['X-Hello'] = 'World'
    return response

这段代码的作用是访问首页时,在页面上输出"Hello, World!",同时在header中增加一个自定义header信息"X-Hello: World"。

3. make_response的参数

make_response(response=None, status=None, headers=None, cookies=None)

response: 需要返回的响应对象,可以是字符串或模板渲染的结果

status: HTTP状态码

headers: 响应头信息

cookies: cookie信息

二、使用场景

1. 设置cookie信息

from flask import make_response

@app.route('/')
def hello():
    response = make_response('Hello, World!')
    response.set_cookie('username', 'flask')
    return response

这段代码的作用是在访问页面时,设置一个名为"username"的cookie,值为"flask"。

2. 渲染模板

from flask import make_response, render_template

@app.route('/')
def hello():
    html = render_template('index.html')
    response = make_response(html)
    return response

这段代码的作用是访问首页时,渲染一个html模板,并将渲染结果封装成response对象返回。

3. 返回文件

from flask import make_response, send_from_directory

@app.route('/download/')
def download():
    response = make_response(send_from_directory('static', 'file.txt', as_attachment=True))
    response.headers["Content-Disposition"] = "attachment; filename=file.txt;"
    return response

这段代码的作用是访问/download/时,下载static目录下的"file.txt"文件,并且在响应头中设置"Content-Disposition"字段,提示浏览器将文件保存到本地磁盘。

三、make_response的高级用法

1. 返回json数据

from flask import make_response, jsonify

@app.route('/api/')
def api():
    data = {"hello": "world"}
    response = make_response(jsonify(data))
    return response

这段代码的作用是访问/api/时,返回json格式的数据。

2. 设置响应header信息

from flask import make_response

@app.route('/')
def hello():
    response = make_response('Hello, World!')
    response.headers['X-Hello'] = 'World'
    return response

这段代码的作用是访问首页时,在页面中输出"Hello, World!",并在header中增加一个自定义header信息"X-Hello: World"。

3. 设置响应状态码

from flask import make_response

@app.route('/')
def hello():
    response = make_response('Hello, World!')
    response.status_code = 404
    return response

这段代码的作用是访问首页时,返回HTTP状态码为404的响应报文。

四、总结

本文主要从make_response的基本概念、使用场景、高级用法等多个方面进行了详细阐述。在实际的flask开发中,合理使用make_response可以极大地提高开发效率,为项目的开发和维护提供更多的便利。