Django模板层——三种自定义模板simple_tag、inclusion_tag、filter的用法

2024-04-04 16:36

本文主要是介绍Django模板层——三种自定义模板simple_tag、inclusion_tag、filter的用法,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

目录

1. 前言

2. 前置操作

3. simple_tag

3.1 注意点

4. inclusion_tag

5. filter

6. 结尾


1. 前言

在前后端不分离的模式中,Django的模板语法尤为重要,我们可以动态传入变量,并在前端HTML中进行展示。在变量展示时,会有一些内置的过滤器和方法,但这远远不能满足我们的需求。因此,在Django模板中,还有三大自定义的常用模板:simple_taginclusion_tagfilter ,能在开发中,为我们省去很多麻烦。

我将通过实际案例的方式,引出自定义模板的用法。

2. 前置操作

  • 注册app

先注册好需要使用的app:

我这里用app01来进行演示

  • 在视图中定义好返回的HTML

  • 创建templatetags文件夹

我们需要先创建templatetags文件夹,并放入我们自定义的模板函数,这样做是为了保证Django能够更好的管理他们,并且在后续引入模块的时候,直接去templatetags中找。

注意:templatetags是需要放在应用程序app下的,Django默认去app下寻找

  • 建立自己的自定义模块

这里的名字可以随意

  • 注册自定义模板标签

实例化Library对象,用于注册自定义模板标签,以至于Django能够使用这些标签

from django.template.library import Libraryregister = Library()

3. simple_tag

simple_tagDjango自定义模板中的一个装饰器,主要用于字符串的处理,可以定义一个接受参数并返回字符串的自定义标签

我们还是从需求出发:

需求:在页面中实时刷新显示当前时间(简单一点,刷新之后,动态显示时间)

我们可以自定义我们的时间格式:

import datetimefrom django.template.library import Libraryregister = Library()@register.simple_tag()
def my_func(format_string):return datetime.datetime.now().strftime(format_string)
{% load test_tag %}
<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><title>Title</title>
</head>
<body>
当前日期时间: {% my_func "%Y-%m-%d %H:%M:%S" %}</body>
</html>

最终显示: 

刷新后:

3.1 注意点

如果你在代码执行时,遇到了这个报错:

django.template.exceptions.TemplateSyntaxError: '####' is not a registered tag libr...

并且,你的代码没有任何问题,你只需要重新启动Django程序,清理缓存就好了。

4. inclusion_tag

inclusion_tag主要用于复用模板,如果在多个页面都需要使用同一段HTML代码,这个时候,复用就会使得代码变得更加简洁。

需求:使用列表展示信息

@register.inclusion_tag("user.html")
def my_xo(num):return {"x1": [item for item in num]}

user.html

<ul>{% for item in x1 %}<li>{{ item }}</li>{% endfor %}
</ul>

view.py

def test(request):return render(request, 'test.html', {'num': ['王者荣耀', '原神', '和平精英']})

调用:

{% load test_tag %}
<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><title>Title</title>
</head>
<body>
当前日期时间: {% my_func "%Y-%m-%d %H:%M:%S" %}展示列表:
{% my_xo num %}</body>
</html>

结果:

5. filter

Django 模板系统中的一个过滤器,用于在模板中对变量进行简单的处理和过滤。过滤器可以用于修改变量的显示方式、筛选列表、格式化数据等。

需求:页面展示标题,最长10个字,超出打自定义传入的符号

test_tag.py

@register.filter
def my_filter(x1, sign):return x1[:10] + sign

test.html

{% load test_tag %}
<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><title>Title</title>
</head>
<body>
当前日期时间: {% my_func "%Y-%m-%d %H:%M:%S" %}展示列表:
{% my_xo num %}标题:
{{ '我爱玩原神,那么,原神启动!'|my_filter:'...' }}</body>
</html>

展示:

6. 结尾

有关Django模板层中三种自定义模板标签就介绍到这里了。

利用这些自定义标签,在我们日后的开发中能省却很多代码量,大多都是重复的。

这会让我们的代码更加具有可复用性。

这篇关于Django模板层——三种自定义模板simple_tag、inclusion_tag、filter的用法的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/876291

