Apache FreeMarker自定义指令与方法：在Java中处理模板参数值

import freemarker.core.Environment;
import freemarker.template.*;
import java.io.IOException;
import java.io.Writer;
import java.util.Map;

/**
 * 自定义FreeMarker指令，用于处理账户号码。
 * 如果账户号码大于0，则输出其值；否则输出"0000"。
 */
public class AccNoDirective implements TemplateDirectiveModel {

    @Override
    public void execute(Environment env, Map params, TemplateModel[] loopVars, TemplateDirectiveBody body)
            throws TemplateException, IOException {

        // 1. 尝试从指令参数中获取 'value'
        TemplateScalarModel valueModel = (TemplateScalarModel) params.get("value");
        String accNoStr = null;

        if (valueModel != null) {
            accNoStr = valueModel.getAsString();
        } else {
            // 2. 如果指令参数中没有 'value'，则尝试从环境变量中获取 'accNo' (不推荐，但作为示例)
            TemplateModel accNoVar = env.getVariable("accNo");
            if (accNoVar instanceof TemplateScalarModel) {
                accNoStr = ((TemplateScalarModel) accNoVar).getAsString();
            } else if (accNoVar instanceof TemplateNumberModel) {
                accNoStr = ((TemplateNumberModel) accNoVar).getAsNumber().toString();
            }
        }

        String result = "0000"; // 默认值
        if (accNoStr != null && !accNoStr.trim().isEmpty()) {
            try {
                long accNo = Long.parseLong(accNoStr);
                if (accNo > 0) {
                    result = accNoStr;
                }
            } catch (NumberFormatException e) {
                // 处理非数字输入，可以抛出异常或输出错误信息
                env.getOut().write("Error: accNo parameter is not a valid number.");
                return;
            }
        }

        // 将结果写入输出流
        env.getOut().write(result);
    }
}

<#-- 假设在Java代码中已注册 accNoDirective -->

<#-- 方式一：作为指令参数传入 (推荐) -->
<#assign accNo1 = 12345>
{ "Account_Number" : "<@accNoDirective value=accNo1 />" }
<#-- 输出: { "Account_Number" : "12345" } -->

<#assign accNo2 = 0>
{ "Account_Number" : "<@accNoDirective value=accNo2 />" }
<#-- 输出: { "Account_Number" : "0000" } -->

<#assign accNo3 = -5>
{ "Account_Number" : "<@accNoDirective value=accNo3 />" }
<#-- 输出: { "Account_Number" : "0000" } -->

<#assign accNo4 = "abc">
{ "Account_Number" : "<@accNoDirective value=accNo4 />" }
<#-- 输出: { "Account_Number" : "Error: accNo parameter is not a valid number." } -->

<#-- 方式二：从环境变量获取 (不推荐，仅作示例) -->
<#assign accNo = 67890>
{ "Account_Number" : "<@accNoDirective />" }
<#-- 输出: { "Account_Number" : "67890" } -->

<#assign accNo = 0>
{ "Account_Number" : "<@accNoDirective />" }
<#-- 输出: { "Account_Number" : "0000" } -->

import freemarker.template.TemplateMethodModelEx;
import freemarker.template.TemplateModelException;
import freemarker.template.TemplateScalarModel;
import freemarker.template.SimpleScalar;
import java.util.List;

/**
 * 自定义FreeMarker方法，用于处理账户号码。
 * 如果账户号码大于0，则返回其值；否则返回"0000"。
 */
public class AccNoMethod implements TemplateMethodModelEx {

    @Override
    public Object exec(List arguments) throws TemplateModelException {
        if (arguments.isEmpty()) {
            throw new TemplateModelException("AccNoMethod expects at least one argument.");
        }

        // 获取第一个参数
        Object arg0 = arguments.get(0);
        if (!(arg0 instanceof TemplateScalarModel)) {
            throw new TemplateModelException("The argument must be a scalar (string or number).");
        }
        TemplateScalarModel accNoModel = (TemplateScalarModel) arg0;
        String accNoStr = accNoModel.getAsString();

        String result = "0000"; // 默认值
        if (accNoStr != null && !accNoStr.trim().isEmpty()) {
            try {
                long accNo = Long.parseLong(accNoStr);
                if (accNo > 0) {
                    result = accNoStr;
                }
            } catch (NumberFormatException e) {
                // 抛出异常，让FreeMarker捕获并处理
                throw new TemplateModelException("Argument is not a valid number: " + accNoStr, e);
            }
        }
        // 必须返回一个TemplateModel对象
        return new SimpleScalar(result);
    }
}

<#-- 假设在Java代码中已注册 accNoMethod -->

<#assign accNo1 = 12345>
{ "Account_Number" : "${accNoMethod(accNo1)}" }
<#-- 输出: { "Account_Number" : "12345" } -->

<#assign accNo2 = 0>
{ "Account_Number" : "${accNoMethod(accNo2)}" }
<#-- 输出: { "Account_Number" : "0000" } -->

<#assign accNo3 = -5>
{ "Account_Number" : "${accNoMethod(accNo3)}" }
<#-- 输出: { "Account_Number" : "0000" } -->

<#assign accNo4 = "abc">
{ "Account_Number" : "${accNoMethod(accNo4)}" }
<#-- 这会抛出 TemplateModelException，FreeMarker会将其转换为模板错误 -->

import freemarker.template.Configuration;
import freemarker.template.Version;
import freemarker.template.TemplateExceptionHandler;

public class FreeMarkerConfigurator {

    public static Configuration createFreeMarkerConfiguration() {
        // 创建FreeMarker配置实例，并指定FreeMarker版本
        Configuration cfg = new Configuration(new Version("2.3.31"));

        // 设置模板加载器 (例如，从类路径加载模板)
        cfg.setClassForTemplateLoading(FreeMarkerConfigurator.class, "/templates");

        // 设置默认编码
        cfg.setDefaultEncoding("UTF-8");

        // 设置异常处理器 (开发环境通常设置为HTML_DEBUG_HANDLER，生产环境设置为RETHROW_HANDLER)
        cfg.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER);

        // 注册自定义指令
        cfg.setSharedVariable("accNoDirective", new AccNoDirective());

        // 注册自定义方法
        cfg.setSharedVariable("accNoMethod", new AccNoMethod());

        return cfg;
    }

    // 示例：如何使用配置渲染模板
    /*
    public static void main(String[] args) throws Exception {
        Configuration cfg = createFreeMarkerConfiguration();
        Template template = cfg.getTemplate("my_template.ftl");

        Map<String, Object> data = new HashMap<>();
        data.put("someVariable", "Hello");

        // 渲染模板到控制台
        template.process(data, new OutputStreamWriter(System.out));
    }
    */
}