模型的元数据Meta -- Django从入门到精通系列教程

该系列教程系我的原创，并完整发布在我的官网刘江的博客和教程

全部转载本文者，需在顶部显著位置注明原做者及www.liujiangblog.com官网地址。

---

模型的元数据，指的是“除了字段外的全部内容”，例如排序方式、数据库表名、人类可读的单数或者复数名等等。全部的这些都是非必须的，甚至元数据自己对模型也是非必须的。可是，我要说可是，有些元数据选项能给予你极大的帮助，在实际使用中具备重要的做用，是实际应用的‘必须’。

想在模型中增长元数据，方法很简单，在模型类中添加一个子类，名字是固定的Meta，而后在这个Meta类下面增长各类元数据选项或者说设置项。参考下面的例子：

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’，分别表示排序和复数名，下面咱们会详细介绍有哪些可用的元数据选项。

强调：每一个模型均可以有本身的元数据类，每一个元数据类也只对本身所在模型起做用。

---

abstract

若是abstract=True，那么模型会被认为是一个抽象模型。抽象模型自己不实际生成数据库表，而是做为其它模型的父类，被继承使用。具体内容能够参考Django模型的继承。

---

app_label

若是定义了模型的app没有在INSTALLED_APPS中注册，则必须经过此元选项声明它属于哪一个app，例如：

app_label = 'myapp'

---

base_manager_name

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

---

db_table

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

db_table = 'my_freinds'

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

---

db_tablespace

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

---

default_manager_name

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

---

default_related_name

默认状况下，从一个模型反向关联设置有关系字段的源模型，咱们使用<model_name>_set，也就是源模型的名字+下划线+set。

这个元数据选项可让你自定义反向关系名，同时也影响反向查询关系名！看下面的例子：

from django.db import models

class Foo(models.Model):
    pass

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

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

具体的使用差异以下：

>>> bar = Bar.objects.get(pk=1)
>>> # 不能再使用"bar"做为反向查询的关键字了。
>>> Foo.objects.get(bar=bar)
>>> # 而要使用你本身定义的"bars"了。
>>> Foo.objects.get(bars=bar)

---

get_latest_by

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

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

get_latest_by = "order_date"

---

managed

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

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

---

order_with_respect_to

这个选项很差理解。其用途是根据指定的字段进行排序，一般用于关系字段。看下面的例子：

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]：

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

咱们能够经过set_RELATED_order()方法，指定上面这个列表的顺序：

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

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

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

这个元数据的做用......还没用过，囧。

---

ordering

最经常使用的元数据之一了！

用于指定该模型生成的全部对象的排序方式，接收一个字段名组成的元组或列表。默认按升序排列，若是在字段名前加上字符“-”则表示按降序排列，若是使用字符问号“？”表示随机排列。请看下面的例子：

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

---

permissions

该元数据用于当建立对象时增长额外的权限。它接收一个全部元素都是二元元组的列表或元组，每一个元素都是(权限代码, 直观的权限名称)的格式。好比下面的例子：

permissions = (("can_deliver_pizzas", "能够送披萨"),)

---

default_permissions

Django默认给全部的模型设置('add', 'change', 'delete')的权限，也就是增删改。你能够自定义这个选项，好比设置为一个空列表，表示你不须要默认的权限，可是这一操做必须在执行migrate命令以前。

---

proxy

若是设置了proxy = True，表示使用代理模式的模型继承方式。具体内容与abstract选项同样，参考模型继承章节。

---

required_db_features

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

---

required_db_vendor

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

---

select_on_save

决定是否使用1.6版本以前的django.db.models.Model.save()算法保存对象。默认值为False。这个选项咱们一般不用关心。

---

indexes

Django1.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'),
        ]

---

unique_together

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

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

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

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

好比：

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

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

unique_together接收一个二维的元组((xx,xx,xx,...),(),(),()...)，每个元素都是一个元组，表示一组联合惟一约束，能够同时设置多组约束。为了方便，对于只有一组约束的状况下，能够简单地使用一维元素，例如：

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

联合惟一没法做用于普通的多对多字段。

---

index_together

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

---

verbose_name

最经常使用的元数据之一！用于设置模型对象的直观、人类可读的名称。能够用中文。例如：

verbose_name = "story"
verbose_name = "披萨"

若是你不指定它，那么Django会使用小写的模型名做为默认值。

---

verbose_name_plural

英语有单数和复数形式。这个就是模型对象的复数名，好比“apples”。由于咱们中文一般不区分单复数，因此保持和verbose_name一致也能够。

verbose_name_plural = "stories"
verbose_name_plural = "披萨"

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

---

label

前面介绍的元数据都是可修改和设置的，但还有两个只读的元数据，label就是其中之一。

label等同于app_label.object_name。例如polls.Question，polls是应用名，Question是模型名。

---

label_lower

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