相关文章

C语言中%zu的用法解读

《C语言中%zu的用法解读》size_t是无符号整数类型,用于表示对象大小或内存操作结果,%zu是C99标准中专为size_t设计的printf占位符,避免因类型不匹配导致错误,使用%u或%d可能引发... 目录size_t 类型与 %zu 占位符%zu 的用途替代占位符的风险兼容性说明其他相关占位符验证示

MySQL中EXISTS与IN用法使用与对比分析

《MySQL中EXISTS与IN用法使用与对比分析》在MySQL中,EXISTS和IN都用于子查询中根据另一个查询的结果来过滤主查询的记录,本文将基于工作原理、效率和应用场景进行全面对比... 目录一、基本用法详解1. IN 运算符2. EXISTS 运算符二、EXISTS 与 IN 的选择策略三、性能对比

全面解析Golang 中的 Gorilla CORS 中间件正确用法

《全面解析Golang中的GorillaCORS中间件正确用法》Golang中使用gorilla/mux路由器配合rs/cors中间件库可以优雅地解决这个问题,然而,很多人刚开始使用时会遇到配... 目录如何让 golang 中的 Gorilla CORS 中间件正确工作一、基础依赖二、错误用法(很多人一开

Java Stream流之GroupBy的用法及应用场景

《JavaStream流之GroupBy的用法及应用场景》本教程将详细介绍如何在Java中使用Stream流的groupby方法,包括基本用法和一些常见的实际应用场景,感兴趣的朋友一起看看吧... 目录Java Stream流之GroupBy的用法1. 前言2. 基础概念什么是 GroupBy?Stream

springboot自定义注解RateLimiter限流注解技术文档详解

《springboot自定义注解RateLimiter限流注解技术文档详解》文章介绍了限流技术的概念、作用及实现方式,通过SpringAOP拦截方法、缓存存储计数器,结合注解、枚举、异常类等核心组件,... 目录什么是限流系统架构核心组件详解1. 限流注解 (@RateLimiter)2. 限流类型枚举 (

Java Spring的依赖注入理解及@Autowired用法示例详解

《JavaSpring的依赖注入理解及@Autowired用法示例详解》文章介绍了Spring依赖注入(DI)的概念、三种实现方式(构造器、Setter、字段注入),区分了@Autowired(注入... 目录一、什么是依赖注入(DI)?1. 定义2. 举个例子二、依赖注入的几种方式1. 构造器注入(Con

SpringBoot 异常处理/自定义格式校验的问题实例详解

《SpringBoot异常处理/自定义格式校验的问题实例详解》文章探讨SpringBoot中自定义注解校验问题,区分参数级与类级约束触发的异常类型,建议通过@RestControllerAdvice... 目录1. 问题简要描述2. 异常触发1) 参数级别约束2) 类级别约束3. 异常处理1) 字段级别约束

详解MySQL中JSON数据类型用法及与传统JSON字符串对比

《详解MySQL中JSON数据类型用法及与传统JSON字符串对比》MySQL从5.7版本开始引入了JSON数据类型,专门用于存储JSON格式的数据,本文将为大家简单介绍一下MySQL中JSON数据类型... 目录前言基本用法jsON数据类型 vs 传统JSON字符串1. 存储方式2. 查询方式对比3. 索引

SpringBoot集成EasyPoi实现Excel模板导出成PDF文件

《SpringBoot集成EasyPoi实现Excel模板导出成PDF文件》在日常工作中,我们经常需要将数据导出成Excel表格或PDF文件,本文将介绍如何在SpringBoot项目中集成EasyPo... 目录前言摘要简介源代码解析应用场景案例优缺点分析类代码方法介绍测试用例小结前言在日常工作中,我们经

全面掌握 SQL 中的 DATEDIFF函数及用法最佳实践

《全面掌握SQL中的DATEDIFF函数及用法最佳实践》本文解析DATEDIFF在不同数据库中的差异,强调其边界计算原理,探讨应用场景及陷阱,推荐根据需求选择TIMESTAMPDIFF或inte... 目录1. 核心概念:DATEDIFF 究竟在计算什么?2. 主流数据库中的 DATEDIFF 实现2.1