1. 程式人生 > >關係型別欄位 -- Django從入門到精通系列教程

關係型別欄位 -- Django從入門到精通系列教程

該系列教程繫個人原創,並完整發布在個人官網劉江的部落格和教程

所有轉載本文者,需在頂部顯著位置註明原作者及www.liujiangblog.com官網地址。

除了我們前面說過的普通型別欄位,Django還定義了一組關係型別欄位,用來表示模型與模型之間的關係。

一、多對一(ForeignKey)

多對一的關係,通常被稱為外來鍵。外來鍵欄位類的定義如下:

class ForeignKey(to, on_delete, **options)[source]

外來鍵需要兩個位置引數,一個是關聯的模型,另一個是on_delete選項。實際上,在目前版本中,on_delete選項也可以不設定,但Django極力反對如此,因此在Django2.0版本後,該選項會設定為必填。

外來鍵要定義在‘多’的一方!

from django.db import models

class Car(models.Model):
    manufacturer = models.ForeignKey(
        'Manufacturer',
        on_delete=models.CASCADE,
    )
    # ...

class Manufacturer(models.Model):
    # ...
    pass

上面的例子中,每輛車都會有一個生產工廠,一個工廠可以生產N輛車,於是用一個外來鍵欄位manufacturer表示,並放在Car模型中。注意,此manufacturer非彼Manufacturer模型類,它是一個欄位的名稱。在Django的模型定義中,經常出現類似的英文單詞大小寫不同,一定要注意區分!

如果要關聯的物件在另外一個app中,可以顯式的指出。下例假設Manufacturer模型存在於production這個app中,則Car模型的定義如下:

class Car(models.Model):
    manufacturer = models.ForeignKey(
        'production.Manufacturer',      # 關鍵在這裡!!
        on_delete=models.CASCADE,
    )

如果要建立一個遞迴的外來鍵,也就是自己關聯自己的的外來鍵,使用下面的方法:

models.ForeignKey('self', on_delete=models.CASCADE)

核心在於‘self’這個引用。什麼時候需要自己引用自己的外來鍵呢?典型的例子就是評論系統!一條評論可以被很多人繼續評論,如下所示:

class Comment(models.Model):
    title = models.CharField(max_length=128)
    text = models.TextField()
    parent_comment = models.ForeignKey('self', on_delete=models.CASCADE)
    # .....

注意上面的外來鍵欄位定義的是父評論,而不是子評論。為什麼呢?因為外來鍵要放在‘多’的一方!

在實際的資料庫後臺,Django會為每一個外來鍵新增_id字尾,並以此建立資料表裡的一列。在上面的工廠與車的例子中,Car模型對應的資料表中,會有一列叫做manufacturer_id。但實際上,在Django程式碼中你不需要使用這個列名,除非你書寫原生的SQL語句,一般我們都直接使用欄位名manufacturer

關係欄位的定義還有個小坑。在後面我們會講到的verbose_name引數用於設定欄位的別名。很多情況下,為了方便,我們都會設定這麼個值,並且作為欄位的第一位置引數。但是對於關係欄位,其第一位置引數永遠是關係物件,不能是verbose_name,一定要注意!

引數說明:

外來鍵還有一些重要的引數,說明如下:

on_delete

當一個被外來鍵關聯的物件被刪除時,Django將模仿on_delete引數定義的SQL約束執行相應操作。比如,你有一個可為空的外來鍵,並且你想讓它在關聯的物件被刪除時,自動設為null,可以如下定義:

user = models.ForeignKey(
    User,
    models.SET_NULL,
    blank=True,
    null=True,
)

該引數可選的值都內建在django.db.models中,包括:

  • CASCADE:模擬SQL語言中的ON DELETE CASCADE約束,將定義有外來鍵的模型物件同時刪除!(該操作為當前Django版本的預設操作!)
  • PROTECT:阻止上面的刪除操作,但是彈出ProtectedError異常
  • SET_NULL:將外來鍵欄位設為null,只有當欄位設定了null=True時,方可使用該值。
  • SET_DEFAULT:將外來鍵欄位設為預設值。只有當欄位設定了default引數時,方可使用。
  • DO_NOTHING:什麼也不做。
  • SET():設定為一個傳遞給SET()的值或者一個回撥函式的返回值。注意大小寫。
from django.conf import settings
from django.contrib.auth import get_user_model
from django.db import models

def get_sentinel_user():
    return get_user_model().objects.get_or_create(username='deleted')[0]

class MyModel(models.Model):
    user = models.ForeignKey(
        settings.AUTH_USER_MODEL,
        on_delete=models.SET(get_sentinel_user),
    )

