5 ORM 简介、常用字段以及参数

一、ORM 简介

1 查询数据层次图解：如果操作mysql，ORM是在pymysq之上又进行了一层封装

MVC 或者 MTV 框架中包括一个重要的部分，就是 ORM，它实现了数据模型与数据库的解耦，即数据模型的设计不需要依赖于特定的数据库，通过简单的配置就可以轻松更换数据库，这极大的减轻了开发人员的工作量，不需要面对因数据库变更而导致的无效劳动
ORM是“对象-关系-映射”的简称。

二、ORM 字段

1 AutoField

　　int 自增列，必须填入参数 primary_key=True。若 model 中如果没有自增列，则自动会创建一个列名为 id 的列。

2 IntegerField

　　一个整数类型,范围在 -2147483648 to 2147483647。

3 CharField

　　字符类型，必须提供 max_length 参数，max_length 表示字符长度。

4 DateField

　　日期字段，日期格式 YYYY-MM-DD，相当于 Python 中的 datetime.date() 实例。

5 DateTimeField

　　日期时间字段，格式 YYYY-MM-DD HH:MM[:ss[.uuuuuu]][TZ]，相当于 Python 中的 datetime.datetime() 实例

  1     BigAutoField(AutoField)
  2         - bigint自增列，必须填入参数 primary_key=True
  3 
  4         注：当model中如果没有自增列，则自动会创建一个列名为id的列
  5         from django.db import models
  6 
  7         class UserInfo(models.Model):
  8             # 自动创建一个列名为id的且为自增的整数列
  9             username = models.CharField(max_length=32)
 10 
 11         class Group(models.Model):
 12             # 自定义自增列
 13             nid = models.AutoField(primary_key=True)
 14             name = models.CharField(max_length=32)
 15 
 16     SmallIntegerField(IntegerField):
 17         - 小整数 -32768 ～ 32767
 18 
 19     PositiveSmallIntegerField(PositiveIntegerRelDbTypeMixin, IntegerField)
 20         - 正小整数 0 ～ 32767
 21     IntegerField(Field)
 22         - 整数列(有符号的) -2147483648 ～ 2147483647
 23 
 24     PositiveIntegerField(PositiveIntegerRelDbTypeMixin, IntegerField)
 25         - 正整数 0 ～ 2147483647
 26 
 27     BigIntegerField(IntegerField):
 28         - 长整型(有符号的) -9223372036854775808 ～ 9223372036854775807
 29 
 30     BooleanField(Field)
 31         - 布尔值类型
 32 
 33     NullBooleanField(Field):
 34         - 可以为空的布尔值
 35 
 36     TextField(Field)
 37         - 文本类型
 38 
 39     EmailField(CharField)：
 40         - 字符串类型，Django Admin以及ModelForm中提供验证机制
 41 
 42     IPAddressField(Field)
 43         - 字符串类型，Django Admin以及ModelForm中提供验证 IPV4 机制
 44 
 45     GenericIPAddressField(Field)
 46         - 字符串类型，Django Admin以及ModelForm中提供验证 Ipv4和Ipv6
 47         - 参数：
 48             protocol，用于指定Ipv4或Ipv6， 'both',"ipv4","ipv6"
 49             unpack_ipv4， 如果指定为True，则输入::ffff:192.0.2.1时候，可解析为192.0.2.1，开启此功能，需要protocol="both"
 50 
 51     URLField(CharField)
 52         - 字符串类型，Django Admin以及ModelForm中提供验证 URL
 53 
 54     SlugField(CharField)
 55         - 字符串类型，Django Admin以及ModelForm中提供验证支持 字母、数字、下划线、连接符（减号）
 56 
 57     CommaSeparatedIntegerField(CharField)
 58         - 字符串类型，格式必须为逗号分割的数字
 59 
 60     UUIDField(Field)
 61         - 字符串类型，Django Admin以及ModelForm中提供对UUID格式的验证
 62 
 63     FilePathField(Field)
 64         - 字符串，Django Admin以及ModelForm中提供读取文件夹下文件的功能
 65         - 参数：
 66                 path,                      文件夹路径
 67                 match=None,                正则匹配
 68                 recursive=False,           递归下面的文件夹
 69                 allow_files=True,          允许文件
 70                 allow_folders=False,       允许文件夹
 71 
 72     FileField(Field)
 73         - 字符串，路径保存在数据库，文件上传到指定目录
 74         - 参数：
 75             upload_to = ""      上传文件的保存路径
 76             storage = None      存储组件，默认django.core.files.storage.FileSystemStorage
 77 
 78     ImageField(FileField)
 79         - 字符串，路径保存在数据库，文件上传到指定目录
 80         - 参数：
 81             upload_to = ""      上传文件的保存路径
 82             storage = None      存储组件，默认django.core.files.storage.FileSystemStorage
 83             width_field=None,   上传图片的高度保存的数据库字段名（字符串）
 84             height_field=None   上传图片的宽度保存的数据库字段名（字符串）
 85 
 86     DateTimeField(DateField)
 87         - 日期+时间格式 YYYY-MM-DD HH:MM[:ss[.uuuuuu]][TZ]
 88 
 89     DateField(DateTimeCheckMixin, Field)
 90         - 日期格式      YYYY-MM-DD
 91 
 92     TimeField(DateTimeCheckMixin, Field)
 93         - 时间格式      HH:MM[:ss[.uuuuuu]]
 94 
 95     DurationField(Field)
 96         - 长整数，时间间隔，数据库中按照bigint存储，ORM中获取的值为datetime.timedelta类型
 97 
 98     FloatField(Field)
 99         - 浮点型
