Flask データベース統合
ほとんどの Web アプリケーションでは、データを永続的に保存する必要があります。
この章では、Python に組み込まれている SQLite データベースを使用して、追加の依存関係をインストールせずに Flask にデータベースを統合する方法を説明します。
SQLite クイックスタート
SQLite は軽量なデータベースで、データは 1 つのファイルに保存され、Python 標準ライブラリが標準でサポートしています。
これは学習やプロトタイプ開発に最適です。データベースサーバーのインストールも設定も必要ありません。
サンプル
import sqlite3
# データベースに接続(サンプル.db が存在しない場合は自動的に作成される)
conn = sqlite3.connect("サンプル.db")
# row_factory を設定すると、クエリ結果を辞書のようにフィールド名でアクセスできる
conn.row_factory = sqlite3.Row
# テーブルを作成
conn.execute("CREATE TABLE IF NOT EXISTS user (id INTEGER PRIMARY KEY, username TEXT UNIQUE, password TEXT)")
# データを挿入
conn.execute("INSERT INTO user (username, password) VALUES (?, ?)", ("サンプル", "pass123"))
conn.commit()
# データを照会する
rows = conn.execute("SELECT * FROM user").fetchall()
for row in rows:
print(dict(row)) # 出力: {'id': 1, 'username': 'サンプル', 'password': 'pass123'}
conn.close()
Flask で g オブジェクトを使用してデータベース接続を管理する
gg は特別なオブジェクトであり、そのライフサイクルは単一のリクエストです。
データベース接続を g に保存します。gこれにより、同じリクエスト内の複数のデータベース操作が同じ接続を共有し、リクエスト終了後に自動的にクリーンアップされます。
サンプル
import sqlite3
from flask import g, current_app
def get_db():
"""データベース接続を取得し、同じリクエスト内で再利用する"""
if "db" not in g:
# 設定からデータベースのパスを読み取る
db_path = current_app.config.get("DATABASE", "サンプル.db")
g.db = sqlite3.connect(db_path)
g.db.row_factory = sqlite3.Row # 結果をフィールド名でアクセスできるようにする
return g.db
def close_db(error=None):
"""データベース接続を閉じる(リクエスト終了時に自動的に呼び出される)"""
db = g.pop("db", None)
if db is not None:
db.close()
def init_db():
"""データベースのテーブル構造を初期化する"""
db = get_db()
db.execute("""
CREATE TABLE IF NOT EXISTS user (
id INTEGER PRIMARY KEY AUTOINCREMENT,
username TEXT UNIQUE NOT NULL,
password TEXT NOT NULL,
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
)
""")
db.execute("""
CREATE TABLE IF NOT EXISTS post (
id INTEGER PRIMARY KEY AUTOINCREMENT,
title TEXT NOT NULL,
body TEXT NOT NULL,
author_id INTEGER NOT NULL,
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
FOREIGN KEY (author_id) REFERENCES user (id)
)
""")
db.commit()
def init_app(app):
"""Flask アプリケーションにデータベース関連機能を登録する"""
# リクエスト終了時にデータベース接続を自動的に閉じる
app.teardown_appcontext(close_db)
# CLI コマンドを登録: flask init-db
app.cli.command("init-db")(init_db)
ファクトリパターンによる統合
ファクトリパターンを使用して、データベースを他のモジュールと統合します:
サンプル
from flask import Flask
def create_app():
app = Flask(__name__)
app.secret_key = "dev-secret-key"
# データベースのパスを設定(instance フォルダーに保存)
import os
app.config["DATABASE"] = os.path.join(app.instance_path, "サンプル.db")
# instance フォルダーが存在することを確認
os.makedirs(app.instance_path, exist_ok=True)
# データベースを初期化
from db import init_app as init_db
init_db(app)
# ブループリントを登録
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
完全なブログ API を作成する
データベースと組み合わせて、記事の CRUD(作成・読み取り・更新・削除)操作を実装します:
サンプル
from flask import Blueprint, request, jsonify, abort, g
from db import get_db
bp = Blueprint("blog", __name__)
@bp.get("/api/posts")
def list_posts():
"""すべての記事のリストを取得する"""
db = get_db()
posts = db.execute(
"SELECT p.id, p.title, p.body, p.created_at, u.username"
" FROM post p JOIN user u ON p.author_id = u.id"
" ORDER BY p.created_at DESC"
).fetchall()
# Row オブジェクトのリストを dict のリストに変換する
return jsonify([dict(post) for post in posts])
@bp.get("/api/posts/<int:post_id>")
def get_post(post_id):
"""単一記事の詳細を取得する"""
db = get_db()
post = db.execute(
"SELECT id, title, body, created_at FROM post WHERE id = ?",
(post_id,)
).fetchone()
if post is None:
abort(404, description=f記事 {post_id} は存在しません)
return jsonify(dict(post))
@bp.post("/api/posts")
def create_post():
"""新しい記事を作成する"""
data = request.json
title = data.get("title", "").strip()
body = data.get("body", "").strip()
author_id = data.get("author_id", 1) # デフォルトの著者 ID
if not title:
return jsonify({"error": "タイトルは空にできません"}), 400
db = get_db()
cursor = db.execute(
"INSERT INTO post (title, body, author_id) VALUES (?, ?, ?)",
(title, body, author_id)
)
db.commit()
return jsonify({"id": cursor.lastrowid, "title": title, "message": "記事が作成されました"}), 201
@bp.put("/api/posts/<int:post_id>")
def update_post(post_id):
"""記事を更新する"""
data = request.json
title = data.get("title", "").strip()
body = data.get("body", "").strip()
if not title:
return jsonify({"error": "タイトルは空にできません"}), 400
db = get_db()
db.execute(
"UPDATE post SET title = ?, body = ? WHERE id = ?",
(title, body, post_id)
)
db.commit()
return jsonify({"id": post_id, "message": "記事が更新されました"})
@bp.delete("/api/posts/<int:post_id>")
def delete_post(post_id):
"""記事を削除する"""
db = get_db()
db.execute("DELETE FROM post WHERE id = ?", (post_id,))
db.commit()
return jsonify({"message": "記事が削除されました"})
API をテストする:
# 获取文章列表
$ curl http://127.0.0.1:5000/api/posts
# 创建文章
$ curl -X POST http://127.0.0.1:5000/api/posts \
-H "Content-Type: application/json" \
-d '{"title":"サンプル 教程","body":"Flask 入门教程内容","author_id":1}'
# 更新文章
$ curl -X PUT http://127.0.0.1:5000/api/posts/1 \
-H "Content-Type: application/json" \
-d '{"title":"サンプル 教程(修订版)","body":"更新后的内容"}'
# 删除文章
$ curl -X DELETE http://127.0.0.1:5000/api/posts/1
ベストプラクティス: API が JSON データを返す場合、正しい HTTP ステータスコードを使用します。作成には201、成功には200、クライアントエラーには400、リソースが存在しない場合には404。これにより、フロントエンドのコードがリクエストの結果を判断しやすくなります。
データベース初期化コマンド
Flask CLI を使用して、データベースを初期化するカスタムコマンドを作成できます:
# 初始化数据库(创建表结构) (.venv) $ flask init-db # 验证表已创建 (.venv) $ sqlite3 instance/サンプル.db ".tables" post user
SQL インジェクション対策
パラメータ化クエリ(?プレースホルダー)を使用することが、SQL インジェクションを防ぐ鍵です:
サンプル
# SQLite ドライバーがパラメータを自動的にエスケープし、悪意のある入力が SQL として実行されるのを防ぎます
db.execute("SELECT * FROM user WHERE username = ?", (username,))
# 誤った方法: f-string で SQL を連結する(非常に危険!)
# db.execute(f"SELECT * FROM user WHERE username = '{username}'")
# 悪意のある入力 '; DROP TABLE user; -- はテーブル全体を削除します!
Flask-SQLAlchemy を使用する(上級者向け・任意)
大規模なプロジェクトでは、手動で SQL を書くのは次第に面倒になります。
Flask-SQLAlchemyFlask-SQLAlchemy は広く人気のある拡張機能であり、ORM(オブジェクト関係マッピング)機能を提供します:
サンプル
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
app = Flask(__name__)
app.config["SQLALCHEMY_DATABASE_URI"] = "sqlite:///サンプル.db"
db = SQLAlchemy(app)
# データモデルを定義(テーブル構造は Python クラスで表現)
class User(db.Model):
id = db.Column(db.Integer, primary_key=True)
username = db.Column(db.String(80), unique=True, nullable=False)
email = db.Column(db.String(120), unique=True, nullable=False)
def __repr__(self):
return f"<User {self.username}>"
# テーブルを作成
with app.app_context():
db.create_all()
# ユーザーを作成
user = User(username="サンプル", email="test@example.com")
db.session.add(user)
db.session.commit()
# ユーザーを照会する
users = User.query.all()
サンプル_user = User.query.filter_by(username="サンプル").first()
その他の拡張機能この章でネイティブ SQLite を使用するのは、追加の依存関係を導入しないためであり、学習や小規模プロジェクトに適しています。実際の本番プロジェクトでは、SQLAlchemy または類似の ORM を使用することをお勧めします。これにより、重複コードを大幅に削減し、安全性を向上させることができます。