limit_choices_to

該引數用於限制外來鍵所能關聯的物件,只能用於Django的ModelForm(Django的表單模組)和admin後臺,對其它場合無限制功能。其值可以是一個字典、Q物件或者一個返回字典或Q物件的函式呼叫,如下例所示:

staff_member = models.ForeignKey(
    User,
    on_delete=models.CASCADE,
    limit_choices_to={'is_staff': True},
)

這樣定義,則ModelForm的staff_member欄位列表中,只會出現那些is_staff=True的Users物件,這一功能對於admin後臺非常有用。

可以參考下面的方式,使用函式呼叫:

def limit_pub_date_choices():
    return {'pub_date__lte': datetime.date.utcnow()}

# ...
limit_choices_to = limit_pub_date_choices
# ...

用於關聯物件反向引用模型的名稱。以前面車和工廠的例子解釋,就是從工廠反向關聯到車的關係名稱。

通常情況下,這個引數我們可以不設定,Django會預設以模型的小寫作為反向關聯名,比如對於工廠就是car,如果你覺得car還不夠直觀,可以如下定義:

class Car(models.Model):
    manufacturer = models.ForeignKey(
        'production.Manufacturer',      
        on_delete=models.CASCADE,
        related_name='car_producted_by_this_manufacturer',  # 看這裡!!
    )

也許我定義了一個蹩腳的詞,但表達的意思很清楚。以後從工廠物件反向關聯到它所生產的汽車,就可以使用maufacturer.car_producted_by_this_manufacturer了。

如果你不想為外來鍵設定一個反向關聯名稱,可以將這個引數設定為“+”或者以“+”結尾,如下所示:

user = models.ForeignKey(
    User,
    on_delete=models.CASCADE,
    related_name='+',
)

反向關聯查詢名。用於從目標模型反向過濾模型物件的名稱。(過濾和查詢在後續章節會介紹)

class Tag(models.Model):
    article = models.ForeignKey(
        Article,
        on_delete=models.CASCADE,
        related_name="tags",
        related_query_name="tag",       # 注意這一行
    )
    name = models.CharField(max_length=255)

# 現在可以使用‘tag’作為查詢名了
Article.objects.filter(tag__name="important")

to_field

預設情況下,外來鍵都是關聯到被關聯物件的主鍵上(一般為id)。如果指定這個引數,可以關聯到指定的欄位上,但是該欄位必須具有unique=True屬性,也就是具有唯一屬性。

db_constraint

預設情況下,這個引數被設為True,表示遵循資料庫約束,這也是大多數情況下你的選擇。如果設為False,那麼將無法保證資料的完整性和合法性。在下面的場景中,你可能需要將它設定為False:

  • 有歷史遺留的不合法資料,沒辦法的選擇
  • 你正在分割資料表

當它為False,並且你試圖訪問一個不存在的關係物件時,會丟擲DoesNotExist 異常。

swappable

控制遷移框架的動作,如果當前外來鍵指向一個可交換的模型。使用場景非常稀少,通常請將該引數保持預設的True。

二、多對多(ManyToManyField)

多對多關係在資料庫中也是非常常見的關係型別。比如一本書可以有好幾個作者,一個作者也可以寫好幾本書。多對多的欄位可以定義在任何的一方,請儘量定義在符合人們思維習慣的一方,但不要同時都定義。

class ManyToManyField(to, **options)[source]

多對多關係需要一個位置引數:關聯的物件模型。它的用法和外來鍵多對一基本類似。

在資料庫後臺,Django實際上會額外建立一張用於體現多對多關係的中間表。預設情況下,該表的名稱是“多對多欄位名+關聯物件模型名+一個獨一無二的雜湊碼”,例如‘author_books_9cdf4’,當然你也可以通過db_table選項,自定義表名。

引數說明:

參考外來鍵的相同引數。

參考外來鍵的相同引數。

limit_choices_to

參考外來鍵的相同引數。但是對於使用through引數自定義中間表的多對多欄位無效。

symmetrical

預設情況下,Django中的多對多關係是對稱的。看下面的例子:

from django.db import models

class Person(models.Model):
    friends = models.ManyToManyField("self")

Django認為,如果我是你的朋友,那麼你也是我的朋友,這是一種對稱關係,Django不會為Person模型新增person_set屬性用於反向關聯。如果你不想使用這種對稱關係,可以將symmetrical設定為False,這將強制Django為反向關聯新增描述符。

through

(定義中間表)

