除了我们前面说过的普通类型字段,Django还定义了一组关系类型字段,用来表示模型与模型之间的关系。
多对一的关系,通常被称为外键。外键字段类的定义如下:
class ForeignKey(to, on_delete, **options)
外键需要两个位置参数,一个是关联的模型,另一个是on_delete
。
外键要定义在‘多’的一方!
from django.db import models class Manufacturer(models.Model): # ... pass class Car(models.Model): manufacturer = models.ForeignKey(Manufacturer, on_delete=models.CASCADE) # ...
多对一字段的变量名一般设置为关联模型的小写单数,而多对多则一般设置为小写复数。
如果你要关联的模型在代码中位于当前模型之后,则需要通过字符串的方式进行引用,看下面的例子:
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, ) # 这种写法要确保能正确访问到关联模型,不是很安全。最好是先import进来。
如果要创建一个递归的外键,也就是自己关联自己的的外键,使用下面的方法:
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
,一定要注意!
外键有一些重要的参数,说明如下:
位置参数,必填!
当外键关联的对象被删除时,Django将模仿on_delete
参数定义的SQL约束执行相应操作。
比如,你有一个可为空的外键,并且你想让它在关联的对象被删除时,自动设为null,可以如下定义:
user = models.ForeignKey( User, on_delete=models.SET_NULL, blank=True, null=True, )
该参数可选的值都内置在django.db.models
中(全部为大写),包括:
ON DELETE CASCADE
约束,将定义有外键的模型对象同时删除!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), )
# 假设有这样的三个模型以及外键关系 class Artist(models.Model): name = models.CharField(max_length=10) class Album(models.Model): artist = models.ForeignKey(Artist, on_delete=models.CASCADE) # 注意这里 class Song(models.Model): artist = models.ForeignKey(Artist, on_delete=models.CASCADE) # 注意这里 album = models.ForeignKey(Album, on_delete=models.RESTRICT) # 注意这里
尝试在Django的shell里测试下面的API:
>>> artist_one = Artist.objects.create(name='artist one') >>> artist_two = Artist.objects.create(name='artist two') >>> album_one = Album.objects.create(artist=artist_one) >>> album_two = Album.objects.create(artist=artist_two) >>> song_one = Song.objects.create(artist=artist_one, album=album_one) >>> song_two = Song.objects.create(artist=artist_one, album=album_two) >>> album_one.delete() # Raises RestrictedError. 不可以删除 >>> artist_two.delete() # Raises RestrictedError. 不可以删除 >>> artist_one.delete() (4, {'Song': 2, 'Album': 1, 'Artist': 1}) # 居然可以删除
为什么artist_one
可以被删除,但是artist_two
不可以?Django设计的这个模式真的比较难以理解。
该参数用于限制外键所能关联的对象,只能用于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会默认以模型的小写加上_set
作为反向关联名。
比如对于工厂就是car_set
,如果你觉得car_set
还不够直观,可以如下定义:
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='+', )
反向关联查询名。用于从目标模型反向过滤模型对象的名称。(过滤和查询在后续章节会介绍)
这个参数的默认值是定义有外键字段的模型的小写名,如果设置了related_name
参数,那么就是这个参数值,如果在此基础上还指定了related_query_name
的值,则是related_query_name
的值。三者依次有优先顺序。
要注意related_query_name
和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)
多对多关系在数据库中是常见的关系类型。
比如一本书可以有好几个作者,一个作者也可以写好几本书。
多对多的字段可以定义在任何的一方,请尽量定义在符合人们思维习惯的一方,但不要同时都定义,只能选择一个模型设置该字段(比如我们通常将披萨上的配料字段放在披萨模型中,而不是在配料模型中放置披萨字段)。
from django.db import models class Topping(models.Model): # ... pass class Pizza(models.Model): # ... toppings = models.ManyToManyField(Topping)
建议为多对多字段名使用复数形式。
多对多关系需要一个位置参数:关联的对象模型,其它用法和外键基本类似。
如果要创建一个关联自己的多对多字段,依然是通过'self'
引用。
在数据库后台,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参数对多对多字段无效,因为没有办法在数据库层面建立关系!设置null=True毫无意义。
一对一关系类型的定义如下:
class OneToOneField(to, on_delete, parent_link=False, **options)
从逻辑上讲,一对一关系非常类似具有unique=True
属性的外键关系,也就是反向关联对象只有一个的情况。
这种关系类型多数用于当一个模型需要从别的模型扩展而来的情况。比如,Django自带auth模块的User用户表,如果你想在自己的项目里创建用户模型,又想方便的使用Django的auth中的一些功能,那么一个方案就是在你的用户模型里,使用一对一关系,添加一个与auth的User模型关联的字段。(这不一定是最好的做法,实际上,继承AbstractUser抽象类,比一对一关联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, )
完程
这比写sql的学习成本还高
顺利完成
shirt_size = models.CharField(max_length=1, choices=SHIRT_SIZES) 似乎通不过,应该加上默认值,如下: shirt_size = models.CharField(max_length=1, choices=SHIRT_SIZES,default='L') 不知道我说的对不对。
在django3.0上测试了一下,没有default也是可以的,去官网看了一下,也没有强调必须要有这个default参数。 但是为choices提供一个default值是比较好的做法,我一般都会提供。 事实上,作为经验之谈,为一切字段考虑blank、null、default等参数的设定,是防止以后数据库翻车的良好习惯。
最后一段 validators,感觉是开发中比较重要的一环呢, 按需求自定义验证器,望刘大大阐释一下机理啊~~!
赞同