Flask - 04 路由

现代 web 应用都使用有意义的 URL ，这样有助于用户记忆，网页会更得到用户的青睐，提高回头率。
Flask使用route()装饰器来把函数绑定到 URL。

有以下三种方式定义路由规则：

route()装饰器
add_url_rule()函数
底层Werkzeug的url_map函数

一、route()装饰器

route(rule, options)装饰器接受两个参数，第一个为路由匹配规则。分以下几种

1. 简单URL

指定一个字符串作为url

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

@app.route('/hello')
def hello():
    return 'Hello, World'

2. 含变量的URL

url含有变量标记<variable_name>，标记部分会作为参数传给函数

@app.route('/user/<username>')
def show_user_profile(username):
    # show the user profile for that user
    return 'User %s' % escape(username)

3. 含转换器的URL

为变量增加转换器作为规则<converter:variable_name>

@app.route('/post/<int:post_id>')
def show_post(post_id):
    # show the post with the given id, the id is an integer
    return 'Post %d' % post_id

@app.route('/path/<path:subpath>')
def show_subpath(subpath):
    # show the subpath after /path/
    return 'Subpath %s' % escape(subpath)

转换器(converter)类型有：

值	描述
string	（缺省值）接受任何不包含斜杠的文本
int	接受正整数
float	接受正浮点数
path	类似string，但可以包含斜杠
uuid	UUID字符串

4 URL中斜杠(/)的重定向

使用route装饰器定义url时，字符串的末尾有无斜杠意义不同

@app.route('/projects/')
def projects():
    return 'The project page'

访问如上URL时如果末尾不带斜杠，Flask 会自动进行重定向，帮你在尾部加上一个斜杠。
所以，访问http://xxx/projects时会自动重定向到末尾带斜杠的url http://xxx/projects/，从而匹配projects函数进行响应

@app.route('/about')
def about():
    return 'The about page'

访问如上一个url，必须不带斜杠。如果带斜杠则会提示404。故访问http://xxx/about/ 则会报404

5. 多路由

同一个函数可以由多个route装饰，并可设置默认路由

@app.route('/users/', defaults={'page': 1})
@app.route('/users/page/<int:page>')
def show_users(page):
   print('show users in page ' , page)

如果用户访问/users/，则访问第一页。/users/page/n则访问第N页
注意，默认的路由只能接受get请求

4. 带HTTP的路由

route(rule, option)第二个参数可以指定该方法接受的HTTP操作，默认是get请求

@app.route('/login', methods=['GET', 'POST'])
def login():
    if request.method == 'POST':
        return do_the_login()
    else:
        return show_the_login_form()

5. 构建URL

url_for(function)拥有获取某个函数对应的url

from flask import Flask, redirect, url_for,
app = Flask(__name__)

@app.route('/task/')
def get_task(id):
    return "task"

# 必须有context时url_for才起作用，此处仅为demo
with app.test_request_context():
    print(url_for('get_task')) # 输出'/task/'

当HTML页面需要导航到某个url时，可用url_for生成一个url字符串

<a href={{ url_for('get_task', id='no1') }}>获取task</a>

# 输出
<a href='/task/no1'>获取task</a>

也可以为route()传入endpoint为url传入别名，这样当使用url_for()时参数就是这个别名而非原来的函数名

@app.route(‘/‘，endpoint=‘index‘）
def hello_world():
    return ‘hello world‘

url_for('index')

参数
url_for()也可以附带一些参数，比如想要完整的URL，可以设置_external为Ture：

endpoint
URL的端点（即函数的名字）
values
URL的变量参数
_external
如果设置为True，则生成一个绝对路径URL
_scheme
一个字符串指定所需的URL方案。_external参数必须设置为True，不然会抛出ValueError。
_anchor
如果设置了这个则给URL添加一个mao
_method
如果设置这个则显示地调用这个HTTP方法

url('task', _external=True, id=1)，构建出的url是http://localhost/task/1

二、add_url_rule

可以通过此函数动态绑定一个url与一个函数。route()装饰器内部实际上也是调用这个函数。

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

# Is equivalent to the following:

def get_task():
    pass
app.add_url_rule('/', 'task', get_task)

参数
add_url_rule(rule, endpoint=None, view_func=None, provide_automatic_options=None, **options)

rule：设置的url
endpoint: url设置的别名，可省略
view_func：函数名