[[437021]]

本文轉載自微信公眾號「dongfanger」，作者dongfanger。轉載本文請聯系dongfanger公眾號。

 Flask的view函數是用來對請求作出響應的。單個URL能匹配到單個View，那么多個類似的URL，比如：

/auth/register 
/auth/login 
/auth/logout 

有沒有什么比較優雅的寫法呢?

Blueprints

Blueprints就是一個路由分組，可以把共同的路由前綴注冊為一個Blueprint，比如：

在flaskr/auth.py文件中先定義一個Blueprint：

import functools 
 
from flask import ( 
    Blueprint, flash, g, redirect, render_template, request, session, url_for 
) 
from werkzeug.security import check_password_hash, generate_password_hash 
 
from flaskr.db import get_db 
 
bp = Blueprint('auth', __name__, url_prefix='/auth') 

• 'auth'是Blueprint的名字。
• __name__用來告訴Blueprint它的定義位置。
• url_prefix就是路由前綴。

接著在flaskr/__init__.py文件中注冊：

def create_app(): 
    app = ... 
    # existing code omitted 
 
    from . import auth 
    app.register_blueprint(auth.bp) 
 
    return app 

Views

定義和注冊了Blueprints后就可以在view中使用了。比如：

①在flaskr/auth.py文件中添加一個注冊view：

@bp.route('/register', methods=('GET', 'POST')) 
def register(): 
    if request.method == 'POST': 
        username = request.form['username'] 
        password = request.form['password'] 
        db = get_db() 
        error = None 
 
        if not username: 
            error = 'Username is required.' 
        elif not password: 
            error = 'Password is required.' 
 
        if error is None: 
            try: 
                db.execute( 
                    "INSERT INTO user (username, password) VALUES (?, ?)", 
                    (username, generate_password_hash(password)), 
                ) 
                db.commit() 
            except db.IntegrityError: 
                error = f"User {username} is already registered." 
            else: 
                return redirect(url_for("auth.login")) 
 
        flash(error) 
 
    return render_template('auth/register.html') 

• @bp.route就會把路由前綴加到'/register'上拼成/auth/register。
• request.form是一個字典，可以讀取接口入參。
• db.execute執行SQL語句。db.commit()提交。
• redirect在注冊成功后重定向到登錄頁面。
• url_for根據view名字來獲取url，因為這里用到了Blueprint，所以入參是"auth.login"。如果沒有用Blueprint，url_for()函數入參就寫view函數名即可。

②在flaskr/auth.py文件中添加一個登錄view：

@bp.route('/login', methods=('GET', 'POST')) 
def login(): 
    if request.method == 'POST': 
        username = request.form['username'] 
        password = request.form['password'] 
        db = get_db() 
        error = None 
        user = db.execute( 
            'SELECT * FROM user WHERE username = ?', (username,) 
        ).fetchone() 
 
        if user is None: 
            error = 'Incorrect username.' 
        elif not check_password_hash(user['password'], password): 
            error = 'Incorrect password.' 
 
        if error is None: 
            session.clear() 
            session['user_id'] = user['id'] 
            return redirect(url_for('index')) 
 
        flash(error) 
 
    return render_template('auth/login.html') 

• fetchone()取一行數據，fetchall()取多行數據。
• 登錄成功后會把user_id存入session中，session是一個字典，這樣后續請求就可以用到這個數據。比如：

@bp.before_app_request 
def load_logged_in_user(): 
    user_id = session.get('user_id') 
 
    if user_id is None: 
        g.user = None 
    else: 
        g.user = get_db().execute( 
            'SELECT * FROM user WHERE id = ?', (user_id,) 
        ).fetchone() 

值得注意的是@bp.before_app_request有點像setup，就是在所有請求前先運行這一段代碼。

③在flaskr/auth.py文件中添加一個登出view：

flaskr/auth.py 
@bp.route('/logout') 
def logout(): 
    session.clear() 
    return redirect(url_for('index')) 

• session.clear()清除session。

④最后可以在在flaskr/auth.py文件中順手寫一個裝飾器，用來做認證鑒權：

def login_required(view): 
    @functools.wraps(view) 
    def wrapped_view(**kwargs): 
        if g.user is None: 
            return redirect(url_for('auth.login')) 
 
        return view(**kwargs) 
 
    return wrapped_view 

在需要登錄才能訪問的view上，就可以加上這個login_required裝飾器。

參考資料：

https://flask.palletsprojects.com/en/2.0.x/tutorial/views/