100 
101     DecimalField(Field)
102         - 10进制小数
103         - 参数：
104             max_digits，小数总长度
105             decimal_places，小数位长度
106 
107     BinaryField(Field)
108         - 二进制类型

不常用字段

 1 对应关系：
 2     'AutoField': 'integer AUTO_INCREMENT',
 3     'BigAutoField': 'bigint AUTO_INCREMENT',
 4     'BinaryField': 'longblob',
 5     'BooleanField': 'bool',
 6     'CharField': 'varchar(%(max_length)s)',
 7     'CommaSeparatedIntegerField': 'varchar(%(max_length)s)',
 8     'DateField': 'date',
 9     'DateTimeField': 'datetime',
10     'DecimalField': 'numeric(%(max_digits)s, %(decimal_places)s)',
11     'DurationField': 'bigint',
12     'FileField': 'varchar(%(max_length)s)',
13     'FilePathField': 'varchar(%(max_length)s)',
14     'FloatField': 'double precision',
15     'IntegerField': 'integer',
16     'BigIntegerField': 'bigint',
17     'IPAddressField': 'char(15)',
18     'GenericIPAddressField': 'char(39)',
19     'NullBooleanField': 'bool',
20     'OneToOneField': 'integer',
21     'PositiveIntegerField': 'integer UNSIGNED',
22     'PositiveSmallIntegerField': 'smallint UNSIGNED',
23     'SlugField': 'varchar(%(max_length)s)',
24     'SmallIntegerField': 'smallint',
25     'TextField': 'longtext',
26     'TimeField': 'time',
27     'UUIDField': 'char(32)',

ORM字段与数据库实际字段的对应关系

三、ORM字段参数

1 null

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

2 unique

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

3 db_index

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

4 default

　　为该字段设置默认值。

5 DateField 和 DateTimeField 的参数

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

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

 1 null                数据库中字段是否可以为空
 2     db_column           数据库中字段的列名
 3     db_tablespace
 4     default             数据库中字段的默认值
 5     primary_key         数据库中字段是否为主键
 6     db_index            数据库中字段是否可以建立索引
 7     unique              数据库中字段是否可以建立唯一索引
 8     unique_for_date     数据库中字段【日期】部分是否可以建立唯一索引
 9     unique_for_month    数据库中字段【月】部分是否可以建立唯一索引
10     unique_for_year     数据库中字段【年】部分是否可以建立唯一索引
11 
12     verbose_name        Admin中显示的字段名称
13     blank               Admin中是否允许用户输入为空
14     editable            Admin中是否可以编辑
15     help_text           Admin中该字段的提示信息
16     choices             Admin中显示选择框的内容，用不变动的数据放在内存中从而避免跨表操作
17                         如：gf = models.IntegerField(choices=[(0, '何穗'),(1, '大表姐'),],default=1)
18 
19     error_messages      自定义错误信息（字典类型），从而定制想要显示的错误信息；
20                         字典健：null, blank, invalid, invalid_choice, unique, and unique_for_date
21                         如：{'null': "不能为空.", 'invalid': '格式错误'}
22 
23     validators          自定义错误验证（列表类型），从而定制想要的验证规则
24                         from django.core.validators import RegexValidator
25                         from django.core.validators import EmailValidator,URLValidator,DecimalValidator,
26                         MaxLengthValidator,MinLengthValidator,MaxValueValidator,MinValueValidator
27                         如：
28                             test = models.CharField(
29                                 max_length=32,
30                                 error_messages={
31                                     'c1': '优先错信息1',
32                                     'c2': '优先错信息2',
33                                     'c3': '优先错信息3',
34                                 },
35                                 validators=[
36                                     RegexValidator(regex='root_d+', message='错误了', code='c1'),
37                                     RegexValidator(regex='root_112233d+', message='又错误了', code='c2'),
38                                     EmailValidator(message='又错误了', code='c3'), ]
39                             )

