ブループリント(Blueprint)
アプリが1つのファイルだけの場合、すべてのルートを一緒に書いても問題はありません。
しかし機能が増えてくると——ユーザーモジュール、記事モジュール、管理バックエンド——コードは保守しにくくなります。
Blueprint(ブループリント)Flaskが提供するモジュール化ソリューションであり、アプリを独立した機能単位に分割できるようにします。
なぜブループリントが必要か
ブループリントが解決する核心的な問題:
- コード構成:関連するルート、テンプレート、静的ファイルを1つのグループにまとめる
- 再利用性:同じブループリントを異なるアプリに登録したり、複数回登録(異なるプレフィックスを付けて)したりできる
- チームコラボレーション:異なる開発者が異なるブループリントモジュールを担当し、競合を減らす
ブループリントの作成
ブループリントの使用Blueprintクラスで作成し、使い方はFlask非常に似ています——同じルートデコレータ、同じビュー関数の書き方:
例
from flask import Blueprint, render_template, request, session, redirect, url_for
# ブループリントインスタンスを作成
# 最初の引数 "auth" はブループリントの名前です(url_for で参照するため)
# __name__ はブループリントにテンプレートと静的ファイルをどこから探すかを伝えます
bp = Blueprint("auth", __name__)
# ブループリントでは app.route ではなく bp.route を使用します
@bp.route("/login", methods=["GET", "POST"])
def login():
if request.method == "POST":
username = request.form.get("username", "")
if username:
session["username"] = username
return redirect(url_for("blog.index"))
return render_template("auth/login.html")
@bp.route("/register", methods=["GET", "POST"])
def register():
if request.method == "POST":
username = request.form.get("username", "")
if username:
return redirect(url_for("auth.login"))
return render_template("auth/register.html")
@bp.route("/logout")
def logout():
session.clear()
return redirect(url_for("blog.index"))
例
from flask import Blueprint, render_template
bp = Blueprint("blog", __name__)
@bp.route("/")
def index():
# 記事データのモック
posts = [
{"title": "Flask 入門", "author": "サンプル"},
{"title": "Blueprint 詳説", "author": "サンプル"},
]
return render_template("blog/index.html", posts=posts)
@bp.route("/create", methods=["GET", "POST"])
def create():
return render_template("blog/create.html")
ブループリントの登録
ブループリントは作成後に自動では有効になりません。アプリで登録する必要があります:
例
from flask import Flask
from auth import bp as auth_bp
from blog import bp as blog_bp
app = Flask(__name__)
app.secret_key = "dev-secret-key"
# ブループリントをアプリに登録
# url_prefix:ブループリント内のすべてのルートに共通のプレフィックスを追加します
app.register_blueprint(auth_bp, url_prefix="/auth")
# auth ブループリントのルートは:/auth/login, /auth/logout, /auth/register になります
app.register_blueprint(blog_bp)
# blog ブループリントはプレフィックスなし、ルートは:/、/create のまま
登録後の完全なルートテーブル:
| URL | ブループリント | endpoint(url_for で使用) |
|---|---|---|
| / | blog | blog.index |
| /create | blog | blog.create |
| /auth/login | auth | auth.login |
| /auth/register | auth | auth.register |
| /auth/logout | auth | auth.logout |
ブループリントを登録すると、url_for()内の endpoint にブループリント名のプレフィックスを付ける必要があります。例:url_for("auth.login")ではなくurl_for("login")。
ブループリントにおける url_for の特別な使い方
同じブループリント内では、ドットで始まる相対参照を使用できます:
例
@bp.route("/")
def index():
# 同じブループリント内の相対参照(. で始まる)
login_url = url_for(".login") # url_for("auth.login") と同等
register_url = url_for(".register") # url_for("auth.register") と同等
# ブループリントをまたぐ参照には完全な endpoint が必要です
blog_url = url_for("blog.index") # blog ブループリントの index を参照
ブループリントのテンプレートと静的ファイル
ブループリントは独自のテンプレートと静的ファイルを持つこともできます。
ブループリントが独自のテンプレートフォルダを持つ場合、Flask はまずアプリのtemplatesフォルダ内を検索し、見つからなければブループリントが指定したフォルダを検索します。
例
bp = Blueprint("auth", __name__, template_folder="templates")
# ブループリント固有のテンプレート構成
# パス:auth/templates/auth/login.html
# レンダリング時:render_template("auth/login.html")
# このように構成することでファイル名の衝突を避けられます(login.html は auth と blog で異なる可能性があります)
推奨されるブループリントのディレクトリ構造:
myflaskapp/
├── app.py # 应用入口,注册蓝图
├── auth.py # 认证蓝图
├── blog.py # 博客蓝图
├── templates/ # 应用级模板(公共 base.html 等)
│ └── base.html
├── static/ # 应用级静态文件
│ └── style.css
├── auth/ # auth 蓝图的独立资源(可选)
│ └── templates/
│ └── auth/
│ ├── login.html
│ └── register.html
└── blog/ # blog 蓝图的独立资源(可选)
└── templates/
└── blog/
├── index.html
└── create.html
最も簡単な方法は、ブループリントに独立したテンプレートフォルダを設定せず、テンプレートをプロジェクトルートディレクトリのtemplates/下に置き、サブディレクトリで区別します:templates/auth/login.html、templates/blog/index.html。
ファクトリパターン——create_app
ブループリントが増えるにつれて、モジュールのトップレベルで直接app = Flask(__name__)作成すると、循環インポートの問題に遭遇します。
ファクトリパターン(Factory Pattern)はこの問題を解決するベストプラクティスです:
例
from flask import Flask
def create_app():
"""アプリファクトリ関数——設定済みの Flask インスタンスを返す"""
app = Flask(__name__)
app.secret_key = "dev-secret-key"
# 設定を読み込む
app.config.from_pyfile("config.py", silent=True)
# 関数内部でブループリントをインポートし、循環参照を回避
from auth import bp as auth_bp
from blog import bp as blog_bp
# ブループリントを登録
app.register_blueprint(auth_bp, url_prefix="/auth")
app.register_blueprint(blog_bp)
return app
ファクトリパターンの利点:
- 循環インポートを解消:ブループリントはインポートでき、app,appアプリもブループリントをインポートできます。インポートが関数内部で行われるためです。
- テストのサポート:異なる設定の app インスタンスを作成してテストできます
- マルチインスタンスデプロイ:同じコードで複数の独立した app インスタンスを作成できます
ファクトリパターンを使用した後は、flask --app "app:create_app()" run起動:
$ flask --app "app:create_app()" run
ブループリントのその他の機能
ブループリントは before_request、errorhandler などのデコレータもサポートしており、使い方は app と同じです:
例
def check_login():
"""auth ブループリントのすべてのリクエストの前にログイン状態をチェックする"""
if request.endpoint not in ("auth.login", "auth.register"):
if "username" not in session:
return redirect(url_for("auth.login"))
@bp.errorhandler(404)
def not_found(error):
"""auth ブループリント専用の 404 エラーページ"""
return render_template("auth/404.html"), 404
他の拡張機能ブループリントのbefore_requestエラーハンドラはそのブループリント内のルートにのみ影響します。すべてのリクエスト前にロジックを実行する必要がある場合は、app.before_request。