除了我们前面说过的普通类型字段,Django还定义了一组关系类型字段,用来表示模型与模型之间的关系。

一、多对一(ForeignKey)

多对一的关系,通常被称为外键。外键字段类的定义如下:

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

外键需要两个位置参数,一个是关联的模型,另一个是on_delete选项。实际上,在目前版本中,on_delete选项也可以不设置,但Django极力反对如此,因此在Django2.0版本后,该选项会设置为必填。

外键要定义在‘多’的一方!

  1. from django.db import models
  2. class Car(models.Model):
  3. manufacturer = models.ForeignKey(
  4. 'Manufacturer',
  5. on_delete=models.CASCADE,
  6. )
  7. # ...
  8. class Manufacturer(models.Model):
  9. # ...
  10. pass

上面的例子中,每辆车都会有一个生产工厂,一个工厂可以生产N辆车,于是用一个外键字段manufacturer表示,并放在Car模型中。注意,此manufacturer非彼Manufacturer模型类,它是一个字段的名称。在Django的模型定义中,经常出现类似的英文单词大小写不同,一定要注意区分!

如果要关联的对象在另外一个app中,可以显式的指出。下例假设Manufacturer模型存在于production这个app中,则Car模型的定义如下:

  1. class Car(models.Model):
  2. manufacturer = models.ForeignKey(
  3. 'production.Manufacturer', # 关键在这里!!
  4. on_delete=models.CASCADE,
  5. )

如果要创建一个递归的外键,也就是自己关联自己的的外键,使用下面的方法:

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

核心在于‘self’这个引用。什么时候需要自己引用自己的外键呢?典型的例子就是评论系统!一条评论可以被很多人继续评论,如下所示:

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

注意上面的外键字段定义的是父评论,而不是子评论。为什么呢?因为外键要放在‘多’的一方!

在实际的数据库后台,Django会为每一个外键添加_id后缀,并以此创建数据表里的一列。在上面的工厂与车的例子中,Car模型对应的数据表中,会有一列叫做manufacturer_id。但实际上,在Django代码中你不需要使用这个列名,除非你书写原生的SQL语句,一般我们都直接使用字段名manufacturer

关系字段的定义还有个小坑。在后面我们会讲到的verbose_name参数用于设置字段的别名。很多情况下,为了方便,我们都会设置这么个值,并且作为字段的第一位置参数。但是对于关系字段,其第一位置参数永远是关系对象,不能是verbose_name,一定要注意!

参数说明:

外键还有一些重要的参数,说明如下:

on_delete

注意:这个参数在Django2.0之后,不可以省略了,需要显式的指定!这也是除了路由编写方式外,Django2和Django1.x最大的不同点之一!

当一个被外键关联的对象被删除时,Django将模仿on_delete参数定义的SQL约束执行相应操作。比如,你有一个可为空的外键,并且你想让它在关联的对象被删除时,自动设为null,可以如下定义:

  1. user = models.ForeignKey(
  2. User,
  3. models.SET_NULL,
  4. blank=True,
  5. null=True,
  6. )

该参数可选的值都内置在django.db.models中,包括:

  • CASCADE:模拟SQL语言中的ON DELETE CASCADE约束,将定义有外键的模型对象同时删除!(该操作为当前Django版本的默认操作!)
  • PROTECT:阻止上面的删除操作,但是弹出ProtectedError异常
  • SET_NULL:将外键字段设为null,只有当字段设置了null=True时,方可使用该值。
  • SET_DEFAULT:将外键字段设为默认值。只有当字段设置了default参数时,方可使用。
  • DO_NOTHING:什么也不做。
  • SET():设置为一个传递给SET()的值或者一个回调函数的返回值。注意大小写。
  1. from django.conf import settings
  2. from django.contrib.auth import get_user_model
  3. from django.db import models
  4. def get_sentinel_user():
  5. return get_user_model().objects.get_or_create(username='deleted')[0]
  6. class MyModel(models.Model):
  7. user = models.ForeignKey(
  8. settings.AUTH_USER_MODEL,
  9. on_delete=models.SET(get_sentinel_user),
  10. )

