使用Apache Velocity动态填充模板

在软件开发中,我们经常需要将数据动态填充到模板中,以生成各种类型的文本输出。Apache Velocity 是一个流行的模板引擎,可以帮助我们实现这一目标。本文将介绍如何使用 Apache Velocity 动态填充模板,并演示一个简单的示例。

引入包

import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.VelocityEngine;

代码实现
动态填充表达式为 $对象名.参数名 或者 ${对象名.参数名}
举栗子: $admin.realName 或者 ${admin.realName}

注意:表达式不能存在 换行,空格,特殊符号 等操作破坏完整结构,否则动态填充失败。(本人遇到过前端输入描述自动换行,破坏了完整结构(${admin.real\r\nName})导致动态填充失败的情况)

        // 初始化Velocity引擎
        VelocityEngine velocityEngine = new VelocityEngine();
        velocityEngine.init();
        // 创建上下文并添加数据对象
        VelocityContext context = new VelocityContext();

        //需要的参数对象,可以多个
        Admin admin = new Admin();
        admin.setRealName("小明");
        admin.setMobile("1561561568");
        //状态是枚举
        admin.setAdminState(AccountState.NORMAL);
        context.put("admin", admin);

        User user = new User();
        user.setRealName("");
        user.setMobile(null);
        //状态是枚举
        user.setUserState(AccountState.NORMAL);
        context.put("user", user);

        //需要动态填充的字符串,需要填充的参数写法 $admin.realName 或 ${admin.realName}
        String content = "管理员名称 $admin.realName \r\n" +
                "管理员手机号 ${admin.mobile} \r\n" +
                "管理员状态 $admin.adminState.desc \r\n" +
                "用户名称 $user.realName \r\n" +
                "用户手机号 ${user.mobile} \r\n" +
                "用户手机副号 ${user.deputyMobile} \r\n" +
                "用户状态 $user.userState.desc";
        // 合并模板与上下文
        StringWriter writer = new StringWriter();
        velocityEngine.evaluate(context, writer, "logTag", content);
        System.out.println("动态填充结果:\r\n" + writer.toString());
/**
 * 账号状态
 *
 * @author tzq
 */
@Getter
@ToString
@AllArgsConstructor
public enum AccountState {

    NORMAL("NORMAL", "正常状态"),
    LOCK("LOCK", "锁定状态"),
    FORBID("FORBID", "禁止状态"),

    ;

    private final String value;
    private final String desc;

}

结果

动态填充结果:
管理员名称 小明 
管理员手机号 1561561568 
管理员状态 正常状态 
用户名称  
用户手机号 ${user.mobile} 
用户手机副号 ${user.deputyMobile} 
用户状态 正常状态

通过结果我们可以发现,${user.mobile} 和 ${user.deputyMobile} (deputyMobile参数是我乱填的,user中并没有这个参数)并没有被动态填充
这就是我们要注意的点,当值为null 或者 对象/参数不存在时,不会进行动态填充,而是保持表达式原样

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,539评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,911评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,337评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,723评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,795评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,762评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,742评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,508评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,954评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,247评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,404评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,104评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,736评论 3 324
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,352评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,557评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,371评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,292评论 2 352

推荐阅读更多精彩内容