（七）Flask之路由转换器

news2024/11/28 6:42:12

引子：

from flask import Flask

app = Flask(__name__)


# 通过使用<int>转换器，可以捕获URL中的整数值，并将其作为参数传递给视图函数。
@app.route('/index/<int:nid>', methods=['GET', 'POST'])
def index(nid):
    print(nid)
    return 'Index'


if __name__ == '__main__':
    app.run('localhost', 4000)

上述代码中，<int:nid>部分表示nid是一个整数型的动态路由参数。当用户访问形如/index/666的路径时，会执行index函数并将匹配到的nid作为参数传递进去。

Flask自带的路由转换器

Flask提供了多种路由转换器（Route Converters），用于在路由规则中捕获和转换URL中的动态部分。这些转换器允许我们指定特定类型的参数，并限制其匹配的模式。

使用路由转换器时，只需像引子那样将转换器名称放在路由规则中的动态部分尖括号内即可。

常用路由转换器实际使用类似如下：

# 字符串
@app.route('/user/<username>')

@app.route('/post/<int:post_id>')

@app.route('/post/<float:post_id>')

@app.route('/post/<path:path>')

@app.route('/login', methods=['GET', 'POST'])

下面这段代码定义了Flask中默认的路由转换器（Route Converters）及其对应的类：

DEFAULT_CONVERTERS = {
    # 默认转换器，用于匹配任意不包含斜杠的字符串。它使用`UnicodeConverter`类进行转换。
    'default':            UnicodeConverter,
    # 同样是匹配任意不包含斜杠的字符串，使用`UnicodeConverter`类进行转换。
    'string':             UnicodeConverter,
    # 用于匹配任意类型的数据，可以包含斜杠等特殊字符。它使用`AnyConverter`类进行转换。
    'any':                AnyConverter,
    # 用于匹配包含斜杠的字符串，通常用于捕获整个路径段。它使用`PathConverter`类进行转换。
    'path':               PathConverter,
    # 用于匹配正整数，使用`IntegerConverter`类进行转换。
    'int':                IntegerConverter,
    # 用于匹配浮点数，使用`FloatConverter`类进行转换。
    'float':              FloatConverter,
    # 用于匹配符合UUID格式的字符串，使用`UUIDConverter`类进行转换。
    'uuid':               UUIDConverter,
}

这些默认的路由转换器提供了基本的类型匹配功能，可以根据URL中的动态部分的类型和模式进行精确匹配和转换。

在Flask中，我们也可以自定义自己的路由转换器，通过继承werkzeug.routing.BaseConverter类并实现相应的转换逻辑。然后，我们可以使用app.url_map.converters字典将自定义转换器注册到应用程序中。

自定义路由转换器：

自定义Flask的正则路由转换器，并将其应用于路由规则。

from flask import Flask
from werkzeug.routing import BaseConverter

app = Flask(__name__)


class RegexConverter(BaseConverter):
    """
    自定义URL匹配正则表达式
    """
    def __init__(self, map, regex):
        super(RegexConverter, self).__init__(map)
        self.regex = regex

    def to_python(self, value):
        """
        路由匹配时，匹配成功后传递给视图函数中参数的值
        :param value:
        :return:
        """
        return int(value)

    def to_url(self, value):
        """
        使用url_for反向生成url时，传递的参数经过该方法处理，返回的值用于生成url中的参数
        :param value:
        :return:
        """
        val = super(RegexConverter, self).to_url(value)
        return val


# 添加到flask中
app.url_map.converters['regex'] = RegexConverter


@app.route(r'/index/<regex("\d+"):nid>')
def index(nid):
    print(nid, type(nid))
    return 'Index'


if __name__ == '__main__':
    app.run('localhost', 4000)

代码讲解：
引入必要的模块和库：

from flask import Flask：导入Flask类，用于创建Flask应用程序。
from werkzeug.routing import BaseConverter：导入BaseConverter类，它是Werkzeug库中的路由转换器基类，用于定义自定义转换器。

创建Flask应用程序实例：

app = Flask(__name__)

定义自定义转换器类RegexConverter：

这个类继承自BaseConverter类，并重写了to_python方法和to_url方法，以便在路由匹配成功时和反向生成URL时对参数进行处理。

将自定义转换器添加到Flask应用程序中：

app.url_map.converters['regex'] = RegexConverter

通过将自定义转换器对象RegexConverter赋值给converters字典的键为'regex'的位置，将自定义转换器添加到Flask应用程序的URL映射器中。
定义视图函数：
@app.route(r'/index/<regex("\d+"):nid>')
def index(nid):
    print(nid, type(nid))
    return 'Index'
在上述代码中，定义了一个名为index的视图函数，它接受一个参数nid，并使用自定义转换器<regex("\d+"):nid>来匹配URL中的动态部分。
一句话概括：

上述代码使用自定义路由转换器RegexConverter来处理URL中的动态部分。通过定义自定义转换器，并将其添加到Flask应用程序中，可以实现根据正则表达式模式匹配URL并对参数进行处理。

在这里插入图片描述

看看在RegexConverter类的构造方法__init__中的两个参数：map和regex。

map参数是一个Map对象，它代表URL映射器，用于将路由规则映射到相应的视图函数。通过调用父类BaseConverter的构造方法，将map作为参数传递给父类，以确保父类能够正常初始化。
regex参数是一个表示正则表达式的字符串，它用于定义匹配URL动态部分的正则表达式模式。

在上述这个例子中，我们自定义了一个名为RegexConverter的转换器，并将其应用于路由规则中的nid参数。使用<regex("\d+"):nid>作为路由规则，其中regex("\d+")表示我们想要匹配一个或多个数字。通过将regex("\d+")传递给自定义转换器的构造方法，在转换过程中会使用这个正则表达式模式来匹配URL中的动态部分。

**自定义转换器的作用是根据定义的正则表达式模式将URL中的动态部分转换为特定的数据类型，以便在视图函数中进行处理。**在这个例子中，我在自定义转换器的to_python方法中将匹配到的值转换为整数，以便在视图函数中使用。