Learn Python 3 ：Flask Web开发小记

最近看了Flask Web开发：基于Python的Web应用开发实战，书中详细介绍了Web程序的开发、测试、部署过程，值得一读！我在书中例子的基础上做了些更改，实现了一个简单的个人博客：NiceBlog，仅作为个人学习，还有许多不足的地方待完善，这里做一些简单的记录，方便以后查阅，代码放在了Github上：https://github.com/SheHuan/NiceBlog。

一、功能

1、对于普通用户，主要有如下功能：

• 注册、登录、重置密码（邮箱验证）
• 文章列表、详情
• 评论
• 喜欢

2、对于管理员，除了有普通用户的功能，主要有如下功能：

• 写文章（Markdown编辑）
• 用户权限管理（管理喜欢、评论的权限）
• 评论管理（删除、屏蔽）

3、为移动端提供相关api接口

二、项目结构

遵循了书中多文件Flask程序的基本结构，下边是NiceBlog的项目结构：
|-NiceBlog
   |-app/ 主目录
      |-api/ 为移动端提供接口的蓝本
      |-auth/ 权限认证的蓝本
      |-main/ 主体功能的蓝本
      |-manage/ 管理相关功能的蓝本
      |-static/ 静态资源目录（icon、js、css）
      |-templates/ html模板目录
      |-__init__.py 初始化项目的工厂函数
      |-decorators.py 自定义的装饰器
      |-email.py 发送邮件功能
      |-excepitions.py 自定义异常处理
      |-models.py 数据模型
   |-migrations/ 数据库迁移脚本目录
   |-nb_env/ 虚拟环境
   |-tests/ 单元测试目录
   |-config.py 配置文件
   |-manage.py 启动程序以及其他的程序任务
   |-requirements.txt 项目的依赖包列表

三、实现

1、工厂函数

一个简单的Flask Web程序可以写在单文件中，test.py：

app = Flask(__name__)

# 定义的路由
@app.route('/')
def index():
    return '
Hello World!
'

if __name__ == '__main__':
    app.run()

但是执行程序时，由于在全局作用域创建导致无法动态修改配置，也导致了单元测试时无法在不同配置环境运行程序。所以可以把程序的创建转移到可显示调用的工厂函数中，也就是前边项目结构中的__init__.py，在工厂函数中导入需要的Flask扩展：

def create_app(config_name):
    app = Flask(__name__)
    # 导致指定的配置对象
    app.config.from_object(config[config_name])
    # 调用config.py的init_app()
    config[config_name].init_app(app)

    # 初始化扩展
    bootstrap.init_app(app)
    mail.init_app(app)
    moment.init_app(app)
    db.init_app(app)
    login_manager.init_app(app)
    pagedown.init_app(app)
    return app

2、蓝本

新的问题来了，使用工厂函数后，程序在运行时创建，而不是在全局作用域，必须等到执行create_app()后才能使用@app.route()装饰器，这时就要使用蓝本了，在蓝本中也可以定义路由，但是定义的路由处于休眠状态直到蓝本注册到程序后在成为程序一部分，例如main蓝本的目录结构如下：
|-NiceBlog
   |-app/ 主目录
      |-main/ 主体功能的蓝本
         |-__init__.py 创建蓝本
         |-errors.py 蓝本的错误处理
         |-forms.py 蓝本的表单
         |-views.py 蓝本的路由

首先看一下__init__.py：

# 两个参数分别指定蓝本的名字、蓝本所在的包或模块（使用 __name__即可）
main = Blueprint('main', __name__)
# 导入路由模块、错误处理模块，将其和蓝本关联起来
# 在蓝本的末尾导入在两个模块里还要导入蓝本，防止循环导入依赖
from app.main import views, errors

2.1、表单

forms.py是当前蓝本中的表单，项目中使用了FlaskForm，可以方便的完成表单校验，例如创建、编辑文章的表单：

class BlogForm(FlaskForm):
    title = StringField('请输入文章标题', validators=[DataRequired(), Length(1, 128)])
    labels = StringField('文章标签（标签之间用空格隔开）', validators=[DataRequired()])
    summary = TextAreaField('文章概要', validators=[DataRequired()])
    content = TextAreaField('文章内容', validators=[DataRequired()])
    preview = TextAreaField('文章预览', validators=[DataRequired()])
    publish = SubmitField('发布')
    save = SubmitField('保存')