如果你想自定義多對多關係的那張額外的關聯表,可以使用這個引數!引數的值為一箇中間模型。

最常見的使用場景是你需要為多對多關係新增額外的資料,比如兩個人建立QQ好友的時間。

通常情況下,這張表在資料庫內的結構是這個樣子的:

中間表的id列....模型物件的id列.....被關聯物件的id列
# 各行資料

如果自定義中間表並新增時間欄位,則在資料庫內的表結構如下:

中間表的id列....模型物件的id列.....被關聯物件的id列.....時間物件列
# 各行資料

看下面的例子:

from django.db import models

class Person(models.Model):
    name = models.CharField(max_length=50)

class Group(models.Model):
    name = models.CharField(max_length=128)
    members = models.ManyToManyField(
        Person,
        through='Membership',       ## 自定義中間表
        through_fields=('group', 'person'),
    )

class Membership(models.Model):  # 這就是具體的中間表模型
    group = models.ForeignKey(Group, on_delete=models.CASCADE)
    person = models.ForeignKey(Person, on_delete=models.CASCADE)
    inviter = models.ForeignKey(
        Person,
        on_delete=models.CASCADE,
        related_name="membership_invites",
    )
    invite_reason = models.CharField(max_length=64)

上面的程式碼中,通過class Membership(models.Model)定義了一個新的模型,用來儲存Person和Group模型的多對多關係,並且同時增加了‘邀請人’和‘邀請時間’的欄位。

through引數在某些使用場景中是必須的,至關重要,請務必掌握!

through_fields

接著上面的例子。Membership模型中包含兩個關聯Person的外來鍵,Django無法確定到底使用哪個作為和Group關聯的物件。所以,在這個例子中,必須顯式的指定through_fields引數,用於定義關係。

through_fields引數接收一個二元元組('field1', 'field2'),field1是指向定義有多對多關係的模型的外來鍵欄位的名稱,這裡是Membership中的‘group’欄位(注意大小寫),另外一個則是指向目標模型的外來鍵欄位的名稱,這裡是Membership中的‘person’,而不是‘inviter’。

再通俗的說,就是through_fields引數指定從中間表模型Membership中選擇哪兩個欄位,作為關係連線欄位。

db_table

設定中間表的名稱。不指定的話,則使用預設值。

db_constraint

參考外來鍵的相同引數。

swappable

參考外來鍵的相同引數。

ManyToManyField多對多欄位不支援Django內建的validators驗證功能。

null引數對ManyToManyField多對多欄位無效!設定null=True毫無意義

三、一對一(OneToOneField)

一對一關係型別的定義如下:

class OneToOneField(to, on_delete, parent_link=False, **options)[source]

從概念上講,一對一關係非常類似具有unique=True屬性的外來鍵關係,但是反向關聯物件只有一個。這種關係型別多數用於當一個模型需要從別的模型擴充套件而來的情況。比如,Django自帶auth模組的User使用者表,如果你想在自己的專案裡建立使用者模型,又想方便的使用Django的認證功能,那麼一個比較好的方案就是在你的使用者模型裡,使用一對一關係,新增一個與auth模組User模型的關聯欄位。

該關係的第一位置引數為關聯的模型,其用法和前面的多對一外來鍵一樣。

如果你沒有給一對一關係設定related_name引數,Django將使用當前模型的小寫名作為預設值。

看下面的例子:

from django.conf import settings
from django.db import models

# 兩個欄位都使用一對一關聯到了Django內建的auth模組中的User模型
class MySpecialUser(models.Model):
    user = models.OneToOneField(
        settings.AUTH_USER_MODEL,
        on_delete=models.CASCADE,
    )
    supervisor = models.OneToOneField(
        settings.AUTH_USER_MODEL,
        on_delete=models.CASCADE,
        related_name='supervisor_of',
    )

這樣下來,你的User模型將擁有下面的屬性:

>>> user = User.objects.get(pk=1)
>>> hasattr(user, 'myspecialuser')
True
>>> hasattr(user, 'supervisor_of')
True

OneToOneField一對一關係擁有和多對一外來鍵關係一樣的額外可選引數,只是多了一個parent_link引數。

跨模組的模型:

有時候,我們關聯的模型並不在當前模型的檔案內,沒關係,就像我們匯入第三方庫一樣的從別的模組內匯入進來就好,如下例所示:

from django.db import models
from geography.models import ZipCode

class Restaurant(models.Model):
    # ...
    zip_code = models.ForeignKey(
        ZipCode,
        on_delete=models.SET_NULL,
        blank=True,
        null=True,
    )