Flask上下文處理器：全局變量與模板複用

什麼是上下文處理器？¶

上下文處理器是Flask提供的一個裝飾器（@app.context_processor），通過定義一個函數並返回一個字典，就能讓字典中的鍵值對自動成爲所有模板的可用變量。這些變量會在每次渲染模板時被注入到模板的上下文中，相當於“全局”可用，但僅針對當前請求的模板。

基本用法：快速注入共享變量¶

要使用上下文處理器，只需在Flask應用中用@app.context_processor裝飾一個函數，函數返回的字典鍵是模板中變量的名稱，值是變量的具體內容。

示例1：顯示當前時間¶

假設我們想在所有模板中顯示當前時間，使用上下文處理器只需這樣寫：

from flask import Flask, render_template
from datetime import datetime

app = Flask(__name__)

# 定義上下文處理器，返回當前時間
@app.context_processor
def inject_current_time():
    current_time = datetime.now().strftime('%Y-%m-%d %H:%M:%S')
    return {'current_time': current_time}  # 字典鍵名即模板變量名

@app.route('/')
def index():
    return render_template('index.html')  # 無需傳遞current_time變量

@app.route('/about')
def about():
    return render_template('about.html')  # 無需傳遞current_time變量

此時，在任何模板（如index.html或about.html）中，都可以直接使用{{ current_time }}顯示當前時間：

<!-- index.html 或 about.html 中 -->
<p>當前時間：{{ current_time }}</p>

模板複用：共享導航菜單¶

上下文處理器的核心價值之一是模板複用。比如導航菜單、頁腳信息等在多個頁面都需要顯示的內容，用上下文處理器統一管理，修改一處即可應用到所有模板。

示例2：共享導航菜單¶

定義一個導航菜單列表，通過上下文處理器返回，所有模板都能直接使用：

@app.context_processor
def inject_navigation():
    nav_items = [
        {'name': '首頁', 'url': '/'},
        {'name': '關於', 'url': '/about'},
        {'name': '聯繫', 'url': '/contact'},
        {'name': '登錄', 'url': '/login'}
    ]
    return {'nav_items': nav_items}  # 模板中用nav_items變量

@app.route('/')
def index():
    return render_template('index.html')

@app.route('/contact')
def contact():
    return render_template('contact.html')

在模板中循環渲染導航菜單：

<!-- base.html 或 index.html 中 -->
<nav>
    <ul>
        {% for item in nav_items %}
            <li><a href="{{ item.url }}">{{ item.name }}</a></li>
        {% endfor %}
    </ul>
</nav>

這樣，無論訪問哪個頁面，導航菜單都會自動顯示，無需在每個視圖函數中重複傳遞nav_items。

動態數據：當前用戶信息¶

上下文處理器的變量可以是動態的（比如根據用戶登錄狀態變化）。例如，顯示當前登錄用戶的信息：

@app.context_processor
def inject_user_info():
    # 假設從session中獲取用戶信息（實際項目需結合用戶認證）
    # 這裏用模擬數據，登錄狀態爲True時返回用戶信息，否則返回None
    user = {'name': '小明', 'is_logged_in': True} if True else None
    return {'current_user': user}

@app.route('/profile')
def profile():
    return render_template('profile.html')

在模板中根據用戶信息顯示不同內容：

{% if current_user %}
    <h1>歡迎回來，{{ current_user.name }}！</h1>
    <a href="/logout">退出登錄</a>
{% else %}
    <p>請先登錄</p>
    <a href="/login">登錄</a>
{% endif %}

不用上下文處理器？對比更清晰¶

如果不用上下文處理器，每個視圖函數都需要手動傳遞共享變量。例如，顯示當前時間和導航菜單，視圖函數需要這樣寫：

@app.route('/')
def index():
    current_time = datetime.now().strftime('%Y-%m-%d %H:%M:%S')
    nav_items = [{'name': '首頁', 'url': '/'}, ...]
    return render_template('index.html', current_time=current_time, nav_items=nav_items)

@app.route('/about')
def about():
    current_time = datetime.now().strftime('%Y-%m-%d %H:%M:%S')
    nav_items = [{'name': '首頁', 'url': '/'}, ...]
    return render_template('about.html', current_time=current_time, nav_items=nav_items)

而用上下文處理器後，視圖函數只需返回模板名稱，變量自動注入，代碼更簡潔：

@app.route('/')
def index():
    return render_template('index.html')  # 無需傳遞變量

@app.route('/about')
def about():
    return render_template('about.html')  # 無需傳遞變量

總結¶

上下文處理器是Flask中一個高效的模板複用工具，核心作用是自動注入共享變量到所有模板，避免重複代碼，讓多個模板可以共享導航、用戶信息、頁腳等內容。它的優勢在於：
- 代碼簡潔：無需在每個視圖函數中重複傳遞變量；
- 動態更新：變量可隨請求動態變化（如當前時間、用戶登錄狀態）；
- 維護性高：修改共享內容只需改上下文處理器，所有模板自動生效。

下次開發Flask項目時，如果遇到多個模板需要共享數據，不妨試試上下文處理器，讓代碼更優雅、更易維護！