Freemarker自定义指令和方法

最新推荐文章于 2021-06-30 11:10:05 发布
最新推荐文章于 2021-06-30 11:10:05 发布
阅读量1.2k 收藏 4
点赞数 2
分类专栏： 日常工作 文章标签： Freemarker自定义指令 Freemarker自定义方法
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/xiaoxufox/article/details/88839132
版权

文章目录


之前在项目中使用了Freemarker的自定义指令和方法，感觉挺方便的，记录下，防止遗忘。Talk is cheap， show the code！

Freemarker模板

添加Freemarker的maven依赖

	  <dependency>
          <groupId>org.freemarker</groupId>
          <artifactId>freemarker</artifactId>
          <version>2.3.28</version>
      </dependency>

hello.ftl

模板包含一个自定义手机号码隐位的方法和一个菜单展示的自定义指令

<html>
<head>
    <title>你好,${username}</title>
</head>
<body>
手机号码：${phoneMask(phone, 2, 4)}
<@menus  method="menus"; showAll>
    <#if showAll>
        <#if menus?? && menus?size gt 0>
            <#list menus as item>
            <h1>${item}</h1>
            </#list>
        </#if>
    <#else>
        没有可用菜单
    </#if>
</@menus>
</body>
</html>

自定义指令

自定义一个菜单展示指令：MenusTagDirective.java

import java.io.IOException;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

import freemarker.core.Environment;
import freemarker.template.Configuration;
import freemarker.template.DefaultObjectWrapperBuilder;
import freemarker.template.TemplateBooleanModel;
import freemarker.template.TemplateDirectiveBody;
import freemarker.template.TemplateDirectiveModel;
import freemarker.template.TemplateException;
import freemarker.template.TemplateModel;

public class MenusTagDirective implements TemplateDirectiveModel {

    /**
     * @param environment           环境变量(实现复杂功能时可能会用)
     * @param map                   在.ftl模板中使用自定义指令传的参数(key-value形式)
     * @param templateModels        返回值，数组形式
     * @param templateDirectiveBody 指令内容
     * @throws TemplateException
     * @throws IOException
     */
    @Override
    public void execute(Environment environment, Map map, TemplateModel[] templateModels, TemplateDirectiveBody templateDirectiveBody) throws TemplateException, IOException {
        DefaultObjectWrapperBuilder builder = new DefaultObjectWrapperBuilder(Configuration.VERSION_2_3_28);
        if (map.containsKey("method") && "menus".equalsIgnoreCase(map.get("method").toString())) {
            // 这里直接new一个菜单列表，真实环境可以自己获取
            List<String> menusList = new LinkedList<>();
            menusList.add("用户管理");
            menusList.add("角色管理");
            menusList.add("权限管理");
            menusList.add("系统设置");
            environment.setVariable("menus", builder.build().wrap(menusList));

            templateModels[0] = TemplateBooleanModel.TRUE;
        }else{
            templateModels[0] = TemplateBooleanModel.FALSE;
        }
        templateDirectiveBody.render(environment.getOut());
    }
}

自定义方法

自定义手机号码隐位的method，继承自TemplateMethodModelEx，以前TemplateMethodModel被Deprecated。

import java.util.List;

import freemarker.template.TemplateMethodModelEx;
import freemarker.template.TemplateModelException;

/**
 * 手机隐位
 * ${phoneMask(phone, beginIdx, suffixIdx)}
 */
public class PhoneMask implements TemplateMethodModelEx {

    @Override
    public Object exec(List args) throws TemplateModelException {
        if (args.size() != 3) {
            throw new TemplateModelException(
                    "the field number of phoneMask is wrong");
        }

        try {
            String phoneNum  = args.get(0).toString();
            int beginIdx = Integer.valueOf(args.get(1).toString().trim());
            int suffixIdx = Integer.valueOf(args.get(1).toString().trim());

            // 这里没有对begin和suffix做严格校验
            StringBuilder sb = new StringBuilder();
            int size = phoneNum.length();
            if(size > beginIdx + suffixIdx) {
                String prefix = phoneNum.substring(0, beginIdx);
                String suffix = phoneNum.substring(size - suffixIdx);
                String middle = phoneNum.substring(beginIdx, size - suffixIdx).replaceAll(".", "*");
                sb.append(prefix).append(middle).append(suffix);
            } else {
                sb.append(phoneNum);
            }

            return sb.toString();
        } catch (Exception e) {
            throw new TemplateModelException(
                    "phoneMask 处理异常", e);
        }
    }
}

测试方法

public static void main( String[] args )
    {
        Configuration cfg = new Configuration(Configuration.getVersion());
        try {
            // 设置模板位置
            cfg.setDirectoryForTemplateLoading(new File("D:\\workspaces\\freemarkerdemo\\src\\main\\resources"));
            cfg.setDefaultEncoding("UTF-8");
            cfg.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER);
            // 自定义指令\方法
            cfg.setSharedVariable("menus", new MenusTagDirective());
            cfg.setSharedVariable("phoneMask", new PhoneMask());

            Template temmplate = cfg.getTemplate("hello.ftl");
            Map<String, String> map = new HashMap<>();
            map.put("username", "admin");
            map.put("phone", "13849323456");

            StringWriter sw = new StringWriter();
            try {
                temmplate.process(map,sw);
            } catch (TemplateException e) {
                e.printStackTrace();
            }
            System.out.println(sw.toString());

        } catch (IOException e) {
            e.printStackTrace();
        }
    }

