Django模型计算字段与外键搜索实现详解

Cora
Cora
发布时间:2026-10-13| 4人浏览过
原创

本文介绍在Django中实现模型计算字段的方法,包括在Model类和ModelAdmin类中定义只读字段,并解决search_fields中如何正确查询外键字段的问题,通过双下划线语法实现关联字段的搜索功能。

Django模型中计算字段的定义与显示

在Django的models.py文件中,可以通过定义方法来实现计算字段。例如,在Person模型中定义了family_name(姓)和given_name(名)两个字符字段。为了在管理界面显示全名,可以定义一个名为name的方法,该方法返回姓和名的组合字符串。需要注意的是,计算字段若要显示在修改页面中,必须将其添加到readonly_fields列表中,否则不会显示。此外,通过设置name.short_description属性,可以指定该字段在管理界面显示的标题,否则将默认显示为方法名'name'。


class Person(models.Model):
  family_name= models.CharField(max_length=20, verbose_name='姓')
  given_name = models.CharField(max_length=20, verbose_name='名')
  def name(self): # 计算字段要显示在修改页面中只能定义在只读字段中(否则不显示):readonly_fields = ('sc',)
    return '%s,%s' % (self.family_name, self.given_name)
  name.short_description = '全名' # 用于显示时的名字 , 没有这个,字段标题将显示'name'
  def __str__(self):
    return "%s %s " % (self.family_name, self.given_name)

在admin.py文件中,需要注册Person模型及其对应的PersonAdmin类。在PersonAdmin类中,通过设置readonly_fields = ('name',)来指定name字段为只读字段,这样计算出的全名就能在管理界面的修改页面中正确显示。最后,使用admin.site.register(Person, PersonAdmin)将模型和管理类注册到Django后台。

ModelAdmin中计算字段的配置


class PersonAdmin(admin.ModelAdmin):
  readonly_fields = ('name',)

admin.site.register(Person, PersonAdmin)

除了直接在Model类中定义计算字段外,还可以将计算字段的逻辑写在ModelAdmin类中。这种方式使得计算字段的定义与管理界面的配置更加紧密,便于统一管理。

在另一种实现方式中,可以在models.py中仅定义基础字段,如family_name和given_name,并在__str__方法中返回全名。这种方式适用于只需要在列表视图或字符串表示中使用计算结果的情况,而不需要在修改页面中显示为单独的字段。


class Person(models.Model):
  family_name= models.CharField(max_length=20, verbose_name='姓')
  given_name = models.CharField(max_length=20, verbose_name='名')

  def __str__(self):
    return "%s %s " % (self.family_name, self.given_name)

在admin.py文件中,可以在PersonAdmin类中定义一个名为name的方法,该方法接收两个参数:第一个是ModelAdmin类的实例,第二个是当前管理的模型实例(如Person)。该方法返回姓和名的组合字符串,并通过设置name.short_description指定显示标题。最后,将name添加到readonly_fields列表中,并在admin.site.register中注册模型和管理类。这种方式使得计算字段的定义更加灵活,且可以直接访问模型实例的属性。

在ModelAdmin中定义计算字段


class PersonAdmin(admin.ModelAdmin):
  
  def name(self,obj): 
    # 这个方法会得到两个参数,第一个是类本身的一个实例(app.PersonAdmin),第二个是这个类管理的模型实例(Person)
    return '%s,%s' % (self.family_name, self.given_name)

  name.short_description = '全名' # 用于显示时的名字 , 没有这个,字段标题将显示'name'
  readonly_fields = ('name',)

admin.site.register(Person, PersonAdmin)

补充知识:Django如何在search_fields中包含外键字段

在search_fields中直接添加外键的名字无法进行查询,必须采用(外键名__外键中的字段名)的形式。例如,若要通过外键关联的字段进行搜索,可以设置search_fields = ('attributename', 'goodsclass__cn')。这样,当搜索'手机 分辨率'时,系统会同时匹配attributename字段和goodsclass关联模型中的cn字段,从而实现对外键关联字段的搜索。

search_fields中外键字段的搜索实现


search_fields = ('attributename','goodsclass__cn')
# goodsclass__cn 就可以搜索外键的名字中有搜索词的条目了,
# 比如搜索手机的分辨率,而不是电脑的分辨率,就可以搜索'手机 分辨率'

以上介绍了Django模型中计算字段的实现方法以及如何在search_fields中包含外键字段。通过合理定义计算字段和使用双下划线语法,可以提升Django后台管理的灵活性和查询效率。希望这些内容能对读者有所帮助,欢迎参考和实践。

相关标签:

免责声明:本文内容仅供参考,不代表本站观点。转载或引用请注明出处。

Python 相关产品和应用

全部下载
Selenium

Selenium

4.51.0 · Windows

用于浏览器自动化和 Web 测试的 Python 工具。

scikit-learn

scikit-learn

1.9.1 · Windows

常用 Python 机器学习算法与模型评估工具库。

Black

Black

26.10.1 · Windows

强调一致性的 Python 自动代码格式化工具。

Ruff

Ruff

0.17.1 · macOS

由 Rust 编写的高速 Python 代码检查和格式化工具。

pytest

pytest

9.1.1 · Windows

简洁而强大的 Python 自动化测试框架。

FastAPI

FastAPI

0.146.0 · Windows

高性能 Python API 框架,支持类型提示和自动接口文档。

Flask

Flask

3.1.3 · Windows

轻量灵活的 Python Web 应用框架。

Django

Django

6.1.2 · Windows

成熟的 Python Web 框架,适合构建内容站点和业务系统。

Spyder

Spyder

6.1.7 · Windows

面向科学计算与数据分析的 Python 集成开发环境。

SciPy

SciPy

1.18.1 · Windows

面向科学、工程和技术计算的 Python 算法库。