flask学习文档02-正则匹配路由,装饰器路由

版权声明:内容版权为CSDN用户:kayseen 所有,若您需要引用、转载,需要注明来源及原文链接 https://blog.csdn.net/m0_43394876/article/details/88540151

1.正则匹配路由

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

具体实现步骤为:

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

1.代码实现

  • 导入转换器基类
from werkzeug.routing import BaseConverter
  • 自定义转换器
# 自定义正则转换器
class RegexConverter(BaseConverter):
    def __init__(self, url_map, *args):
        super(RegexConverter, self).__init__(url_map)
        # 将接受的第1个参数当作匹配规则进行保存
        self.regex = args[0]
  • 添加转换器到默认的转换器字典中,并指定转换器使用时名字为: re
app = Flask(__name__)

# 将自定义转换器添加到转换器字典中,并指定转换器使用时名字为: re
app.url_map.converters['re'] = RegexConverter
  • 使用转换器去实现自定义匹配规则
    • 当前此处定义的规则是:3位数字
@app.route('/user/<re("[0-9]{3}"):user_id>')
def user_info(user_id):
    return "user_id 为 %s" % user_id

运行测试:http://127.0.0.1:5000/user/123 ,如果访问的url不符合规则,会提示找不到页面

2.自定义转换器其他两个函数实现

继承于自定义转换器之后,还可以实现 to_python 和 to_url 这两个函数去对匹配参数做进一步处理:

  • to_python:
    • 该函数参数中的 value 值代表匹配到的值,可输出进行查看
    • 匹配完成之后,对匹配到的参数作最后一步处理再返回,比如:转成 int 类型的值再返回:
class RegexConverter(BaseConverter):
    def __init__(self, url_map, *args):
        super(RegexConverter, self).__init__(url_map)
        # 将接受的第1个参数当作匹配规则进行保存
        self.regex = args[0]

    def to_python(self, value):
        return int(value)

运行测试,在视图函数中可以查看参数的类型,由之前默认的 str 已变成 int 类型的值

  • to_url:
    • 在使用 url_for 去获取视图函数所对应的 url 的时候,会调用此方法对 url_for 后面传入的视图函数参数做进一步处理
    • 具体可参见 Flask 的 app.py 中写的示例代码:ListConverter
class ListConverter(BaseConverter):
    regex = "(\\d+,?)+\\d$"
    def to_python(self, value):
        return value.split(',')
    def to_url(self, values):
        result = ','.join(str(v) for v in value)
        return result

2.系统自带转换器

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

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

3.代码实例

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


class RegexConverter(BaseConverter):
    """自定义正则的转换器"""

    # regex = "[0-9]{6}"

    def __init__(self, url_map, *args):
        super(RegexConverter, self).__init__(url_map)
        # 取到第1个参数,给regex属性赋值
        self.regex = args[0]


class ListConverter(BaseConverter):
    # 先走to_url 再走regex 最后走to_python
    """自己定义转换器"""
    regex = "(\\d+,?)+\\d$"
    #自己补充: to_python里面的返回内容会返回到调用他的demo2里面的返回值中去
    def to_python(self, value):
        """当匹配到参数之后,对参数做进一步处理之后,再返回给视图函数中"""
        return value.split(',')         #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["re"] = RegexConverter
app.url_map.converters["list"] = ListConverter


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


# 规则:/user/6位数字 [0-9]{6}
# 自定义转换器

@app.route('/user/<re("[0-9]{6}"):user_id>')
def demo1(user_id):
    return '用户id是 %s' % user_id


@app.route('/users/<list:user_ids>')
def demo2(user_ids):
    # 如果才能在视图函数中接收到的 user_ids 就是一个列表
    return "用户的id列表是 %s" % user_ids


@app.route('/demo3')
def demo3():
    return redirect(url_for('demo2', user_ids=[1, 3, 4, 5]))


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

4.装饰器路由

Flask有两大核心:Werkzeug和Jinja2

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

Werkzeug是一个遵循WSGI协议的python函数库

- 其内部实现了很多Web框架底层的东西,比如request和response对象;
- 与WSGI规范的兼容;支持Unicode;
- 支持基本的会话管理和签名Cookie;
- 集成URL请求路由等。

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

routing模块内部有:

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

猜你喜欢

转载自blog.csdn.net/m0_43394876/article/details/88540151