Flask诞生于2010年,是Armin ronacher(人名)用 Python 语言基于 Werkzeug 工具箱编写的轻量级Web开发框架。
Flask 本身相当于一个内核,其他几乎所有的功能都要用到扩展(邮件扩展Flask-Mail,用户认证Flask-Login,数据库Flask-SQLAlchemy),都需要用第三方的扩展来实现。比如可以用 Flask 扩展加入ORM、窗体验证工具,文件上传、身份验证等。Flask 没有默认使用的数据库,你可以选择 MySQL,也可以用 NoSQL。其 WSGI 工具箱采用 Werkzeug(路由模块),模板引擎则使用 Jinja2。这两个也是 Flask 框架的核心。
准备
mkvirtualenv flask_demo -p python3
安装
pip install flask==0.12.4
一 .创建Flask项目
Flask不同于Django,不会提供任何自动的操作,所以需要手动创建项目目录,需要手动创建启动项目的管理文件
例如,创建项目目录flaskdemo,在目录中创建manage.py。在pycharm中打开项目并指定上面创建的虚拟环境
1 form flask import Flask 2 app = Flask(__name__) 3 4 @app.route('/') 5 def index(): 6 return 'Hello World' 7 8 if __name__ == '__main__': 9 app.run
代码分析:
1 #导入Flask类 2 3 """ 4 import_name Flask程序所在的包(模块),传 __name__ 就可以 5 其可以决定 Flask 在访问静态文件时查找的路径 6 static_path 静态文件访问路径(不推荐使用,使用 static_url_path 代替) 7 static_url_path 静态文件访问路径,可以不传,默认为:/ + static_folder 8 static_folder 静态文件存储的文件夹,可以不传,默认为 static 9 template_folder 模板文件存储的文件夹,可以不传,默认为 templates 10 11 """ 12 app = Flask(__name__)
1 #加载项目配置 2 #配置类 3 class Config(object) 4 DEBUG = True 5 SECRET_KEY = "aaabbbbbddddeeeeb" 6 7 app.config.from_object(Config) 8 9 10 11 12 #指定服务器IP和端口 13 app.run(host="0.0.0.0",port=5000,debug = True)
二.路由的基本定义
1 #指定访问路径为demo1 2 @app.route('/demo1') 3 def demo1(): 4 return 'demo1'
路由可以设置传递参数,2种方式
1 # 路由传递参数[没有限定类型] 2 @app.route('/user/<user_id>') 3 def user_info(user_id): 4 return 'hello %s' % user_id 5 6 7 # 路由传递参数[限定数据类型] 8 @app.route('/user/<int:user_id>') 9 def user_info(user_id): 10 return 'hello %d' % user_id
路由限定请求方式
1 def demo2(): 2 # 直接从请求中取到请求方式并返回 3 return request.method
三.正则匹配路由
在 web 开发中,可能会出现限制用户访问规则的场景,那么这个时候就需要用到正则匹配,根据自己的规则去限定请求参数再进行访问
具体实现步骤为:
- 导入转换器基类:在 Flask 中,所有的路由的匹配规则都是使用转换器对象进行记录
- 自定义转换器:自定义类继承于转换器基类
- 添加转换器到默认的转换器字典中
- 使用自定义转换器实现自定义匹配规则
四.代码实现
> 导入转换器基类
from werkzeug.routing import BaseConverter
> 自定义转换器
1 # 自定义正则转换器 2 from werkzeug.routing import BaseConverter 3 class RegexConverter(BaseConverter): 4 def __init__(self,url_map,*args): 5 super(RegexConverter, self).__init__(url_map) 6 # 正则参数 7 self.regex = args[0]
> 添加转换器到默认的转换器字典中,并指定转换器使用时名字为: re
1 # 将自定义转换器添加到转换器字典中,并指定转换器使用时名字为: re 2 app.url_map.converters['re'] = RegexConverter
> 使用转换器去实现自定义匹配规则
>> 当前此处定义的规则是 :手机号
1 # 正则匹配路由 2 @app.route("/login/<re('1\d{10}'):mobile>") 3 def login(mobile): 4 return mobile
五.系统自带转换器
1 DEFAULT_CONVERTERS = { 2 'default': UnicodeConverter, 3 'path': PathConverter, 4 'string': UnicodeConverter, 5 'any': AnyConverter, 6 'int': IntegerConverter, 7 'float': FloatConverter, 8 'uuid': UUIDConverter, 9 }
系统自带的转换器具体使用方式在每种转换器的注释代码中有写,请留意每种转换器初始化的参数。
1 from flask import Flask 2 # 新增一个配置文件,在配置文件中设置配置信息 3 from config import Config 4 from flask import request 5 # from collections import OrderedDict # 有序字典 6 7 app = Flask(__name__) 8 9 # 调用app.config加载配置 10 app.config.from_object(Config) 11 12 13 from werkzeug.routing import BaseConverter 14 15 class RegexConverter(BaseConverter): 16 def __init__(self,url_map,*args): 17 super(RegexConverter, self).__init__(url_map) 18 # 正则参数 19 self.regex = args[0] 20 21 # converter["路由转换器名称"] = 实现路由转换功能的自定义类 22 app.url_map.converters['re'] = RegexConverter 23 # 绑定路由 24 @app.route("/") 25 def index(): 26 return "hello flask" 27 28 29 # 默认情况下,路由使用的就是关键字参数,也叫"命名路由" 30 # router(路由地址, http请求方式 ) 31 @app.route("/list/<int:page>/<string:content>",methods=["GET","POST"]) 32 def mylist(content,page): 33 return "第%s页<br>内容:%s" % (page,content) 34 35 # 正则匹配路由 36 @app.route("/login/<re('1\d{10}'):mobile>") 37 def login(mobile): 38 return mobile
六.Http的请求与响应
> 请求
.request: flask中代表当前请求的 request对象
.作用: 在视图函数中取出本次请求数据
.导入: from flask import request
常用的属性如下:
属性 | 说明 | 类型 |
---|---|---|
data | 记录请求的数据,并转换为字符串 | * |
form | 记录请求中的表单数据 | MultiDict |
args | 记录请求中的查询参数 | MultiDict |
cookies | 记录请求中的cookie信息 | Dict |
headers | 记录请求中的请求头 | EnvironHeaders |
method | 记录请求使用的HTTP方法 | GET/POST |
url | 记录请求的URL地址 | string |
files | 记录请求上传的文件 | * |
json | 记录请求的json数据 | json |
获取请求中查询字符串
http://127.0.0.1:5000/demo1?a=10
1 """获取客户端的请求""" 2 @app.route("/request") 3 def req1(): 4 """获取查询字符串""" 5 query_string = request.args 6 print(query_string) 7 # 浏览器输入 http://127.0.0.1:5000/request?a=1&b=2 8 """打印效果: ImmutableMultiDict([('a', '1'), ('b', '2')])""" 9 10 # 获取一个参数的一个值 11 http://127.0.0.1:5000/request?username=abcd 12 username = request.args.get("username") 13 # print(username) 14 """打印效果: abcd """ 15 16 # 获取一个参数的多个值 17 # http://127.0.0.1:5000/request?username=xiaoming&love=吹牛&love=睡觉 18 love = request.args.getlist("love") 19 # print(love) 20 """打印效果: ['吹牛', '睡觉']""" 21 22 23 # 把传递过来的数据抓换成原生的字典 24 data = request.args.to_dict() 25 # print(data) 26 """打印效果:{'username': 'xiaoming', 'love': '吹牛'} """ 27 28 return "ok" 29 30 @app.route("/request2",methods=["POST"]) 31 def req2(): 32 """获取post数据和请求头""" 33 # 必须传 json 格式的数据 34 # print( request.data ) 35 # """打印结果: 36 # b'{\n\t"username":"xiaoming",\n\t"age":18,\n\t"sex":1\n}' 37 # """ 38 # 方式一 39 # import json 40 # from flask import json 41 # data = json.loads(request.data) 42 # print(data) 43 # """打印结果: 44 # {'username': 'xiaoming', 'age': 18, 'sex': 1} 45 #方式二 46 print(request.json) 47 # """打印结果: 48 # {'username': 'xiaoming', 'age': 18, 'sex': 1} 49 # """ 50 # 51 # """获取请求行数据""" 52 # print( request.headers ) 53 # print( request.headers.to_list() ) 54 55 56 """获取上传文件""" 57 print( request.files ) 58 print( request.files.get("avatar") ) 59 """打印效果: 60 ImmutableMultiDict([('avatar', <FileStorage: 'avatar.png' ('image/png')>)]) 61 <FileStorage: 'avatar.png' ('image/png')> 62 """ 63 64 return "ok" 65 66 if __name__ == '__main__': 67 app.run()
响应
flask默认支持2种响应方式:
- 数据响应:
默认响应html文本,也可以返回 JSON格式 - 页面响应:
重定向 url_for
响应的时候,flask也支持自定义http响应状态码
响应html文本
1 @app.route("/") 2 def index(): 3 # [默认支持]响应html文本 4 return "<img src='http://flask.pocoo.org/static/logo.png'>"
返回JSON数据
在 Flask 中可以直接使用 jsonify 生成一个 JSON 的响应
1 from flask import Flask, request, jsonify 2 3 @app.route("/") 4 def index(): 5 # 也可以响应json格式代码 6 data = [ 7 {"id":1,"username":"liulaoshi","age":18}, 8 {"id":2,"username":"liulaoshi","age":17}, 9 {"id":3,"username":"liulaoshi","age":16}, 10 {"id":4,"username":"liulaoshi","age":15}, 11 ] 12 return jsonify(data)
flask中返回json 数据,都是flask的jsonify方法返回就可以了.
重定向
重定向到百度页面
1 # 页面跳转响应 2 from flask import Flask, request, jsonify, redirect 3 @app.route("/user") 4 def user(): 5 # 页面跳转 redirect函数就是response对象的页面跳转的封装 6 # Location: http://www.baidu.com 7 return redirect("http://www.baidu.com")
重定向到自己写的视图函数
可以直接填写自己 url 路径
也可以使用 url_for 生成指定视图函数所对应的 url
1 # 内容响应 2 @app.route("/") 3 def index(): 4 # [默认支持]响应html文本 5 # return "<img src='http://flask.pocoo.org/static/logo.png'>" 6 7 # 也可以响应json格式代码 8 data = [ 9 {"id":1,"username":"liulaoshi","age":18}, 10 {"id":2,"username":"liulaoshi","age":17}, 11 {"id":3,"username":"liulaoshi","age":16}, 12 {"id":4,"username":"liulaoshi","age":15}, 13 ] 14 return jsonify(data) 15 16 #使用url_for可以实现视图方法之间的内部跳转 17 # url_for("视图方法名") 18 from flask import Flask, request, jsonify, redirect, url_for 19 @app.route("/login") 20 def login(): 21 return redirect( url_for("index") )
重定向到带有参数的视图函数
在 url_for 函数中传入参数
1 # 路由传递参数 2 @app.route('/user/<user_id>') 3 def user_info(user_id): 4 return 'hello %s' % user_id 5 6 # 重定向 7 @app.route('/demo4') 8 def demo4(): 9 # 使用 url_for 生成指定视图函数所对应的 url 10 return redirect(url_for('user_info', user_id=100))
自定义状态码
在 Flask 中,可以很方便的返回自定义状态码,以实现不符合 http 协议的状态码,例如:status code: 666
1 @app.route('/demo4') 2 def demo4(): 3 return '状态码为 666', 400
三、会话控制
所谓的会话,就是用户和浏览器中网站之间一次交互过程.
会话的开始是在用户打开浏览器以后第一次访问网站.
会话的结束时在用户关闭浏览器以后.
因为 http 是一种无状态协议,浏览器请求服务器是无状态的。
无状态:指一次用户请求时,浏览器、服务器无法知道之前这个用户做过什么,每次请求都是一次新的请求。
无状态原因:浏览器与服务器是使用 socket 套接字进行通信的,服务器将请求结果返回给浏览器之后,会关闭当前的 socket 连接,而且服务器也会在处理页面完毕之后销毁页面对象。
有时需要保持下来用户浏览的状态,比如用户是否登录过,浏览过哪些商品等
实现状态保持主要有两种方式:
- 在客户端存储信息使用
Cookie,本地存储,token[jwt,oauth]
- 在服务器端存储信息使用
Session
,redis
四、cookie
Cookie是由服务器端生成,发送给客户端浏览器,浏览器会将Cookie的key/value保存,下次请求同一网站时就发送该Cookie给服务器(前提是浏览器设置为启用cookie)。Cookie的key/value可以由服务器端自己定义。
使用场景: 登录状态, 浏览历史, 网站足迹
Cookie是存储在浏览器中的一段纯文本信息,建议不要存储敏感信息如密码,因为电脑上的浏览器可能被其它人使用
Cookie基于域名安全,不同域名的Cookie是不能互相访问的
如访问luffy.com时向浏览器中写了Cookie信息,使用同一浏览器访问baidu.com时,无法访问到luffy.com写的Cookie信息
浏览器的同源策略针对cookie也有限制作用.
当浏览器请求某网站时,会将本网站下所有Cookie信息提交给服务器,所以在request中可以读取Cookie信息
设置cookie
设置cookie需要通过flask的Response响应对象来进行设置,由flask内部提供了一个make_response函数给我们可以快速创建响应对象
1 from flask imoprt Flask,make_response 2 @app.route('/set_cookie') 3 def set_cookie(): 4 resp = make_response('this is to set cookie') 5 resp.set_cookie('username', 'xiaoming', max_age=3600) 6 # max_age 为cookie有效期,单位为秒 7 return resp
获取cookie
1 from flask import Flask,request 2 @app.route('/get_cookie') 3 def resp_cookie(): 4 resp = request.cookies.get('username') 5 return resp
五、session
对于敏感、重要的信息,建议要存储在服务器端,不能存储在浏览器中,如用户名、余额、等级、验证码等信息
在服务器端进行状态保持的方案就是Session
注意: Session依赖于Cookie,而且flask中使用session,需要配置SECRET_KEY选项,否则报错.
设置session
1 from flask import session 2 @app.route('/set_session') 3 def set_session(): 4 session['username'] = 'xiaoming' 5 return 'ok!'
获取session
1 @app.route('/get_session') 2 def get_session(): 3 return session.get('username')