了解一下

四、关系字段

1 ForeignKey

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

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

（1）to：设置要关联的表

（2）to_field：设置要关联的表字段

（3）related_name：反向操作时，使用的字段名，用于代替原反向查询时的 '表名小写_set'。

（4）实例

1 class Classes(models.Model):
2     name = models.CharField(max_length=32)
3 
4 class Student(models.Model):
5     name = models.CharField(max_length=32)
6     theclass = models.ForeignKey(to="Classes")

1️⃣ 正常情况下，查询某个班级关联的所有学生（反向查询）时的写法：

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

2️⃣ 在 ForeignKey 字段中添加了参数 related_name ：

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

3️⃣ 查询某个班级关联的所有学生（反向查询）时的写法：

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

（5）related_query_name

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

（6）on_delete

 1 当删除关联表中的数据时，当前表与其关联的行的行为。
 2 
 3 　　models.CASCADE
 4 　　删除关联数据，与之关联也删除
 5 
 6 
 7 　　models.DO_NOTHING
 8 　　删除关联数据，引发错误IntegrityError
 9 
10 
11 　　models.PROTECT
12 　　删除关联数据，引发错误ProtectedError
13 
14 
15 　　models.SET_NULL
16 　　删除关联数据，与之关联的值设置为null（前提FK字段需要设置为可空）
17 
18 
19 　　models.SET_DEFAULT
20 　　删除关联数据，与之关联的值设置为默认值（前提FK字段需要设置默认值）
21 
22 
23 　　models.SET
24 
25 　　删除关联数据，
26 　　a. 与之关联的值设置为指定值，设置：models.SET(值)
27 　　b. 与之关联的值设置为可执行对象的返回值，设置：models.SET(可执行对象)

1 def func():
2     return 10
3 
4 class MyModel(models.Model):
5     user = models.ForeignKey(
6         to="User",
7         to_field="id"，
8         on_delete=models.SET(func)
9     )

models.SET

（7）db_constraint

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

五、OneToOneField

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

1 class Author(models.Model):
2     name = models.CharField(max_length=32)
3     info = models.OneToOneField(to='AuthorInfo')
4     
5 
6 class AuthorInfo(models.Model):
7     phone = models.CharField(max_length=11)
8     email = models.EmailField()

（1）to：设置要关联的表

（2）to_field：设置要关联的字段

（3）on_delete：同 ForeignKey 字段

六、ManyToManyField

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

（1）to：设置要关联的表

（2）related_name：反向操作时，使用的字段名，用于代替原反向查询时的 '表名小写_set'。

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

（4）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 属性进行反向查询

（5）through：

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

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

（6）through_fields：设置关联的字段

（7）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")

4 注意：

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

　　当使用第三种方式创建多对多关联表的关系时，不能使用 set、add、remove、clear 这些方法来管理第三张表了，需要通过 models 来管理第三张表。

八、元信息

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

（1）db_table：ORM在数据库中的表名默认是 app_类名，可以通过 db_table 可以重写表名。

（2）index_together：联合索引

（3）unique_together：联合唯一索引

（4）ordering：指定默认按照什么字段排序，只有设置了该属性，我们查询到的结果才可以被 reverse()

 1 class UserInfo(models.Model):
 2         nid = models.AutoField(primary_key=True)
 3         username = models.CharField(max_length=32)
 4 
 5         class Meta:
 6             # 数据库中生成的表名称 默认 app名称 + 下划线 + 类名
 7             db_table = "table_name"
 8 
 9             # 联合索引
10             index_together = [
11                 ("pub_date", "deadline"),
12             ]
13 
14             # 联合唯一索引
15             unique_together = (("driver", "restaurant"),)
16             
17             ordering = ('name',)
18             
19             # admin中显示的表名称
20             verbose_name='哈哈'
21 
22             # verbose_name加s
23             verbose_name_plural=verbose_name

实例

九、自定义字段

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

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


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

自定义char类型字段（了解）