freemarker 数字格式化深入理解

Freemarker是一个功能强大的Java模板引擎，它可以帮助我们以更加灵活和高效的方式生成各种文本格式。数字格式化是Freemarker的一个重要特性，它提供了许多选项来格式化数字类型数据，并且还支持各种自定义格式化方式。本文将深入探讨Freemarker数字格式化的原理和用法。

数字格式化语法

Freemarker的数字格式化语法类似于Java的DecimalFormat。我们可以使用${}语法在模板中格式化数字类型的数据：

${number?string("pattern")}

其中number是需要格式化的数字数据，pattern是格式化的模式。下面是一些常用的模式：

• 整数部分和小数部分分别用逗号分隔

${1234567.89?string("#,##0.00")}

输出结果：1,234,567.89

• 不足位数补零

${19?string("00")}

输出结果：19

• 百分号格式化

${0.1234?string("0.00%")}

输出结果：12.34%

• 取整

${12.34?string("0")}

输出结果：12

数字格式化选项

选项	作用	示例	输出结果
0	补零，不足位数用0填充	${12.3?string("000.00")}	012.30
#	只有在需要显示的数字位数大于格式中指定的数字位数时才显示该数字	${12.3?string("#.#")}	12.3
.	小数点分隔符	${1234.5?string("0.0")}	1234.5
,	千分位分隔符。和#结合使用可以实现小数部分的数字位数不足时也显示千分位分隔符	${1234567.8?string("#,##0.00")}	1,234,567.80
%	百分号。和.结合使用可以实现小数位数精度控制	${0.1234?string("0.0%")}	12.3%
x	指定格式的数字左侧添加指定字符	${12.34?string("x##.#")}	x12.3
-	用于指定负数时的符号显示	${-12.34?string("+##.##;-##.##")}	-12.34
(	指定负数时的符号显示为括号包围数字	${-12.34?string("(##.##)")}	(12.34)

数字格式化示例

下面通过两个示例来说明数字格式化的用法：

示例1

将数字格式化为美元金额的形式，保留两位小数，用逗号分隔千分位：

<#assign number = 1234567.89>
${number?string("#,##0.00")}

输出结果：

1,234,567.89

示例2

将数字格式化为定点数的形式，指定小数点后的数字位数，如果小数位数不够则自动补零：

<#assign number = 12.3456>
${number?string("0.000")}

输出结果：

12.346

自定义数字格式化

使用标准的数字格式化选项可以满足大部分数字格式化需求，但在某些情况下，我们可能需要更加灵活的格式化方式。此时，我们就可以使用自定义数字格式化器来完成。自定义数字格式化器是一个Java类，它实现了freemarker.template.TemplateNumberFormat接口，并提供了自定义的数字格式化方式。

实现自定义数字格式化器

实现自定义数字格式化器需要遵循以下步骤：

1. 创建一个Java类，实现freemarker.template.TemplateNumberFormat接口
2. 在Java类中实现自定义数字格式化逻辑
3. 在模板中使用格式化语法引用自定义数字格式化器

下面是一个将数字四舍五入到指定位数的自定义数字格式化器的示例：

import freemarker.template.TemplateNumberFormat;
import java.math.BigDecimal;
import java.math.RoundingMode;
import java.text.DecimalFormat;
import java.text.FieldPosition;

public class RoundNumberFormat implements TemplateNumberFormat {
    private static final long serialVersionUID = 1L;
    private int rounding;

    public RoundNumberFormat(int rounding) {
        this.rounding = rounding;
    }

    public String formatToPlainText(Number number) throws IllegalArgumentException, TemplateModelException {
        return format(number);
    }

    public String format(Number number) {
        BigDecimal bd = new BigDecimal(number.doubleValue()).setScale(rounding, RoundingMode.HALF_UP);
        return bd.toPlainString();
    }

    public StringBuffer format(Object number, StringBuffer toAppendTo, FieldPosition pos) {
        toAppendTo.append(format((Number)number));
        return toAppendTo;
    }

    public Number parse(String s, java.text.ParsePosition parsePosition) throws java.text.ParseException {
        DecimalFormat df = new DecimalFormat();
        df.setParseBigDecimal(true);
        return df.parse(s, parsePosition);
    }
}

以上代码定义了一个名为RoundNumberFormat的自定义数字格式化器，它将数字四舍五入到指定位数。接下来，在模板中使用自定义数字格式化器：

<#assign number = 1234.5678>
${number?string?round(2)}

输出结果：

1234.57

在这个例子中，我们创建了一个名为RoundNumberFormat的自定义数字格式化器，并将它用作数字的格式化方式。在模板中，我们通过${number?string?round(2)}语法引用了这个自定义数字格式化器。

总结

数字格式化是Freemarker的一个重要特性，它提供了许多数字格式化选项和灵活的自定义方式。通过仔细研究Freemarker的数字格式化语法和选项，我们可以轻松实现各种数字格式化需求。同时，自定义数字格式化器为我们提供了更加灵活和可定制的数字格式化方式。