在使用Flask做项目的过程中,总结了一些知识点,因此写了这份笔记,主要内容有:
- 兼容带 / 的URL
- 修改代码后如何自动重启
- 路由注册
- 聊一聊if ... main的判断
- 视图函数的奥秘
- 配置文件的注意事项
兼容带 / 的URL
我们访问网页的时候,比如我的简书首页,使用下面两个URL都可以访问到:
区别在哪里呢,眼尖的你一定会发现,区别在URL尾部是否有 / 。
那么如果我们用flask新建了一个项目,端口是8001,并且写了这样的视图函数
@app.route('/hello')
def index():
return 'Hello, my friend!'
那么使用http://127.0.0.1:8001/hello是可以访问的:
但是使用http://127.0.0.1:8001/hello/是不行的:
那么我们如何做到两种写法都可以访问呢?
把上面代码里的@app.route('/hello')
改为@app.route('/hello/')
,这样就可以兼容 / 有、无的情形了:
下面我们再看为什么能够兼容。把代码修改成@app.route('/hello/')
之后,确保flask服务已经重启,使用了最新代码。然后打开浏览器的调试模式,看network这里,访问http://127.0.0.1:8001/hello/ ,截图如下:
你会发现是一下子就找到了这个路由,返回了200.
那么访问http://127.0.0.1:8001/hello看看呢?
这里不一样了,先访问hello,返回一个status=301的重定向,然后再访问到hello/,这时返回status=200,也展现出了正确的结果。
因此flask是采用了重定向的方式进行兼容,把不带/的URL重定向到了带/的URL上面。
那么为什么flask要这样做?
因为flask遵循了唯一URL原理。所以要做一个这样的重定向,保证唯一URL。
如果我们没有用唯一的话,同一个视图函数对应两个不同的URL,就会被搜索引擎索引两次。再往后深入,就会涉及到SEO,搜索引擎的优化。这里我们就不继续了。
修改代码后如何自动重启
实战过程中,经常需要修改代码之后再重新启动flask服务,手工的话比较麻烦,怎么办呢?
flask内置了自动重启,只需要开启调试模式即可。
app.run(debug=True)
启动之后,提示:debugger is active!
注意,生产上不能用调试模式:
- 性能差、使用的是flask自带的服务器。
- 不能把网站的详细信息暴露给用户
路由注册
路由注册有两种写法:
- 一种正如上面我们提到的
@app.route('/hello')
那样,装饰器或注解的方式(Python、C#、Java等语言支持),非常优雅方便,缺点是不够灵活 -
app.add_url_rule('/hello', view_func=hello)
的注册方式。
那么看看区别,装饰器中没有指定view_func
,这是因为装饰器打在了需要装饰的函数上面,所以不需要指定view_func
。
建议:绝大多数情况下使用装饰器(虽然装饰器实际上也是调用app.add_url_rule
实现的,不过这种装饰器的封装看起来更为优雅)。
如果需要使用基于类的视图(即插视图),就必须需要使用app.add_url_rule
来注册。
聊一聊if ... main的判断
我们经常会用到这样一句判断if __name__ == '__main__':
,大家应该也知道,如果这个文件是作为模块被导入的,那么这一行下面的代码不会被执行。
具体到flask项目文件里面,我们会在app.run的相关代码之前,写上这样一行判断,那么为什么要增加这一行判断,之后再启动服务器?
在开发环境,启动的web服务器是flask自带的非常简单的服务器,但是部署到生产环境一般不用,会用nginx(前置服务器,接受浏览器发来的请求,然后转发成uwsgi)+uwsgi。
uwsgi加载模块,启动相关代码,此时这个文件就不再是入口文件,而是被加载的入口文件,app.run就不会执行。
如果缺少这个if判断,生产环境加载了这个文件之后,app.run就会执行——启动两个服务器是不可以的。
因此先加上这个if判断,保证生产环境不会启动flask自带的服务器。
视图函数的奥秘
和普通函数不一样,它除了返回主要的内容之外,还会返回一系列附加信息:
例如,status状态码,content-type http header
告诉接收方如何解析返回的主体内容。视图函数如果返回的是一串文本,如何解析这串文本,默认情况下(不指定content-type),默认值content-type = text/html。
flask返回的还有一些其他的内容,但是主要关注这三个内容:status, content-type, 返回的那个字符串.
flask会把所有返回的内容,封装成Response对象。
如何创建Response对象?make_response()
headers = {
'content-type':'text/plain'
}
response = make_response('<html></html>', 404)
response.headers = headers
returen response
状态码并不会对内容产生影响,状态码只是一个标识而已。
比如 301
headers = {
'content-type':'text/plain'
'location':'www.bing.com'
}
response = make_response('<html></html>', 301)
就会重定向到bing这个网站。
如果返回json格式怎么办?content-type改成json,返回的内容写成一个json字符串。
web返回的内容,本质上都是一个字符串,控制的因素在content-type,指定了要如何解释我们的返回。
return '<html></html>', 301, headers #
这样返回元组也可以,flask会把元组转换成Response对象再返回回去。
配置文件的注意事项
我们一般会想到新建一个config.py,并写入自己的配置:
config.py
DEBUG= True
使用app.config.from_object('config')
可以导入一个配置文件
入参是一个模块的路径,比如config和本文件在一个目录下,就可以这样写
debug=app.config['DEBUG']
但是有一个问题,如果:
config.py
Debug = True
打印app.config['DEBUG']
,则是False
打印app.config['Debug']
,则是报错,为何?!
解答:
- DEBUG在flask里面是一个默认参数,默认值是False
- 若以from_object的形式载入参数,flask要求,配置参数名必须都是大写,小写的读取不到。
因此,上面app.config['Debug']
的情况下,其实是找不到配置参数的;而
app.config['DEBUG']
则是读取了flask的默认参数呢!
所以自己使用的时候,要记住这点,就不会在报错的时候感到奇怪。