Django中外键ForeignKey介绍使用

这一篇笔记介绍 Django 系统 model 的外键处理，ForeignKey 以及相应的处理方法。

这是一种一对多的字段类型，表示两张表之间的关联关系。

本篇笔记的目录如下：

• on_delete
• related_name
• related_query_name
• 外键字段的保存

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()