Django如何复用同一HTML模板适配不同ListView的列表展示需求

问题本质 #

你在视图中传入模板的data1/data2/data3是字符串值，Django模板引擎不会自动将其解析为对象属性的调用路径，所以只会原样输出字符串，不会读取item对应的属性值。按以下步骤调整即可实现模板复用：

第一步：调整视图传递的参数 #

去掉context中字段名的item.前缀，仅传递模型的字段名字符串即可：

# WO_TravelView 调整示例
class WO_TravelView(ListView):
    template_name = 'TravelLaborPartsLists.html'
    model = WorkOrderTravel

    def get_context_data(self, **kwargs):
        id_ = self.kwargs.get('str')
        context = super().get_context_data(**kwargs)
        context['list'] = WorkOrderTravel.objects.filter(wo_num=id_).order_by('wo_travel_slug')
        context['page'] = 'Travel logged for'
        context['string'] = id_
        context['label'] = 'Work order-instance / Start / Stop '
        # 仅传字段名，去掉item.前缀
        context['data1'] = 'wo_travel_slug'
        context['data2'] = 'wo_travel_start'
        context['data3'] = 'wo_travel_stop'
        return context

# WO_PartsView 同理调整
class WO_PartsView(ListView):
    template_name = 'TravelLaborPartsLists.html'
    model = WorkOrderParts

    def get_context_data(self, **kwargs):
        id_ = self.kwargs.get('str')
        context = super().get_context_data(**kwargs)
        context['list'] = WorkOrderParts.objects.filter(wo_num=id_).order_by('wo_travel_slug')
        context['page'] = 'Parts included in order'
        context['string'] = id_
        context['label'] = 'Operation / Partnumber / Qty '
        context['data1'] = 'wo_part_op'
        context['data2'] = 'wo_part_id'
        context['data3'] = 'wo_part_qty'
        return context

第二步：自定义模板过滤器实现动态属性读取 #

Django原生模板没有直接支持动态获取对象属性的过滤器，我们可以自己实现一个：

1. 在你对应的Django应用目录下，新建templatetags文件夹，文件夹内新增两个文件：

• 空文件__init__.py，用于标识该目录为Python包
• 新建custom_filters.py，写入以下代码：

from django import template

register = template.Library()

@register.filter
def get_attr(obj, attr_name):
    """动态获取对象的属性值，属性不存在时返回空字符串"""
    return getattr(obj, attr_name, '')

2. 重启Django服务，确保自定义过滤器被加载。

第三步：修改HTML模板 #

<!-- 顶部先加载自定义过滤器 -->
{% load custom_filters %}

<h1>{{ page }}</h1>
<h1>{{ string }}</h1>

<l2>{{ label }}</l2>

{% for item in list %}
     <p>{{ item|get_attr:data1 }} - <a>{{ item|get_attr:data2 }}</a> - {{ item|get_attr:data3 }}</p>
{% endfor %}

可选优化 #

如果后续需要展示的字段数量会变化，可以直接传递字段列表到模板，模板循环读取即可，无需新增dataN变量：
视图中改为：

context['display_fields'] = ['wo_travel_slug', 'wo_travel_start', 'wo_travel_stop']

模板循环部分改为：

{% for item in list %}
<p>
  {% for field in display_fields %}
    {{ item|get_attr:field }}
    {% if not forloop.last %} - {% endif %}
  {% endfor %}
</p>
{% endfor %}

内容的提问来源于stack exchange，提问作者Jonas