2.2、路由

views.py就是在蓝本中定义的路由，例如主页的路由：

@main.route('/create-blog', methods=['GET', 'POST'])
@admin_required
def create_blog():
    """
    写新文章
    """
    form = BlogForm()
    if form.validate_on_submit():
        blog = None
        if form.publish.data:
            # 发布
        elif form.save.data:
            # 保存草稿
        return redirect(url_for('main.index'))
    return render_template('markdown_editor.html', form=form, type='create')

注意装饰器为当前蓝本的名字main，而不是之前的app。create_blog()称为视图函数，一个路由保存了URL到视图函数的映射关系。redirect(url_for('main.index'))代表重定向到主页，url_for()的参数为要跳转到的URL对应的视图函数名，但需要加上视图函数所在的蓝本名，即main.index。render_template()是Flask提供的函数，把Jinja2模板引擎集成到了程序中，第一个参数是模板名称对应一个html文件，即执行该视图函数后最终要渲染的页面，后边的参数为传递给模板的参数。

2.3、错误处理

errors.py是蓝本中的错误处理程序，例如：

@main.app_errorhandler(404)
def page_not_found(e):
    if request.url.find('api') != -1:
        return jsonify({'error': '请求的资源不存在', 'code': '404', 'data': ''})
    return render_template('error/404.html'), 404

如果使用@main.errorhandler装饰器只有当前蓝本的错误才能触发，为了使其它错误也能触发所以使用了@main.app_errorhandler装饰器

2.4、注册蓝本

其它蓝本的定义也类似，最后需要在工厂函数中重注册蓝本，例如：

def create_app(config_name):
    # ......
    # 注册main蓝本
    from app.main import main as main_blueprint
    app.register_blueprint(main_blueprint)

    # 注册auth蓝本
    from app.auth import auth as auth_blueprint
    # 使用url_prefix注册后，蓝本中定义的所有路由都会加上指定前缀，/login --> /auth/login
    app.register_blueprint(auth_blueprint, url_prefix='/auth')

    return app

3、前端

3.1、Jinja2

Flask使用Jinja2作为模板引擎，模板是一个包含响应文本的HTML文件，其中包含只有在请求的上下文才知道的动态占位变量。默认情况下，模板保存在templates目录。

在Jinja2模板中{{ 变量名 }}代表一个变量（注意变量名两边有一个空格，可以识别任意类型的变量），从渲染模板时使用的数据中获取。如果变量的值是HTML，由于转义的原因导致浏览器不能正常显示HTML代码，所以需要使用safe过滤器，例如文章详情的HTML显示就需要这样处理，过滤器写在变量名后用竖线隔开{{ 变量名|过滤器名 }}

Jinja2中用{% 控制语句 %}代表控制结构来改变模板的渲染流程，例如：

# 条件控制
{% if xxx %}
    
Android
{% else %}
    
iOS
{% endif %}

# for循环
{% for x in xs %}
    
{{ x }}
{% endfor %}

# 导入
{% import 'xxx.html' %}

# 包含
{% include 'xxx.html' %}

导入、包含的目的都是为了复用，还可以通过继承实现复用，类似于类的继承：

# 继承
{% extends "base.html" %}

通过继承，模板中重复的代码都可以写在父模板里，例如导航条和页面底部footer就可以放在父模板里。

3.2、Bootstrap

前端使用了Bootstrap框架，它提供了良好的CSS规范，可以帮助我们更好的美化界面，具体的可参考：
https://v3.bootcss.com/，要在项目中集成它可以使用Flask的Flask-Bootstrap扩展，直接在PyCharm安装，并在工厂函数中初始化，还要让项目的父模板继承Bootstrap的基类模板：

# common_base.html
{% extends "bootstrap/base.html" %}

Bootstrap的基类模板base.html提供了一个网页框架，包含了Bootstrap中的所有CSS和JS文件。除此之外基类模板还定义了许多可在其子类模板中重定义的块，使用格式如下：

{% block 块名称 %}
{% endblock %}

常用的块如下：

块名称	含义
head	标签中的内容
title