Flask导读

雨点打透心脏的1/2处 2022-05-28 12:39 188阅读 0赞

Flask的基本功能：

![20180405200133005][]

这里的request和session请参考http协议《[Http协议详解][Http]》，没什么特别的地方。

current\_app比较简单，就是我们构造这个app时设置的那个name。

g这个有点难度，在java开发中我没有见过，需要配合flask里的钩子来理解。

Flask提供了4种钩子：

![20180405200331831][]

请求：

请求处理函数用@app.route(‘/url/<username>’,methods=\[‘GET’,’POST’\])这中注解声明，

说明了接收请求的url地址，动态参数，http请求方式，函数体内可以通过上面介绍的request、session来获取上下文。

响应：

文本方式返回：

return‘<h1>Hello</h1>’,200

其中状态码没有特殊自定义可以省略。

Response对象返回:需要引入flask的make\_response

response = make\_response(‘<h1>Hello</h1>’)

response.set\_cookie(‘answer’,’gaga’)

return response

重定向返回：需要引入flask的redirect

return redirect(‘https://www.163.com’)

如果是系统内部调换，不需要去关心绝对路径和相对路径的问题，只需要引入flask的url\_for(‘function\_name’)就好了。

ps：url\_fo()有个入参 \_external=True/false，代表是相对路径还是绝对路径，默认为false

模板返回：需要引入flask的render\_template

return render\_template(‘hello.html’,param=param)

为什么使用模板？

Flask使用的是Jinja2模板引擎

有过Spring Cloud微服务开发经验的Java开发人员上手这一部分会很快，因为设计原理差不多。模板页面也是存放在templates目录下，静态资源存放在static中。

模板中的变量用\{ \{ name \}\}这种结构来标识，甚至可以处理一些复杂的类型，例如列表、字典、对象，而且可以增加一些过滤器渲染，例如\{ \{ name \}\}就是把变量name里的值首字母转化成大写，其他字母转化成小写。

过滤器还有：

![20180405200445973][]

更详细的文档需要参考：http://jinja.pocoo.org/docs/2.10/templates/\#builtin-filters

模板的引入与freemaker一致，使用include关键字：

{% include ‘XXX.html’ %}

条件控制：

{% if XXX%}
    {% else %}
    {% endif %}

循环控制：

{% for comment in comments %}
    {% endfor %}

Jinjia2还支持宏，对宏的理解有点像页面级别的AOP，例如：

{% macro show_user(user) %}
    	<li>{
       { user.name }}</li>
    	<h1>{
       { user.email }}</h1>
    {% endmacro %}

并将宏存储为单独的文件demo.html

调用宏如下：

{% import ‘demo.html’ as showUserMacro %}
    {
       { showUserMacro .show_user(user) }}

还需要掌握模板的继承，例如建立一个base.html母版，里面预留很多block定义甚至实现，样式如下：

{% block head %}
    XXXX
    {% endblock %}

子模板需要继承母模板，并实现或者重写母模板中的block

{% extends “base.html” %}

这样设计的好处是，第一可以统一风格，第二让子模板专注自己业务部分的展现。

Flask-Bootstrap

安装：$pip install flask-bootstrap

其本质就是内组织了一些模板和静态资源，省的我们自己再去开发了，好处是不用重复发明轮子，缺点是我们要花些精力把轮子的能力和用法研究清楚。

要知道轮子能干哪些事情，需要参考网站：

英文：[http://pythonhosted.org/Flask-Bootstrap/][http_pythonhosted.org_Flask-Bootstrap]

中文：[http://flask-bootstrap-zh.readthedocs.io/zh/latest/][http_flask-bootstrap-zh.readthedocs.io_zh_latest]

boot有个很好的开发工具推荐给像我这样前端技术水平较弱的同学，可以通过拖拽的方式形成自己想要的布局和组件，然后生成代码挑选自己有兴趣的copy到自己的项目中，再简单改下。工具地址：http://www.bootcss.com/p/layoutit/

通过errorhandler标签来自定义错误页面

@app.errorhandler(404)
    def page_not_found(e):
    return render_template('404.html'), 404

本地化日期和时间扩展：

pip install flask-moment

为模板里的时间变量提供了丰富的渲染，format、动态刷新、语言、时区等。

Form表单的处理，需要引入flask-wtf

首先要架设CSRF保护：

app.config\[‘SECRET\_KEY’\] = ‘your secretkey’

PS：这里只是为了演示，不要在代码中以明文的方式设置，需要通过环境变量。这个设置是强制的，否则启动时会报错：KeyError: 'A secret key is required to use CSRF.'

关于CSRF攻击的原理参考[https://www.cnblogs.com/phpstudy2015-6/p/6771239.html][https_www.cnblogs.com_phpstudy2015-6_p_6771239.html]

对于WTF表单的处理，对我来说上手非常别扭，因为常年的Java开发和对Struts的使用，一直认为表单是一个form类进行表单数据封装的，但是在WTF中表单是一个完整的组件，包括了构造、封装、前台展示整套前后台逻辑。自定义表单类需要继承flask\_wtf的Form类，我们在开发form的时候就把前后台一起开发好了。

例如一个最简单的表单：

class NameForm(Form):
        nameField = StringField('what is your name?', validators=[Required()])
        submit = SubmitField('submit')

form的组件有：

![20180405200900087][]

组件中有个validation属性做输入验证的，这里也内置了很多种验证方式:

![20180405200925062][]

模板中对form的渲染：

{% import 'bootstrap/wtf.html' as wtf %}
    {
       { wtf.quick_form(userForm) }}

后台对form的接收处理：

userForm = NameForm()
    if userForm.validate_on_submit():
      name=userForm.nameField.data

我们还需要学会巧用flask的flash，后台处理中一些警告、报错等消息信息我们可以存放在flash中，然后前台加载进行展现。Flash就像一个前后台之间的queue，后台通过flash()函数进行add，前台页面通过get\_flashed\_messages()进行消费。

后台代码如下：

from flask import flash
    flash(‘My flash information’)

前台页面如下：

{% for message in get_flashed_messages() %}
    <div class="alert alert-warning">
        <button type="button" class="close" data-dismiss="alert">
            ×
        </button>
        {
        {message}}
    </div>
    {% endfor %}

PS：建议将前台对flash的处理放在base模板中形成通用的组件。

Flask的持久层扩展SQLAlchemy

$pip install flask-sqlalchemy

本质与Hibernate、myBatis一样属于ORMapping技术，以实现代码与数据库的松耦合，以面向对象的方式服务上层操作。

先抛开SQLAlchemy，ORMapping在使用时需要哪些元素？

1数据库信息的配置，以确保代码与数据库的正常连接。

2代码实体类与数据库表名和属性的映射，通过配置文件或者代码直接定义的方式。

3对实体类增删改查操作的上层封装。

OK，回到SQLAlchemy，我们来看下如何实现以上3个元素的。

1数据库连接：

from flask_sqlalchemy import SQLAlchemy
    app.config['SQLALCHEMY_DATABASE_URI'] = 'mysql://root:admin123@192.168.226.137/python'
    db = SQLAlchemy(app)

只需要引入sqlalchemy，配置数据库服务地址，然后跟app绑定一下。同理生产中服务地址不要像我这样写进代码，而是要通过环境变量的方式去加载，防止敏感信息泄露。

2实体类映射：

实体类需要继承SQLAlchemy的Model类

#__tablename__定义的是表名
    #__repr__是非必须的
    class Role(db.Model):
        __tablename__ = 'ROLES'
        id = db.Column(db.Integer, primary_key=True)
        name = db.Column(db.String(20), unique=True)
    
        #第一个参数定义的是对应的哪个模型class
        #第二个参数backref给users添加一个role属性来反向指定本Role实例
        #lazy标识真正用到users时才进行关联
        users = db.relationship('User',backref='role',lazy='dynamic')
    
        def __repr__(self):
            return '<Role %r>' %self.name
    
    class User(db.Model):
        __tablename__ = 'USERS'
        id = db.Column(db.Integer, primary_key=True)
        username = db.Column(db.String(20), unique=True, index=True)
        password = db.Column(db.String(20))
        role_id = db.Column(db.Integer, db.ForeignKey('ROLES.id'))
    
        def __repr__(self):
            return '<User %r>' % self.username

上面定义了2个实体类，其中role与user是一对多的关系，开发过hibernate的同学对这段代码不会太陌生。有两个细节，我通过\_\_tablename\_\_强制指定了表命，是因为我想让表名更规范；Column也可以强制指定表中的属性名，但是我没有这么做，下面会给详细的解释。

附上实例定义的类型：

![20180405201346506][]

实例的约束：

![20180405201417476][]

3增删改查操作：

user_role = Role(name='User')
    user_susan = User(username='susan', role=user_role)
    user_david = User(username='david', role=user_role)
    db.session.add(user_role)
    db.session.add(user_susan)
    db.session.add(user_david)
    print(user_role.id)
    db.session.commit()
    print(user_role.id)
    for role in Role.query.filter_by(name='User').all():
        db.session.delete(role)
    print(User.query.filter_by(role=None).count())

与其它ORMapping技术几乎一样，利用db.session的add、delete方法来操作数据（其中的add方法本质上是saveOrUpdate效果），直接调用类型的query方法可以查询数据。

查询过滤器有：

![20180405201514480][]

查询执行器有：

![20180405201530635][]

以Role.query.filter\_by(name='User').all()为例，先过滤后执行，其中过滤器是非必须的，执行器是必须的。

4 数据库的初始化

回到前面引入的那个问题，为什么我们没有强制指定colum的表属性？其实理论上来说我们都不需要强制指定表名，因为Python的ORMapping与Java的ORMapping在**定位上存在着本质上的差距**！Java是应用语言，通过开发来解决应用的问题；而Python不仅是应用语言，更重要的是管理语言，通过代码来管理应用的问题。

我们可以通过

db.drop\_all()

db.create\_all()

来执行所有实体类表、属性的创建，然后通过随机、解析文档、代码硬编码等形式初始化数据，也就是说python不仅是数据库DML操作的入口，更重要的是在整个项目中对数据库整体的管理和操作，承接了DML、DDL的功能。我们不需要像传统软件开发那样先执行建表语句等DDL脚本，而是直接通过python来实现。

PS：虽然通过python管理数据库是主推的方式，但是如果你自己数据库功底足够深厚还是最好直接去操作数据库，无论是效率还是数据库设计等方面比起python来管理要好得多。

Flask的其它扩展：

邮件功能：pip install flask-mail

Flask的蓝本Blueprint

蓝本主要解决2个问题，第一个是休眠加载；第二个是套件更新。

我们一般把form、自定义error、view（相当于java中的action层）定义成一个蓝本，通过把蓝本注入运行时的app中，注册不同的蓝本就可以更换不同的处理业务和表示风格。

蓝本的构建：

from flask import Blueprint
    main = Blueprint('main', __name__)
    from . import view, error

蓝本的引入：

app.register\_blueprint(main\_blueprint)

[20180405200133005]: /images/20220528/33b6f1fa383c4866958b3e4e22a33ad7.png
[Http]: http://blog.csdn.net/yejingtao703/article/details/78320374
[20180405200331831]: /images/20220528/83a946c42b864006bace87b647dae73a.png
[20180405200445973]: /images/20220528/ded6f2f74c8a4f05b2d1949a6bf963d5.png
[http_pythonhosted.org_Flask-Bootstrap]: http://pythonhosted.org/Flask-Bootstrap/
[http_flask-bootstrap-zh.readthedocs.io_zh_latest]: http://flask-bootstrap-zh.readthedocs.io/zh/latest/
[https_www.cnblogs.com_phpstudy2015-6_p_6771239.html]: https://www.cnblogs.com/phpstudy2015-6/p/6771239.html
[20180405200900087]: /images/20220528/3a8e1c72503a4ed4858ca23acc12d0a1.png
[20180405200925062]: /images/20220528/f8682fdf63844765aa32ecb46213968f.png
[20180405201346506]: /images/20220528/b559f4d39eee44688e37ce21bba30870.png
[20180405201417476]: /images/20220528/6f6e68e3877e470a88039bbde1df8017.png
[20180405201514480]: /images/20220528/4ba28fcba33543f391578774ac2daf67.png
[20180405201530635]: /images/20220528/8c0a4acf3b1143689d1430bb541b25d1.png