1、Web框架

web网站发展至今，特别是服务器端，涉及到的知识、内容，非常广泛。这对程序员的要求会越来越高。如果采用成熟，稳健的框架，那么一些基础的工作，比如，安全性，数据流控制等都可以让框架来处理，那么程序开发人员可以把精力放在具体的业务逻辑上面。使用框架的优点：

稳定性和可扩展性强
可以降低开发难度，提高开发效率。

在 Python 中常用的 Web 框架有:

Flask 、Django、Tornado

2、Flask简介

Flask 是一个 Python 实现的 Web 开发微框架。你正在阅读的是开发版本的文档。

中文文档（http://docs.jinkan.org/docs/flask/）

英文文档（http://flask.pocoo.org/docs/0.11/）

Flask 依赖两个外部库： Jinja2 模板引擎和 Werkzeug WSGI 工具集。此文档不包含这两个库的文档。要细读它们的文档，请点击下面的链接：

Jinja2模板引擎

Werkzeug WSGI工具集

3、HelloWorld示例-基础

# 第一步   导入Flask类
from flask import Flask
# 第二步    Flask函数接收一个参数__name__，它会指向程序所在的包
app = Flask(__name__)

# 第三步   装饰器的作用是将路由映射到视图函数 demo ,并返回 helloworld
@app.route('/')
def demo():
    return "helloworld!!"

# 第四步   Flask应用程序实例的 run 方法 启动 WEB 服务器
if __name__ == '__main__':
    app.run()

4、相关配置参数

4、1 初始化参数
Flask 程序实例在创建的时候，需要默认传入当前 Flask 程序所指定的包(模块)，接下来就来详细查看一下 Flask 应用程序在创建的时候一些需要我们关注的参数：

app = Flask(__name__,  # Flask程序所在的包(模块)，传 __name__ 就可以 ;其可以决定 Flask 在访问静态文件时查找的路径
            static_path='static',  # 静态文件访问路径(不推荐使用，使用 static_url_path 代替)
            static_url_path='static',  # 静态文件访问路径，可以不传，默认为：/ + static_folder
            static_folder='static',  # 静态文件存储的文件夹，可以不传，默认为 static
            template_folder='templates'  # 模板文件存储的文件夹，可以不传，默认为 templates
            )

4、2 程序加载配置

在 Flask 程序运行的时候，可以给 Flask 设置相关配置，比如：配置 Debug 模式，配置数据库连接地址等等，设置 Flask 配置有以下三种方式：

# 第一种   从对象中加载配置
class Config(object):
    DEBUG = True

app.config.from_object(Config)

# 第二种   从文件中加载配置
app.config.from_pyfile('config.ini')

# 第二种   从环境变量中加载配置
app.config.from_envvar('ENVCONFIG')

4、3 app.run的参数

可以指定运行的主机IP地址，端口，是否开启调试模式

app.run(host="0.0.0.0", port=5000, debug = True)

5、Flask中的路由

5.1 指定路由地址：

# 指定访问路径为 demo1
@app.route('/demo1')
def demo1():
    return 'demo1'

5.2 给路由传参示例：有时我们需要将同一类 URL 映射到同一个视图函数处理，比如：使用同一个视图函数来显示不同用户的个人信息。

# 路由传递参数
@app.route('/user/<user_id>')
def user_info(user_id):
    return 'hello %s' % user_id

路由传递的参数默认当做 string 处理，也可以指定参数的类型

# 路由传递参数
@app.route('/user/<int:user_id>')
def user_info(user_id):
    return 'hello %d' % user_id

这里指定int，尖括号中的内容是动态的，在此暂时可以理解为接受 int 类型的值，实际上 int 代表使用 IntegerConverter 去处理 url 传入的参数

5.3 指定请求方式：

@app.route('/demo2', methods=['GET', 'POST'])
def demo2():
    # 直接从请求中取到请求方式并返回
    return request.method

6、视图常用逻辑

6、1 返回JSON

在使用 Flask 写一个接口时候需要给客户端返回 JSON 数据，在 Flask 中可以直接使用 jsonify 生成一个 JSON 的响应

# 返回JSON
@app.route('/demo4')
def demo4():
    json_dict = {
        "user_id": 10,
        "user_name": "laowang"
    }
    return jsonify(json_dict)

注：不推荐使用 json.dumps 转成 JSON 字符串直接返回，因为返回的数据要符合 HTTP 协议规范，如果是 JSON 需要指定 content-type:application/json

6、2 重定向

重定向到百度网址

# 重定向
@app.route('/demo5')
def demo5():
    return redirect('http://www.baidu.com')

