django-field-tutorial

Django ORM and Relationship Field

認識 Django OneToOneField , ForeignKey ,ManyToManyField 📝

為什麼我會把這三個特別拿出來講呢？因為他會影響到你設計資料庫，更影響到你的整體架構。

建議對 Django 不熟悉的朋友，可以先觀看我之前寫的文章（先認識一下 Django ）

Django 基本教學 - 從無到有 Django-Beginners-Guide

我可以從這篇學到什麼

OneToOneField
ForeignKey
ManyToManyField

安裝套件

請在 cmd ( 命令提示字元 ) 輸入以下指令

pip install django==4.2.3

如果你想要使用 PostgreSQL, 請多安裝

pip install psycopg2==2.9.6

並且修改 settings.py

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql_psycopg2',
        'NAME': 'postgres',
        'USER': 'myuser',
        'PASSWORD': 'password123',
        'HOST': 'localhost',
        'PORT': 5432,
    }
}

教學

我們先透過 OneToOneField_tutorial 來認識基本的流程，所以請將 settings.py 裡的 INSTALLED_APPS修改一下，修改如下

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'OneToOneField_tutorial',
    # 'ForeignKey_tutorial',
    # 'ManyToManyField_tutorial',
]

在 OneToOneField_tutorial 的 models.py 裡，有我們事先寫好的 model，

我們先 makemigrations

python manage.py makemigrations OneToOneField_tutorial

接著你應該會看到這類的文件訊息

Migrations for 'OneToOneField_tutorial':
  OneToOneField_tutorial\migrations\0001_initial.py
    - Create model Profile

接著我們再透過 sqlmigrate 指令來看 migration 將會執行的 SQL，

下面這行並不會馬上執行你的 SQL

python manage.py sqlmigrate OneToOneField_tutorial 0001

接著你應該會看到這類的文件訊息

BEGIN;
--
-- Create model Profile
--
CREATE TABLE "OneToOneField_tutorial_profile" ("user_id" integer NOT NULL PRIMARY KEY REFERENCES "auth_user" ("id"), "date_of_birth" date NULL);
COMMIT;

上面這些資訊能幫助你更了解對資料庫做了什麼事情

sqlmigrate 這個指令是可以省略的，我建議可以執行這個指令多去了解將會執行的 SQL

最後我們再 migrate

( 這行才會幫你執行 SQL )

python manage.py migrate

不管你對 model 做了任何的新增，修改，刪除，請記得一定要再執行 makemigrations 以及 migrate

以上是基本的流程，接著我要進入今天的主題 😁

OneToOneField

OneToOneField 官方文件的參考

https://docs.djangoproject.com/en/4.2/topics/db/examples/one_to_one/

https://docs.djangoproject.com/en/4.2/ref/models/fields/#django.db.models.OneToOneField

在 OneToOneField_tutorial 的 models.py 裡，有我們事先寫好的 model，

models.py 裡面的程式碼如下

class Profile(models.Model):
    user = models.OneToOneField(
        settings.AUTH_USER_MODEL,
        on_delete=models.CASCADE,
        primary_key=True
    )
    date_of_birth = models.DateField(blank=True, null=True)

    def __str__(self):
        return f'Profile for user {self.user.username}'

OneToOneField 我們最常用的時機就是擴充 ( extends )，舉個例子，

Django 的 User Model 預設已經有一些存在的 field ，但很多時候我們

常常需要增加一些額外的資料，像是需要記錄使用者的生日，這時候

OneToOneField 就派上用場了。建立一個 Profile 的 model，透過

OneToOneField 和 User Model 建立 一對一（ one-to-one ） 的關係。

我在再透過 python console 來把玩一下，

我們先建立一個 user

from django.contrib.auth.models import User

# create user
user = User.objects.create_user(username='user1',email='user@test.com',password='password123')

接著再加入 Profile

from OneToOneField_tutorial.models import Profile

import datetime

# create profile
profile = Profile.objects.create(user=user, date_of_birth=datetime.datetime(2017,2,3))

profile.user
> <User: user1>

也可以反查

# via user get profile
user = User.objects.get(username='user1')
user.profile
> <Profile: Profile for user user1>

這邊的反查是使用預設的反查機制.

也可以自己透過 related_name 定義反查機制, 範例如下

