Django 的 HTTP 萬能工具 - 'django.utils.http'

這個模塊展現其光芒的時刻。

一般的 Base64 編碼會包含+或/等特殊字符。這些字符在 URL 中有特殊的意義（如空格、路徑分隔等），因此在通過 URL 傳遞值時可能會造成問題。

urlsafe_base64_encode會將這些字符用在 URL 中安全使用的-和_替代，以進行編碼。

主要使用情境:

• 基於電子郵件的註冊認證令牌
• 密碼重設鏈接的用戶 ID(pk) 編碼

範例: (生成密碼重設鏈接)

from django.utils.http import urlsafe_base64_encode, urlsafe_base64_decode
from django.utils.encoding import force_bytes, force_str
from django.contrib.auth.models import User

# 1. 在生成令牌時（編碼）
user = User.objects.get(username='testuser')
# 重要：編碼前必須始終轉換為 bytes。
uid_bytes = force_bytes(user.pk)
uid_token = urlsafe_base64_encode(uid_bytes)

print(f"編碼的令牌: {uid_token}")
# 例如: 'Mg' (假設 user.pk 是 2)
# reset_url = f"/password-reset/{uid_token}/..."


# 2. 當用戶點擊鏈接時（解碼）
try:
    # 將從 URL 接收到的令牌重新解碼為 bytes
    uid_bytes_decoded = urlsafe_base64_decode(uid_token)
    # 轉換回字符串（或整數）
    user_pk = force_str(uid_bytes_decoded)
    user = User.objects.get(pk=user_pk)
    print(f"恢復的 PK: {user.pk}")
except (TypeError, ValueError, OverflowError, User.DoesNotExist):
    user = None

注意: force_bytes 和 force_str 在 django.utils.encoding 模塊中，通常與 urlsafe_base64 函數一起使用。

2. 查詢字符串生成器: urlencode

將 Python 字典(dict) 對象輕鬆轉換為 HTTP GET 請求所用的查詢字符串（例如：?key=value&key2=value2）。

範例:

from django.utils.http import urlencode

params = {
    'page': 3,
    'q': 'django rest framework',
    'region': 'ja'
}

# 將字典的鍵和值進行 URL 編碼以生成查詢字符串。
# 'django rest framework' 的空格將安全地編碼為 '+' 或 '%20'。
query_string = urlencode(params)

print(query_string)
# 輸出: 'page=3&q=django+rest+framework&region=ko'

3. 確認安全重定向: is_safe_url

from django.utils.http import is_safe_url
from django.shortcuts import redirect, resolve_url

def login_success_redirect(request):
    # 從 GET 參數中獲取 'next' 值。
    next_url = request.GET.get('next')

    # 1. 確保 next 值存在且
    # 2. 必須通過 is_safe_url 檢查才能重定向到該 URL。
    if next_url and is_safe_url(
        url=next_url,
        allowed_hosts={request.get_host()},  # 只允許當前請求的主機
        require_https=request.is_secure()   # 如果當前請求是 HTTPS，則重定向也必須是 HTTPS
    ):
        return redirect(next_url)

    # 如果不安全或不存在 'next' 值，則重定向到默認頁面。
    return redirect(resolve_url('main-dashboard'))