FreeMarker动态模板

前言

当我们开发功能时,不仅要考虑当前,也要考虑之后的迭代.

对于邮件正文内容,有时候需要配置HTML格式,所以选择了FreeMarker

准备工作

  • FreeMarker的依赖
        <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-starter-freemarker</artifactId>

        </dependency>
  • 其余Spring相关依赖
        <dependency>

            <groupId>org.projectlombok</groupId>

            <artifactId>lombok</artifactId>

            <optional>true</optional>

        </dependency>

        <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-starter-web</artifactId>

        </dependency>

FreeMarker

官方文档 http://freemarker.foofun.cn/

最简单的模板通常是普通的HTML文件,当然也可以用来写word,pdf之类

对于FreeMarker的模板语言,和动态sql有些相似

既然是动态模板,那么是要传入数据的

http://freemarker.foofun.cn/dgui_datamodel_types.html

常用的传参类型有List,Map,自定义对象 在上方的官方文档中你可以查看支持的全部类型

代码构建

项目结构

创建 Configuration 实例

参考官方文档中步骤 http://freemarker.foofun.cn/pgui_quickstart.html

package com.lizi.util;

import freemarker.template.Configuration;

import freemarker.template.Template;

import lombok.extern.slf4j.Slf4j;

import org.springframework.stereotype.Component;

import org.springframework.ui.freemarker.FreeMarkerTemplateUtils;

import javax.annotation.PostConstruct;

import java.util.Locale;

/**

 * @author lizi

 * @description FreeMarkerUtil

 * @date 2022/01/01

 */

@Component

@Slf4j

public class FreeMarkerUtil {

    private static Configuration configuration = null;

    @PostConstruct

    public void init() {

        if (null == configuration) {

            // 设置版本号

            configuration = new Configuration(Configuration.VERSION_2_3_23);

            // ”/template“为模板文件来源

            configuration.setClassForTemplateLoading(FreeMarkerTemplateUtils.class, "/template");

            // 设置编码格式

            configuration.setEncoding(Locale.CHINA, "UTF-8");

        }

    }

    /**

     * @param file template文件路径

     * @param data 数据

     * @return String

     */

    public static String getResult(String file, Object data) {

        String result = "";

        try {

            // 获取通用模板

            Template template = configuration.getTemplate(file);

            // 通过模板创建动态数据

            result = FreeMarkerTemplateUtils.processTemplateIntoString(template, data);

        } catch (Exception e) {

            log.error("processTemplateIntoString error : {} ", e.getMessage());

        }

        return result;

    }

}

调用

package com.lizi.controller;

import com.lizi.Entity.Pokemon;

import com.lizi.util.FreeMarkerUtil;

import org.springframework.web.bind.annotation.PostMapping;

import org.springframework.web.bind.annotation.RestController;

import java.util.HashMap;

import java.util.Map;

/**

 * @author lizi

 * @description FreeMarkerController

 * @date 2022/01/01

 */

@RestController

public class FreeMarkerController {

    @PostMapping("/getTemplate")

    public String getTemplate() {

        // 创建数据模型

        Map<String, Object> dataMap = new HashMap<>(16);

        Map<String, Object> map = new HashMap<>(16);

        map.put("珍珠", "pearl");

        map.put("钻石", "diamond");

        Pokemon pokemon=new Pokemon();

        pokemon.setName("ground_dragon");

        pokemon.setRace("108,130,95,80,85,102");

        dataMap.put("strong",pokemon);

        dataMap.put("pokemon", map);

        dataMap.put("ground_dragon","108,130,95,80,85,102");

        return FreeMarkerUtil.getResult("template.ftl", dataMap);

    }

}

模板文件

对于模板语言,可以更多的去参考官方文档,

<html>

<#-- 传入类型是Map  ${ground_dragon} 表示对Map.get("ground_dragon") -->

<td>${ground_dragon}</td>

<#-- 我传入的类型是Map 这里pokemon 表示Map.get("pokemon")之后获取的value 代码中也是一个Map -->

<#if pokemon?exists>

<#--  list,表示遍历  -->

    <#list pokemon?keys as key>

        <tr>

            <td>${key}</td>

            <td>${pokemon[key]}</td>

        </tr>

    </#list>

</#if>

<#-- Map.get("strong") 是一个自定义类 访问属性可以直接用.的方式获取 -->

<td>${strong.name}</td>

<td>${strong.race}</td>

</body>

</html>

调用结果

<html>

<td>108,130,95,80,85,102</td>

        <tr>

            <td>钻石</td>

            <td>diamond</td>

        </tr>

        <tr>

            <td>珍珠</td>

            <td>pearl</td>

        </tr>

<td>ground_dragon</td>

<td>108,130,95,80,85,102</td>

</body>

</html>

Tips

  1. 对于传入的数据模型,需要用Map做一层包装,不然会出错
  2. 如果对象可能不存在,需要做一层判断,不然会出错

