flask里的路由变量—动态URL

路由变量

1. 绑定动态URL

有时我们需要将同一类 URL 映射到同一个视图函数处理，比如：使用同一个视图函数来显示不同用户的个人信息。这时可以设置路由变量让视图函数可以绑定动态URL。

# 设置路由变量  格式:  <路由变量>
@app.route('/user/<user_id>')
def user_info(user_id):
    return 'hello %s' % user_id

• 一旦设置了路由变量, 必须在视图函数设置同名的参数, 用于接收URL的动态部分

2. 路由变量规则

在 Web 开发中，可能会出现限制用户访问规则的场景，那么这个时候就需要用到正则匹配，根据自己的规则限定URL的动态部分的格式, 满足格式的动态URL才可以调用视图函数

具体实现步骤为：

• 自定义转换器类：继承于转换器基类
• 添加转换器到Flask应用的转换器字典中
• 使用自定义转换器实现自定义匹配规则

代码实现

• 自定义转换器类

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不符合规则，会提示找不到页面

自定义转换器的两个函数

继承于自定义转换器之后，还可以实现 to_python 和 to_url 这两个函数去对路由变量做进一步处理：

• to_python：
  • 路由变量传给视图函数前会调用
  • 该函数的参数 value 对应路由变量记录的值
  • 方便开发者对路由变量提前进行一些处理, 如类型转换 (路由变量的值默认是str类型)

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, 就会调用
  • 去获取视图函数所对应的 url 的时候，会调用此方法对 url_for 中传入的 URL动态内容 做进一步处理
  • 具体可参见 Flask 的 app.py 中写的示例代码：ListConverter

系统自带转换器

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

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