FreeMarker注入静态方法，以及在IDEA中获取代码编写提示

前言

1. springbootWeb项目
2. 项目中引入的Hutool5.8.x版本工具类。

FreeMarker注入全局变量

@Slf4j
public class FreemarkerConfig {

    public static void init() {

        Configuration c = SpringUtil.getBean(Configuration.class);
        BeansWrapperBuilder beansWrapperBuilder = new BeansWrapperBuilder(c.getIncompatibleImprovements());
        BeansWrapper wrapper = beansWrapperBuilder.build();
        TemplateHashModel staticModels = wrapper.getStaticModels();
        try {
            TemplateHashModel dateUtil = (TemplateHashModel) staticModels.get(DateUtil.class.getName());
            c.setSharedVariable("dateUtil", dateUtil);
            // 默认输出,如果无小数点即是整数，有 小数点则显示小数点。
            c.setNumberFormat("#.########");
            // 定义数字格式，在页面中使用   <#setting number_format="#"> 标签来指定数字格式化
            // 或者这种写法，写法  ${x?string.@amt}可指定此格式输出，
            c.setCustomNumberFormats(MapUtil.of("amt", AmtTemplateNumberFormatFactory.INSTANCE));
            c.setDateTimeFormat(DatePattern.NORM_DATETIME_PATTERN);
            c.setDateFormat(DatePattern.NORM_DATE_PATTERN);
            c.setTimeFormat(DatePattern.NORM_TIME_PATTERN);
            c.setTemplateExceptionHandler(TemplateExceptionHandler.IGNORE_HANDLER);
        } catch (Exception e) {
            log.error("FreeMarker全局变量注入失败!", e);
        }
    }
}

自定义数字格式化

AmtTemplateNumberFormatFactory.java

public class AmtTemplateNumberFormatFactory extends TemplateNumberFormatFactory {

    public static final AmtTemplateNumberFormatFactory INSTANCE
            = new AmtTemplateNumberFormatFactory();

    private AmtTemplateNumberFormatFactory() {
    }

    @Override
    public TemplateNumberFormat get(String params, Locale locale, Environment env)
            throws InvalidFormatParametersException {
        TemplateFormatUtil.checkHasNoParameters(params);
        return HexTemplateNumberFormat.INSTANCE;
    }

    private static class HexTemplateNumberFormat extends TemplateNumberFormat {

        private static final HexTemplateNumberFormat INSTANCE = new HexTemplateNumberFormat();

        private HexTemplateNumberFormat() {
        }

        @Override
        public String formatToPlainText(TemplateNumberModel numberModel)
                throws UnformattableValueException, TemplateModelException {
            Number n = TemplateFormatUtil.getNonNullNumber(numberModel);
            try {
                return cn.hutool.core.util.NumberUtil.decimalFormat("#.00####", n);
            } catch (ArithmeticException e) {
                throw new UnformattableValueException(n + " 不适合金额");
            }
        }

        @Override
        public boolean isLocaleBound() {
            return false;
        }

        @Override
        public String getDescription() {
            return "金额格式化";
        }

    }

}

IDEA中获取代码编写提示

在templates文件夹下新建freemarker_implicit.ftl文件

[#ftl]
[#-- @implicitly included --]
[#-- @ftlvariable name="dateUtil" type="cn.hutool.core.date.DateUtil.static" --]
[#--说明，此文件主要用于IDEA代码提示，存在或不存在不影响实际功能--]

新建项目启动后执行钩子让配置生效

新建PostRunner.java文件

/**
 * 项目启动后执行方法顺序
 * --@PostConstruct > InitializingBean > ApplicationRunner > CommandLineRunner
 */

@Component
public class PostRunner implements CommandLineRunner {

    @Override
    public void run(String... args) {
        FreemarkerConfig.init();
    }
}