使用FreeMarker配置动态模板的更多相关文章

  1. vert.x学习（六），动态模板与静态文件的结合

    这篇学习在动态模板里面引入css,把动态模板与静态文件结合起来使用. 编写DynamicReference.java package com.javafm.vertx.helloworld; impo ...

  2. SpringBoot下配置FreeMarker配置远程模版

    需求产生原因 要求在同一个接口中,根据不同的参数,返回不同的视图结果 所有的视图中的数据基本一致 要求页面能静态化,优化SEO 例如:A接口返回客户的信息 客户A在调用接口时,返回其个性化定制的页面A ...

  3. 如何通过Spring Boot配置动态数据源访问多个数据库

    之前写过一篇博客<Spring+Mybatis+Mysql搭建分布式数据库访问框架>描述如何通过Spring+Mybatis配置动态数据源访问多个数据库.但是之前的方案有一些限制(原博客中 ...

  4. 使用freemarker生成xml模板

    今天在java交流群里有个人问我如何用freemarker生成xml模板文件,可以手动配置参数,于是我到网上百度了一下.发现有一位同行的博文写的很nice,于是我就照着他的代码敲了一遍,最后实现了,本 ...

  5. 迷你MVVM框架 avalonjs 沉思录 第3节 动态模板

    模板的发明是编程史上的一大里程碑,让我们摆脱了烦锁且易出错的字符串拼接,维护性大大提高. 都在JSP,ASP时代,人们已经学会使用include等语句,将多个页面片断拼接成一个页面. 此外,为了将数据 ...

  6. FreeMarker之根据模板生成Java代码

    FreeMarker根据模板生成Java代码,光这句话,大家想必也知道它的应用了,比如流行的DRY原则,该原则的意思,可简单概述为"不要写重复的代码". 比如Java中三层架构,数 ...

  7. spark写入ES(动态模板）

    使用es-hadoop插件,主要使用elasticsearch-spark-20_2.11-6.2.x.jar 官网:https://www.elastic.co/guide/en/elasticse ...

  8. SpringBoot整合MyBatisPlus配置动态数据源

    目录 SpringBoot整合MyBatisPlus配置动态数据源 SpringBoot整合MyBatisPlus配置动态数据源 推文:2018开源中国最受欢迎的中国软件MyBatis-Plus My ...

  9. Logstash动态模板映射收集Nginx的Json格式日志

    Logstash传输给ES的数据会自动映射为5索引,5备份,字段都为text的的索引.这样基本上无法进行数据分析.所以必须将Logstash的数据按照既定的格式存储在ES中,这时候就要使用到ES模板技 ...

随机推荐

  1. 题解 洛谷 P2388 阶乘之乘

    目录 简要题意 题解 主要思路 一个 \(\omega(n)\) 的算法 一个 \(O(\log n)\) 的算法 一个算法 代码 算法 \(1\)(\(\omega(n)\)) 算法 \(2\) 算 ...

  2. placeholder 设置换行三种方式

    在 html 中编写代码时保留代码换行 <textarea name="" id="" cols="30" rows="10 ...

  3. [LNOI2022]盒

    \(LNOI2022\)盒 由于是加的形式,那么可以套路的拆贡献,枚举每条边的贡献就好了 \(40pts\) //比较显然的事情 //首先确定了一个B数组之后 //最小的移动应该是 //设左右两侧比原 ...

  4. 数据平台调度升级改造 | 从Azkaban 平滑过度到 Apache DolphinScheduler 的操作实践

    Fordeal的数据平台调度系统之前是基于Azkaban进行二次开发的,但是在用户层面.技术层面都存在一些痛点问题难以被解决.比如在用户层面缺少任务可视化编辑界面.补数等必要功能,导致用户上手难体验差 ...

  5. Apache DolphinScheduler 使用文档（8/8）：附录

    本文章经授权转载,原文链接: https://blog.csdn.net/MiaoSO/article/details/104770720 目录 附录.队列管理 附录.令牌管理 附录.队列管理 Q : ...

  6. Windows 电脑杀毒简单有效的方式

    Windows 电脑杀毒通常会选择杀毒软件,这样太笨重,且容易占内存和存在流氓软件侵入. 推荐使用 Windows 自带的恶意软件删除工具 按住 Win + R 键,弹出运行窗口,输入 mrt. 系统 ...

  7. 百亿数据百亿花, 库若恒河沙复沙,Go lang1.18入门精炼教程，由白丁入鸿儒，Go lang数据库操作实践EP12

    Golang可以通过Gorm包来操作数据库,所谓ORM,即Object Relational Mapping(数据关系映射),说白了就是通过模式化的语法来操作数据库的行对象或者表对象,对比相对灵活繁复 ...

  8. 刷题记录：Codeforces Round #731 (Div. 3)

    Codeforces Round #731 (Div. 3) 20210803.网址:https://codeforces.com/contest/1547. 感觉这次犯的低级错误有亿点多-- A 一 ...

  9. [CF1526D] Kill Anton（逆序对，搜索）

    题面 A N T O N \rm ANTON ANTON 的基因由 A , N , T , O \rm A,N,T,O A,N,T,O 四种碱基排列组成. A N T O N \rm ANTON AN ...

  10. [HNOI2010]弹飞绵羊 （平衡树，LCT动态树）

    题面 题解 因为每个点都只能向后跳到一个唯一的点,但可能不止一个点能跳到后面的某个相同的点, 所以我们把它抽象成一个森林.(思考:为什么是森林而不是树?) 子节点可以跳到父节点,根节点再跳就跳飞了. ...