flask框架自定义url转换器操作详解
作者:stu_xujin
这篇文章主要介绍了flask框架自定义url转换器操作,结合实例形式分析了URL转换器的相关原理、实现方法与操作注意事项,需要的朋友可以参考下
本文实例讲述了flask框架自定义url转换器。分享给大家供大家参考,具体如下:
什么是url转换器
可以指定url的规制,对url做一定的限制。
自带的url转换器
可以参考我的上一篇博客: flask–url与重定向详解
自定义url转换器
首先我们提一个需求,根据需求来写代码,现在我们假设一个url需要满足电话号码的格式才能访问我们的函数视图,例如这样的url: 127.0.0.1:5000/user/<电话号码>/.
# 首先导入BaseConverter from werkzeug.routing import BaseConverter from flask import Flask app = Flask(__name__) # 然后我们写一个类,需要继承BaseConverter这个类 class TelphoneConverter(BaseConverter): # 然后将我们url的规则写到regex这个属性上,必须为regex,正则表达式 # 以1开始,第二位数只能是3458中的一个,然后后面随便跟9个数字 regex = '1[3458]\d{9}' # 然后我们需要注册我们自定义的转换器 # 'tel': 为我们给这个转换器取的名字,我们使用的时候就会使用这个名字 # 'TelephoneConverter': 为'tel'这个转换器对应的类,也就是我们上面写的类,当我们使用'tel'时,就会去使用这个类中的regex属性 app.url_map.converters['tel'] = TelephoneConverter # 然后使用我们的tel转换器 @app.route('/user/<tel:telephone>') def tel_demo(telephone): return "你的电话号码是:%s" % telephone
然后我们就可以输入网址测试了,如果我们输入的规则不满足我们写的正则表达式的话,就会出现404页面。
在上面的tel转换器中,我们只是写了规则,我们还可以对url进行一些自定义的处理,然后再传给我们的视图函数.
这个时候就会使用到我们的to_python和to_url方法了
需求:当输入的url为127.0.0.1/a+b/这样的时候,我们想在视图函数中拿到的时候就直接是一个列表['a','b'],而不用我们每次都去自己转换。而当我们使用url_for闯入参数的时候,我们直接传入['a','b'],也能直接给我们变成a+b这种形式。
代码如下:
from flask import Flask from flask import url_for from werkzeug.routing import BaseConverter class ListConverter(BaseConverter): # 重写to_python方法,value就是url传入的参数,也就是我们url中传入的参数会经过这个方法处理之后, # 然后再返回给我们的视图函数,也就是我们在视图函数中拿到的值是经过这个函数处理过后的值 def to_python(self,value): return value.split('+') # 重写to_url方法,value就是我们在使用url_for的时候传入的参数,也就是说我们传入的参数会经过这个方法的处理,再变成url def to_url(self,value): return "+".join(value) # 然后我们还是要注册我们的转换器 app.url_map.converters['list'] = ListConverter # 然后编写一个视图来测试 @app.route('/index/') def index(): return url_for('board',boards=['a','b']) @app.route('/<list:boards>/') def demo(boards): print(boards) return 'boards is ' + str(boards)
然后启动项目,当我们访问127.0.0.1:5000/index/的时候,我们就能看到/a+b/,这个就是to_url函数起作用了。而当我们在浏览中输入127.0.01:5000/a+b/,就能看到了一个列表。这也就是我们的to_python起作用了。
总结:
- 自定义url转换器需要继承自BaseConverter这个类
- url的规则需要重写regex这个属性(写正则表达式)
- to_python方法是在url中的参数传入视图函数之前,会对参数进行处理
- to_url方法在使用url_for的时候,会对传入的参数进行处理,再转化为url
- 最后,一定要将自定义的url转换器添加至app.url_map.converters中
希望本文所述对大家基于flask框架的Python程序设计有所帮助。