Flask 框架小记
Flask 实例
-
创建示例的代码
from flask import Flask # __name__ 是模块名, 用于反射导入模块 app = Flask(__name__, import_name, static_url_path=None, static_folder='static', static_host=None, host_matching=False, subdomain_matching=False, template_folder='templates', instance_path=None, instance_relative_config=False, root_path=None) # 其中 Flask 实例, debug=True 将实施热更新 app.run('0.0.0.0', 8080, debug=True) -
最常用的配置是,
static_folder,static_url_path,template_folder, 其中static_folder和static_url_path用于反向查询 -
有用的配置
static_host指定静态服务器,host_matching指定可以放给服务的主机,root_path为项目的根目录, 这些一般不会修改
视图
视图的返回值
'returned string': 返回Responseredirect: 重定向render_template: 返回 jinja2 的模板文件,render_template会在templates目录下查找文件jsonify: 返回序列化好的 json 字符串sendfile: 直接发送服务器的文件到客户端, 加分的功能
request 对象
- 导入
from flask import request, 其中此request对象不是request对象, 它是一个LocalProxy对象, 内部封装了request对象, 通过反射获取出request中的各个属性和方法 - 属性
method: 客户端发起的请求方式form: 客户端发送的form表单, 是一个ImmutableMultiDict字典对象, 通过get()获取; 通过keys()获取所有的键, 通过values()获取所有的值;to_dict()转为 Python 字典args: url 通过?传递的所有参数values: 只要是参数都会放到这里面, 不管是form还是ars, 返回的是CombinedMultiDict对象headers: 请求的消息头, 是一个字典, 通过get()直接获取对应的值, 并且headers的__str__返回的字符串的格式很好, 比 Django 人性化多了files: 上传的文件对象, 是一个字典, 通过get()拿出值, 就可以直接save()到本地, 加分功能data: 当mimetype不是 Flask 可以识别的数据类型时, 就放到这里面json: 当mimetype是application/json时存放数据url: url 全路径path: 资源路径url_root: 上一级的 url, 比如http://127.0.0.1/home, 则url_root返回http://127.0.0.1/
路由系统
-
@app.route('/', endpoint=None, **options)endpoint: 用于反向路由生成, 和 Django 中的 urlpartten 中的 path 中的 name 类似, 一般都与给 endpoint 赋值防止意料之外的错误
-
options包括methods=['GET', 'POST']等允许的请求strict_slashes: 为True表示严格模式, 加入/home/末尾加了/, 在浏览器地址栏也要加上; 否则加与不加都可以redirect_to: 无需进入视图函数, 直接在 route 中进行重定向
-
动态路由参数
- 示例代码
@app.router('/user/<int:age>/', endpoint='user',
methods=['GET'])
def user(age):
...
```
蓝图
- 类似于 Django 中的蓝图
- 蓝图的目录结构
.
├── app # 存放 app, 和 django 不同, 这里所有的东西都放到 app 里面
│ ├── __init__.py # 在 __init__.py 有 create_app() 方法, 用于创建 Flask 实例, 并注册蓝图, 最后返回 app
│ ├── __pycache__
│ │ └── __init__.cpython-36.pyc
│ ├── models # 存放 ORM
│ └── views # 存放各个模块的 views, 就是蓝图书写的地方
│ ├── __pycache__
│ │ └── users.cpython-36.pyc
│ └── users.py # 蓝图文件, 在 users.py 中, 和 之前没有蓝图使用 app 一样, 先创建蓝图对象, 在使用 @bp.route 添加路由
├── manage.py # 程序启动文件, 调用 app 获取 app 实例, 启动 app
├── static
└── templates
7 directories, 5 files
- 创建蓝图
from flask import Blueprint
# __name__ 是模块名, 用于反射导入模块
bp = Blueprint('my_bp', __name___, templates_folder=..., static_folder=...)
- 注册蓝图,
app.register_blueprint(bp, url_prefix='/users')
特殊的装饰器(flask 中的中间件)
@app.before_requset, 在调用视图函数之前调用, 如果返回 None 则通过
Session
- 使用 flask 自带的 session 需要配置
app.config['SECRET_KEY'] = 'your key' from flask import sessionsession['username'] = 'jack'- flask 中的 session 是存在浏览器中的, 浏览器返回时通过算法进行解密
Flask 配置
- 如果配置内容比较多, 则将配置写到 config.py 模块中, 再使用
app.config.from_object(config)
Flask-Script
- 实现类似 Django 中的
python manage.py runserver的功能 - 在 manage.py 中使用
from flask_script import Manager
manager = Manager(app)
manager.run()
Flask-Migrate
- 实现 Django 中的
migrate功能 - 在 manage.py 中使用
from flask_script import Manager
from flask_migrate import Migrate, MigrateCommand
main_app = create_app()
manager = Manager(main_app)
Migrate(main_app, app.db)
manager.add_command('db', MigrateCommand)
manager.run()
- 命令
python manage.py initpython manage.py migrate# django 中 makemigrationspython manage.py upgrade# django 中 migrate
Flask-SQLAlchemy
# app/__init__.py
from flask_sqlalchemy import SQAlchemy
# 要在蓝图导入之前
db = SQLAlchemy()
def create_app():
...
app.config['SQLALCHEMY_DATABASE_URI'] = 'mysql+pymysql://username:password@127.0.0.1:3306/dbname?charset=utf8'
app.config['SQLALCHEMY_POOL_SIZE'] = 6
app.config['SQLALCHEMY_POOL_TIMEOUT'] = 10
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
db.init_app(app)
...
# models/user.py
from app import db
class User(db.Model):
__tablename__ = 'user'
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.String(64))
# 使用和 django 类似
User.query(...)
# 支持原生 SQL
User.query(text('SELECT * FROM user;'))
# 如果直接打印, 输出的是原生 SQL 语句, 在 for 中迭代取出数据