Django的ORM详解

1 ORM介绍

1.1 ORM概念

对象关系映射（Object Relational Mapping，简称ORM）模式是一种为了解决面向对象与关系数据库存在的互不匹配的现象的技术。

简单的说，ORM是通过使用描述对象和数据库之间映射的元数据，将程序中的对象自动持久化到关系数据库中。

ORM在业务逻辑层和数据库层之间充当了桥梁的作用。

1.2 ORM由来

让我们从O/R开始。字母O起源于"对象"(Object),而R则来自于"关系"(Relational)。

几乎所有的软件开发过程中都会涉及到对象和关系数据库。在用户层面和业务逻辑层面，我们是面向对象的。当对象的信息发生变化的时候，我们就需要把对象的信息保存在关系数据库中。

按照之前的方式来进行开发就会出现程序员会在自己的业务逻辑代码中夹杂很多SQL语句用来增加、读取、修改、删除相关数据，而这些代码通常都是重复的。

1.3 ORM的优势和劣势

1.3.1ORM的优势

ORM解决的主要问题是对象和关系的映射。它通常把一个类和一个表一一对应，类的每个实例对应表中的一条记录，类的每个属性对应表中的每个字段。

ORM提供了对数据库的映射，不用直接编写SQL代码，只需像操作对象一样从数据库操作数据。

让软件开发人员专注于业务逻辑的处理，提高了开发效率。

1.3.2 ORM的劣势

ORM的缺点是会在一定程度上牺牲程序的执行效率。

ORM用多了SQL语句就不会写了，关系数据库相关技能退化…

1.4 ORM总结

ORM只是一种工具，工具确实能解决一些重复，简单的劳动。这是不可否认的。

但我们不能指望某个工具能一劳永逸地解决所有问题，一些特殊问题还是需要特殊处理的。

但是在整个软件开发过程中需要特殊处理的情况应该都是很少的，否则所谓的工具也就失去了它存在的意义。

2 Django models常用字段

2.1 Django models常用字段

from django.db import models


class ForeignKey(models.Model):
    pass


class ForeignMany(models.Model):
    pass


class Event(models.Model):
    # int自增列，必须填入参数 primary_key=True。当model中没有指定主键，django自动会创建一个列名为id的列，做为主键。
    a = models.AutoField(primary_key=True)  # 主键
    # 最常用的字段，必须指定max_length字符长度
    b = models.CharField(max_length=24, null=False)  # 项目名称
    # 布尔型和NullBooleanField有区别，True/False，本类型不允许出现null。
    c = models.BooleanField(default=True)  # 是否有效
    # 可以为null的布尔型
    d = models.NullBooleanField(default=True)  # 是否显示
    # json类型
    e = models.JSONField()  # 事件明细
    # UUID
    f = models.UUIDField()
    # 小整数 - 32768 ～ 32767
    g = models.SmallIntegerField()
    # 正小整数 0 ～ 32767
    h = models.PositiveSmallIntegerField()
    # 整数列(有符号的) -2147483648 ～ 2147483647
    i = models.IntegerField()
    # 正整数 0 ～ 2147483647
    j = models.PositiveIntegerField()
    # 长整型(有符号的) -9223372036854775808 ～ 9223372036854775807
    k = models.BigIntegerField()
    # 长整数，时间间隔，数据库中按照bigint存储，ORM中获取的值为datetime.timedelta类型
    l = models.DurationField()
    # 浮点型
    m = models.FloatField()
    # 金额型->100.12
    n = models.DecimalField(max_digits=5, decimal_places=2)
    # 二进制类型
    o = models.BinaryField()
    # 一对多
    p = models.ForeignKey(to=ForeignKey,  # 关联那张表
                          to_field='project_id',  # 关联表的那个字段，可以不指定，不指定就和关联表的主键关联
                          db_constraint=False,  # 是否生成外键约束（默认为True）
                          related_name="_project_id",  # 反向查询名称
                          on_delete=models.PROTECT,  # 关联删除选项
                          db_column='project_id',  # 设置表中的名称
                          help_text='关联到Event表的project_id',  # 说明字段，会显示在admin后台，不会同步到数据库
                          )
    # 一对一，和一对多系统，只是默认加了unique=True
    q = models.OneToOneField(to=ForeignKey,  # 关联那张表
                             to_field='project_id',  # 关联表的那个字段，可以不指定，不指定就和关联表的主键关联
                             db_constraint=False,  # 是否生成外键约束（默认为True）
                             related_name="_project_id",  # 反向查询名称
                             on_delete=models.PROTECT,  # 关联删除选项
                             db_column='project_id',  # 设置表中的名称
                             help_text='关联到Event表的project_id',  # 说明字段，会显示在admin后台，不会同步到数据库
                             )
    # 多对多
    # 手动创建第三张表，虽然可以使用orm的查询方法，但不支持使用add(), set(), remove(), clear()
    r = models.ManyToManyField(to='ForeignKey',  # 关联那张表，也就是说和那张表关联
                               through='ForeignMany',  # 自定义第三张表，可以不设置，不设置Django就自动生成第三张表
                               through_fields=('book', 'author')  # 自定义第三张表中，那个二个字段管理主表和关联表，可以不设置
                               )
    # 创建时间，创建数据记录的时候会把当前时添加到数据库。
    s = models.DateTimeField(auto_now_add=True)
    # 修改时间，每次更新数据记录的时候会更新该字段。
    t = models.DateTimeField(auto_now=True)


