Go to Qiita Advent Calendar Top
LoginSignup
0
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

@h4cker_j

FastAPIで独自のフォーラムを構築する：ステップ2 - データベースの統合

Posted at

Cover

前の記事では、スクラッチから始め、FastAPIを使用してフォーラムのプロトタイプを迅速に構築しました。機能は基本的でしたが、投稿とスレッドの表示というフォーラムのコア機能はすでに備わっていました。

このプロトタイプには、1つの重大な問題があります。インメモリデータベースとしてPythonリストを使用しました。これは、サーバーが再起動するたびに、ユーザーが公開したすべての投稿が消えてしまうことを意味します。

この問題を解決するために、この記事では、フォーラムに実際のデータベースであるPostgreSQLを導入し、SQLAlchemy ORMを介して操作することで、永続的なデータストレージを実現します。

始めましょう！

PostgreSQLの準備

チュートリアルを開始する前に、PostgreSQLデータベースを準備しておく必要があります。ローカルにインストールすることもできます。手順は公式PostgreSQLウェブサイトにあります。

より簡単な代替案として、Leapcellを使用して、ワンクリックで無料のオンラインデータベースを取得できます。

Leapcell

ウェブサイトでアカウントを登録した後、「データベースの作成」をクリックします。

DbImageP1

データベース名を入力し、デプロイリージョンを選択すると、PostgreSQLデータベースが作成できます。

表示される新しいページで、データベースに接続するために必要な情報が表示されます。下部にはコントロールパネルがあり、ウェブページ上で直接データベースを読み取ったり変更したりできます。

DbImageP2

この接続情報を使用すると、追加のローカル構成なしで、さまざまなツールからデータベースに直接アクセスできます。

ステップ1：新しい依存関係のインストール

PythonがPostgreSQLと通信できるようにするには、いくつかの新しいライブラリが必要です。仮想環境がアクティブであることを確認し、次のコマンドを実行します。

pip install "sqlalchemy[asyncio]" "psycopg[binary]"

sqlalchemyはPythonエコシステムで最も人気のあるオブジェクトリレーショナルマッパー（ORM）ツールです。これにより、煩雑なSQLステートメントを作成する代わりに、Pythonコードを使用してデータベースを操作できます。
psycopg[binary]は、PostgreSQLとPythonを接続するために使用されます。SQLAlchemyはこれを使用してデータベースと通信します。

ステップ2：データベース接続の確立

データベース接続関連の設定をすべて処理するために、database.pyという新しいファイルを作成します。

database.py

from sqlalchemy.ext.asyncio import create_async_engine, async_sessionmaker
from sqlalchemy.orm import DeclarativeBase

# 1. Database URL
# Format: "postgresql+psycopg://<user>:<password>@<host>:<port>/<dbname>"
DATABASE_URL = "postgresql+psycopg://your_user:your_password@localhost/fastapi_forum_db"

# 2. Create the database engine
engine = create_async_engine(DATABASE_URL)
SessionLocal = async_sessionmaker(autocommit=False, autoflush=False, bind=engine)

# 3. Create a Base class
# Our ORM models will inherit from this class later
class Base(DeclarativeBase):
    pass
  • create_async_engineは、データベースとの通信のコアとなるSQLAlchemyエンジンを作成します。
  • SessionLocalは、データベース操作（作成、読み取り、更新、削除）を実行するために使用されます。
  • Baseクラスは、このチュートリアルで使用するすべてのデータベースモデル（データテーブル）の基本クラスになります。

ステップ3：データテーブルモデルの定義

これで、メモリをデータベースとして使用する必要はなくなりました。データベース内のpostsテーブルの構造を実際に定義するSQLAlchemyモデルを作成しましょう。

models.pyという新しいファイルを作成します。

models.py

from sqlalchemy import Column, Integer, String
from .database import Base

class Post(Base):
    __tablename__ = "posts"

    id = Column(Integer, primary_key=True, index=True)
    title = Column(String, index=True)
    content = Column(String)

このPostクラスは、postsテーブルの構造に直接対応します。

  • __tablename__ = "posts"：データベースに対応するテーブル名を指定します。
  • id：整数型の主キーで、クエリを高速化するためにインデックスが作成されます。
  • titleとcontent：文字列型のフィールドです。

モデルを定義しただけでは、テーブルがデータベースにすでに存在することを意味するわけではありません。このテーブルを手動で作成するには、SQLなどのコマンドを実行する必要があります。

対応するSQLは次のとおりです。

CREATE TABLE posts (
    id SERIAL PRIMARY KEY,
    title VARCHAR,
    content TEXT
);

Leapcellでデータベースを作成した場合、そのウェブページで直接SQLを入力してデータベースを変更できます。

ステップ4：APIのデータベース利用のためにリファクタリング

これが最も重要なステップです。インメモリのdbリストを完全に削除し、APIルート関数をSQLAlchemyセッションを介してPostgreSQLとやり取りするように変更する必要があります。

まず、database.pyに依存関係関数を追加します。

database.py（関数追加）

# ... previous code remains unchanged ...

# Dependency: Get a database session
async def get_db():
    async with SessionLocal() as session:
        yield session

