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. vscode 个人配置 settings.json

    {     "workbench.colorTheme": "Default Dark+",     "workbench.iconTheme&quo ...

  2. k8s QoS与pod驱逐

    概述 QoS是Quality of Service的缩写,即服务质量.每个pod属于某一个QoS分类,而Kubernetes会根据pod的QoS级别来决定pod的调度.抢占调度和驱逐优先级,而且pod ...

  3. JVM内存模型和结构详解(五大模型图解)

    JVM内存模型和Java内存模型都是面试的热点问题,名字看感觉都差不多,实际上他们之间差别还是挺大的. 通俗点说,JVM内存结构是与JVM的内部存储结构相关,而Java内存模型是与多线程编程相关@mi ...

  4. selenium基本用法

    一.元素操作 send_keys:赋值 clear:清空 click:点击 from selenium import webdriver from selenium.webdriver.common. ...

  5. Spring Boot部署方法

    Spring Boot部署方法     网上搜到的部署方法无非是打成jar包,然后shell执行nohup java调用jar命令,或者是打成war包然后部署到tomcat或者jetty容器上面. S ...

  6. Magicodes.Pay已支持Volo Abp

    Magicodes.Pay已支持Volo Abp 简介 Magicodes.Pay希望打造一个统一支付库,相关库均使用.NET标准库编写,支持.NET Framework以及.NET Core.目前已 ...

  7. Vue 内联样式

    前置说明 Vue 绑定HTML 全局属性style,可以动态地改变属性值.这里就不讲内联样式的基础了,具体轻查看官网文档 Class 与 Style 绑定. 主要分为以下两个步骤进行: v-bind ...

  8. systemd之导致内核 crash

    本文主要讲解linux kernel panic系列其中一种情况: Attempted to kill init! exitcode=0x0000000b 背景:linux kernel 的panic ...

  9. Java开发学习(二十八)----拦截器（Interceptor）详细解析

    一.拦截器概念 讲解拦截器的概念之前,我们先看一张图: (1)浏览器发送一个请求会先到Tomcat的web服务器 (2)Tomcat服务器接收到请求以后,会去判断请求的是静态资源还是动态资源 (3)如 ...

  10. 第六十二篇：Vue的双向绑定与按键修饰符

    好家伙,依旧是vue的基础 1.按键修饰符 假设我们在一个<input>框中输入了12345,我们希望按一下"Esc" 然后删除所有前面输入的内容,这时候,我们会用到按 ...