Django丨模版层 - 6. Meta-模型的元数据

发表于2020-10-27更新于2020-10-27字数统计2.3k阅读次数

Django丨模版层 - 6. Meta-模型的元数据

1. 介绍

模型的元数据，指的是”除了字段外的所有内容”(例如，排列方式、数据库表名，人类可读的单数 或 复数名等)。
所有的这些都是非必须的，甚至元数据本身对模型也是非必须的。但是在实际使用中居右重要的作用。

2. 使用

想在模型中增加元数据，方法很简单，在模型类中添加一个子类，名字固定是Meta，然后在这个Meta类下面增加各种元数据选项(设置项)

例如：

1
2
3
4
5
6
7
8
from django.db import models

class Ox(models.Model):
    horn_length = models.IntegerField()

    class Meta:         # 注意，是模型的子类，要缩进！
        ordering = ["horn_length"]  # 元数据：排序
        verbose_name_plural = "oxen"  # 元数据：复数名

上面的例子中，我们为模型Ox增加了两个元数据：ordering和verbose_name_plural，分别表示排序和复数名。

注意：每个模型类都可以有自己的元数据类，每个元数据类也只对自己所在模型起作用。

3. 元数据字段解析

3.1 verbose_name

最常用的元数据之一！
用于设置模型对象的直观、人类可读的名称。可以用中文。

例如：

1
2
verbose_name = "story"
verbose_name = "披萨"

如果你不指定它，那么Django会使用小写的模型名作为默认值。

3.2 verbose_name_plural

英语有单数和复数形式。这个就是模型对象的复数名，比如apples。
因为我们中文通常不区分单复数，所以保持和verbose_name一致也可以。

1
2
verbose_name_plural = "stories"
verbose_name_plural = "披萨"

如果不指定该选项，那么默认的复数名字是verbose_name加上‘s’

3.3 ordering

最常用的元数据之一！

用于指定该模型生成的所有对象的排序方式，接收一个字段名组成的元组或列表。

默认按升序排列，如果在字段名前加上字符“-”则表示按降序排列，如果使用字符问号“？”表示随机排列。

请看下面的例子：

1
2
3
ordering = ['pub_date']             # 表示按'pub_date'字段进行升序排列
ordering = ['-pub_date']            # 表示按'pub_date'字段进行降序排列
ordering = ['-pub_date', 'author']  # 表示先按'pub_date'字段进行降序排列，再按`author`字段进行升序排列。

3.4 label(只读的元数据)

前面介绍的元数据都是可修改和设置的，但还有两个只读的元数据，label就是其中之一。
label等同于app_label.object_name。例如：polls.Question，polls是应用名，Question是模型名。

3.5 label_lower

同上，不同的是这个是小写的模型名。

3.6 db_table

指定在数据库中，当前模型生成的数据表的表名。

比如：

1
db_table = 'my_freinds'

友情建议：使用MySQL数据库时，db_table用小写英文。

3.7 db_tablespace

自定义数据库表空间的名字。默认值是工程的DEFAULT_TABLESPACE设置。

3.8 default_manager_name

自定义模型的_default_manager管理器的名字。Django1.10新增。

默认情况下，从一个模型反向关联设置有关系字段的源模型，我们使用<model_name>_set，也就是源模型的名字 + 下划线 + set。
这个元数据选项可以让你自定义反向关系名，同时也影响反向查询关系名！

看下面的例子：

1
2
3
4
5
6
7
8
9
10
from django.db import models

class Foo(models.Model):
    pass

class Bar(models.Model):
    foo = models.ForeignKey(Foo)

    class Meta:
        default_related_name = 'bars'   # 关键在这里

具体的使用差别如下：

1
2
3
4
5
6
7
>>> bar = Bar.objects.get(pk=1)

>>> # 不能再使用"bar"作为反向查询的关键字了。
>>> Foo.objects.get(bar=bar)

>>> # 而要使用你自己定义的"bars"了。
>>> Foo.objects.get(bars=bar)

3.10 abstract

如果 abstract=True，那么模型会被认为是一个抽象模型。
抽象模型本身不实际生成数据库表，而是作为其它模型的父类，被继承使用。

3.11 app_label

如果定义了模型的app没有在INSTALLED_APPS中注册，则必须通过此元选项声明它属于哪个app，
例如：
app_label = 'myapp'

3.12 unique_together

这个元数据是非常重要的一个！它等同于数据库的联合约束！

举个例子，假设有一张用户表，保存有用户的姓名、出生日期、性别和籍贯等等信息。要求是所有的用户唯一不重复，可现在有好几个叫“张伟”的，如何区别它们呢？（不要和我说主键唯一，这里讨论的不是这个问题）