class Meta:
    # 模型在数据库中的表名默认是 APP名称_类名，可以通过db_table重新默认值，相当于指定模型在数据库中的表明
    db_table = 'project_event'

2.2 Django models字段参数

• null

用于表示某个字段可以为空。

• unique

如果设置为unique=True 则该字段在此表中必须是唯一的 。

• db_index

如果db_index=True 则代表着为此字段设置数据库索引。

• default

为该字段设置默认值。

• auto_now_add

时间字段独有,DatetimeField、DateField、TimeField这个三个时间字段，都可以设置如下属性。

配置auto_now_add=True，创建数据记录的时候会把当前时间添加到数据库。

• auto_now

时间字段独有,DatetimeField、DateField、TimeField这个三个时间字段，都可以设置如下属性。

配置上auto_now=True，每次更新数据记录的时候会更新该字段。

2.3 Django models关系字段

2.3.1 ForeignKey

外键类型在ORM中用来表示外键关联关系，一般把ForeignKey字段设置在 '一对多’中’多’的一方。

ForeignKey可以和其他表做关联关系同时也可以和自身做关联关系。

字段参数

• to

设置要关联的表

• to_field

设置要关联的表的字段

• related_name

反向操作时，使用的字段名，用于代替原反向查询时的’表名_set’。

例如：

class Classes(models.Model):
    name = models.CharField(max_length=32)

class Student(models.Model):
    name = models.CharField(max_length=32)
    theclass = models.ForeignKey(to="Classes")

当我们要查询某个班级关联的所有学生（反向查询）时，我们会这么写：

models.Classes.objects.first().student_set.all()

当我们在ForeignKey字段中添加了参数 related_name 后，

class Student(models.Model):
    name = models.CharField(max_length=32)
    theclass = models.ForeignKey(to="Classes", related_name="students")

当我们要查询某个班级关联的所有学生（反向查询）时，我们会这么写：

models.Classes.objects.first().students.all()

• related_query_name

反向查询操作时，使用的连接前缀，用于替换表名。

• on_delete

当删除关联表中的数据时，当前表与其关联的行的行为。

参数	操作
models.CASCADE	删除关联数据，与之关联也删除
models.DO_NOTHING	删除关联数据，引发错误IntegrityError
models.PROTECT	删除关联数据，引发错误ProtectedError
models.SET_NULL	删除关联数据，与之关联的值设置为null（前提FK字段需要设置为可空）
models.SET_DEFAULT	删除关联数据，与之关联的值设置为默认值（前提FK字段需要设置默认值）
models.SET	删除关联数据， a. 与之关联的值设置为指定值，设置：models.SET(值) b. 与之关联的值设置为可执行对象的返回值，设置：models.SET(func():return 10)

• db_constraint

是否在数据库中创建外键约束，默认为True。

2.3.2 OneToOneField

一对一字段。

通常一对一字段用来扩展已有字段。

一对一的关联关系多用在当一张表的不同字段查询频次差距过大的情况下，将本可以存储在一张表的字段拆开放置在两张表中，然后将两张表建立一对一的关联关系。

字段参数

• to

设置要关联的表。

• to_field

设置要关联的字段。

• on_delete

同ForeignKey字段。

2.3.3 ManyToManyField

用于表示多对多的关联关系。在数据库中通过第三张表来建立关联关系。

字段参数

• to

设置要关联的表

• related_name

同ForeignKey字段。

• related_query_name

同ForeignKey字段。

• symmetrical

