teccon forum

バックエンドエンジニアリング実践

6 min read

バックエンド エンジニアリングの実践

概要

バックエンドエンジニアリングは、ウェブアプリケーションのサーバー側の構築や維持管理を行う技術の集合体です。これには、APIの設計や、データベースとのやり取り、認証機能の実装、サービスのコンテナ化やスケーラビリティに対する配慮などが含まれます。近年のマイクロサービスアーキテクチャの普及により、より柔軟でスケーラブルなバックエンドシステムが求められるようになっています。以下に、実践的なバックエンドエンジニアリングの各要素について解説します。

API設計とRESTの基本

  • API（Application Programming Interface）は、システムやアプリケーションが外部との通信を行うためのインターフェースを提供するものである
  • REST（Representational State Transfer）は、Web上のリソースに対して一貫性のあるインターフェースを提供するためのアーキテクチャスタイルであり、HTTPメソッド（GET、POST、PUT、DELETE）を用いてリソース操作を行う
  • RESTful APIの設計では、リソースをシンプルかつ直感的に表現することが求められ、URL構造やメソッドの意味を明確にすることで、開発者やクライアントが効率的に利用できるインターフェースを構築する

FastAPIを用いたAPI実装

  • FastAPIはPythonベースのWebフレームワークで、迅速かつ効率的なAPIの構築が可能である
  • 非同期処理を標準でサポートしており、パフォーマンスが高いAPIの開発に適している
  • FastAPIを使うことで、リクエストとレスポンスの型定義が可能になり、開発者がコードの構造を理解しやすくする
  • 例として、以下のコードはシンプルなGETリクエストを処理するAPIの実装である
from fastapi import FastAPI
 
app = FastAPI()
 
@app.get("/items/{item_id}")
async def read_item(item_id: int):
    return {"item_id": item_id}

データベースの設計と連携

  • バックエンドシステムでは、データベースと効果的に連携することが重要である
  • 一般的なRDBMS（リレーショナルデータベース）やNoSQLデータベースを使用してデータを永続化し、SQLAlchemyなどのORM（オブジェクトリレーショナルマッピング）を用いてデータベース操作を行うことができる
  • データの正規化やインデックスの適切な設定により、パフォーマンスの最適化を図る必要がある
  • FastAPIでは、SQLAlchemyやTortoise-ORMを統合して、Pythonオブジェクトとしてデータベース操作を行える

認証と認可の実装

  • バックエンドエンジニアリングにおいて、ユーザー認証や権限管理（認可）は不可欠である
  • JWT（JSON Web Token）を用いた認証は、トークンベースでセッションを管理し、スケーラブルな認証システムを実現する
  • FastAPIでは、標準ライブラリでJWTを使った認証を簡単に実装できる
from fastapi import Depends, FastAPI, HTTPException
from fastapi.security import OAuth2PasswordBearer
from jose import JWTError, jwt
 
oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")
app = FastAPI()
 
@app.get("/users/me")
async def read_users_me(token: str = Depends(oauth2_scheme)):
    try:
        payload = jwt.decode(token, "secret", algorithms=["HS256"])
        return payload
    except JWTError:
        raise HTTPException(status_code=401, detail="Invalid token")

Dockerによるコンテナ化とデプロイ

  • バックエンドのサービスを開発・テスト・本番環境で一貫して動作させるために、Dockerを用いたコンテナ化が推奨される
  • Dockerを利用することで、依存関係の問題や環境差異による不具合を最小化でき、スケーラブルなデプロイが可能になる
  • バックエンドシステムをDockerコンテナ内で実行する際、Dockerfileを作成し、アプリケーションのビルドと実行に必要な環境を明示することができる
FROM python:3.9-slim
 
WORKDIR /app
COPY . /app
 
RUN pip install -r requirements.txt
CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "80"]

マイクロサービスアーキテクチャ

  • マイクロサービスは、アプリケーションを独立した複数のサービスに分割し、それぞれが独自にデプロイ・スケーリング可能である
  • 各サービスは独立して実行され、APIを介して通信を行うため、障害が発生しても他のサービスへの影響を最小限に抑えることができる
  • DockerやKubernetesなどのコンテナオーケストレーションツールを利用することで、マイクロサービスの管理が容易になる

テストとCI/CD

  • バックエンドシステムの品質を保証するために、単体テスト、統合テスト、E2E（エンドツーエンド）テストを実施する
  • FastAPIでは、pytestを使ったテストが推奨される
  • CI/CD（継続的インテグレーションと継続的デリバリー）パイプラインを構築することで、コードの変更がテスト・ビルド・デプロイされるプロセスを自動化することが可能である
from fastapi.testclient import TestClient
from .main import app
 
client = TestClient(app)
 
def test_read_item():
    response = client.get("/items/42")
    assert response.status_code == 200
    assert response.json() == {"item_id": 42}

バックエンドエンジニアリングのまとめ

  • バックエンドエンジニアリングは、API設計、データベース連携、認証、コンテナ化、マイクロサービス化、テスト自動化といった多岐にわたる技術を統合してシステムを構築する
  • FastAPIを使った開発は、Pythonのエコシステムを活かして迅速にスケーラブルなサービスを提供できる
  • DockerやCI/CDツールを組み合わせることで、開発から本番環境まで一貫したワークフローを実現する

Graph View