重定向也可以使用url_for生成指定视图函数所对应的url

@app.route('/demo1')
def demo1():
    return 'demo1'

# 重定向
@app.route('/demo5')
def demo5():
    return redirect(url_for('demo1'))

重定向可以到带参数的视图函数, 在url_for 函数中传入参数

# 路由传递参数
@app.route('/user/<int:user_id>')
def user_info(user_id):
    return 'hello %d' % user_id

# 重定向
@app.route('/demo5')
def demo5():
    # 使用 url_for 生成指定视图函数所对应的 url
    return redirect(url_for('user_info', user_id=100))

6.3 自定义状态码

在 Flask 中，可以很方便的返回自定义状态码，以实现不符合 http 协议的状态码，例如：status code: 666

@app.route('/demo6')
def demo6():
    return '状态码为 666', 666

7、正则匹配路由

在 web 开发中，可能会出现限制用户访问规则的场景，那么这个时候就需要用到正则匹配，根据自己的规则去限定请求参数再进行访问

具体实现步骤为：

导入转换器基类：在 Flask 中，所有的路由的匹配规则都是使用转换器对象进行记录
自定义转换器：自定义类继承于转换器基类
添加转换器到默认的转换器字典中
使用自定义转换器实现自定义匹配规则

1、代码实现

from flask import Flask
# 第一步:导入转换器基类
from werkzeug.routing import BaseConverter


# 第二步:自定义转换器类
class RegexConverter(BaseConverter):
    def __init__(self, url_map, *args):
        super(RegexConverter, self).__init__(url_map)
        # 将接收到的第一个参数当做匹配规则进行保存
        self.regex = args[0]


app = Flask(__name__)
# 第三步: 将自定义转化器添加到转化器字典中去, 并指定转化器使用时的名字为:re
app.url_map.converters['re'] = RegexConverter


# 第四步: 使用转化器实现自定义匹配规则, 此处定义的是6位整数
@app.route('/user/<re("[0-9]{6}:user_id")>')
def user_info(user_id):
    return "user_id 为 %s" % user_id


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

7、2 自定义转换器其他两个函数实现--to_python 和 to_url

to_python：

该函数参数中的 value 值代表匹配到的值，可输出进行查看
匹配完成之后，对匹配到的参数作最后一步处理再返回，比如：转成 int 类型的值再返回：

to_url：

在使用 url_for 去获取视图函数所对应的 url 的时候，会调用此方法对 url_for 后面传入的视图函数参数做进一步处理
具体可参见 Flask 的 app.py 中写的示例代码：ListConverter

from flask import Flask
from flask import redirect
from flask import url_for
from werkzeug.routing import BaseConverter

class ListConverter(BaseConverter):
    regex = "(\\d+,?)+\\d$" #匹配多个数字字符串

    def to_python(self, value):
        #对匹配到的参数做进一步处理再返回(访问数据的时候)
        return value.split(',')  #字符串->列表

    def to_url(self, value):
        #对视图函数参数做进一步处理(返回数据的时候)
        #针对url_for()中的参数做处理
        result = ','.join(str(v) for v in value) # 列表->字符串
        return result
app = Flask(__name__)
app.url_map.converters["list"] = ListConverter

@app.route('/')
def index():
    return 'index'

#规定访问的参数必须是列表
@app.route('/users/<list:user_ids>')
def demo2(user_ids):
    #print(type(user_ids)) #列表
    return "用户的id列表是 %s" % user_ids #当做字符串返回

@app.route('/demo3')
def demo3():
    #url_for 通过函数匹配路由，在匹配的时候可以调用to_url
    return redirect(url_for('demo2', user_ids=[1, 3, 4, 5]))

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

7、3 系统自带的转化器

DEFAULT_CONVERTERS = {
    'default':          UnicodeConverter,
    'string':           UnicodeConverter,
    'any':              AnyConverter,
    'path':             PathConverter,
    'int':              IntegerConverter,
    'float':            FloatConverter,
    'uuid':             UUIDConverter,
}

系统自带的转换器具体使用方式在每种转换器的注释代码中有写，请留意每种转换器初始化的参数。

8、异常捕获

8、1 HTTP 异常主动抛出

abort 方法：抛出一个给定状态代码的 HTTPException 或者指定响应，例如想要用一个页面未找到异常来终止请求，你可以调用 abort(404)。只能抛出 HTTP 协议的错误状态码

# abort(404)
abort(500)

8、2 捕获错误

errorhandler 装饰器：注册一个错误处理程序，当程序抛出指定错误状态码的时候，就会调用该装饰器所装饰的方法，参数为HTTP的错误状态码或指定异常；