仅用于多对多自关联时，指定内部是否创建反向操作的字段。默认为True。

举个例子：

class Person(models.Model):
    name = models.CharField(max_length=16)
    friends = models.ManyToManyField("self")

此时，person对象就没有person_set属性。

class Person(models.Model):
    name = models.CharField(max_length=16)
    friends = models.ManyToManyField("self", symmetrical=False)

此时，person对象现在就可以使用person_set属性进行反向查询。

• through

在使用ManyToManyField字段时，Django将自动生成一张表来管理多对多的关联关系。

但我们也可以手动创建第三张表来管理多对多关系，此时就需要通过through来指定第三张表的表名。

• through_fields

设置关联的字段。

• db_table

默认创建第三张表时，数据库中表的名称。

多对多关联关系的三种方式

1. 方式一：自行创建第三张表

class Book(models.Model):
    title = models.CharField(max_length=32, verbose_name="书名")


class Author(models.Model):
    name = models.CharField(max_length=32, verbose_name="作者姓名")


# 自己创建第三张表，分别通过外键关联书和作者
class Author2Book(models.Model):
    author = models.ForeignKey(to="Author")
    book = models.ForeignKey(to="Book")

    class Meta:
        unique_together = ("author", "book")

2.方式二：通过ManyToManyField自动创建第三张表

class Book(models.Model):
    title = models.CharField(max_length=32, verbose_name="书名")


# 通过ORM自带的ManyToManyField自动创建第三张表
class Author(models.Model):
    name = models.CharField(max_length=32, verbose_name="作者姓名")
    books = models.ManyToManyField(to="Book", related_name="authors")

3.方式三：设置ManyTomanyField并指定自行创建的第三张表

class Book(models.Model):
    title = models.CharField(max_length=32, verbose_name="书名")


# 自己创建第三张表，并通过ManyToManyField指定关联
class Author(models.Model):
    name = models.CharField(max_length=32, verbose_name="作者姓名")
    books = models.ManyToManyField(to="Book", through="Author2Book", through_fields=("author", "book"))
    # through_fields接受一个2元组（'field1'，'field2'）：
    # 其中field1是定义ManyToManyField的模型外键的名（author），field2是关联目标模型（book）的外键名。


class Author2Book(models.Model):
    author = models.ForeignKey(to="Author")
    book = models.ForeignKey(to="Book")

    class Meta:
        unique_together = ("author", "book")

注意：

当我们需要在第三张关系表中存储额外的字段时，就要使用第三种方式。

但是当我们使用第三种方式创建多对多关联关系时，就无法使用set、add、remove、clear方法来管理多对多的关系了，需要通过第三张表的model来管理多对多关系。

2.4 元信息

ORM对应的类里面包含另一个Meta类，而Meta类封装了一些数据库的信息。主要字段如下:

class Meta:
    #app_label声明属于哪个应用
    app_label='Grade_manager'
    #table_name自定义表名、如果没有指定表名会是:应用名_类名
    db_table='grade'
    #有些数据库有数据库表空间，比如Oracle。你可以通过db_tablespace来指定这个模型对应的数据库表放在哪个数据库表空间。
    db_tablespace = "user"
    #个 DateField 或 DateTimeField 字段的名字. 若提供该选项, 该模块将拥有一个 get_latest() 函数以得到 "最新的" 对象(依据那个字段): 得到最近一		条order_date字段记录、
    get_latest_by = "order_date"   
    #给这个模型取一个更简单、好读的名字
    verbose_name = "pizza"        
    #模型的复数形式是什么
    verbose_name_plural
    # 联合索引
    index_together=("grade","user")
    # 指定默认按什么字段排序,只有设置了该属性，我们查询到的结果才可以被reverse()。
    ordering="grade"

2.5 blank和null的区别

• blank
  设置为True时，字段可以为空。设置为False时，字段是必须填写的。字符型字段CharField和TextField是用空字符串来存储空值的。
  如果为True，字段允许为空，默认不允许。

• null
  设置为True时，django用Null来存储空值。日期型、时间型和数字型字段不接受空字符串。所以设置IntegerField，DateTimeField型字段可以为空时，
  需要将blank，null均设为True。
  如果为True，空值将会被存储为NULL，默认为False。

  如果想设置BooleanField为空时可以选用NullBooleanField型字段。

  一句话概括，null 是针对数据库而言，如果 null=True, 表示数据库的该字段可以为空。blank 是针对表单的，如果 blank=True，表示你的表单填写该字段的时候可以不填，比如 admin 界面下增加 model 一条记录的时候。直观的看到就是该字段不是粗体

