20. Django 2.1.7 模型管理器 models.Manager 以及 元选项

2022-01-17 09:54:28 浏览数 (1)

上一篇Django 2.1.7 模型的关联讲述了关于Django模型一对多、多对多、自关联等模型关系。

在查询数据的时候,对于某种固定的查询,例如视图之类的查询,通用类型的查询每次都需要写一遍,有没有一个地方可以将这类通用的查询抽象出来,进行模型的业务管理呢?

这时候就要看看模型的管理器了。

参考文献

https://docs.djangoproject.com/zh-hans/2.1/topics/db/managers/

管理器Manager

在前面的篇章中,使用模型进行查询的时候,都会调用objects,那么这个objects到底是什么呢?

默认情况下,Django 为每个Django模型类添加一个模型管理类Manager的对象为objects。如果想要将这个对象修改为其他名称,那么可以用models.Manager()来自定义创建对象,如下:

代码语言:javascript复制
# 全国区域信息
class AREA(models.Model):
    ....
    area_obj = models.Manager() # 自定义模型管理对象

    class Meta:
        db_table = 'AREA' # 设置表名为 AREA

使用自定义的模型管理类对象来进行查询如下:

代码语言:javascript复制
In [1]: from assetinfo.models import AREA

# 使用自定义的模型管理类对象查询
In [2]: AREA.area_obj.all()
Out[2]: <QuerySet [<AREA: AREA object (1)>, <AREA: AREA object (2)>, <AREA: AREA object (3)>]>

In [3]: 

上面已经修改了模型管理类的对象了,那么可不可以再来自定义模型管理类呢?将某些固定的查询写到模型管理类中,避免重复编写。

自定义管理器类主要用于两种情况:

1.修改原始查询集,重写all()方法 2.向管理器类中添加额外的方法,如向数据库中插入数据。

1.修改原始查询集,重写all()方法。

a)打开assetinfo/models.py文件,创建自定义模型管理类MiddlewareInfoManager

代码语言:javascript复制
## 自定义中间件的模型管理类
class MiddlewareInfoManager(models.Manager):

    def all(self):
        # 默认查询所有的中间件信息,包含已删除的数据
        # 调用父类的成员语法为:super().方法名
        return super().all().filter(is_delete=False) # 设置只返回未删除的数据

b)在模型类MiddlewareInfo中定义管理器

代码语言:javascript复制
class MiddlewareInfo(models.Model):
    ....
    # 定义数据管理类
    middlewares_obj = MiddlewareInfoManager()

测试使用自定义的管理类的all()方法,如下:

代码语言:javascript复制
In [1]: from assetinfo.models import MiddlewareInfo

In [2]: MiddlewareInfo.middlewares_obj.all()
Out[2]: <QuerySet [<MiddlewareInfo: MiddlewareInfo object (2)>, <MiddlewareInfo: MiddlewareInfo object (3)>, <MiddlewareInfo: MiddlewareInfo object (4)>, <MiddlewareInfo: Middlewar
eInfo object (5)>, <MiddlewareInfo: MiddlewareInfo object (6)>]>

对应执行的SQL如下:

代码语言:javascript复制
mysql> SELECT `assetinfo_middlewareinfo`.`id`, `assetinfo_middlewareinfo`.`name`, `assetinfo_middlewareinfo`.`port`, `assetinfo_middlewareinfo`.`server_id`, `assetinfo_middlewareinfo`.`shelves_date`, `assetinfo_middlewareinfo`.`update_time`, `assetinfo_middlewareinfo`.`is_delete` FROM `assetinfo_middlewareinfo` WHERE `assetinfo_middlewareinfo`.`is_delete` = 0  LIMIT 21;
 ---- ----------- ------ ----------- ---------------------------- ---------------------------- ----------- 
| id | name      | port | server_id | shelves_date               | update_time                | is_delete |
 ---- ----------- ------ ----------- ---------------------------- ---------------------------- ----------- 
|  2 | mongodb   | 3388 |         2 | 2019-06-15 12:17:57.094171 | 2019-06-15 12:17:57.094171 |         0 |
|  3 | mysql     | 3306 |         1 | 2019-06-15 12:18:04.319148 | 2019-06-15 12:18:04.319148 |         0 |
|  4 | redis     | 6379 |         1 | 2019-06-15 12:18:43.873882 | 2019-06-15 12:18:43.873882 |         0 |
|  5 | kafka     | 9092 |         1 | 2019-06-15 12:18:54.232060 | 2019-06-15 12:18:54.232060 |         0 |
|  6 | zookeeper | 2181 |         1 | 2019-06-15 12:19:06.437532 | 2019-06-15 12:19:06.437532 |         0 |
 ---- ----------- ------ ----------- ---------------------------- ---------------------------- ----------- 
5 rows in set (0.00 sec)

mysql> 

可以看到,存在 WHERE assetinfo_middlewareinfo.is_delete = 0 条件了。

2.在管理器类中定义创建对象的方法

对模型类对应的数据表进行操作时,推荐将这些操作数据表的方法封装起来,放到模型管理器类中。

a)打开assetinfo/models.py文件,定义方法create。

代码语言:javascript复制
## 自定义中间件的模型管理类
class MiddlewareInfoManager(models.Manager):

    def create_middleware(self,name,port,server):
        m = self.model() # #创建模型类对象self.model可以获得模型类
        m.name = name
        m.port = port
        m.server = server
        m.save()
        return m

b) 测试使用create方法

代码语言:javascript复制
In [1]: from assetinfo.models import ServerInfo, MiddlewareInfo

# 查询中间件需要的服务器
In [2]: s = ServerInfo.objects.get(server_hostname='预发布服务器')

In [3]: s.server_hostname
Out[3]: '预发布服务器'

# 创建中间件信息
In [9]: m = MiddlewareInfo.middlewares_obj.create_middleware('test_create',1122,s)

In [10]: m.name
Out[10]: 'test_create'

元选项

先来看看django默认创建模型类的表名,如下:

代码语言:javascript复制
mysql> show tables;
 ------------------------------------------ 
| Tables_in_assetinfo                      |
 ------------------------------------------ 
| AREA                                     |
| assetinfo_middlewareinfo                 |
| assetinfo_scriptinfo                     |
| assetinfo_serverinfo                     |
| assetinfo_serverinfo_server_used_type_id |
| assetinfo_serverusedtype                 |
| auth_group                               |
| auth_group_permissions                   |
| auth_permission                          |
| auth_user                                |
| auth_user_groups                         |
| auth_user_user_permissions               |
| django_admin_log                         |
| django_content_type                      |
| django_migrations                        |
| django_session                           |
 ------------------------------------------ 
16 rows in set (0.00 sec)

mysql> 

可以看到表名基本上都是 assetinfo_serverusedtype 的格式 = 应用名_数据类名。 那么如果需要固定指定一个表名呢? 此时就可以使用元选项来设置了。

代码语言:javascript复制
# 全国区域信息
class AREA(models.Model):
    # 使用 db_column='ID' 设置字段名
    ID = models.AutoField(primary_key=True,db_column='ID',auto_created=True, serialize=False, verbose_name='ID')
   
    # 定义元选项
    class Meta:
        db_table = 'AREA' # 设置表名为 AREA

通过上面的两个方法,就可以设置表名和字段名了。

0 人点赞