除了咱们前面说过的普通类型字段,Django还定义了一组关系类型字段,用来表示模型与模型之间的关系。数据库
多对一的关系,一般被称为外键。外键字段类的定义以下:django
class ForeignKey(to, on_delete, **options)[source]
外键须要两个位置参数,一个是关联的模型,另外一个是on_delete
选项。实际上,在目前版本中,on_delete
选项也能够不设置,但Django极力反对如此,所以在Django2.0版本后,该选项会设置为必填。app
外键要定义在‘多’的一方!框架
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模型的定义以下:this
class Car(models.Model): manufacturer = models.ForeignKey( 'production.Manufacturer', # 关键在这里!! on_delete=models.CASCADE, )
若是要建立一个递归的外键,也就是本身关联本身的的外键,使用下面的方法:spa
models.ForeignKey('self', on_delete=models.CASCADE)
核心在于‘self’这个引用。何时须要本身引用本身的外键呢?典型的例子就是评论系统!一条评论能够被不少人继续评论,以下所示:code
class Comment(models.Model): title = models.CharField(max_length=128) text = models.TextField() parent_comment = models.ForeignKey('self', on_delete=models.CASCADE) # .....
注意上面的外键字段定义的是父评论,而不是子评论。为何呢?由于外键要放在‘多’的一方!orm
在实际的数据库后台,Django会为每个外键添加_id
后缀,并以此建立数据表里的一列。在上面的工厂与车的例子中,Car模型对应的数据表中,会有一列叫作manufacturer_id
。但实际上,在Django代码中你不须要使用这个列名,除非你书写原生的SQL语句,通常咱们都直接使用字段名manufacturer
。对象
关系字段的定义还有个小坑。在后面咱们会讲到的verbose_name
参数用于设置字段的别名。不少状况下,为了方便,咱们都会设置这么个值,而且做为字段的第一位置参数。可是对于关系字段,其第一位置参数永远是关系对象,不能是verbose_name
,必定要注意!
外键还有一些重要的参数,说明以下:
注意:这个参数在Django2.0以后,不能够省略了,须要显式的指定!这也是除了路由编写方式外,Django2和Django1.x最大的不一样点之一!
当一个被外键关联的对象被删除时,Django将模仿on_delete
参数定义的SQL约束执行相应操做。好比,你有一个可为空的外键,而且你想让它在关联的对象被删除时,自动设为null,能够以下定义:
user = models.ForeignKey( User, models.SET_NULL, blank=True, null=True, )
该参数可选的值都内置在django.db.models
中,包括:
ON DELETE CASCADE
约束,将定义有外键的模型对象同时删除!(该操做为当前Django版本的默认操做!)ProtectedError
异常null=True
时,方可以使用该值。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), )
该参数用于限制外键所能关联的对象,只能用于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")
默认状况下,外键都是关联到被关联对象的主键上(通常为id)。若是指定这个参数,能够关联到指定的字段上,可是该字段必须具备unique=True
属性,也就是具备惟一属性。
默认状况下,这个参数被设为True,表示遵循数据库约束,这也是大多数状况下你的选择。若是设为False,那么将没法保证数据的完整性和合法性。在下面的场景中,你可能须要将它设置为False:
当它为False,而且你试图访问一个不存在的关系对象时,会抛出DoesNotExist 异常。
控制迁移框架的动做,若是当前外键指向一个可交换的模型。使用场景很是稀少,一般请将该参数保持默认的True。
多对多关系在数据库中也是很是常见的关系类型。好比一本书能够有好几个做者,一个做者也能够写好几本书。多对多的字段能够定义在任何的一方,请尽可能定义在符合人们思惟习惯的一方,但不要同时都定义。
class ManyToManyField(to, **options)[source]
多对多关系须要一个位置参数:关联的对象模型。它的用法和外键多对一基本相似。
在数据库后台,Django实际上会额外建立一张用于体现多对多关系的中间表。默认状况下,该表的名称是“多对多字段名+关联对象模型名+一个独一无二的哈希码”,例如‘author_books_9cdf4’,固然你也能够经过db_table
选项,自定义表名。
参考外键的相同参数。
参考外键的相同参数。
参考外键的相同参数。可是对于使用through
参数自定义中间表的多对多字段无效。
默认状况下,Django中的多对多关系是对称的。看下面的例子:
from django.db import models class Person(models.Model): friends = models.ManyToManyField("self")
Django认为,若是我是你的朋友,那么你也是个人朋友,这是一种对称关系,Django不会为Person模型添加person_set
属性用于反向关联。若是你不想使用这种对称关系,能够将symmetrical设置为False,这将强制Django为反向关联添加描述符。
若是你想自定义多对多关系的那张额外的关联表,可使用这个参数!参数的值为一个中间模型。
最多见的使用场景是你须要为多对多关系添加额外的数据,好比两我的创建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参数在某些使用场景中是必须的,相当重要,请务必掌握!
接着上面的例子。Membership模型中包含两个关联Person的外键,Django没法肯定到底使用哪一个做为和Group关联的对象。因此,在这个例子中,必须显式的指定through_fields
参数,用于定义关系。
through_fields
参数接收一个二元元组('field1', 'field2'),field1是指向定义有多对多关系的模型的外键字段的名称,这里是Membership中的‘group’字段(注意大小写),另一个则是指向目标模型的外键字段的名称,这里是Membership中的‘person’,而不是‘inviter’。
再通俗的说,就是through_fields
参数指定从中间表模型Membership中选择哪两个字段,做为关系链接字段。
设置中间表的名称。不指定的话,则使用默认值。
参考外键的相同参数。
参考外键的相同参数。
ManyToManyField多对多字段不支持Django内置的validators验证功能。
null参数对ManyToManyField多对多字段无效!设置null=True毫无心义
一对一关系类型的定义以下:
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, )