2.6 Django models字段与mysql字段对照

django字段	mysql字段	准备
AutoField	integer AUTO_INCREMENT	自增主键，Django Model默认提供，能够被重写。
BigAutoField	bigint AUTO_INCREMENT
BooleanField	tinyint(1)	布尔类型字段，通常用于记录状态标记。
BinaryField	longblob
CharField	varchar(%(max_length)s)
CommaSeparatedIntegerField	varchar(%(max_length)s)
DecimalField	numeric((max_digits)s , %(decimal_places)s)	开发对数据精准要求较高大的业务时考虑使用。 models.DecimalField(max_length=8, decimal_places=2) 就是定义长度为8位、精度位2位的数字，例如数字：666666.66
IntergerField	int(11)	同AutoField同样，惟一的差异就是不自增。
PositiveIntegerField	int(11)	同IntegerField，只包含正整数。
SmallIntegerField	smallint	小整数时通常会用到。
CommaSeparatedIntegerField	varchar(%(max_length)s)
DateField	date
DateTimeField	datetime
DurationField	bigint
FileField	varchar(%(max_length)s)
FilePathField	varchar(%(max_length)s)
FloatField	double precision
IntegerField	integer
BigIntegerField	bigint
IPAddressField	char(15)
GenericIPAddressField	char(39)
NullBooleanField	bool
OneToOneField	integer
PositiveIntegerField	integer UNSIGNED
PositiveSmallIntegerField	smallint UNSIGNED
SlugField	varchar(%(max_length)s)
SmallIntegerField	smallint
TextField	longtext
TimeField	time
UUIDField	char(32)

2.7 Django models字段与Sql语句

下面这个例子定义了一个 Person 模型，包含 first_name 和 last_name。

from django.db import models

class Person(models.Model):
    first_name = models.CharField(max_length=30)
    last_name = models.CharField(max_length=30)

first_name 和 last_name 是模型的字段。每个字段被指定为一个类属性，每个属性映射到一个数据库列。

上面的 Person 模型将会像这样创建一个数据库表：

CREATE TABLE myapp_person (
    "id" serial NOT NULL PRIMARY KEY,
    "first_name" varchar(30) NOT NULL,
    "last_name" varchar(30) NOT NULL
);

一些说明：

• 表myapp_person的名称是自动生成的，如果你要自定义表名，需要在model的Meta类中指定 db_table 参数，强烈建议使用小写表名，特别是使用MySQL作为后端数据库时。
• id字段是自动添加的，如果你想要指定自定义主键，只需在其中一个字段中指定 primary_key=True 即可。如果Django发现你已经明确地设置了Field.primary_key，它将不会添加自动ID列。
• 本示例中的CREATE TABLE SQL使用PostgreSQL语法进行格式化，但值得注意的是，Django会根据配置文件中指定的数据库后端类型来生成相应的SQL语句。
• Django支持MySQL5.5及更高版本。

3 Django中的ORM

2.1 Django项目使用MySQL数据库

1. 在Django项目的settings.py文件中，配置数据库连接信息：

DATABASES = {
    "default": {
        "ENGINE": "django.db.backends.mysql",
        "NAME": "你的数据库名称",  # 需要自己手动创建数据库
        "USER": "数据库用户名",
        "PASSWORD": "数据库密码",
        "HOST": "数据库IP",
        "POST": 3306
    }
}

2. 在Django项目的__init__.py文件中写如下代码，告诉Django使用pymysql模块连接MySQL数据库:

import pymysql

pymysql.install_as_MySQLdb()

2.2 Models自定义字段（了解为主）

class UnsignedIntegerField(models.IntegerField):
    def db_type(self, connection):
        return 'integer UNSIGNED'

class FixedCharField(models.Field):
    """
    自定义的char类型的字段类
    """
    def __init__(self, max_length, *args, **kwargs):
        super().__init__(max_length=max_length, *args, **kwargs)
        self.length = max_length

    def db_type(self, connection):
        """
        限定生成数据库表的字段类型为char，长度为length指定的值
        """
        return 'char(%s)' % self.length


class Class(models.Model):
    id = models.AutoField(primary_key=True)
    title = models.CharField(max_length=25)
    # 使用上面自定义的char类型的字段
    cname = FixedCharField(max_length=25)

4.Django ORM查询常用方法

4.1 常用查询操作

