Java模板引擎StringTemplate4 - EMail模板格式化

什么是StringTemplate4

StringTemplate4是轻量级模板引擎，Antlr 组织开发，主要用于java代码，网页，邮件，或其他格式化文本的生成，只有一个依赖项。

模板引擎都有语法，如果我们要使用，就必须掌握语法。这里是StringTemplate4 项目地址，本文不讲解语法，只是用一个简单的示例，展示StringTemplate4的功能。

使用版本：

JDK 11
StringTemplate4 4.3.1

开发项目

在POM文件中引入项目依赖

    <dependencies><dependency><groupId>org.antlr</groupId><artifactId>ST4</artifactId></dependency></dependencies>

编写EMail模板文件email.stg，存放到resources目录下，文件内容如下：

email(order,separator) ::= <<
<! This is a comment
!>Hello, <if(order.customer.firstName)><order.customer.firstName><else>dear customer<endif>!On <order.orderDate> we received the following order:Shipping address:
<if(order.customer.firstName)><order.customer.firstName> <endif><order.customer.lastName>
<order.customer.address><order.items:{item|<item.amount>x <item.article.name> à <item.article.price; format="currency"> = <item.subTotal; format="currency">};separator="\n">
<if(!order.freeShipping)>plus shipping = <order.shippingCost; format="currency"><endif>
<separator>
Total = <order.total; format="currency">Thank you for ordering!
>>

使用StringTemplate4格式化非常简单，如下：

STGroup group = new STGroupFile("email.stg");
ST st = group.getInstanceOf("email");
st.add("order", order);
st.add("separator", "----------------");System.out.println(st.render());

其中 order 变量就是数据。格式化的Email内容输出到控制台。格式化结果如下：

Hello, Oliver!On Fri Jan 28 14:35:02 CST 2011 we received the following order:Shipping address:
Oliver Zeigermann
Gaußstraße 180
22765 Hamburg
GERMANY1x How to become famous à 17.80 = 17.80
2x Cool stuff à 1.00 = 2.00
plus shipping = 3.00
----------------
Total = 22.80Thank you for ordering!

如果我们需要Order（订单）中关于金钱的信息格式化输出，该如何操作？这个很简单，我们需要定义格式化金钱的类（BigDecimalRenderer.java）：

public static class BigDecimalRenderer implements AttributeRenderer<BigDecimal> {private static final DecimalFormat DECIMAL_FORMAT = new DecimalFormat("##,##0.00", DecimalFormatSymbols.getInstance(Locale.GERMANY));private static final String EURO_CHARACTER = "\u20AC";@Overridepublic String toString(BigDecimal value, String formatString, Locale locale) {if (formatString.equals("currency")) {NumberFormat numberFormat = DECIMAL_FORMAT;String formatted = numberFormat.format(value) + " "+ EURO_CHARACTER;return formatted;}return value.toString();}}

然后注册实例即可，如下：

        STGroup group = new STGroupFile("email.stg");group.registerRenderer(Date.class, new DateRenderer());group.registerRenderer(BigDecimal.class, new BigDecimalRenderer());ST st = group.getInstanceOf("email");st.add("order", order);st.add("separator", "----------------");System.out.println(st.render());

DateRenderer是日期格式化类，框架自带的。

最后

本文的全部代码，可以在这里查看string-template4，感谢支持！

Java模板引擎StringTemplate4 - EMail模板格式化相关推荐

由浅入深：自己动手开发模板引擎——置换型模板引擎（四）
受到群里兄弟们的竭力邀请,老陈终于决定来分享一下.NET下的模板引擎开发技术.本系列文章将会带您由浅入深的全面认识模板引擎的概念.设计.分析和实战应用,一步一步的带您开发出完全属于自己的模板引擎.关于 ...
由浅入深：自己动手开发模板引擎——置换型模板引擎（三）
受到群里兄弟们的竭力邀请,老陈终于决定来分享一下.NET下的模板引擎开发技术.本系列文章将会带您由浅入深的全面认识模板引擎的概念.设计.分析和实战应用,一步一步的带您开发出完全属于自己的模板引擎.关于 ...
由浅入深：自己动手开发模板引擎——解释型模板引擎
受到群里兄弟们的竭力邀请,老陈终于决定来分享一下.NET下的模板引擎开发技术.本系列文章将会带您由浅入深的全面认识模板引擎的概念.设计.分析和实战应用,一步一步的带您开发出完全属于自己的模板引擎.关于 ...
由浅入深：自己动手开发模板引擎——置换型模板引擎（二）
受到群里兄弟们的竭力邀请,老陈终于决定来分享一下.NET下的模板引擎开发技术.本系列文章将会带您由浅入深的全面认识模板引擎的概念.设计.分析和实战应用,一步一步的带您开发出完全属于自己的模板引擎.关于 ...
由浅入深：自己动手开发模板引擎——置换型模板引擎（一）
受到群里兄弟们的竭力邀请,老陈终于决定来分享一下.NET下的模板引擎开发技术.本系列文章将会带您由浅入深的全面认识模板引擎的概念.设计.分析和实战应用,一步一步的带您开发出完全属于自己的模板引擎.关于 ...
由浅入深：自己动手开发模板引擎——解释型模板引擎（二）
受到群里兄弟们的竭力邀请,老陈终于决定来分享一下.NET下的模板引擎开发技术.本系列文章将会带您由浅入深的全面认识模板引擎的概念.设计.分析和实战应用,一步一步的带您开发出完全属于自己的模板引擎.关于 ...
实现一个简单的模板引擎，输入模板和数据，输出html
实现一个简单的模板引擎,输入模板和数据,输出html 示例: 输入: "<div>{{$1}}({{$2}}){{$3}}</div>",["第一 ...
php2twig,symfony2 twig模板引擎，symfony2twig模板_PHP教程
symfony2 twig模板引擎,symfony2twig模板 1.基本语法 Says something:{{ }} Does something:{% %} Comment something: ...
Node.js(二)——pug模板引擎，nunjucks模板引擎，在koa中使用pug和nunjucks模板引擎
目录 1.知识点及课堂目标 2.模板引擎 3.pug模板引擎使用 3.1安装pug 3.2pug常用语法 3.2.1通过缩进关系,代替以往html的层级包含关系. 3.2.2html 元素属性/sty ...

Java模板引擎StringTemplate4 - EMail模板格式化

什么是StringTemplate4

开发项目

最后

Java模板引擎StringTemplate4 - EMail模板格式化相关推荐

最新文章

热门文章