关系类型字段

阅读: 116429     评论:36

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

一、多对一(ForeignKey)

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

class ForeignKey(to, on_delete, **options)

外键需要两个位置参数,一个是关联的模型,另一个是on_delete。在Django2.0版本后,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,
    )

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

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,一定要注意!

参数说明:

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

on_delete

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

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

user = models.ForeignKey(
    User,
    on_delete=models.SET_NULL,
    blank=True,
    null=True,
)

该参数可选的值都内置在django.db.models中(全部为大写),包括:

  • CASCADE:模拟SQL语言中的ON DELETE CASCADE约束,将定义有外键的模型对象同时删除!
  • PROTECT:阻止上面的删除操作,但是弹出ProtectedError异常
  • SET_NULL:将外键字段设为null,只有当字段设置了null=True时,方可使用该值。
  • SET_DEFAULT:将外键字段设为默认值。只有当字段设置了default参数时,方可使用。
  • DO_NOTHING:什么也不做。
  • SET():设置为一个传递给SET()的值或者一个回调函数的返回值。注意大小写。
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),
    )
  • RESTRICT: Django3.1新增。这个模式比较难以理解。它与PROTECT不同,在大多数情况下,同样不允许删除,但是在某些特殊情况下,却是可以删除的。看下面的例子,多揣摩一下:
# 假设有这样的三个模型以及外键关系

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设计的这个模式真的比较难以理解。

limit_choices_to

该参数用于限制外键所能关联的对象,只能用于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
# ...

related_name

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

通常情况下,这个参数我们可以不设置,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_query_name

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

这个参数的默认值是定义有外键字段的模型的小写名,如果设置了related_name参数,那么就是这个参数值,如果在此基础上还指定了related_query_name的值,则是related_query_name的值。三者依次有优先顺序。

要注意related_query_namerelated_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")

to_field

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

db_constraint

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

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

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

swappable

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

二、多对多(ManyToManyField)

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选项,自定义表名。

参数说明:

related_name

参考外键的相同参数。

related_query_name

参考外键的相同参数。

limit_choices_to

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

symmetrical

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

from django.db import models

class Person(models.Model):
    friends = models.ManyToManyField("self")

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

through

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

最常见的使用场景是你需要为多对多关系添加额外的数据,比如添加两个人建立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参数在某些使用场景中是必须的,至关重要,请务必掌握!

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)

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

class OneToOneField(to, on_delete, parent_link=False, **options)

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

 模型和字段 字段的参数 

评论总数: 36


点击登录后方可评论

原文: on_delete=models.RESTRICT >>> song_one = Song.objects.create(artist=artist_one, album=album_one) >>> song_two = Song.objects.create(artist=artist_one, album=album_two) 这个关键字的作用应该是没问题的,亲测。博主的例子中song_two也是调用的artist_one



完成



AssertionError: ForeignKey(<function AUTH_USER_MODEL at 0x03314D18>) is invalid. First parameter to ForeignKey must be either a model, a model name, or the string 'self' 做不下去了,请问这个是怎么回事?



ImportError: cannot import name 'production' from 'polls.models' (C:\Users\liang\mysite\polls\models.py) 还是做不下去,怎么办?



留着问题,往后先学习,有些会自然明白。



1、在应用的models中定义好class;2、项目manage.py目录下打开终端执行makemigrations和migrate命令;3、py manage.py shell打开终端,from django.db import models 与 from 应用.models import 类名。 我是这样解决类似问题的,给后面同学提供点思路,如有不对请指正谢谢。



博主,OneToOneField可以理解成继承吗?



感觉是OneToOneField的两个表产生了对应关系更贴切,应该不是继承,给原来User表额外添加了字段,但又不在一个空间里,使用关联查询能查到



为什么这个User没有定义?需要导入什么吗? 作者麻烦解释一下 Traceback (most recent call last): File "<input>", line 1, in <module> NameError: name 'User' is not defined



models.CASCADE 后面用不用加() ??? 在pycharm中自动补全中后面有括号



不能加。IDE自动补全不是万能的



“而不是子评论。为什么呢?因为外键要放在‘多’的一方!” 为什么 父评论 是比较多的一方 ? 能解释一下吗 ?谢谢



一个父评论下可以有多个子评论,而一个子评论只能属于某个特定的父评论,所以这是个外键,一对多的关系。并且子评论是多的一方,父评论是‘一’的一方。根据Django模型的定义原则,外键放在多的一方。



如果你仔细推敲原文,其实博主没写错。只不过初学者会觉得文中有点饶,容易误解而已。



写的没有错,对比一下上边儿的car,在多的一方car中定义外键的返回名是manufacturer,可能描述产生了歧义



子评论是’多‘的一方,博主这边定义的common指的就是’子评论表‘,外键为父评论。外键可以理解为外部表的主键,他一定是唯一的。但是评论的性质又决定了这是个套娃表



老师,related_name小节下面第二行是不是写错了?Django应该是默认以模型的小写+‘_set'作为反向关联名吧?



你说得对。博主没有细说这个。



感觉写了很多平时根本用不到的内容。



博主前面说过,“参考书式的讲解,可能比较晦涩,但绝对是你入门之后,最好的帮手,我们可以时不时,在需要的情况下,回头再翻翻,然后恍然大悟”,这篇教程是像字典那样把知识点罗列起来,很多字可能确实不常用,但是你以后遇到了可以来这里查看是什么意思。你觉得没用,不深究就行了,快速带过。



你们俩说的都有道理。我看第一遍的时候傻乎乎地一个个细节都从头看到尾,有一点不懂我就觉得好痛苦。 现在觉得应该是好读书不求甚解。我也打算挑重点看,不重要的晦涩的东西就一遍过,知道一个大概,留下一个印象就好了。加油,fighting!



django2.0.1+xadmin,在models中,A类有a,b,c三个CharField类型字段,B类中d,外键关联ForeignKey,关联到指定的字段b或c,咋关联啊?d就自动关联到a字段的值了。跪求老师和在座的各位大神们,帮忙解答下,实在没办法了



ForeignKey('User')和ForeignKey(User)有什么区别呢,感觉应该是一样的呀



加引号时User模型可以在引用的模型之后,不加引号的话只能在前边先定义好User



through段落倒数第二句: ‘邀请时间’的字段。 应该是"邀请原因"的字段.~



请问博主,假如我有一个5行*6列的表,其中有的行 每一列都有数据,有的行只有其中3列有数据。那么在adminsite显示的时候,可否让那些没有值的charfield不显示呢?



参考http://www.liujiangblog.com/course/django/158



博主您好,我看了您发给我的链接。其中exclude可以不显示某一特定的列,但是我想实现的是仅显示一列中有值的内容,而不显示没有值的内容。请问用什么方法可以做到呢?



ModelAdmin.empty_value_display



谢谢您的回复。但是我查到的关于empty_value_display的用法只是说这个可以改变empty value的显示形式(比如‘None’或者其他自定义形式)但是没有说可以不显示,请问是需要override这个类吗?



灵活一下...



测试



为什么models.OneToOneField(to=User),若加上参数to_field=User.name则报错?(注:User.name已设为唯一约束)



问题描述不清晰。根据报错信息具体分析吧。



对应mysql外键的on delete, on update 关键字



没有