【Django】ForeignKey：一側から多側のモデルを参照（逆参照）する方法（_set）

ForeignKeyとは

リレーションフィールドの一つ、ForeignKeyは「多対一」の関係があるモデル間を関連付けます。「１」側が親、「多」側が子となる関係になります。

主にForeignKeyフィールドは多側のモデルクラスに設けます。

リレーションフィールドについて詳しくは以下記事をご参照ください。

【django】モデルのリレーションフィールド：ForeignKey、OneToOneField、ManyToManyField

多側から一側のモデルを参照する

多側（子）から一側（親）のモデルを参照する方法を解説していきます。

例えばUserモデル（ForeginKey：department）からDepartmentモデル（親）を参照するには次のように記述します。

>>> obj = User.objects.get(id=1)
>>> obj.department

上記ではUserモデルからget(id=1)でUserオブジェクトを生成し、「department」フィールドからDepartmentモデルを参照しています。

Departmentモデルがnameフィールドを持っていた場合、次のようにして値を取得できます。

>>> obj = User.objects.get(id=1)
>>> obj.department.name

サンプルモデル

ここからの解説には以下サンプルモデルを使って解説を進めていきます。

class Dapartment(models.Model):
    name = models.CharField(max_length=255)
    address = models.CharField(max_length=255)
    def __str__(self):
        return self.name

class User(models.Model):
    username = models.CharField(max_length=100, unique=True)
    department = models.ForeignKey(Department, on_delete=models.CASCADE)
    def __str__(self):
        return self.username

models.pyにモデルを定義するする基本については以下記事をご参照ください。

【Django】Model（モデル）とは：models.pyの書き方とデータベース連携（テーブル作成）

models.pyのクラスで指定するフィールドの型やフィールドオプションについては以下記事をご参照ください。

【django】モデルのフィールドについて：フィールドの型・オプション一覧

一側から多側のモデルを参照（逆参照）

一側（親）のモデルから多側（子）のモデルを参照（逆参照）する方法について解説していきます。

逆参照で多側のモデルオブジェクトを取得するには_set属性名を利用します。

上記構文の注意点として、関連先のモデルクラス名は小文字で記述することです。
models.pyでは先頭大文字ですが、逆参照では必ず小文字にします。

例としてサンプルモデルを使って逆参照するコードを以下に記します。

>>> obj = Department.objects.get(id=1)
>>> for user in obj.user_set.all():
...    print(user.username)

上記コードではまずDepartmentでid=1のクラスオブジェクトを生成しています。
２行目では_setを使ってDepartmentからUserを逆参照しています。

このようにしてForeignKeyが定義されていないモデル側から、定義されているモデルを参照します。

ここで使用した_setは多対多のリレーション（ManyToManyField）でも同じように利用することができます。

テンプレートで逆参照

テンプレートで逆参照を行う場合は、タグや変数表示を用いて以下のように記述できます。

{% for user in obj.user_set.all %}
    <p>{{ user.username }}</p>

上記のようにテンプレートで記述することで、テンプレートでも問題なく逆参照を行うことができます。