@app.errorhandler(500)
def internal_server_error(e):
    return '服务器搬家了'

捕获制定异常：

@app.errorhandler(ZeroDivisionError)
def zero_division_error(e):
    return '除数不能为0'

9、请求勾子

在客户端和服务器交互的过程中，有些准备工作或扫尾工作需要处理，比如：

在请求开始时，建立数据库连接；
在请求开始时，根据需求进行权限校验；
在请求结束时，指定数据的交互格式；

请求钩子是通过装饰器的形式实现，Flask支持如下四种请求钩子：

before_first_request
- 在处理第一个请求前执行
before_request
- 在每次请求前执行
- 如果在某修饰的函数中返回了一个响应，视图函数将不再被调用
after_request
- 如果没有抛出错误，在每次请求后执行
- 接受一个参数：视图函数作出的响应
- 在此函数中可以对响应值在返回之前做最后一步修改处理
- 需要将参数中的响应在此参数中进行返回
teardown_request：
- 在每次请求后执行
- 接受一个参数：错误信息，如果有相关错误抛出

10、装饰器路由具体实现梳理

Flask有两大核心：Werkzeug和Jinja2：

- Werkzeug实现路由、调试和Web服务器网关接口
- Jinja2实现了模板。

Werkzeug库的 routing 模块负责实现 URL 解析。不同的 URL 对应不同的视图函数，routing模块会对请求信息的URL进行解析，匹配到URL对应的视图函数，执行该函数以此生成一个响应信息。

routing模块内部有：

Rule类
- 用来构造不同的URL模式的对象，路由URL规则
Map类
- 存储所有的URL规则和一些配置参数
BaseConverter的子类
- 负责定义匹配规则
MapAdapter类
- 负责协调Rule做具体的匹配的工作

11、request

request 就是flask中代表当前请求的 request 对象，其中一个请求上下文变量(理解成全局变量，在视图函数中直接使用可以取到当前本次请求)

常用的属性如下：

属性	说明	类型
data	记录请求的数据，并转换为字符串	*
form	记录请求中的表单数据	MultiDict
args	记录请求中的查询参数	MultiDict
cookies	记录请求中的cookie信息	Dict
headers	记录请求中的报文头	EnvironHeaders
method	记录请求使用的HTTP方法	GET/POST
url	记录请求的URL地址	string
files	记录请求上传的文件	*

12、状态保持

http 是一种无状态协议，浏览器请求服务器是无状态的

无状态：指一次用户请求时，浏览器、服务器无法知道之前这个用户做过什么，每次请求都是一次新的请求。

无状态原因：浏览器与服务器是使用 socket 套接字进行通信的，服务器将请求结果返回给浏览器之后，会关闭当前的 socket 连接，而且服务器也会在处理页面完毕之后销毁页面对象。

但是实际情况需要保持用户浏览的状态，通常有两种方式：

在客户端存储信息使用Cookie
在服务器端存储信息使用Session

Cookie：指某些网站为了辨别用户身份、进行会话跟踪而储存在用户本地的数据（通常经过加密）；Cookie是由服务器端生成，发送给客户端浏览器，浏览器会将Cookie的key/value保存，下次请求同一网站时就发送该Cookie给服务器（前提是浏览器设置为启用cookie）；Cookie的key/value可以由服务器端自己定义。

应用：
- 最典型的应用是判定注册用户是否已经登录网站，用户可能会得到提示，是否在下一次进入此网站时保留用户信息以便简化登录手续，这些都是Cookie的功用。
- 网站的广告推送，经常遇到访问某个网站时，会弹出小窗口，展示我们曾经在购物网站上看过的商品信息。
- 购物车，用户可能会在一段时间内在同一家网站的不同页面中选择不同的商品，这些信息都会写入Cookie，以便在最后付款时提取信息。
提示：
- Cookie是存储在浏览器中的一段纯文本信息，建议不要存储敏感信息如密码，因为电脑上的浏览器可能被其它人使用
- Cookie基于域名安全，不同域名的Cookie是不能互相访问的
  - 如访问itcast.cn时向浏览器中写了Cookie信息，使用同一浏览器访问baidu.com时，无法访问到itcast.cn写的Cookie信息
  - 浏览器的同源策略
- 当浏览器请求某网站时，会将本网站下所有Cookie信息提交给服务器，所以在request中可以读取Cookie信息

Cookie的增删改查代码：

from flask import Flask, make_response, request

app = Flask(__name__)


@app.route('/')
def index():
    # 查询cookie
    user_id = request.cookies.get('user_id')
    user_name = request.cookies.get('user_name')
    return '%s----%s' % (user_id, user_name)


