url.routeurl 参数

在 urls.py 文件中，使用 name 参数来命名 URL 模式。

# myproject/urls.py
from django.contrib import admin
from django.urls import path
from . import views
urlpatterns = [
    path('admin/', admin.site.urls),
    path('', views.index, name='index'),  # 路由名是 'index'
    path('user/profile/<str:username>/', views.show_profile, name='user_profile'), # 路由名是 'user_profile'
]

在视图中使用

# myapp/views.py
from django.shortcuts import redirect
from django.urls import reverse
def login_view(request):
    # ... 登录逻辑 ...
    # 登录成功后，重定向到用户资料页
    return redirect(reverse('user_profile', kwargs={'username': 'johndoe'}))

在模板中使用

<!-- templates/base.html -->
<a href="{% url 'index' %}">Home</a>
<!-- templates/user_list.html -->
<ul>
{% for user in users %}
  <li>
    <a href="{% url 'user_profile' username=user.username %}">
      {{ user.name }}
    </a>
  </li>
{% endfor %}
</ul>

C. FastAPI

FastAPI 的 APIRouter 和 Request 对象提供了强大的 URL 生成功能。

定义路由并命名

在 FastAPI 中，路由的名称通常就是其路径操作函数的名称。

from fastapi import FastAPI, Request, APIRouter
from fastapi.responses import RedirectResponse
app = FastAPI()
router = APIRouter()
# 路由名是 'read_root'
@app.get("/")
def read_root():
    return {"message": "Hello World"}
# 路由名是 'read_item'
@app.get("/items/{item_id}")
def read_item(item_id: str, q: str | None = None):
    return {"item_id": item_id, "q": q}
# 路由名是 'show_user_profile'
@router.get("/user/profile/{username}")
def show_user_profile(username: str):
    return {"username": username}
app.include_router(router)
# 视图函数中生成 URL
@app.get("/login-success")
async def login_success(request: Request):
    # 使用 request.url_for() 生成 URL
    profile_url = request.url_for("show_user_profile", username="johndoe")
    return RedirectResponse(profile_url)

在模板中使用 (使用 Jinja2)

FastAPI 本身不包含模板引擎，但可以轻松集成 Jinja2。

<!-- templates/item.html -->
<a href="{{ url_for('read_item', item_id=item.id, q='search query') }}">Link to Item</a>
<!-- templates/user.html -->
<a href="{{ url_for('show_user_profile', username=user.username) }}">Link to Profile</a>

注意：在 FastAPI 的模板中，url_for 的行为与 Flask 类似，它会查找路由函数的名称。

参数详解

当你调用 url_for() 或 {% url %} 时，可以传递多种类型的参数：

• 位置参数：

  • 用于匹配 URL 路径中的动态部分。
  • 在 Flask 中，如 url_for('show_profile', 'johndoe')。
  • 在 Django 中，如 {% url 'user_profile' 'johndoe' %}。
  • 强烈建议使用关键字参数，因为它更清晰、不易出错。

• 关键字参数：

  • 这是最推荐的方式,参数名必须与 URL 路径中定义的变量名完全匹配。
  • url_for('show_profile', username='johndoe')

• 查询参数：

  • 任何不在路由路径模式中定义的额外关键字参数,都会被自动转换为查询字符串。
  • 路由是 /items/{item_id}，调用 url_for('read_item', item_id='foo', q='search', page=2) 会生成 /items/foo?q=search&page=2。

• 锚点：

  • 可以通过 _anchor 参数添加 URL 片段（锚点）。
  • url_for('read_item', item_id='foo', _anchor='section2') 会生成 /items/foo#section2。

• 方案：

  • 可以通过 _scheme 参数强制 URL 使用 http 或 https。
  • url_for('read_item', item_id='foo', _scheme='https')

• 网络位置：

  • 可以通过 _netloc 参数覆盖 URL 的主机名。
  • url_for('read_item', item_id='foo', _netloc='example.com') 会生成 http://example.com/items/foo

与直接拼接 URL 的对比

假设我们有这样一个路由：/blog/<int:year>/<int:month>/

url.routeurl（或 url_for, reverse）是现代 Web 框架的一个核心特性，它通过用名称代替路径的方式，极大地提升了代码的健壮性和可维护性，在任何需要生成 URL 的地方（尤其是在模板和重定向中），都应该优先使用这种模式，而不是手动拼接字符串。