Django 入门之 ORM 介绍字段字段参数元信息

ORM

ORM概念

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

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

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

ORM由来

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

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

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

ORM的优势

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

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

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

ORM的劣势

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

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

ORM总结

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

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

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

Django项目使用MySQL数据库

设置

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

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

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

1 2	`import pymysql pymysql.install_as_MySQLdb()`

Model

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

基本情况：

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

快速入门

下面这个例子定义了一个 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及更高版本。
对于外键字段，Django 会在字段名上添加”_id” 来创建数据库中的列名
外键字段 ForeignKey 有一个 null=True 的设置(它允许外键接受空值 NULL)，你可以赋给它空值 None 。

Django ORM 常用字段

# 带 ** 为常用字段
AutoField(Field) **
    int自增列，必须填入参数 primary_key=True，当model中如果没有自增列，则自动会创建一个列名为id的列。

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]，
     相当于Python中的datetime.datetime()实例

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

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

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

FloatField(Field)
     浮点型

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

BinaryField(Field)
    二进制类型

自定义字段（了解为主）

1
2
3

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

自定义char类型字段：

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)

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)',

常用字段选项参数

null
用于表示某个字段可以为空。如果为True，Django 将用NULL 来在数据库中存储空值， 默认值是 False.

blank
如果为True，该字段允许不填。默认为False。
要注意，这与 null 不同。null纯粹是数据库范畴的，而 blank 是数据验证范畴的。
如果一个字段的blank=True，表单的验证将允许该字段是空值。如果字段的blank=False，该字段就是必填的。

default
字段的默认值。可以是一个值或者可调用对象。如果可调用 ，每有新对象被创建它都会被调用。

primary_key
如果为True，那么这个字段就是模型的主键。如果你没有指定任何一个字段的primary_key=True，
Django 就会自动添加一个IntegerField字段做为主键，所以除非你想覆盖默认的主键行为，
否则没必要设置任何一个字段的primary_key=True。

unique
如果该值设置为 True, 这个数据字段的值在整张表中必须是唯一的

db_index
如果db_index=True 则代表着为此字段设置数据库索引。
choices
由二元组组成的一个可迭代对象（例如，列表或元组），用来给字段提供选择项。 
例如  choice_example = ((1,'a'),(2,'b'))
如果设置了choices，默认的表单将是一个选择框而不是标准的文本框，而且这个选择框的选项就是choices 中的选项。

每个元组中的第一个元素，是存储在数据库中的值；
第二个元素是在管理界面或 ModelChoiceField 中用作显示的内容。 
在一个给定的 model 类的实例中，想得到某个 choices 字段的显示值，就调用 get_FOO_display 方法(这里的 FOO 就是 choices 字段的名称 )。例如：

from django.db import models

class Person(models.Model):
    SHIRT_SIZES = (
        ('S', 'Small'),
        ('M', 'Medium'),
        ('L', 'Large'),
    )
    name = models.CharField(max_length=60)
    shirt_size = models.CharField(max_length=1, choices=SHIRT_SIZES)
    
时间字段独有
DatetimeField、DateField、TimeField这个三个时间字段，都可以设置如下属性。

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

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

更多详见模型字段参考
一旦你建立好数据模型之后，django会自动生成一套数据库抽象的API，可以让你执行关于表记录的增删改查的操作。

其他字段选项

null                数据库中字段是否可以为空
db_column           数据库中字段的列名
db_tablespace
default             数据库中字段的默认值
primary_key         数据库中字段是否为主键
db_index            数据库中字段是否可以建立索引
unique              数据库中字段是否可以建立唯一索引
unique_for_date     数据库中字段【日期】部分是否可以建立唯一索引
unique_for_month    数据库中字段【月】部分是否可以建立唯一索引
unique_for_year     数据库中字段【年】部分是否可以建立唯一索引

verbose_name        Admin中显示的字段名称
blank               Admin中是否允许用户输入为空
editable            Admin中是否可以编辑
help_text           Admin中该字段的提示信息
choices             Admin中显示选择框的内容，用不变动的数据放在内存中从而避免跨表操作
                    如：gf = models.IntegerField(choices=[(0, '何穗'),(1, '大表姐'),],default=1)

error_messages      自定义错误信息（字典类型），从而定制想要显示的错误信息；
                    字典健：null, blank, invalid, invalid_choice, unique, and unique_for_date
                    如：{'null': "不能为空.", 'invalid': '格式错误'}