@app.route('/login')
def login():
    response = make_response('success')
    # 设置cookie
    response.set_cookie('user_id', '1')
    response.set_cookie('user_name', 'laowang')
    print("login"+str(response))
    return response

@app.route('/logout')
def logout():
    response = make_response('success')
    # 删除cookie
    response.delete_cookie('user_id')
    response.delete_cookie('user_name')
    print("logout" + str(response))
    return response

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

设置过期时间

@app.route('/cookie')
def set_cookie():
    response = make_response('hello world')
    response.set_cookie('username', 'itheima', max_age=3600)
    return response

12、2 Session

对于敏感、重要的信息，建议要存储在服务器端，不能存储在浏览器中，如用户名、余额、等级、验证码等信息
在服务器端进行状态保持的方案就是Session
Session依赖于Cookie
增删改查代码：

from flask import Flask, session

app = Flask(__name__)
# 使用session 需要设置SECRET_KEY
app.config['SECRET_KEY'] = 'dnuqi12kqiejadklalw'


@app.route('/')
def index():
    # 查询session
    user_id = session.get('user_id', "")
    user_name = session.get('user_name', "")
    return '%s====%s' % (user_id, user_name)


@app.route('/login')
def login():
    # 加载校验成功  设置session
    session['user_id'] = '1'
    session['user_name'] = 'laowang'
    return 'login success!'


@app.route('/logout')
def logout():
    # 删除session
    session.pop('user_id', None)
    session.pop('user_name', None)
    return 'logout ok!'


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

13、上下文

Flask中有两种上下文，请求上下文（request context）和应用上下文(application context)

13、1 请求上下文(request context)

在 flask 中，可以直接在视图函数中使用 request 这个对象进行获取相关数据，而 request 就是请求上下文的对象，保存了当前本次请求的相关数据，请求上下文对象有：request、session

request
- 封装了HTTP请求的内容，针对的是http请求。举例：user = request.args.get('user')，获取的是get请求的参数。
session
- 用来记录请求会话中的信息，针对的是用户信息。举例：session['name'] = user.id，可以记录用户信息。还可以通过session.get('name')获取用户信息。

13、2 应用上下文(application context)

它的字面意思是应用上下文，但它不是一直存在的，它只是request context 中的一个对 app 的代理(人)，所谓local proxy。它的作用主要是帮助 request 获取当前的应用，它是伴 request 而生，随 request 而灭的。

应用上下文对象有：current_app，g

current_app

应用程序上下文,用于存储应用程序中的变量，可以通过current_app.name打印当前app的名称，也可以在current_app中存储一些变量，例如：

应用的启动脚本是哪个文件，启动时指定了哪些参数
加载了哪些配置文件，导入了哪些配置
连了哪个数据库
有哪些public的工具类、常量
应用跑再哪个机器上，IP多少，内存多大

g变量

g 作为 flask 程序全局的一个临时变量,充当者中间媒介的作用,我们可以通过它传递一些数据，g 保存的是当前请求的全局变量，不同的请求会有不同的全局变量，通过不同的thread id区别

g.name='abc'

注意：不同的请求，会有不同的全局变量

13、3 两者区别：

请求上下文：保存了客户端和服务器交互的数据
应用上下文：flask 应用程序运行过程中，保存的一些配置信息，比如程序名、数据库连接、应用信息等

上下文中的对象只能在指定上下文中使用，超出范围不能使用请求上下文和应用上下文原理实现：https://segmentfault.com/a/1190000004223296

===未完结！！待续！！！===

后端框架之Flask--初识

1、Web框架

3、HelloWorld示例-基础

4、相关配置参数

4、2 程序加载配置

4、3 app.run的参数

可以指定运行的主机IP地址，端口，是否开启调试模式

5、Flask中的路由

6、视图常用逻辑

6、2 重定向

7、正则匹配路由

8、异常捕获

9、请求勾子

10、装饰器路由具体实现梳理

11、request

12、状态保持

12、2 Session

13、上下文

current_app

g变量

13、3 两者区别：

猜你喜欢

后端框架之Flask--初识

1、Web框架

3、HelloWorld示例-基础

4、相关配置参数

4、2 程序加载配置

4、3 app.run的参数

可以指定运行的主机IP地址，端口，是否开启调试模式

5、Flask中的路由

6、视图常用逻辑

6、2 重定向

7、正则匹配路由

8、异常捕获

9、请求勾子

10、装饰器路由具体实现梳理

11、request

12、状态保持

12、1 Cookie

12、2 Session

13、上下文

current_app

g变量

13、3 两者区别：

猜你喜欢