欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Django contenttypes 框架详解(小结)

程序员文章站 2022-12-17 20:51:58
一、什么是django contenttypes? django contenttypes是由django框架提供的一个核心功能,它对当前项目中所有基于django驱动的...

一、什么是django contenttypes?

django contenttypes是由django框架提供的一个核心功能,它对当前项目中所有基于django驱动的model提供了更高层次的抽象接口。 当然我们不是说的是http中的content-type!完全没有任何关系!

下面将一步一步解释django contenttypes在django框架中做了什么,以及如何使用django contenttypes。 

当然,如果对于contenttypes有了初步了解而只是不了解它的应用场景,可以直接查阅一下原文档:

二、django contenttypes做了什么?

当使用django-admin初始化一个django项目的时候,可以看到在默认的install_apps已经包含了django.contrib.contenttypes:

installed_apps = [
  'django.contrib.admin',
  'django.contrib.auth',
  'django.contrib.contenttypes',
  'django.contrib.sessions',
  'django.contrib.messages',
  'django.contrib.staticfiles',
]

而且注意django.contrib.contenttypes是在django.contrib.auth之后,这是因为auth中的permission系统是根据contenttypes来实现的。

我们来查询查阅了一下django.contrib.contenttypes.models文件:

class contenttype(models.model):
  app_label = models.charfield(max_length=100)
  model = models.charfield(_('python model class name'), max_length=100)
  objects = contenttypemanager()

  class meta:
    verbose_name = _('content type')
    verbose_name_plural = _('content types')
    db_table = 'django_content_type'
    unique_together = (('app_label', 'model'),)

  def __str__(self):
    return self.name

大家可以看到contenttype就是一个简单的django model,而且它在数据库中的表的名字为django_content_type。

这个表的名字一般都不会陌生,在第一次对django的model进行migrate之后,就可以发现在数据库中出现了一张默认生成的名为django_content_type的表。

如果没有建立任何的model,默认django_content_type是这样的:

Django contenttypes 框架详解(小结)

因此,django_content_type记录了当前的django项目中所有model所属的app(即app_label属性)以及model的名字(即model属性)。

当然,django_content_type并不只是记录属性这么简单,contenttypes是对model的一次封装,

因此可以通过contenttypes动态的访问model类型,而不需要每次import具体的model类型。

  • contenttype实例提供的接口 
    • contenttype.model_class() 
      • 获取当前contenttype类型所代表的模型类
    • contenttype.get_object_for_this_type() 
      • 使用当前contenttype类型所代表的模型类做一次get查询
    • contenttype管理器(manager)提供的接口 
    • contenttype.objects.get_for_id() 
      • 通过id寻找contenttype类型,这个跟传统的get方法的区别就是它跟get_for_model共享一个缓存,因此更为推荐。
    • contenttype.objects.get_for_model() 
      • 通过model或者model的实例来寻找contenttype类型

三、django contenttypes的使用场景

在我们这个项目中各种商品的优惠卷就运用到了这个知识点:

假使我们models下有这几张表:

class electrics(models.model): #电器类
  name = models.charfield(max_length=32)
  price= models.integerfield(default=100)

  def __str__(self):
    return self.name


class foods(models.model):   #食物类
  name = models.charfield(max_length=32)
  price = models.integerfield(default=100)

  def __str__(self):
    return self.name


class clothes(models.model):  #衣服类
  name = models.charfield(max_length=32)
  price= models.integerfield(default=100)
  def __str__(self):
    return self.name

class coupon(models.model):  #优惠券
  name = models.charfield(max_length=32)

  def __str__(self):
    return self.name

我们先来考虑一个问题,如何把这些商品和优惠卷相关联?

一种商品一个优惠卷,那我们就在表中加入一种商品的优惠券,就是一个一对多的foreignkey,那么多个商品就有各种优惠卷,

但是一种商品的特定优惠卷在表结构中,就那个字段有值,别的不相关的记录为null,而且每增加一个商品,又要手动的去添加外键,

这是繁琐的!

所以我们就使用contenttypes 应用中提供的特殊字段genericforeignkey,我们可以解决上面的问题:

只需要以下三步:

  • 在model中定义foreignkey字段,并关联到contenttype表。通常这个字段命名为“content_type”
  • 在model中定义positiveintegerfield字段,用来存储关联表中的主键。通常这个字段命名为“object_id”
  • 在model中定义genericforeignkey字段,传入上述两个字段的名字。

具体实例代码:

class coupon(models.model):
  name = models.charfield(max_length=32)

  content_type = models.foreignkey(to=contenttype) # step 1
  object_id = models.positiveintegerfield() # step 2
  content_object = genericforeignkey('content_type', 'object_id') # step 3

  def __str__(self):
    return self.name

这样的话不管表的数据都可以查询出来,而且添加新的商品的商品,也不需要动优惠券的源码。

但我们在查询的过程中,用orm实在太繁琐了,所以还有一个反向查询的方法:

就是在每个商品中关联 绑定一个关系:

coupons = genericrelation(to='coupon') # 用于反向查询,不会生成表字段

这样我们就可以直接orm的.coupons找相应的字段!