Django REST Framework

·

Django 5.2

·

Django 4.2

·

Django 3.2

·

Django 2.2

1. 这里主要指 Django 和 Django REST Framework 两个框架。
2. 按照 废弃政策 的发行节奏，Django 从 2.0 开始只发行 x.0、x.1 和 x.2 LTS 三个大的子版本。
3. 技术选型前可以参考 Python 兼容性，旧版本的兼容性可以在 上面 旧版本的 Django 文档中查到。
4. Django 文档非常齐全，首页把文档全部掰碎了摊开，包含新手起步流程和熟手进阶方向，只需按图索骥即可解决大部分问题。
5. Django REST Framework 在导航栏把文档划分成“教程”“API 参考”“话题” 三个部分，基本对应新手、进阶、深入三个阶段。

配置

Django 的配置存放在是以一个 Python 包的形式存在，因此你可以借助 Python 语法实现很多操作。

Django 配置
https://docs.djangoproject.com/zh-hans/5.2/ref/settings/

1. 缓存部分：https://docs.djangoproject.com/zh-hans/5.2/ref/settings/#caches
2. 数据库部分：https://docs.djangoproject.com/zh-hans/5.2/ref/settings/#databases

Settings - Django REST Framework
Configuration for REST framework is all namespaced inside a single Django setting, named REST_FRAMEWORK.

Django REST Framework 的配置亦是存放在 settings.py 中，且统一存放在一个变量 REST_FRAMEWORK 中。

配置 Django 配置
https://docs.djangoproject.com/zh-hans/5.2/topics/settings/

如何导入配置？如何添加自定义配置？命名风格？对比默认值，我修改过什么配置？

区分生产环境

1. 假设配置在 ./myproject/settings.py。

2. 复制一份 settings 到 ./myproject/settings_prod.py 来进行单独修改。

3. 设置环境变量

   set DJANGO_SETTINGS_MODULE=myproject.settings_prod

   或者在运行时添加参数

   python manage.py runserver --settings=myproject.settings_prod

美化配置

因为 Settings 以一个 Python 包的形式存在，因此可以用形参对固定配置加以区分：

./我的项目/settings.py

DATABASES = {
    'default': dict(
        ENGINE='django.db.backends.postgresql',
        NAME='我的项目',
        USER='postgres',
        PASSWORD='我的密码',
        HOST='localhost',
        PORT='5432',
    ),
}

模型层

模型 API 参考
https://docs.djangoproject.com/zh-hans/5.2/ref/models/

包含字段类型、字段参数、索引、约束、关联、Meta、查询集、查询表达式、条件表达式等与数据库相关的参考。

字段类型

模型字段参考
本文档包含 Field 类的所有 API 参考，包括 字段选项 和 字段类型。

PostgreSQL 特有模型字段
所有这些字段都可以从 django.contrib.postgres.field 模块中获得。

编写自定义模型字段
https://docs.djangoproject.com/zh-hans/5.2/howto/custom-model-fields/

Meta

模型 Meta 选项
模型内部类 Meta 的参考，其用于控制模型的行为，例如表名、约束、排序、抽象等。

自定义管理器

自定义管理器
Manager 是一种接口，它赋予了 Django 模型操作数据库的能力。Django 应用中每个模型拥有至少一个 Manager。有两种原因可能使你想要自定义 Manager：添加额外的 Manager 方法，修改 Manager 返回的原始 QuerySet。

from django.db import models

class ExistenceManager(models.Manager):
    def get_queryset(self):
        return super().get_queryset().filter(deleted=False)

class Book(models.Model):
    title = models.CharField('标题', max_length=100)
    deleted = models.BooleanField('已删除', default=False, blank=True)

    objects = models.Manager()  # 默认管理器，在此处声明是为了确保默认情况下可以拿到表中所有数据。
    existences = ExistenceManager()  # 过滤掉已删除的数据。

Book.existences.filter(title__contains='ayuu')
# 等价于
Book.objects.filter(deleted=False, title__contains='ayuu')

查询

执行查询（注：基本教程）
https://docs.djangoproject.com/zh-hans/5.2/topics/db/queries/

QuerySet API

QuerySet API 参考
https://docs.djangoproject.com/zh-hans/5.2/ref/models/querysets/

QuerySet 实例的 API 参考。包含