これで、APIパス操作関数でDepends(get_db)を使用してデータベースセッションを取得できます。

以下は、データベースの使用に完全に切り替わったmain.pyの最終的な完全版です。

main.py（最終完全版）

from fastapi import FastAPI, Form, Depends
from fastapi.responses import HTMLResponse, RedirectResponse
from sqlalchemy.ext.asyncio import AsyncSession
from sqlalchemy import select, desc
from typing import List

from . import models
from .database import engine, get_db

app = FastAPI()

# --- HTML Template ---
def generate_html_response(posts: List[models.Post]):
    posts_html = ""
    for post in posts:  # No need for reversed() anymore, we can sort in the query
        posts_html += f"""
        <div style="border: 1px solid #ccc; padding: 10px; margin-bottom: 10px;">
            <h3>{post.title} (ID: {post.id})</h3>
            <p>{post.content}</p>
        </div>
        """

    html_content = f"""
    <html>
        <head>
            <title>My FastAPI Forum</title>
            <style>
                body {{ font-family: sans-serif; margin: 2em; }}
                input, textarea {{ width: 100%; padding: 8px; margin-bottom: 10px; box-sizing: border-box; }}
                button {{ padding: 10px 15px; background-color: #007BFF; color: white; border: none; cursor: pointer; }}
                button:hover {{ background-color: #0056b3; }}
            </style>
        </head>
        <body>
            <h1>Welcome to My Forum</h1>
            <h2>Create a New Post</h2>
            <form action="/api/posts" method="post">
                <input type="text" name="title" placeholder="Post Title" required><br>
                <textarea name="content" rows="4" placeholder="Post Content" required></textarea><br>
                <button type="submit">Post</button>
            </form>
            <hr>
            <h2>Post List</h2>
            {posts_html}
        </body>
    </html>
    """
    return HTMLResponse(content=html_content, status_code=200)

# --- Routes ---

@app.get("/", response_class=RedirectResponse)
def read_root():
    return "/posts"

# Route for displaying the page
@app.get("/posts", response_class=HTMLResponse)
async def view_posts(db: AsyncSession = Depends(get_db)):
    # 1. Query all posts from the database
    result = await db.execute(select(models.Post).order_by(desc(models.Post.id)))
    posts = result.scalars().all()
    # 2. Render the HTML
    return generate_html_response(posts)

@app.post("/api/posts")
async def create_post(
    title: str = Form(...),
    content: str = Form(...),
    db: AsyncSession = Depends(get_db)
):
    # 1. Create a new Post object
    new_post = models.Post(title=title, content=content)
    # 2. Add it to the database session
    db.add(new_post)
    # 3. Commit and save to the database
    await db.commit()
    # 4. Refresh the object to get the newly generated ID
    await db.refresh(new_post)

    return RedirectResponse(url="/posts", status_code=303)

上記の手順により、以下が達成されました。

  1. インメモリdbリストが削除されました。
  2. データベースとやり取りするすべてのルート関数はasync defに変更され、データベース操作の前にawaitが使用されるようになりました。これは、非同期データベースドライバーとエンジンを選択したためです。
  3. GET /postsとPOST /api/postsは、データベースからの読み取りとデータベースへの書き込みを行うように変更されました。

実行と検証

次に、uvicornサーバーを再起動します。

uvicorn main:app --reload

ブラウザを開き、http://127.0.0.1:8000にアクセスします。投稿のリストは空（データベースは新品であるため）で表示されます。

いくつかの新しい投稿を公開してみてください。以前と同じように表示されます。

次に、データ永続性をテストしましょう。

  1. ターミナルでCtrl+Cを押してuvicornサーバーをシャットダウンします。
  2. サーバーを再起動します。
  3. http://127.0.0.1:8000に再度アクセスします。

以前に公開した投稿がまだ存在することに気付くでしょう！フォーラムデータは現在PostgreSQLに保存されており、永続的なストレージが実現しました。

プロジェクトのオンラインデプロイ

最初のチュートリアルと同様に、このステップの結果をオンラインにデプロイして、友人たちにプロジェクトの変更と進捗を体験してもらうことができます。

簡単なデプロイソリューションはLeapcellを使用することです。

Leapcell

過去にデプロイしたことがある場合は、コードをGitリポジトリにプッシュするだけで、Leapcellが最新コードを自動的に再デプロイします。

Leapcellのデプロイメントサービスを初めて使用する場合は、この記事のチュートリアルを参照してください。

まとめ

このチュートリアルでは、フォーラムのバックエンドストレージを信頼性の低いインメモリリストから堅牢なPostgreSQLデータベースに正常に移行しました。

しかし、main.pyファイルに長いHTML文字列がたくさん含まれていて、コードの保守が困難になっていることに気付いたかもしれません。

次回の記事では、「テンプレートエンジン」の概念を導入し、Jinja2を使用してHTMLコードを独立したテンプレートファイルに分離し、フロントエンドコードの可読性と保守性を簡素化します。

Xでフォローする：@LeapcellJapan

ブログでこの記事を読む

関連記事：

0
1
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
Sign upLogin
0
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?