Flask 应用开发和实践
目录
- flask基本环境和核心功能
- flask 基本route和blueprint
- form 和 template
- 数据库集成
- 安全相关
- rest api
- 异步访问
- 前端集成
- 测试
- 部署和容器化
python是通用的开发语言，在web应用开发方面，既有大而全的djaong，也有小而精的flask，还有其他各种特性的特定目的的web应用框架。 微内核框架，适合大而全的框架比较而言的。 微，不代表这功能少，什么都需要自己开发，而是将开发和架构的选择权交付给用户，只关注于核心的web请求和路由的功能，其他的功能通过可扩展的方式，同样可以完成django等大型框架实现的功能。 在这里，微内核可以快速起步，可以更灵活的选择所需要的相关技术框架，可以为应用的使用场景进行定制开发，扩展相关的功能。 在Nodejs上面，同样有express和koa的框架存在，需要使用哪一个框架，还是看具体的需求。
[fullstack] (https://www.fullstackpython.com/) 这里有起步python全面的资源，常用的web框架和相关的资源已经在这里
[flask mega ] (https://blog.miguelgrinberg.com/post/the-flask-mega-tutorial-part-i-hello-world)
[explore-flask] (http://exploreflask.com/) 我的flask 快速开始脚手架 flask boilplate
现在已经是python3的时代，不需要讨论2还是3，但是虚拟环境方面，还是要看大家的喜好。 python3 中已经内嵌了venv，同时也可以考虑conda。 我推荐miniconda, 尽量选择X64的发行版，相关镜像设置可以参考 tsinghua mirrors [ustc mirros] (https://mirrors.tuna.tsinghua.edu.cn/anaconda/) ## 现在usts源中的anaconda的帮助不见了
在我的开苏开始脚手架中，大家可以看到下面的目录结构
/- |- config.py |- requirements.txt |- .gitignore |- LICENSE |- todo/- - init.py
对于简单的web应用，flask使用一个py文件就可以了，但是在实践当中，还是遵循合理的工程布局，将相关的功能和代码放在python模块和包中，这样可维护性和可扩展性会更好。
首先，还是从hello world开始起步。 大家可以参考flask官方的教程的最小flask应用部分 Flask official link
flask quick start - minimal app
app.py # the flask app start file
- from flask import Flask
- app = Flask(name)
- @app.route('/')
- def hello_world():
- return 'Hello, World!'
- 引入flask的包
- 实例化flask程序,这是一个符合wsgi标准的web程序
- 使用装饰符告诉flask web应用的路由
- 实际路由定义的函数
- 这里只是简单的返回 ’hello world!'
首先需要引入两个环境变量 FLASK_APP=app.py FLASK_ENV=development
第一个变量，是告诉flask命令flask应用的入口文件是什么，这里是app.py模块，后面我们会看到入口可以是一个模块，或者一个包。 默认情况下flask会寻找当前目录下的app.py或者run.py，但是不推荐这么做了。 FLASK_ENV和 FLASK_DEBUG是控制开发和生产模式的开关变量，在开发模式下，我们可以web界面看到调试的信息，可以利用系统内置的hot-reload模式不用重启应用看到代码更改之后的变化。 如果想要使用更稳定强大的hot-reload功能，推荐使用watchdog。 推荐使用python-dotenv，可以自动加载 .env文件中的环境变量
在 Hello World中，我们定义了一个web请求的入口，app.route是flask的装饰器，可以帮助我们在flask应用上下文中注册相关的view 控制器，用于处理用户提交url请求后相关的处理。、
@app.route('/')
def index():
return "Hello World!"
这是这个应用的主入口，用户在浏览器中输入http://localhost:5000/， flask就会解析这个请求，根据应用的配置信息和这个定义，将接下来的处理逻辑交给在这里定义的函数。
在现实应用中，http请求和处理远比这个示例复杂。
对于 http://localhost:5000/, 用户在浏览器中输入这个url，接下来会发生什么呢？
| Browser | Flask | app code |
|---|---|---|
| 发出get | -> | - |
| - | flask截获请求，判断请求方法，查找路由表，构造request和response对象，调用对应的处理函数 | -> |
| - | <- | 处理函数分析request对象，执行业务逻辑，返回response对象- |
| <- | flask对response对象进一步处理，返回请求结果到客户端 | - |
| 浏览器解析返回结果，显示相关的内容 | - | - |
现在我们定义一个新的请求路径
@app.route('/home’)
def home():
return "HOME"
我们可以使用http://localhost:5000/home 来访问这个新定义的功能了。
在route中，我们不仅可以定义路径，同时还可以定义我们需要处理的变量和变量的类型
@app.route('/hello/<username>')
def home(username):
# greeting to the username
return "Hello " + username
@app.route('/post/<int:post_id>')
def show_post(post_id):
return f'Post Id: {post_id}'
@app.route('/home/<path:subpath>')
def show_subpath(subpath):
return f'Subpath is {subpath}'
在实际的应用中，我们需要在应用的不同位置引用需要访问的url地址，使用绝对路径可以解决问题，但是如果你的应用发生变化，所有相关的路径都需要修改。 url_for（）函数可以帮助我们解决这个问题，flask可以帮助我们反推出我们相关url处理函数中定义的url路径，这样我们可以在应用中可以清晰的指定这个请求需要处理的函数是什么。
具体url_for()的应用，我们在模板中会有相关的示例。
http 请求方法主要是GET，POST，PUT，UPDATE，DELETE，HEAD，其中最常用的是GET和POST,对于表单的处理，一般是使用post方式，所以需要在代码中明确处理的http方法
@app.route('/home',methods=['GET'])
def home():
return "HOME"
@app.route('/new_user',methods=['GET','POST'])
def home():
if request.method == 'POST':
# processing the post
web应用中需要使用色的图片，样式，javascript等文件，可以利用web服务器来存取，但是如果只有flask，可以利用flask内置的静态url端点来服务这些请求
url_for（'static'，filename='style.css')
根据约定，需要应用相对路径下面创建static目录，将相关的文件放在这个目录下面。
在动态web应用中，和html相关的样式，布局等和前端展示相关的内容，可以使用模板定义在不同的文件中，在请求中，将需要的内容更新后，将相关的内容展示交给相应的模板引擎进行渲染，然后返回给客户端。 Flask 缺省使用Jinja2模板引擎，你也可以配置自己的模板引擎。
@app.route('/home',methods=['GET'])
def home():
title = 'Home'
return render_template('index.html',title=title)
模板相关的文件放在应用相对的templates路径下面。
<!doctype html>
<head>
<title> {{title}} </title>
</head>
<body>
{%if name %}
<h1>Hello {{name}}</h1>
{%else %}
<h1>Hello World</h1>
{% endif %}
</body>
</html>
在模板中，flask 中相关的web请求的对象 request,response， session和g都是可见的，同时可以使用get_flashed_messages()或者后端推送的消息。
{{ title }} 可以在模板中直接输出python变量的内容， {% %} 可以执行模板的动态语言。
现在，我们需要开始一个完整的web应用程序。 循序渐进，我们首先从一个简单的todo应用开始。
todo应用主要是追踪用户的代办事项。
第一步，可以显示用户的代办事项。 第二步，可以增删改相关的代办事项。 第三步，连接后台的数据库，持久化相关的用户状态到数据库。
首先我们采用修改现有的应用组织方式，删除现有app.py,采用包的方式，将todo相关的逻辑功能组织到一个目录里面。
Flask-todo/
|- todo
|- __init__.py
|- templates
|- static
|- config.py
|- .env
|- LICENSE
|- README.txt
|- requirements.txt
首先，我们专注在核心逻辑上面，代办事项使用一个数组
todos = [
{ 'task': '1st task', 'isDone': False},
{ 'task': '2nd task', 'isDone': True}
]
添加到routes.py里面，作为一个全局变量，这个变量在应用启动启动以后会一直存在，知道你重启这个应用。
我们需要显示这个代办事项，在index中，我们这样显示
{% for todo in todos %}
<li> {{ todo.task}} </li>
{% endfor %}
在实际项目中，我们使用了模板继承，base.html定义应用的主要页面布局，在index.html中，扩展base.html，只需要将上面的代码逻辑放在main block里面就可以。
这里，我们需要实现代办事项的增删改等相关的操作。首先从新建代办开始。
在routes.py中，新添加一个新的路由
@app.route('/new',methods=['GET','POST'])
def new():
if request.method == 'POST':
task = request.form['task']
todos.append({'task': task, 'isDone': False})
return redirect(url_for('index'))
return render_template('edit.html')
这里，我们需要手动从request对象中解析前端表单中相关的变量，然后创建简单的etask对象，然后添加到todos数组中。
对于修改和更新，我们需要一个唯一的ID获取todos中的todo对象，简单的数字的索引就可以，后面我们使用数据库的时候，需要使用数据库提供的ID唯一标识追踪这些代办事项。
@app.route('/edit/<int:id>',methods=['GET','POST'])
def new(id):
todo = todos[id]
if request.method == 'POST':
task = request.form['task']
isDone = request.form['isDone']
todos[i] = {'task': task, 'isDone': isDone }
return redirect(url_for('index'))
return render_template('edit.html',task=task)
这里，更新代办事项需要一个表单，显示现有代办事项信息，可以更新代办事项的状态，所以需要一个唯一的ID追踪这些状态变化，这里首先取出代办事项的现有状态，然后在前端显示更新的表单，用户提交表单时，会使用POST方法将新的状态传回来，然后我们可以获得相关的状态，更新到代办列表中。
@app.route('/edit/<int:id>',methods=['GET'])
def delete(id):
del todos[id]
return redirect(url_for('index'))
从列表中删除这个代办事项，然后直接返回到开始页面。
我们的表单只是一个基本的输入表单，没有模型承载这个表单，没有基本的数据校验和错误反馈机制。 现在，我们需要利用flask提供的扩展flask-wtf改造这个表单，能够实现数据的校验。
前面没有详谈应用的配置，现在在表单中需要配置表单的secret_key配置,这样我们就可以利用flask-wtf的内置能力保证前端提交的数据是真实有效的，防止跨站伪造请求攻击（CSRF - Cross-Site Request Forgery）。
app.config.from_mapping(
SECRET_KEY='the_key_never_be_guessed'
)
在包的初始化中，指定配置项。
在flask中，app.config是应用的全局变量，我们可以从python对象中，python文件中，简单的k/v映射中配置相关的内容。 在云原生应用中，对不同环境准备不同的配置文件是很好的实践。
flask-wtf扩展使用python的类来表示前端的web表单，表单类继承于FlaskForm，定义我们需要的web表单的字段和数据校验的逻辑。 为了结构清晰，我们将表单放在forms.py文件中。
from flask_wtf import FlaskForm
from wtforms import StringField, BooleanField, SubmitField
from wtforms.validators import DataRequired
class TodoForm(FlaskForm):
task = StringField('Task', validators=[DataRequired()])
isDone = BooleanField('isDone')
submit = SubmitField('Save')
在前端web页面，我们的form页面改造成下面的形式： ··· {% extends 'base.htm' %} {% block main %}
{{ form_hidden_tag() }} </div>
<div class='conatainer'>
{{ form.submit() }}
</div>
</form>
{% endblock %} ··· 在这个模板中，form.hidden_tag（）是强制存在的，flask-wtf利用这种机制实现CSRF功能。
··· @app.route('/new') def new(): form = TodoForm() return render_template('edit.html',form=form) ···
Flask-wtf中，处理表单的工作变得简单，我们不需要在解析request中的数据，直接构造表单对象，数据检查和数据转换都由wtf承担，我们只需要关注表单接受以后的业务逻辑。
@app.route('/new',methods=['POST']):
form = TodoForm()
if form.validate_on_submit()
todos.append({'task': form.task, 'isDone': form.isDone})
return redirect('/index')
现在，我们的todos 代办事项相关的数据只是在内存中存在，web应用运行时我们添加的数据，如何在应用重启以后还能继续使用呢。 这就涉及到数据持久的问题。 在数据持久方面，有多种考虑因素，是否需要复杂存储逻辑，是否会有大量逻辑计算，是否需要多人共享，这些都是我们考虑后端持久化层的技术选型的主要依据。
- 如果只是简单保存数据，文件是python中最直接的方式，直接将todos对象序列化到文件，保存到应用的数据目录，这种方式不需要额外的技术支持，直接使用python的对象持久化和文件操作就可以了。 但是如果需要并发访问，逻辑运算，我们需要额外的系统支持。
- 传统上我们使用的主要技术是数据库，关系型数据库技术历史悠久，技术成熟，对于我们简单的todos相关的对象存储，小型数据库想sqlite还是适合的，但是想oracle和sql server这样的企业数据库，显然有些大材小用了。
- 还有就是现在新型的非关系型数据库技术（mongodb），在实际的应用中也逐渐成为考虑的技术，在大型分布式系统中，会是比较好的选择。
在flask框架中，这些持久化技术都是支持的。 这里我们引入数据库的支持，能够将todo代办事项保存到数据中。 在flask中，我们可以使用python提供的数据库驱动包的支持，直接写sql语句操作数据库，也可以使用ORM(对象关系模型)框架（sqlalchemy或者peewee）操作数据库，flask微核心框架的特性就在于可以允许我们选择合适的框架。 数据库方面，小而精的sqlite，python内置已经支持了，在你安装python的时候，sqlite相关的库和运行时已经
SqlAlchemy是python上流行的ORM库，封装了大部分关系型数据相关的操作。 flask-sqlalchemy是flask上面的sqlalchemy的扩展，可以方便操作sqlalchemy
''' pip install flask-sqlalchemy ''' 这样就可以安装好sqlalchemy相关的支持了。
同时我们还需要数据库迁移的支持，方便我们更改了模型相关的代码，利用flask命令行就可以更改数据库的结构。 ''' pip install flask-migrate '''
在开发过程中，我们可以使用sqlite作为测试数据库，在配置文件中，我们可以切换开发和生产不同的配置文件，指定开发和生产不同的数据库类型和相关的配置。
现在我们需要在新建一个config.py， 指定sqlalchemy相关的配置
''' import os basedir = os.path.abspath(os.path.dirname(file))
SQLALCHEMY_DATABASE_URI = os.environ.get('DATABASE_URL') or
'sqlite:///' + os.path.join(basedir, 'app.db')
SQLALCHEMY_TRACK_MODIFICATIONS = False
'''
然后在todo包的__init__.py中，引入创建的相关配置
''' if(test_config == None): app.config.from_pyfile('../config.py',silent=True) else: app.config.from_mapping(test_config)
try:
os.mkdir(app.instance_path)
except OSError:
print("error create app dir")
'''
然后，我们需要在todo包中的__init__.py中初始化sqlalchemy和migration
''' from flask_sqlalchemy import SQLAlchemy from flask_migrate import Migrate ...
db = SQLAlchemy(app) migrate = Migrate(app,db)
from app import routes,models ''' 这里我们新加入和model模块，用于承载sqlalchemy的数据库模型
'''
from todo import db
Class Todo(db.Model): id = db.Column(db.Integer, primary_key=True) task = db.Column(db.String(120)) isDone= db.Column(db.Boolean)
def __repr__(self):
return f'<Todo> {self.task}'
''' __repr__方法告诉python需要对这个对象字符串表达时返回什么信息。