# 获取到所有的书籍对象,结果是对象列表
models.Book.objects.all()  

# 获取符合条件的对象
models.Book.objects.get(**kwargs)  

# 筛选所有符合条件的,结果是对象列表
models.Book.objects.filter(**kwargs)  

# 筛选出所有不符合条件的,结果是对象列表,这个地方一直有个疑问，好像exclude里面如果是外键排除就不起作用
models.Book.objects.exclude(**kwargs)  

# 字典列表[{id:1,name:20},{id:2,name:18} ],values(‘id’)括号内不指定时显示全部,如指定则只显示指定的,[ {id:1},{id:2,}]
models.Book.objects.all().values("id","name")  

# 元组列表,[ (1,20),(2,18) ]同上,指定时显示指定内容
models.Book.objects.all().values_list("id","name")  

# 按照id升序就行排列
models.Book.objects.all().order_by("id")  

# 按照id降序就行排列
models.Book.objects.all().order_by("-id")  

# 先按age升序,age相同的按id进行降序排列
models.Book.objects.all().order_by("age", "-id") 

# 对结果反转; 注意reverse前必须排序,否则reverse无效; 或在model.py文件中Book类中的Meta中指定ordering=("id", )注意逗号必须有
models.Book.objects.all().order_by("id").reverse()  

# 去重,当获取到的结果Queryset列表中同一对象出现多次时去重,只留一个
models.Book.objects.all().values("id","name").distinct():  

# 计数,可统计结果个数,如对Queryset内元素数进行统计.
models.Book.objects.all().count() 

# 获取结果中的第一条,即使前面结果列表为空,也不会报错
models.Book.objects.all().first()  

# 获取结果中的最后一条
models.Book.objects.filter().last()  

# 判断Queryset列表是否有东西,结果为True或False;
models.Book.objects.filter().exists() 

4.2 返回值

1. 返回对象列表(Queryset)的方法有：
   • all()
   • filter()
   • ordey_by()
   • exclude()
   • values()
   • values_list()
   • reverse()
   • distinct()
2. 返回单个对象的方法有:
   • first()
   • last()
   • get()
   • create()
3. 返回判断布尔值的有
   • exists()
4. 返回返回数字的有
   • count()

4.3 查询API(QuerySet API)

4.3.1 ------ filter -----

filter(**kwargs)

返回一个新的 QuerySet ，它包含了与所给的筛选条件相匹配的对象。

这些筛选条件(**kwargs)在下面的字段筛选(Field lookups) 中有详细介绍。多个条件之间在 SQL 语句中是 AND 关系。

# 条件查询。(可以通过逗号,连接多个条件)  返回QuerySet查询集(可以遍历)

# __exact 等于。 __exact 可以省略。 (__iexact 不区分大小写)
BookInfo.objects.filter(title__exact='天龙八部')

# 等价BookInfo.objects.filter(title__exact='天龙八部')
BookInfo.objects.filter(title='天龙八部')

# __contains 包含。模糊查询。 (__icontains 不区分大小写)
BookInfo.objects.filter(title__contains='天')

# __endswith 以..结尾。 __startswith 以..开头。 (__iendswith 不区分大小写)
BookInfo.objects.filter(title__endswith='部')

# __isnull 是否为空。 True：表示为null。 False表示not null。
BookInfo.objects.filter(title__isnull=False)

# __in 范围查询。
BookInfo.objects.filter(id__in=[1, 3, 5])

# __range 范围查询,查询1到5的id
BookInfo.objects.filter(id__range=[1, 5])

# 大于小于
BookInfo.objects.filter(id__gt=3)  # 大于
BookInfo.objects.filter(id__lt=3)  # 小于
BookInfo.objects.filter(id__gte=3)  # 大于等于
BookInfo.objects.filter(id__lte=3)  # 小于等于

# 日期查询，其中__gt，__lt，__gte，__lte都使用日期
BookInfo.objects.filter(pub_date__gt=date(1980, 1, 1))

# 日期查询
BookInfo.objects.filter(pub_date__year=1980)  # 年
BookInfo.objects.filter(pub_date__month=1980)  # 月
BookInfo.objects.filter(pub_date__day=1980)  # 日
BookInfo.objects.filter(pub_date__week_day=1980)  # 周级
BookInfo.objects.filter(pub_date__hour=1980)  # 时
BookInfo.objects.filter(pub_date__minute=1980)  # 分
BookInfo.objects.filter(pub_date__second=1980)  # 秒