测试结果

<html>
<head>
    <title>你好,admin</title>
</head>
<body>
手机号码：13*******56
            <h1>用户管理</h1>
            <h1>角色管理</h1>
            <h1>权限管理</h1>
            <h1>系统设置</h1>
</body>
</html>
熊猫小牛牛
关注
  • 2
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
FreeMarker源码分析（四）
weixin_45769314的博客
10-23 897
2021SC@SDUSC 目录 template包 Template.java 源码展示 关键代码分析 template（）构造方法 getPlainTextTemplate（）方法 createProcessingEnvironment（）方法 getPrefixedName（）方法 containingElements（）方法 template包 与log有关的代码分析已经完成接下来集中于对FreeMarker的template进行分析。 模板引擎的作用 模板引擎的目标是“.
freemarker 自定义freeMarker标签
04-21
这通常是通过`Configuration`对象的`setSharedVariable`方法完成的，将你的自定义指令类实例绑定到一个特定的名字，这个名字就是你在模板中使用的标签名。 3. 使用自定义标签：在模板文件中，你可以像使用内置标签...
freemarker 实现自定义标签的方法
victor.luo
07-14 7606
freemarker 实现自定义标签的方法 ： 使用    宏定定义标签实现  TemplateDirectiveModel的 execute() 方法，写相应的Java代码（这种方式更加的灵活）   使用 TemplatedirectiveModel 的 execute 方法 来实现自定义标签  （1）页面调用和对于的实现类关系
Freemarker自定义方法
chenzhou123520的专栏
12-26 271
在项目中有一个需求，每个物品有一个guid，存在数据库中，而在页面上需要显示一个对应的业务数据值，暂且叫做serverId，serverId是通过guid移位计算得来。serverId只需要显示，后台并不需要使用。 因为serverId在后台用不到，所以就没有使用VO字段来存储，项目使用了Freemarker作为view层的模板引擎。了解到Freemarker的一个特点是具有很多内置的功能强...
FreeMarker自定义指令
逍遥客的博客
12-10 144
摘要: FreeMarker自定义指令就像struts2的set标签，为了好理解，也可以认为是定义一个方法，就像js的function.在freemarker中的这个标签就是macro。在定义一个指令的时候，可以指定参数，当然也可以不指定，这里要注意了，我这里只贴出模板文件及输出结果，freemarker的工具类请参照FreeMarker入门教程，其实也没有什么改变，直接拿过来用即可 ...
freemarker自定义指令
huashuizhuhui的专栏
04-02 102
和jsp的自定义tag一样，freemarker也可以自定义指令。 比如，我们需要用一个指令，实现两个数字相加。 我们需要实现一个freemarker的模板指令模型(TemplateDirectiveModel ): Java代码 1. public class TempDireModelStub implements TemplateDirectiveModel...
freemarker实现自定义指令和自定义函数
b129266314387022的博客
10-16 435
自定义指令： 1.指令在前台实现 　　<#macro name param1,param2,param3...paramN> 　　</#macro> 2.指令在后台实现 1.实现TemplateDirectiveModel接口 参数说明： environment ： 是环境变量，在这里我们可以拿到 通过 environment....
freemarker自定义的通用分页指令(标签)源码和使用示例
10-18
一个用FTL定义的非常通用数据分页指令，有源码，有使用示例。使用效果图可以参看本人博客中的相关文章：http://blog.csdn.net/qjyong/archive/2009/10/18/4693142.aspx
Freemarker 自定义标签 简单案例
11-01
在这个"Freemarker自定义标签简单案例"中，我们将深入探讨如何利用Freemarker进行模板设计，并结合自定义标签来增强模板的功能。 首先，让我们理解Freemarker的基础知识。Freemarker是一个与语言无关的模板引擎，它...
Freemarker常用指令使用示例
09-04
同时，Freemarker还支持自定义指令和宏，以满足更复杂的需求。 总之，Freemarker的这些常用指令提供了强大的逻辑控制和数据处理能力，使得开发者能够方便地在模板中进行条件判断、循环遍历以及数据操作，从而实现...
Struts2、Spring、Freemarker自定义标签
04-05
而在Freemarker中，可以通过扩展其API创建自定义指令，实现更复杂的逻辑或功能。 总结一下，Struts2、Spring和Freemarker的组合为Java Web开发提供了强大的工具集，涵盖了MVC模式的各个方面。它们的自定义标签功能...
Freemarker自定义方法变量
daobuxinzi的博客
11-05 709
最近在项目开发中使用了freemarker，并在前台显示文本时遇到这样一个需求，当长度超过10个字时只显示出前面10个字，并在后面加...。这里就可以在freemarker中实现一个自定义方法变量。 实现自定义方法变量基本步骤： 1.先实现TemplateMethodModel或TemplateMethodModelEx接口（TemplateMethodModelEx 继承自TemplateMethodModel 接口，我这里使用的是TemplateMethodModelEx接口），再覆盖该接口的Ob..
Freemarker的自定义方法
hck341204的专栏
12-17 245
要想使用Freemarker支持的自定义方法，需要实现freemarker.template.TemplateMethodModel接口，然后将方法对象放入到Freemarker的数据模型中，这样在ftl文件中便可以像使用Freemarker内置方法一样使用该方法了。 [code="java"]/** * Freemarker自定义方法 * 实现response.encode...
freemarker自定义方法
高献涛
06-30 744
freemarker自定义方法官网手册实现方法调用方法 官网手册 数据模型——方法. 方法变量在存于实现了TemplateMethodModel接口的模板中。这个接口包含一个方法：TemplateModel exec(java.util.List arguments)。当使用方法调用表达式调用方法时，exec方法将会被调用。形参将会包含FTL方法调用形参的值。exec方法的返回值给出了FTL方法调用表达式的返回值。 TemplateMethodModelEx接口扩展了TemplateMethodModel接
FreeMarker 自定义方法
路。。。。。
05-08 3078
在FreeMarker中自定义方法 在模板中除了可以通过对象来调用方法如：${object.methed(args)}，也可以直接调用java实现的方法。该java类必须实现于接口TemplateMethodModel。下面是一个结合struts2 的例子：package com.safetys.commerce.youqi.web.tag;import j
freemarker自定义指令及方法
suijiarui的专栏
05-12 6996
“一节复一节,千枝攒万叶”竹子每生长一段就会总结一下打个节，今天我也总结一下最近处理的一个小问题，希望我的小节，对各位看官有所帮助。 背景描述： 最近项目做了一个月报功能，由于生产环境不是所有人都能访问，“皇上”提出要求要求把月报方式到订阅者的邮箱。亲需求一段话，开发两行泪啊。这种问题本人想到的方案也就两种，第一将网页保存为图片然后发送邮件，第二生成静态页面然后发送邮件。第一种需要一下人工参与
FreeMarker 自定义方法（二）
韩世雷 程序员专栏
07-13 3952
1. 模板文件 test303.ftl<#assign x = "something"> ${indexOf("met", x)} ${indexOf("foo", x)}2. 自定义方法 IndexOfMethod.javaps: 返回第一个字符串在第二个字符串第一次出现时的索引位置,如果第二个字符串中不包含第一个字符串。package com.freemarker.test03.Method;i
freemarker 自定义一个list 标签，ListDirective
最新发布
05-17
要自定义一个名为 ListDirective 的 FreeMarker 指令，你需要遵循以下步骤： 1. 创建一个 Java 类来实现指令。这个类应该继承 `freemarker.template.TemplateDirectiveModel` 接口，并且需要实现 `execute()` 方法，该方法会被 FreeMarker 引擎调用来处理指令。 ```java import java.util.Map; import javax.servlet.jsp.JspException; import javax.servlet.jsp.PageContext; import freemarker.core.Environment; import freemarker.template.*; public class ListDirective implements TemplateDirectiveModel { public void execute(Environment env, Map params, TemplateModel[] loopVars, TemplateDirectiveBody body) throws TemplateException, java.io.IOException { // 在这里编写逻辑来处理指令 // ... } } ``` 2. 在 `execute()` 方法中编写处理逻辑。在这里，你需要解析和验证指令参数，并使用 `TemplateModel` 对象来获取指令所在的模板环境和输出流。你也需要创建一个 `SimpleScalar` 对象来包装列表数据，并将其放入模板环境中。 ```java public void execute(Environment env, Map params, TemplateModel[] loopVars, TemplateDirectiveBody body) throws TemplateException, java.io.IOException { // 解析和验证指令参数 String listName = DirectiveUtils.getRequiredParam(params, "name"); Object listData = DirectiveUtils.getRequiredParam(params, "data"); // 获取模板环境和输出流 Writer out = env.getOut(); PageContext pageContext = (PageContext) env.getCustomAttribute("PageContext"); if (pageContext == null) { throw new JspException("PageContext not found"); } // 创建 SimpleScalar 对象来包装列表数据 SimpleScalar listModel = new SimpleScalar(listData.toString()); // 将 SimpleScalar 对象放入模板环境中 env.setVariable(listName, listModel); // 处理指令内容 if (body != null) { body.render(out); } } ``` 3. 将自定义指令注册到 FreeMarker 引擎中。你可以使用 `Configuration` 对象的 `setSharedVariable()` 方法将指令实例添加到引擎中。 ```java import freemarker.template.Configuration; Configuration cfg = new Configuration(Configuration.VERSION_2_3_30); cfg.setSharedVariable("list", new ListDirective()); ``` 现在，你就可以在模板中使用自定义指令了： ``` <@list name="myList" data=[1, 2, 3]> <#list myList as item> ${item} </#list> </@list> ``` 这将输出： ``` 1 2 3 ```
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值