limit_choices_to

该参数用于限制外键所能关联的对象,只能用于Django的ModelForm(Django的表单模块)和admin后台,对其它场合无限制功能。其值可以是一个字典、Q对象或者一个返回字典或Q对象的函数调用,如下例所示:

  1. staff_member = models.ForeignKey(
  2. User,
  3. on_delete=models.CASCADE,
  4. limit_choices_to={'is_staff': True},
  5. )

这样定义,则ModelForm的staff_member字段列表中,只会出现那些is_staff=True的Users对象,这一功能对于admin后台非常有用。

可以参考下面的方式,使用函数调用:

  1. def limit_pub_date_choices():
  2. return {'pub_date__lte': datetime.date.utcnow()}
  3. # ...
  4. limit_choices_to = limit_pub_date_choices
  5. # ...

related_name

用于关联对象反向引用模型的名称。以前面车和工厂的例子解释,就是从工厂反向关联到车的关系名称。

通常情况下,这个参数我们可以不设置,Django会默认以模型的小写加上_set作为反向关联名,比如对于工厂就是car_set,如果你觉得car_set还不够直观,可以如下定义:

  1. class Car(models.Model):
  2. manufacturer = models.ForeignKey(
  3. 'production.Manufacturer',
  4. on_delete=models.CASCADE,
  5. related_name='car_producted_by_this_manufacturer', # 看这里!!
  6. )

也许我定义了一个蹩脚的词,但表达的意思很清楚。以后从工厂对象反向关联到它所生产的汽车,就可以使用maufacturer.car_producted_by_this_manufacturer了。

如果你不想为外键设置一个反向关联名称,可以将这个参数设置为“+”或者以“+”结尾,如下所示:

  1. user = models.ForeignKey(
  2. User,
  3. on_delete=models.CASCADE,
  4. related_name='+',
  5. )

related_query_name

反向关联查询名。用于从目标模型反向过滤模型对象的名称。(过滤和查询在后续章节会介绍)

  1. class Tag(models.Model):
  2. article = models.ForeignKey(
  3. Article,
  4. on_delete=models.CASCADE,
  5. related_name="tags",
  6. related_query_name="tag", # 注意这一行
  7. )
  8. name = models.CharField(max_length=255)
  9. # 现在可以使用‘tag’作为查询名了
  10. Article.objects.filter(tag__name="important")

to_field

默认情况下,外键都是关联到被关联对象的主键上(一般为id)。如果指定这个参数,可以关联到指定的字段上,但是该字段必须具有unique=True属性,也就是具有唯一属性。

db_constraint

默认情况下,这个参数被设为True,表示遵循数据库约束,这也是大多数情况下你的选择。如果设为False,那么将无法保证数据的完整性和合法性。在下面的场景中,你可能需要将它设置为False:

  • 有历史遗留的不合法数据,没办法的选择
  • 你正在分割数据表

当它为False,并且你试图访问一个不存在的关系对象时,会抛出DoesNotExist 异常。

swappable

控制迁移框架的动作,如果当前外键指向一个可交换的模型。使用场景非常稀少,通常请将该参数保持默认的True。

二、多对多(ManyToManyField)

多对多关系在数据库中也是非常常见的关系类型。比如一本书可以有好几个作者,一个作者也可以写好几本书。多对多的字段可以定义在任何的一方,请尽量定义在符合人们思维习惯的一方,但不要同时都定义。

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

多对多关系需要一个位置参数:关联的对象模型。它的用法和外键多对一基本类似。

在数据库后台,Django实际上会额外创建一张用于体现多对多关系的中间表。默认情况下,该表的名称是“多对多字段名+关联对象模型名+一个独一无二的哈希码”,例如‘author_books_9cdf4’,当然你也可以通过db_table选项,自定义表名。