我们可以设置不能有两个用户在同一个地方``同一时刻出生并且都叫“张伟”，使用这种联合约束，保证数据库能不能重复添加用户（也不要和我谈小概率问题）。在Django的模型中，如何实现这种约束呢？

使用unique_together，也就是联合唯一！

比如：

1
unique_together = (('name', 'birth_day', 'address'),)

这样，哪怕有两个在同一天出生的张伟，但他们的籍贯不同，也就是两个不同的用户。一旦三者都相同，则会被Django拒绝创建。这一元数据经常被用在admin后台，并且强制应用于数据库层面。

unique_together接收一个二维的元组((xx,xx,xx,…),(),(),()…)，每一个元素都是一个元组，表示一组联合唯一约束，可以同时设置多组约束。为了方便，对于只有一组约束的情况下，可以简单地使用一维元素

例如：

1
unique_together = ('name', 'birth_day', 'address')

联合唯一无法作用于普通的多对多字段。

3.13 base_manager_name

自定义模型的base_manager管理器的名字。模型管理器是Django为模型提供的API所在。Django1.10新增。

3.14、get_latest_by

Django管理器给我们提供有latest()和earliest()方法，分别表示获取最近一个和最前一个数据对象。但是，如何来判断最近一个和最前面一个呢？也就是根据什么来排序呢？

get_latest_by元数据选项帮你解决这个问题，它可以指定一个类似DateField、DateTimeField或者IntegerField这种可以排序的字段，作为latest()和earliest()方法的排序依据，从而得出最近一个或最前面一个对象。

例如：

1
get_latest_by = "order_date"

3.15 managed

该元数据默认值为True，表示Django将按照既定的规则，管理数据库表的生命周期。、

如果设置为False，将不会针对当前模型创建和删除数据库表。在某些场景下，这可能有用，但更多时候，你可以忘记该选项。

3.16 order_with_respect_to

这个选项不好理解。其用途是根据指定的字段进行排序，通常用于关系字段。

看下面的例子：

1
2
3
4
5
6
7
8
9
10
11
12
from django.db import models

class Question(models.Model):
    text = models.TextField()
    # ...

class Answer(models.Model):
    question = models.ForeignKey(Question, on_delete=models.CASCADE)
    # ...

    class Meta:
        order_with_respect_to = 'question'

上面在Answer模型中设置了order_with_respect_to = 'question'，这样的话，Django会自动提供两个API，get_RELATED_order()和set_RELATED_order()，其中的RELATED用小写的模型名代替。假设现在有一个Question对象，它关联着多个Answer对象，下面的操作返回包含关联的Anser对象的主键的列表[1,2,3]：

1
2
3
>>> question = Question.objects.get(id=1)
>>> question.get_answer_order()
[1, 2, 3]

我们可以通过set_RELATED_order()方法，指定上面这个列表的顺序：

1
>>> question.set_answer_order([3, 1, 2])

同样的，关联的对象也获得了两个方法get_next_in_order()和get_previous_in_order()，用于通过特定的顺序访问对象，如下所示：

1
2
3
4
5
>>> answer = Answer.objects.get(id=2)
>>> answer.get_next_in_order()
<Answer: 3>
>>> answer.get_previous_in_order()
<Answer: 1>

3.17 permissions

该元数据用于当创建对象时增加额外的权限。

它接收一个所有元素都是二元元组的列表或元组，每个元素都是(权限代码, 直观的权限名称)的格式。
比如下面的例子：

1
permissions = (("can_deliver_pizzas", "可以送披萨"),)

3.18 default_permissions

Django默认给所有的模型设置('add', 'change', 'delete')的权限，也就是增删改。

你可以自定义这个选项，比如设置为一个空列表，表示你不需要默认的权限，但是这一操作必须在执行migrate命令之前。

3.19 proxy

如果设置了proxy = True，表示使用代理模式的模型继承方式。

具体内容与abstract选项一样，参考模型继承章节。

3.20 required_db_features

声明模型依赖的数据库功能。比如['gis_enabled']，表示模型的建立依赖GIS功能。

3.21 required_db_vendor

声明模型支持的数据库。Django默认支持sqlite, postgresql, mysql, oracle。

3.22 select_on_save

决定是否使用1.6版本之前的django.db.models.Model.save()算法保存对象。

默认值为False。这个选项我们通常不用关心。

3.23 indexes

Django1.11新增的选项。

接收一个应用在当前模型上的索引列表，

如下例所示：

1
2
3
4
5
6
7
8
9
10
11
from django.db import models

class Customer(models.Model):
    first_name = models.CharField(max_length=100)
    last_name = models.CharField(max_length=100)

    class Meta:
        indexes = [
            models.Index(fields=['last_name', 'first_name']),
            models.Index(fields=['first_name'], name='first_name_idx'),
        ]

3.24 index_together

即将废弃，使用index元数据代替。