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

来源:https://www.cnblogs.com/feixuelove1009/archive/2018/02/04/8414643.html
-Advertisement-
Play Games

該系列教程系個人原創，並完整發佈在個人官網 "劉江的博客和教程" 所有轉載本文者，需在頂部顯著位置註明原作者及www.liujiangblog.com官網地址。 Python及Django學習QQ群：453131687 除了我們前面說過的普通類型欄位，Django還定義了一組關係類型欄位，用來表示模 ...


該系列教程系個人原創，並完整發佈在個人官網劉江的博客和教程

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

Python及Django學習QQ群：453131687

除了我們前面說過的普通類型欄位，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,
    )

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Python之列表方法
    li = ['a','b','c','d'] l = ['e','f'] li.extend(l) print(li) ['a', 'b', 'c', 'd', 'e', 'f'] #返回結果 ...
  • WordPress 4.9.1 添加備案號的正確姿勢
    網上有很多關於WordPress如何添加備案的文章，但並不適合4.9.1這個版本，大多數提供的方案都是去主題目錄下的的foot.php文件修改代碼，但是對於4.9.1這個版本並不適用。正確的添加姿勢如下： ...
  • 8.2，常用模塊介紹：sys,os,time,random
    sys: 介紹：主要包含涉及python編譯器與系統交互的函數。 常用函數： os: 介紹：這個模塊提供了一種方便的使用操作系統函數的方法。 常用函數： 註意： 在某些系統中，os.system跟os.popen的主要區別是前者返回值是腳本的退出狀態碼，後者的返回值是腳本執行過程中的存儲輸出內容的一 ...
  • Head First Servlet and JSP
    這書是原本這樣還是翻譯的問題？好多的地方大小寫都寫錯了，比如javax.servlet，<servlet></servlet>。真是坑啊。 ...
  • CSP201509-1：數組分段
    引言：CSP（http://www.cspro.org/lead/application/ccf/login.jsp）是由中國電腦學會（CCF）發起的“電腦職業資格認證”考試，針對電腦軟體開發、軟體測試、信息管理等領域的專業人士進行能力認證。認證對象是從事或將要從事IT領域專業技術與技術管理人 ...
  • NetCloud——一個網易雲音樂評論抓取和分析的Python庫
    NetCloud——一個網易雲音樂評論抓取和分析的Python庫 ...
  • Django 2.0 admin後臺管理界面修改和添加富文本編輯器
    1.文件路徑： 2.修改登錄界面名稱： 顯示如圖： 3.修改後臺界面樣式： 4.Django 後臺中文和時區配置： 5.Django修改app在Admin後臺顯示的名稱： 顯示如圖： 6.添加富文本編輯器： ...
  • Servlet案例6：顯示用戶的上次訪問時間
    這裡是cookie的簡單應用 告訴用戶您的上次訪問時間是：xxxx-xx-xx xx:xx:xx 思路： 第一次訪問該網站時候，記錄當前訪問時間(new Date()) 把當前時間以cookie的形式寫給客戶端(response.addCookie) 第二次訪問時候，獲取客戶端攜帶的相應的cooki ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類