参数说明:

related_name

参考外键的相同参数。

related_query_name

参考外键的相同参数。

limit_choices_to

参考外键的相同参数。但是对于使用through参数自定义中间表的多对多字段无效。

symmetrical

默认情况下,Django中的多对多关系是对称的。看下面的例子:

  1. from django.db import models
  2. class Person(models.Model):
  3. friends = models.ManyToManyField("self")

Django认为,如果我是你的朋友,那么你也是我的朋友,这是一种对称关系,Django不会为Person模型添加person_set属性用于反向关联。如果你不想使用这种对称关系,可以将symmetrical设置为False,这将强制Django为反向关联添加描述符。

through

(定义中间表)

如果你想自定义多对多关系的那张额外的关联表,可以使用这个参数!参数的值为一个中间模型。

最常见的使用场景是你需要为多对多关系添加额外的数据,比如两个人建立QQ好友的时间。

通常情况下,这张表在数据库内的结构是这个样子的:

  1. 中间表的id列....模型对象的id列.....被关联对象的id
  2. # 各行数据

如果自定义中间表并添加时间字段,则在数据库内的表结构如下:

  1. 中间表的id列....模型对象的id列.....被关联对象的id列.....时间对象列
  2. # 各行数据

看下面的例子:

  1. from django.db import models
  2. class Person(models.Model):
  3. name = models.CharField(max_length=50)
  4. class Group(models.Model):
  5. name = models.CharField(max_length=128)
  6. members = models.ManyToManyField(
  7. Person,
  8. through='Membership', ## 自定义中间表
  9. through_fields=('group', 'person'),
  10. )
  11. class Membership(models.Model): # 这就是具体的中间表模型
  12. group = models.ForeignKey(Group, on_delete=models.CASCADE)
  13. person = models.ForeignKey(Person, on_delete=models.CASCADE)
  14. inviter = models.ForeignKey(
  15. Person,
  16. on_delete=models.CASCADE,
  17. related_name="membership_invites",
  18. )
  19. 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)

一对一关系类型的定义如下:

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

从概念上讲,一对一关系非常类似具有unique=True属性的外键关系,但是反向关联对象只有一个。这种关系类型多数用于当一个模型需要从别的模型扩展而来的情况。比如,Django自带auth模块的User用户表,如果你想在自己的项目里创建用户模型,又想方便的使用Django的认证功能,那么一个比较好的方案就是在你的用户模型里,使用一对一关系,添加一个与auth模块User模型的关联字段。

该关系的第一位置参数为关联的模型,其用法和前面的多对一外键一样。

如果你没有给一对一关系设置related_name参数,Django将使用当前模型的小写名作为默认值。

看下面的例子:

  1. from django.conf import settings
  2. from django.db import models
  3. # 两个字段都使用一对一关联到了Django内置的auth模块中的User模型
  4. class MySpecialUser(models.Model):
  5. user = models.OneToOneField(
  6. settings.AUTH_USER_MODEL,
  7. on_delete=models.CASCADE,
  8. )
  9. supervisor = models.OneToOneField(
  10. settings.AUTH_USER_MODEL,
  11. on_delete=models.CASCADE,
  12. related_name='supervisor_of',
  13. )

这样下来,你的User模型将拥有下面的属性:

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

OneToOneField一对一关系拥有和多对一外键关系一样的额外可选参数,只是多了一个parent_link参数。


跨模块的模型:

有时候,我们关联的模型并不在当前模型的文件内,没关系,就像我们导入第三方库一样的从别的模块内导入进来就好,如下例所示:

  1. from django.db import models
  2. from geography.models import ZipCode
  3. class Restaurant(models.Model):
  4. # ...
  5. zip_code = models.ForeignKey(
  6. ZipCode,
  7. on_delete=models.SET_NULL,
  8. blank=True,
  9. null=True,
  10. )