Djangoでモデルオブジェクトの変更履歴を追跡する方法

モデル履歴追跡とは、モデルオブジェクトに対して行われた変更内容や削除日時などを記録し、管理できる機能です。この機能を使えば、誤って削除したオブジェクトを復元することも可能になります。本記事では、Djangoでモデルオブジェクトの履歴を追跡する方法を、実際の例を通して解説します。

準備：プロジェクトとモデルのセットアップ

まずは、Djangoプロジェクト・アプリ・URL設定・モデルを作成しておきましょう。

django-simple-history のインストール

履歴追跡には django-simple-history ライブラリを使用します。以下のコマンドでインストールしてください。

pip install django-simple-history

settings.py の設定

INSTALLED_APPS += ["simple_history"]
MIDDLEWARE = [
    # その他のミドルウェア
    'simple_history.middleware.HistoryRequestMiddleware',
]

ここでは、"simple_history" をアプリとして INSTALLED_APPS に追加し、あわせてミドルウェアも登録しています。

なお、今回の実装では urls.py や views.py に大きな変更は必要ありません。主な作業は models.py と admin.py で行います。

モデルに履歴フィールドを追加する

models.py

from django.db import models
from simple_history.models import HistoricalRecords

# Create your models here.
class StudentData(models.Model):
    name = models.CharField(max_length=100)
    standard = models.CharField(max_length=100)
    section = models.CharField(max_length=100)
    history = HistoricalRecords()

通常のモデルを作成し、HistoricalRecords() を history フィールドとして定義するだけで、すべての変更が自動的に保存されるようになります。

admin.py

from django.contrib import admin
from .models import StudentData
from simple_history.admin import SimpleHistoryAdmin

admin.site.register(StudentData, SimpleHistoryAdmin)

ここでは、履歴追跡に対応した SimpleHistoryAdmin を使ってモデルを登録しています。これにより、Django管理画面から変更履歴を確認できるようになります。

マイグレーションとスーパーユーザーの作成

以下のコマンドを実行して、データベースを更新し、管理画面用のスーパーユーザーを作成します。

python manage.py makemigrations
python manage.py migrate
python manage.py createsuperuser

これで準備は完了です。models.py に追加したコードにより、すべての履歴データが専用テーブルに保存され、views.py や Djangoシェルから参照できるようになります。

動作確認

管理画面でオブジェクトを作成・編集・削除すると、それぞれの操作が履歴として記録されます。管理画面の「履歴」ボタンから、いつ誰がどのような変更を行ったのかを一覧で確認できます。

また、履歴データは views.py や Djangoシェルから以下のようにクエリして取得できます。

student = StudentData.objects.first()
student.history.all()  # すべての変更履歴を取得

さらに、削除されたオブジェクトも履歴テーブルには残っているため、必要に応じて復元処理を実装することも可能です。監査ログが必要なシステムや、データの変更経緯を把握したいプロジェクトで、django-simple-history は非常に便利なライブラリです。