• 返回和不返回新 QuerySet 对象的方法；
• 适用的运算符 &（即 AND）、|（即 OR）、^（即 XOR）；
• Field 查找器 Lookup；
• 聚合函数 Sum() Count() Max() Min() 等；
• Q() Prefetch() 等相关查询工具。

查询器 Lookup

内置的 Field 查找
字段查找是指定 SQL WHERE 子句的方法。它们被指定为 QuerySet 方法 filter()、exclude() 和 get() 的关键字参数。

PostgreSQL 特有的查找
https://docs.djangoproject.com/zh-hans/5.2/ref/contrib/postgres/lookups/

PostgreSQL 特有模型字段
注：有许多并非特有的查找，比如 ArrayField 重写了的 contains 查询，需要结合具体 PostgreSQL 字段类型浏览。

一种方便的字段查询方式，格式如 __contains。
比如查询 User 表 username 字段是否包含 ayuu 这段字符串，ORM 方法是

User.objects.filter(username__contains='ayuu')

对应 SQL 是

SELECT * FROM user WHERE username LIKE '%ayuu%';

如何编写自定义的查询器
https://docs.djangoproject.com/zh-hans/5.2/howto/custom-lookups/

from django.db.models import Lookup

class HasBits(Lookup):
      """
      检测字段值是否含有某个或某些比特。
      """
      lookup_name = "hasb"  # 想知道在哪里用过，只需全局搜索 "__hasb="
  
      def as_sql(self, compiler, connection):
          lhs, lhs_params = self.process_lhs(compiler, connection)
          rhs, rhs_params = self.process_rhs(compiler, connection)
          params = lhs_params + rhs_params
          return "%s & %s != 0" % (lhs, rhs), params

比如查询 Goods 表 sale_channels 字段是否包含比特 2 或 16，ORM 方法是

Goods.objects.filter(sale_channels__hasb=2 | 16)

对应 SQL 是

SELECT * FROM goods WHERE sale_channels & (2 | 16) != 0;

函数 & 表达式

查询表达式
主要围绕 F() Func() Aggregate() Value() Subquery() 等进行说明。
查询表达式描述了一个值或一个计算，它可以作为更新、创建、过滤、排序、注解或聚合的一部分。当一个表达式输出一个布尔值时，它可以直接用于过滤器中。有许多内置的表达式（在下面的文档中）可以用来帮助你编写查询。表达式可以组合，或者在某些情况下嵌套，以形成更复杂的计算。

数据库函数
底层数据库提供的函数，在 Django 中作为注解、聚合或过滤器，它们也是表达式，所以可以和其它表达式一起使用和组合，比如聚合函数。

PostgreSQL 特有聚合函数
包括对数组、比特、布尔值、JSONB、字符串的通用聚合函数，以及统计相关的聚合函数。

PostgreSQL 特有查询表达式
https://docs.djangoproject.com/zh-hans/5.2/ref/contrib/postgres/expressions/

PostgreSQL 特有数据库函数
https://docs.djangoproject.com/zh-hans/5.2/ref/contrib/postgres/functions/

数据库约束

约束参考
本模块中定义的类可以创建数据库约束。它们被添加到模型中 Meta.constraints 选项中。

数据库事务

数据库事务
https://docs.djangoproject.com/zh-hans/5.2/topics/db/transactions/

原生 SQL 查询

执行原生 SQL 查询
可以使用 Manager.raw() 来 执行原生查询并返回模型实例，或者完全不用模型层 直接执行自定义 SQL。

视图层

URL & 反向解析

URL调度器
路由存储在单独的 Python 模块中，一般是 urls.py。当 Django 服务器接到请求时，会从 settings.ROOT_URLCONF 声明的 urls.py 中提取路由映射来解析，并按照映射传递给其它 urls.py。

请求实例 Request

HttpRequest 对象
https://docs.djangoproject.com/zh-hans/5.2/ref/request-response/

Requests - Django REST Framework
https://www.django-rest-framework.org/api-guide/requests/

响应实例 Response

HttpResponse 对象
https://docs.djangoproject.com/zh-hans/5.2/ref/request-response/#httpresponse-objects

Responses - Django REST Framework
https://www.django-rest-framework.org/api-guide/responses/

参考

替换一个自定义的 User 模型
继承不同层次的父 User 可以获得不同的功能，但这需要在数据库创建之前就替换，否则只能使用一对一关系进行关联。

Django 异常
https://docs.djangoproject.com/zh-hans/5.2/ref/exceptions/