Django筆記六之外鍵ForeignKey介紹

這一篇筆記介紹 Django 系統 model 的外鍵處理，ForeignKey 以及相應的處理方法。

這是一種一對多的欄位類型，表示兩張表之間的關聯關係。

本篇筆記的目錄如下：

1. on_delete
2. related_name
3. related_query_name
4. 外鍵欄位的保存

1、on_delete

假設有兩個 application，app1 和 app2

app1 下的 某個 model 為 App1

app2 下的 某個 model 為 App2

# app1/models.py
class App1(models.Model):
	app2 = models.ForeignKey("app2.App2", on_delete=models.CASCADE)

# app2/models.py
class App2(models.Model):
	pass

當我們設置 ForeignKey 的時候，有一個 on_delete 參數，主要用於當被關聯的外鍵的數據被刪除時，自身數據的處理。

在我們上面的兩個 model 的例子便是，當 App2 的某個數據被刪除時，關聯了該條數據的 App1 的數據的處理方式。

處理方式主要有以下幾種：

CASCADE
關聯刪除，App2 的數據被刪除時，App1 關聯的數據也被刪除

PROTECT
保護處理，如果 App2 的數據被 App1 關聯，那麼關聯了的 App2 的數據不會被刪除

SET_NULL
置空處理，如果 App2 的數據被刪除，App1 中關聯了該條被刪除的App2的數據這個欄位都會被設置為 NULL

DO_NOTHING
不處理，原數據不會有任何操作，也就是說 App2 的某條數據被刪除，App1 中的引用還在。

但其實這是一種不推薦的做法，因為如果訪問到 App1 中的這條數據，用到了 app2 這個欄位，就會報錯。

2、related_name

ForeignKey 有一個屬性，related_name，用於表示從相關對象到此對象的關係的名稱，僅用於展示，但是如果 related_query_name 欄位沒有被賦值的話，那麼 related_query_name 則會預設使用 related_name 這個值。

註意： related_name 還有一個用途，就是在同一個 class 下麵，如果有兩個欄位都是另一個 model 的外鍵欄位，這時候添加 related_name 用來區分兩個欄位是必須的。

示例如下：

class Entry(models.Model):
	blog_old = models.ForeignKey(Blog, related_name='old_entry')
	blog_new = models.ForeignKey(Blog, related_name='new_entry')

3、related_query_name

這個欄位主要用於反向過濾器的搜索，這個欄位如果沒有單獨賦值，則會預設使用 related_name 的值。

關於反向過濾器，我們可以來看下這個功能，以下是兩個 model：

class Blog(models.Model):
    pass

class Entry(models.Model):
    blog = models.ForeignKey(Blog)

現在我們有一個 Blog 的數據，

blog_1 = Blog.objects.get(id=1)

如果我們想要獲取所有 Entry 表裡 blog 這個欄位的值為 blog_1，怎麼處理呢，一般來說是：

entry_list = Entry.objects.filter(blog=blog_1)

但是因為 blog 這個欄位是 外鍵，所以我們使用 反向過濾器 來處理：

entry_list = blog_1.entry_set.all()

上面就是我們 反向過濾器 的用法，就是使用關聯的model 的名稱的小寫 + '_set' 來操作，這是一個固定用法。

但是如果我們設置了 related_query_name 這個欄位， model名稱小寫+'_set' 的用法就可以廢棄了，可以直接使用 related_query_name 來操作，比如 Entry 如下：

class Entry(models.Model):
    blog = models.ForeignKey(Blog, related_name="entries")

這時候，我們沒有設置 related_query_name 的值，所以會自動使用 related_name 的值，使用 反向過濾器 的方法如下：

entry_list = blog_1.entries.all()

4、外鍵欄位的保存

首先我們先來介紹一下外鍵欄位在資料庫和 model 里的樣子。

在 model 里，以 Entry 為例，我們可以看到，關鍵 blog 欄位，直接命名為 'blog'，

但是在資料庫的結構里，我們去查看的話，可以看到該欄位為 blog_id。

當我們獲取了一個 Entry 實例，為 entry_obj，

entry_obj = Entry.objects.get(id=1)

當我們輸出 entry_obj.blog，返回的就是一個 Blog 的實例，是一個 object，

而輸出 entry_obj.blog_id，返回的就是一個int 型的數據。

那麼，我們如何為 Entry 實例保存 blog 欄位呢，
如果我們有一個 blog 實例為 blog_1，那麼可以直接使用：

entry_obj.blog = blod_1
entry_obj.save()

如果我們有某個 Blog 的主鍵 id 為 blog_id，那麼我們可以這樣操作：

entry_obj.blog_id = blod_id
entry_obj.save()

以上就是我們這篇介紹外鍵的全部內容，接下來的筆記我們將介紹 ManyToMany，OneToOne 的用法。

原文鏈接：Django筆記六之外鍵ForeignKey介紹