인증 기능을 갖춘 모듈형 Flask 애플리케이션

Beginner

This tutorial is from open-source community. Access the source code

소개

이 랩에서는 Flask 블루프린트 (blueprint) 를 사용하여 뷰 (view) 를 통해 애플리케이션을 구조화하는 방법을 안내합니다. Flask 블루프린트를 사용하면 관련 뷰, 코드 및 리소스를 함께 그룹화하여 애플리케이션을 모듈화하고 확장 가능하게 만들 수 있습니다. 사용자 인증 및 블로그 게시물 기능을 포함하는 간단한 애플리케이션을 만들 것입니다.

참고: 코드 파일을 직접 생성하고 환경에서 실행해야 합니다. Web 5000 에서 Flask 서비스 상태를 미리 볼 수 있습니다.

블루프린트 생성

애플리케이션을 위한 블루프린트를 생성하는 것으로 시작해 보겠습니다. 이 블루프린트는 'auth'라는 이름으로 지정되며 사용자 인증 관련 뷰를 처리합니다. flaskr/auth.py라는 별도의 모듈에서 블루프린트를 정의합니다.

## flaskr/auth.py

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

## Create a Blueprint named 'auth'
bp = Blueprint('auth', __name__, url_prefix='/auth')

블루프린트 등록

블루프린트를 생성한 후에는 애플리케이션에 등록해야 합니다. 이는 flaskr/__init__.py의 애플리케이션 팩토리 함수에서 수행됩니다.

## flaskr/__init__.py

def create_app():
    app = ...
    ## existing code omitted

    ## Import and register the blueprint
    from . import auth
    app.register_blueprint(auth.bp)

    return app

등록 뷰 구현

이제 flaskr/auth.py에서 등록 뷰를 구현해 보겠습니다. 이 뷰는 등록 양식을 렌더링하고 양식 제출을 처리합니다.

## flaskr/auth.py

@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')

로그인 뷰 구현

다음으로, flaskr/auth.py에서 로그인 뷰를 구현합니다. 이 뷰는 사용자 로그인 기능을 처리합니다.

## flaskr/auth.py

@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')

로그아웃 뷰 구현

이제 flaskr/auth.py에 로그아웃 뷰를 추가해 보겠습니다. 이 뷰는 사용자 로그아웃 기능을 처리합니다.

## flaskr/auth.py

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

로그인 필요 데코레이터 구현

또한 사용자가 로그인해야 하는 뷰를 보호하기 위해 데코레이터가 필요합니다. 이 데코레이터는 flaskr/auth.py에서 구현됩니다.

## 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

요약

이 랩에서는 Flask 블루프린트를 사용하여 애플리케이션을 구조화하는 방법을 배웠습니다. 사용자 인증을 위한 블루프린트를 생성하고 등록, 로그인 및 로그아웃 뷰를 구현했습니다. 또한 사용자가 로그인해야 하는 뷰를 보호하기 위한 데코레이터를 구현했습니다. 이 지식을 통해 이제 Flask 애플리케이션을 모듈식으로 확장 가능한 방식으로 구조화할 수 있습니다.