validators          自定义错误验证（列表类型），从而定制想要的验证规则
                    from django.core.validators import RegexValidator
                    from django.core.validators import EmailValidator,URLValidator,DecimalValidator,
                    MaxLengthValidator,MinLengthValidator,MaxValueValidator,MinValueValidator
                    如：
                        test = models.CharField(
                            max_length=32,
                            error_messages={
                                'c1': '优先错信息1',
                                'c2': '优先错信息2',
                                'c3': '优先错信息3',
                            },
                            validators=[
                                RegexValidator(regex='root_d+', message='错误了', code='c1'),
                                RegexValidator(regex='root_112233d+', message='又错误了', code='c2'),
                                EmailValidator(message='又错误了', code='c3'), ]
                           )

外键

外键字段 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 反向查询操作时，使用的连接前缀，用于替换表名。
limit_choices_to 的作用是设置筛选条件，在admin中只显示筛选后的内容。格式为limit_choices_to：{‘过滤字段’:’过滤值’} 如{‘id__in’:’[1,2,3]’}
on_delete 当删除关联表中的数据时，当前表与其关联的行的行为。
- models.CASCADE 删除关联数据，与之关联也删除
- models.DO_NOTHING 删除关联数据，引发错误IntegrityError
- models.PROTECT 删除关联数据，引发错误ProtectedError
- models.SET_NULL 删除关联数据，与之关联的值设置为null（前提FK字段需要设置为可空）
- models.SET_DEFAULT 删除关联数据，与之关联的值设置为默认值（前提FK字段需要设置默认值）
- models.SET删除关联数据，有两种情况，如下
  - 与之关联的值设置为指定值，设置：models.SET(值)
  - 与之关联的值设置为可执行对象的返回值，设置：models.SET(可执行对象)
db_constraint 是否在数据库中创建外键约束
- false：保留跨表查询的便利(双下划线跨表查询```),但是不用约束字段了,一般公司都用false,这样就省的报错,因为没有了约束(Field字段对象,既约束,又建立表与表之间的关系)
- true：默认值

def func():
    return 10

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

一对一字段 OneToOneField

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

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

class Author(models.Model):
    name = models.CharField(max_length=32)
    info = models.OneToOneField(to='AuthorInfo')
    
class AuthorInfo(models.Model):
    phone = models.CharField(max_length=11)
    email = models.EmailField()

字段参数：

to 设置要关联的表
to_field 设置要关联的表的字段
on_delete 同ForeignKey字段。

多对多 ManyToManyField

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

字段参数

to 设置要关联的表
to_field 设置要关联的表的字段
related_name 反向操作时，使用的字段名，用于代替原反向查询时的’表名_set‘。
related_query_name 反向查询操作时，使用的连接前缀，用于替换表名。
symmetrical 仅用于多对多自关联时，指定内部是否创建反向操作的字段。默认为True。

举个例子：

1
2
3

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

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

1
2
3

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

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

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

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

方式二：通过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")

方式三：设置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来管理多对多关系。

元信息

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

class UserInfo(models.Model):
    nid = models.AutoField(primary_key=True)
    username = models.CharField(max_length=32)
    class Meta:
        # 数据库中生成的表名称 默认 app名称 + 下划线 + 类名
        db_table = "table_name"

        # 联合索引
        index_together = [("pub_date", "deadline"),]

        # 联合唯一索引
        unique_together = (("driver", "restaurant"),)

        # admin中显示的表名称
        verbose_name = '用户表'

        # verbose_name加s
        verbose_name_plural

        # 指定默认按什么字段排序。
        # 只有设置了该属性，我们查询到的结果才可以被reverse()。
        ordering = 字段
        
更多：https://docs.djangoproject.com/en/1.10/ref/models/options/

Python > Django

#Python #Django

Django 入门之 ORM 介绍字段字段参数元信息

https://flepeng.github.io/021-Python-32-框架-Django-Django-入门之-ORM-介绍-字段-字段参数-元信息/

作者

Lepeng

发布于

2021年8月8日

许可协议

Django 入门之 Form 和 ModelForm 组件上一篇

Django 入门之 ORM 区分大小写下一篇

Django 入门之 ORM 介绍 字段 字段参数 元信息

ORM

ORM概念

ORM由来

ORM的优势

ORM的劣势

ORM总结

Django项目使用MySQL数据库

设置

Model

快速入门

Django ORM 常用字段

自定义字段（了解为主）

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

常用字段选项参数

其他字段选项

外键

外键字段 ForeignKey

一对一字段 OneToOneField

多对多 ManyToManyField

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

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

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

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

元信息

Django 入门之 ORM 介绍字段字段参数元信息