Django种ORM介绍和字段及字段参数

要点概论：

1. ORM 介绍

2. Django种的ORM

3. Django ORM常用字段和参数

4. 关系字段

5. 元信息

1. ORM介绍

　　1.1 ORM概念

　　　　

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

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

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

　　1.2 ORM由来

　　

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

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

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

　　1.3 ORM的优势

　　

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

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

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

　　1.4 ORM的劣势

　　

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

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

　　1.5 ORM总结

　　

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

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

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

2. Django中的ORM

　　2.1 数据库相关配置方法

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

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


import pymysql

pymysql.install_as_MySQLdb()

　　

　　2.2 Model

　　

在Django中model是你数据的单一、明确的信息来源。它包含了你存储的数据的重要字段和行为。通常，一个模型（model）映射到一个数据库表，

基本情况：

• 每个模型都是一个Python类，它是django.db.models.Model的子类。
• 模型的每个属性都代表一个数据库字段。
• 综上所述，Django为您提供了一个自动生成的数据库访问API，详询官方文档链接。

　　

　　2.3  对应方式

　　

# 下面这个例子定义了以个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)

上面的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常用字段和参数

　　3.1 常用字段

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

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

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

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

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

　　3.2 字段合集

AutoField(Field)
        - int自增列，必须填入参数 primary_key=True

    BigAutoField(AutoField)
        - bigint自增列，必须填入参数 primary_key=True

        注：当model中如果没有自增列，则自动会创建一个列名为id的列
        from django.db import models

        class UserInfo(models.Model):
            # 自动创建一个列名为id的且为自增的整数列
            username = models.CharField(max_length=32)

        class Group(models.Model):
            # 自定义自增列
            nid = models.AutoField(primary_key=True)
            name = models.CharField(max_length=32)

    SmallIntegerField(IntegerField):
        - 小整数 -32768 ～ 32767

    PositiveSmallIntegerField(PositiveIntegerRelDbTypeMixin, IntegerField)
        - 正小整数 0 ～ 32767
    IntegerField(Field)
        - 整数列(有符号的) -2147483648 ～ 2147483647

    PositiveIntegerField(PositiveIntegerRelDbTypeMixin, IntegerField)
        - 正整数 0 ～ 2147483647

    BigIntegerField(IntegerField):
        - 长整型(有符号的) -9223372036854775808 ～ 9223372036854775807

    BooleanField(Field)
        - 布尔值类型

    NullBooleanField(Field):
        - 可以为空的布尔值

    CharField(Field)
        - 字符类型
        - 必须提供max_length参数， max_length表示字符长度

    TextField(Field)
        - 文本类型

    EmailField(CharField)：
        - 字符串类型，Django Admin以及ModelForm中提供验证机制

    IPAddressField(Field)
        - 字符串类型，Django Admin以及ModelForm中提供验证 IPV4 机制

    GenericIPAddressField(Field)
        - 字符串类型，Django Admin以及ModelForm中提供验证 Ipv4和Ipv6
        - 参数：
            protocol，用于指定Ipv4或Ipv6， 'both',"ipv4","ipv6"
            unpack_ipv4， 如果指定为True，则输入::ffff:192.0.2.1时候，可解析为192.0.2.1，开启此功能，需要protocol="both"

    URLField(CharField)
        - 字符串类型，Django Admin以及ModelForm中提供验证 URL

    SlugField(CharField)
        - 字符串类型，Django Admin以及ModelForm中提供验证支持 字母、数字、下划线、连接符（减号）

    CommaSeparatedIntegerField(CharField)
        - 字符串类型，格式必须为逗号分割的数字

    UUIDField(Field)
        - 字符串类型，Django Admin以及ModelForm中提供对UUID格式的验证

    FilePathField(Field)
        - 字符串，Django Admin以及ModelForm中提供读取文件夹下文件的功能
        - 参数：
                path,                      文件夹路径
                match=None,                正则匹配
                recursive=False,           递归下面的文件夹
                allow_files=True,          允许文件
                allow_folders=False,       允许文件夹

    FileField(Field)
        - 字符串，路径保存在数据库，文件上传到指定目录
        - 参数：
            upload_to = ""      上传文件的保存路径
            storage = None      存储组件，默认django.core.files.storage.FileSystemStorage

    ImageField(FileField)
        - 字符串，路径保存在数据库，文件上传到指定目录
        - 参数：
            upload_to = ""      上传文件的保存路径
            storage = None      存储组件，默认django.core.files.storage.FileSystemStorage
            width_field=None,   上传图片的高度保存的数据库字段名（字符串）
            height_field=None   上传图片的宽度保存的数据库字段名（字符串）

    DateTimeField(DateField)
        - 日期+时间格式 YYYY-MM-DD HH:MM[:ss[.uuuuuu]][TZ]

    DateField(DateTimeCheckMixin, Field)
        - 日期格式      YYYY-MM-DD

    TimeField(DateTimeCheckMixin, Field)
        - 时间格式      HH:MM[:ss[.uuuuuu]]

    DurationField(Field)
        - 长整数，时间间隔，数据库中按照bigint存储，ORM中获取的值为datetime.timedelta类型

    FloatField(Field)
        - 浮点型

    DecimalField(Field)
        - 10进制小数
        - 参数：
            max_digits，小数总长度
            decimal_places，小数位长度

    BinaryField(Field)
        - 二进制类型

　　3.3 自定义字段

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

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)

上例代码所创建的表结构：

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

'AutoField': 'integer AUTO_INCREMENT',
    'BigAutoField': 'bigint AUTO_INCREMENT',
    'BinaryField': 'longblob',
    'BooleanField': 'bool',
    'CharField': 'varchar(%(max_length)s)',
    'CommaSeparatedIntegerField': 'varchar(%(max_length)s)',
    'DateField': 'date',
    'DateTimeField': 'datetime',
    'DecimalField': 'numeric(%(max_digits)s, %(decimal_places)s)',
    '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)',

　　3.5 字段参数

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

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

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

　　　　default：为该字段设置默认值。

　　　　

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

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

4. 关系字段

　　4.1 ForeignKey（外键关联）

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

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

　　外键相关字段参数：

　　　　to：设置要关联的表

　　　　to_field：设置要关联的表的字段

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

　　　　　　　　

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

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

　　　　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(可执行对象)

def func():
    return 10

class MyModel(models.Model):
    user = models.ForeignKey(
        to="User",
        to_field="id"，
        on_delete=models.SET(func)
    )

　　4.2 OneToOneField（一对一字段）

　　

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

　　一对一字段相关参数：

　　　　to：设置要关联的表。

　　　　to_field：设置要关联的字段。

　　　　on_delete：同ForeignKey字段

　　4.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：默认创建第三张表时，数据库中表的名称。

　　　　

　　

5. 元信息

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

　　db_table：ORM在数据库中的表明默认时app_类名，可以通过db_table来重写表名。

　　index_together：联合索引

　　unique_together：联合唯一索引

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