class Profile(models.Model):
    user = models.OneToOneField(
        settings.AUTH_USER_MODEL,
        on_delete=models.CASCADE,
        related_name="user_profile",
    )
    pass

反查代碼變成如下

# via user get profile
user = User.objects.get(username='user1')
user.user_profile
> <Profile: Profile for user user1>

P.S 在 model 裡的 on_delete=models.CASCADE ，

可以幫助你刪除資料時一併刪除。

其他的一些例子

# 找出 username 開頭是 user
Profile.objects.filter(user__username__startswith="user")
> <QuerySet [<Profile: Profile for user user1>]>

# 排除 username 開頭是 user
Profile.objects.exclude(user__username__contains="user")
> <QuerySet []>

如果今天

>>> user2 = User.objects.create_user(username='user2',email='user@test.com',password='password123')
>>> user2.profile
Traceback (most recent call last):
  File "<console>", line 1, in <module>
  File "/home/twtrubiks/.pyenv/versions/test_env_39/lib/python3.9/site-packages/django/db/models/fields/related_descriptors.py", line 492, in __get__
    raise self.RelatedObjectDoesNotExist(
django.contrib.auth.models.User.profile.RelatedObjectDoesNotExist: User has no profile.

# 請使用以下的 code 修正
>>> from django.core.exceptions import ObjectDoesNotExist
>>> try:
...     user2.profile
... except ObjectDoesNotExist:
...     print("no profile")
...
no profile

ForeignKey

ForeignKey 官方文件的參考

https://docs.djangoproject.com/en/4.2/topics/db/examples/many_to_one/

https://docs.djangoproject.com/en/4.2/ref/models/fields/#django.db.models.ForeignKey

在 ForeignKey_tutorial 的 models.py 裡，有我們事先寫好的 model，

models.py 裡面的程式碼如下

class Reporter(models.Model):
    first_name = models.CharField(max_length=30)
    last_name = models.CharField(max_length=30)
    email = models.EmailField()

    def __str__(self):
        return f"{self.first_name} {self.last_name}"

class Article(models.Model):
    headline = models.CharField(max_length=100)
    pub_date = models.DateField()
    reporter = models.ForeignKey(
        Reporter,
        related_name='articles',
        on_delete=models.CASCADE,
        db_index=True # 預設為 True, 會自動幫你建立 index
    )

    # reporter = models.ForeignKey(
    #     Reporter,
    #     on_delete=models.CASCADE)

    def __str__(self):
        return self.headline

    class Meta:
        # ref
        # https://docs.djangoproject.com/en/4.2/ref/models/options/#ordering
        ordering = ["headline"]

        # unique_together = ['headline', 'reporter']
        # indexes = [
        #     models.Index(name='headline_reporter_index', fields=['headline','reporter'],)
        # ]

        # index 建議使用 Meta.indexes, db_index 未來可能會棄用
        # ref
        # https://docs.djangoproject.com/en/4.2/ref/models/fields/#db-index

以上面這個例子來說，我們有一個 Reporter 記者 model 以及一個 Article 文章 model。

在 Article model 中，我們定義了 ForeignKey ，因為一篇文章只屬於一個記者的，而一

個記者可以寫很多篇文章，所以是屬於 多對一（ many-to-one ） 的關係。

註解掉的部份是要和大家解釋，假如你沒有定義 related_name 這個屬性，這樣當你需

要反查回去時，你需要使用 Django model 的名稱再加上 _set，以範例來說，就是 article_set。

我在再透過 python console 來把玩一下，

from ForeignKey_tutorial.models import Reporter, Article

# create reporter
reporter = Reporter.objects.create(first_name='John', last_name='Smith', email='john@example.com')

import datetime

date = datetime.datetime(2017,2,3)

# create article
article = Article.objects.create(headline="This is a test", pub_date=date, reporter=reporter)

# via article get reporter
article.reporter
> <Reporter: John Smith>

article.reporter.id # 會有多餘的 query
> 1

article.reporter_id # 不會有多餘的 query
> 1

如果想要增加效能, 可以透過 select_related,

>>> article = Article.objects.select_related('reporter').get(id=1) # 會有一次 query
>>> article.reporter.id    # 不會 query
>>> article.reporter.email # 不會 query

延伸閱讀透過 django 介紹 N+1 Queries Problem

也可以反查

reporter.articles.all()

# if not set related_name
# reporter.article_set.all()

> <QuerySet [<Article: This is a test>]>

上面兩個結果是一樣的，只是差在是否有設定 related_name

反查可以透過 prefetch_related 改善效能,

>>> reporter = Reporter.objects.prefetch_related('articles').get(id=1)
>>> reporter.articles.first()

延伸閱讀透過 django 介紹 N+1 Queries Problem

透過 Reporter object，建立一個 Article object

# create an article via the reporter object:
new_article = reporter.articles.create(headline="John's second story", pub_date=date)

# new_article = reporter.article_set.create(headline="John's second story", pub_date=date)

new_article.reporter
> <Reporter: John Smith>

其他的一些例子

# 將 article2 的 reporter 從 John Smith -> Tony Shen
reporter2 = Reporter.objects.create(first_name='Tony', last_name='Shen', email='tony@example.com')
article2 = Article.objects.get(headline="This is a test")
article2.reporter
> <Reporter: John Smith>
reporter2.articles.add(article2)
article2.reporter
> <Reporter: Tony Shen>

其他的一些例子

reporter.articles.filter(headline__startswith="This")
> <QuerySet [<Article: This is a test>]>

Article.objects.filter(reporter__first_name="John")
> <QuerySet [<Article: John's second story>, <Article: This is a test>]>

# 列出全部 reporter id 為 1 或 2 的
Article.objects.filter(reporter__in=[1, 2])

# 列出全部 reporter id 為 reporter 物件, 放 id 或 物件 都可以
Article.objects.filter(reporter__in=[reporter])

# 列出全部 reporter id 為 1 或 2 的, 並且根據 headline 下去做 distinct
# ref postgresql
# https://docs.djangoproject.com/en/4.2/ref/models/querysets/#distinct
Article.objects.filter(reporter__in=[1, 2]).order_by("headline").distinct("headline")

ManyToManyField

ManyToManyField 官方文件的參考

https://docs.djangoproject.com/en/4.2/topics/db/examples/many_to_many/

https://docs.djangoproject.com/en/4.2/ref/models/fields/#django.db.models.ManyToManyField

在 ManyToManyField 的 models.py 裡，有我們事先寫好的 model，

models.py 裡面的程式碼如下

class Image(models.Model):
    title = models.CharField(max_length=200)
    description = models.TextField(blank=True)
    created = models.DateField(auto_now_add=True)
    users_like = models.ManyToManyField(
        settings.AUTH_USER_MODEL,
        related_name='images_like'
    )

以上面這個例子來說，我們建立一個 Image model ，一張圖片可以有很多使用者喜歡，

而一個使用者也可以喜歡多張圖片，所以他們是 多對多（ many-to-many ） 的關係。

當你建立多對多（ many-to-many ）的關係時，你會發現被多建立一張表，這張表是用來

記錄多對多的關係。

註解掉的部份是要和大家解釋，假如你沒有定義 related_name 這個屬性，這樣當你需要

反查回去時，你需要使用 Django model 的名稱再加上 _set，以範例來說，就是 image_set

再透過 python console 來把玩一下，

建立 user

from django.contrib.auth.models import User

user1 = User.objects.create_user(username='user1',email='user@test.com',password='password123')

user2 = User.objects.create_user(username='user2',email='user2@test.com',password='password123')

from ManyToManyField_tutorial.models import Image

# create image
image = Image.objects.create(title='img1')

# add users via image
image.users_like.add(user1)
image.users_like.add(user2)

# get users via image
image.users_like.all()
> <QuerySet [<User: user1>, <User: user2>]>

# get images via users
user1.images_like.all()
> <QuerySet [<Image: Image object>]>

後記

這次介紹了 Django 的 OneToOneField , ForeignKey , ManyToManyField ，

除了幫助大家更了解他們的關係之外，更簡單介紹適合的情境，希望能對大

家在設計架構時有幫助，這三個 Field 看似簡單，但值得深入去了解他 😆。

執行環境

Python 3.8

Reference

Django

License

MIT license

twtrubiks / django-field-tutorial

django-field-tutorial

我可以從這篇學到什麼

安裝套件

教學

OneToOneField

ForeignKey

ManyToManyField

後記

執行環境

Reference

License

About

Languages