お気に入り機能とバックエンド管理
この章では、多対多関係を使ってお気に入り機能を実装し、Flask-Admin でバックエンド管理を素早く構築する方法を学びます。
多対多関係の設計
お気に入り機能の要件:1人のユーザーは複数の記事をお気に入りでき、1つの記事は複数のユーザーにお気に入りされる。
SQLAlchemy では、多対多関係は関連テーブル(Association Table)によって実現します。
実例
from datetime import datetime
# 関連テーブル: モデルクラスとして定義する必要はなく、db.Table で直接作成する
favorites = db.Table('favorites',
db.Column('user_id', db.Integer, db.ForeignKey('users.id'), primary_key=True),
db.Column('post_id', db.Integer, db.ForeignKey('posts.id'), primary_key=True),
db.Column('created_at', db.DateTime, default=datetime.utcnow)
)
class Post(db.Model):
__tablename__ = 'posts'
# ... 既存のフィールドは変更なし ...
次にマイグレーションを実行します:
(venv) $ flask db migrate -m "新增收藏关联表" (venv) $ flask db upgrade
お気に入り登録と解除のビュー
実例
from flask import Blueprint, render_template, redirect, url_for, request, flash
from flask_login import login_required, current_user
from app.models import Post, db, favorites
user_bp = Blueprint('user', __name__)
@user_bp.route("/favorite/<int:post_id>", methods=['POST'])
@login_required
def toggle_favorite(post_id):
"""お気に入り状態を切り替える"""
post = Post.query.get_or_404(post_id)
# お気に入り済みかどうかを確認: 関連テーブルにこのユーザーと記事の組み合わせがあるか照会する
is_faved = db.session.query(favorites).filter(
favorites.c.user_id == current_user.id,
favorites.c.post_id == post.id
).first() is not None
if is_faved:
# お気に入り解除
db.session.execute(
favorites.delete().where(
(favorites.c.user_id == current_user.id) &
(favorites.c.post_id == post.id)
)
)
db.session.commit()
flash(f'「{post.title}」のお気に入りを解除しました', 'info')
else:
# お気に入りに追加
db.session.execute(
favorites.insert().values(user_id=current_user.id, post_id=post.id)
)
db.session.commit()
flash(f'「{post.title}」をお気に入りに追加しました', 'success')
return redirect(request.referrer or url_for('main.index'))
@user_bp.route("/favorites")
@login_required
def favorites_list():
"""現在のユーザーのお気に入り一覧"""
# 関連テーブル経由でユーザーがお気に入りした記事を照会する
faved_posts = Post.query.join(
favorites, (favorites.c.post_id == Post.id)
).filter(
favorites.c.user_id == current_user.id
).order_by(favorites.c.created_at.desc()).all()
return render_template('favorites.html', posts=faved_posts)
app.py で Blueprint を登録する
実例
app.register_blueprint(user_bp)
詳細ページと一覧ページにお気に入りボタンを追加する
実例
{% if current_user.is_authenticated %}
<form method="post" action="{{ url_for('user.toggle_favorite', post_id=post.id) }}">
<button type="submit" class="fav-btn">
{% set is_faved = false %}
{# 現在のユーザーが記事のお気に入り登録者リストにいるか確認する #}
♡ お気に入り
</button>
</form>
{% endif %}
お気に入り操作は GET リンクではなく POST リクエスト(フォーム送信)を使用します。GET リクエストは副作用(データベースの変更)を引き起こすべきではありません。これは Web 開発の基本原則です。
Flask-Admin — バックエンド管理
Flask-AdminFlask エコシステムにおける Django Admin に相当する拡張機能です。
設定後、ブラウザで記事とカテゴリのデータを管理できます。
(venv) $ pip install flask-admin
実例
from flask_admin import Admin
from flask_admin.contrib.sqla import ModelView
from app.models import Post, Category, User
# ModelView をカスタマイズ: バックエンドで表示するフィールドを制御
class PostAdmin(ModelView):
column_list = ['title', 'category', 'created_at', 'updated_at']
column_searchable_list = ['title', 'summary']
column_filters = ['category', 'created_at']
form_columns = ['title', 'slug', 'summary', 'content', 'category']
class CategoryAdmin(ModelView):
column_list = ['name', 'slug']
form_columns = ['name', 'slug']
# Admin インスタンスを作成
admin = Admin(app, name='サンプル ブログのバックエンド', template_mode='bootstrap4')
admin.add_view(PostAdmin(Post, db.session, name='記事'))
admin.add_view(CategoryAdmin(Category, db.session, name='カテゴリ'))
admin.add_view(ModelView(User, db.session, name='ユーザー'))
サーバーを起動して、アクセス/adminすると、バックエンド管理画面に入れます。
Flask-Admin vs Django Admin
| 特徴 | Flask-Admin | Django Admin |
|---|---|---|
| 統合方式 | サードパーティ拡張機能、pip install が必要 | django.contrib.admin に組み込み |
| モデルの登録 | admin.add_view(ModelView(Model, session)) | admin.site.register(Model) |
| 一覧フィールド | column_list | list_display |
| 検索 | column_searchable_list | search_fields |
| フィルタ | column_filters | list_filter |
| 認証が必要 | 組み込みではない(手動で @login_required を追加する必要がある) | 管理者権限が組み込み |
Flask-Admin はデフォルトではログインなしでアクセスできます。Flask-Login と組み合わせて権限制御を追加する必要があります。簡単な方法の1つは、ビュー関数の前に追加する
@login_required、または ModelView のis_accessibleメソッドをオーバーライドして管理者権限を確認します。
本章のまとめ
この章では、2つの重要な機能を実装しました。db.Table 関連テーブル + db.session.execute 操作を使ってお気に入りの多対多関係を実現し、Flask-Admin でバックエンド管理システムを素早く構築しました。
これでブログのインタラクティブ機能(ユーザー、お気に入り)と管理機能(バックエンド)がすべて整いました。
その他の拡張