springboot整合Freemark模板(详尽版)

2024-06-01 05:38
文章标签 java 模板 springboot spring 整合 详尽 freemark

本文主要是介绍springboot整合Freemark模板(详尽版)，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

本篇是SpringBoot项目实战（3）：整合Freemark模板一文的修订版，本文使用示例详细介绍、演示了freemarker常用的语法，以及如何通过freemarker生成纯静态的html。

本文知识点：

  1. springboot如何集成freemarker模板引擎
  2. 详细版：常用的freemarker语法
  3. 特别篇：如何在springboot中通过freemarker生成静态html（纯静态化）

想了解freemarker？没有比这篇文章更详细的了

springboot如何集成freemarker模板引擎

添加依赖

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>

配置属性文件

# 是否允许HttpServletRequest属性覆盖(隐藏)控制器生成的同名模型属性。
spring.freemarker.allow-request-override=false
# 是否允许HttpSession属性覆盖(隐藏)控制器生成的同名模型属性。
spring.freemarker.allow-session-override=false
# 是否启用模板缓存。
spring.freemarker.cache=false
# 模板编码。
spring.freemarker.charset=UTF-8
# 是否检查模板位置是否存在。
spring.freemarker.check-template-location=true
# Content-Type value.
spring.freemarker.content-type=text/html
# 是否启用freemarker
spring.freemarker.enabled=true
# 设定所有request的属性在merge到模板的时候，是否要都添加到model中.
spring.freemarker.expose-request-attributes=false
# 是否在merge模板的时候，将HttpSession属性都添加到model中
spring.freemarker.expose-session-attributes=false
# 设定是否以springMacroRequestContext的形式暴露RequestContext给Spring’s macro library使用
spring.freemarker.expose-spring-macro-helpers=true
# 是否优先从文件系统加载template，以支持热加载，默认为true
spring.freemarker.prefer-file-system-access=true
# 设定模板的后缀.
spring.freemarker.suffix=.ftl
# 设定模板的加载路径，多个以逗号分隔，默认: 
spring.freemarker.template-loader-path=classpath:/templates/
# 设定FreeMarker keys.
spring.freemarker.settings.template_update_delay=0
spring.freemarker.settings.default_encoding=UTF-8
spring.freemarker.settings.classic_compatible=true

编写Controller

@Controller
public class FreemarkController {@RequestMapping("/")public String index(Model model) {return "index";}
}

页面

<!DOCTYPE html> 
<html lang="en"> 
<head> <title>SpringBoot + Freemarker</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> 
</head> 
<body> <h1>Hello boy,</h1><br><p>当前时间：${.now?string("yyyy-MM-dd HH:mm:ss.sss")}</p>
</body> 
</html>

常用的freemarker语法

下面详细介绍在ftl模板中如何使用列表、map、字符串、数字、日期、switch以及macro宏指令等语法。

修改下controller，传递一些需要处理的参数

@RequestMapping("/")
public String index(Model model) {Map map = new LinkedHashMap<>();for (int i = 0; i < 5; i++) {map.put("key" + i, "value" + i);}model.addAttribute("list", Arrays.asList("string1", "string2", "string3", "string4", "string5", "string6"));model.addAttribute("map", map);model.addAttribute("name", "   htTps://wWw.zHyD.mE   ");model.addAttribute("htmlText", "<span style=\"color: red;font-size: 16px;\">html内容</span>");model.addAttribute("num", 123.012);model.addAttribute("null", null);model.addAttribute("dateObj", new Date());model.addAttribute("bol", true);return "index";
}

重写index.ftl

<!DOCTYPE html> 
<html lang="en">
<head><title>Freemarker 语法大全</title><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/><style>html {font-size: 14px;font-weight: 400;}.exp {font-size: 12px;color: lightgray;}</style>
</head>
<body>
<p>当前时间：${.now?string("yyyy-MM-dd HH:mm:ss.sss")}</p>
<dl><dt>list长度：<span class="exp">${list?size}</span></dt><dt>列表</dt><#list list as item><dd>${item }, 索引：${item_index }，hasNext：${item_has_next}</dd></#list><dt>数字遍历</dt><#list 1..3 as item><dd>数字${item}</dd></#list><dt>map</dt><#list map?keys as key><dd>${map[key]}, 索引：${key_index }，hasNext：${key_has_next}</dd></#list>
</dl>
<dl><dt>字符串</dt><dd>普通字符串：<span class="exp">${name}</span></dd><dd>非html编码：<span class="exp">${htmlText}</span></dd><dd>html编码：<span class="exp">${htmlText?html}</span></dd><dd>首字母大写：<span class="exp">${name?cap_first}</span></dd><dd>首字母小写：<span class="exp">${name?uncap_first}</span></dd><dd>全小写：<span class="exp">${name?lower_case}</span></dd><dd>全大写：<span class="exp">${name?upper_case}</span></dd><dd>去除首位空格：<span class="exp">${name?trim}</span></dd><dd>空字符串：<span class="exp">${null?if_exists}</span></dd><dd>是否包含某个字符串：<span class="exp">${name?contains("wWw")?string}</span></dd><dd>默认值：<span class="exp">${null?default("空值默认")}</span></dd><dd>“${name}”字符串长度：<span class="exp">${name?length}</span></dd><dd>定义字符串：<span class="exp">str=码一码<#assign str="码一码"/></span></dd><dd>字符串拼接(1)：<span class="exp">${"字符串拼接 + " + str}</span></dd><dd>字符串拼接(2)：<span class="exp">${"字符串拼接 + ${str}"}</span></dd><dd>字符串截取单个字符(1)：<span class="exp">${str[1]}</span></dd><dd>字符串截取(2)：<span class="exp">${str?substring(1)}</span></dd><dd>字符串截取(3)：<span class="exp">${str?substring(1,2)}</span></dd><dd>indexOf：<span class="exp">${str?index_of("一")}</span></dd><dd>split分割字符串：<span class="exp"><#list "a|b|c"?split("|") as item>${item}</#list></span></dd><dd>if...elseif...else：<span class="exp"><#if null == ''>匹配if显示<#elseif null == '1'>匹配elseif显示<#else>匹配else显示</#if></span></dd>
</dl><dl><dt>switch</dt><dd><#switch str><#case "你好">匹配“你好”<#break ><#case "码一码">匹配“码一码”<#break ><#default>默认匹配</#switch></dd>
</dl><dl><dt>数字</dt><dd>普通数字：<span class="exp">${num}</span></dd><dd>数字类型：<span class="exp">${num?string.number}</span></dd><dd>货币类型：<span class="exp">${num?string.currency}</span></dd><dd>百分比类型：<span class="exp">${num?string.percent}</span></dd><dd>格式化数字：<span class="exp">${num?string("#.###")}</span></dd><dd>取数字的整数部分：<span class="exp">${num?int}</span></dd>
</dl><dl><dt>运算符</dt><dd>不等于：!= <span class="exp">例如：${(1 != 2)?string('1 != 2', '1 == 2')}</span></dd><dd>等于：== <span class="exp">例如：${(1 == 1)?string('1 == 1', '1 != 1')}</span></dd><dd>大于(1)：> <spanclass="exp">例如：${(2 > 1)?string('2 > 1', '2 < 1')}。<strong>注：使用> 时必须加括号，否则可能会被当成普通的标签闭合符号而引起报错</strong></span></dd><dd>大于(2)：gt <span class="exp">例如：${(2 gt 1)?string('2 gt 1', '2 lte 1')}</span></dd><dd>大于等于：gte <span class="exp">例如：${(2 gte 2)?string('2 gte 2', '2 lt 2')}</span></dd><dd>小于(1)：< <spanclass="exp">例如：${(1 < 2)?string('1 < 2', '1 > 2')}。<strong>注：使用< 时必须加括号，否则可能会被当成普通的标签闭合符号而引起报错</strong></span></dd><dd>小于(2)：lt <span class="exp">例如：${(1 lt 2)?string('1 lt 2', '1 gte 2')}</span></dd><dd>小于等于：lte <span class="exp">例如：${(2 lte 2)?string('2 lte 2', '2 gt 2')}</span></dd>
</dl><dl><dt>boolean</dt><dd>普通boolean输出：<span class="exp">${bol}</span></dd><dd>boolean判断输出：<span class="exp">${bol?string('true的时候显示','false的时候显示')}</span></dd>
</dl><dl><dt>日期</dt><dd>${dateObj?date}</dd><dd>${dateObj?time}</dd><dd>${dateObj?string("yyyy-MM-dd HH:mm:ss.SSS")}</dd>
</dl><dl><dt>import</dt><dd><#import "import.ftl" as importObj><p>${importObj.importStr}</p><p>${importObj.importStr1}</p></dd>
</dl><dl><dt>macro宏模板</dt><dd><#macro listMacro title items><p>${title?cap_first}:<ul><#list items as item><li>${item?cap_first}</li></#list></ul><#nested ></#macro></dd><dd><@listMacro items=["item1", "item2", "item3"] title="Items">nested标签表示可以插入自定义的内容</@listMacro></dd>
</dl>include 
<#include "eclipse.ftl">
</body>
</html>

freemarker语法大全

通过freemarker生成静态html

首先需要编写一个可以在普通类中获取到springbean的工具类SpringContextHolder

@Component
public class SpringContextHolder implements ApplicationContextAware {private static ApplicationContext appContext = null;/*** 通过name获取 Bean.** @param name* @return*/public static Object getBean(String name) {return appContext.getBean(name);}/*** 通过class获取Bean.** @param clazz* @param <T>* @return*/public static <T> T getBean(Class<T> clazz) {return appContext.getBean(clazz);}/*** 通过name,以及Clazz返回指定的Bean** @param name* @param clazz* @param <T>* @return*/public static <T> T getBean(String name, Class<T> clazz) {return appContext.getBean(name, clazz);}@Overridepublic void setApplicationContext(ApplicationContext applicationContext) throws BeansException {if (appContext == null) {appContext = applicationContext;}}
}

然后编写一个生成静态html文件的工具类FreemarkerUtil

public class FreemarkerUtil {public static String parseTpl(String viewName, Map<String, Object> params) {Configuration cfg = SpringContextHolder.getBean(Configuration.class);String html = null;Template t = null;try {t = cfg.getTemplate(viewName + ".ftl");html = FreeMarkerTemplateUtils.processTemplateIntoString(t, params);} catch (IOException | TemplateException e) {e.printStackTrace();}return html;}
}

为了方便查看， 添加一个mapping

@RequestMapping("/createHtml")
@ResponseBody
public String createHtml(Model model){Map map = new LinkedHashMap<>();for (int i = 0; i < 5; i++) {map.put("key" + i, "value" + i);}model.addAttribute("list", Arrays.asList("string1", "string2", "string3", "string4", "string5", "string6"));model.addAttribute("map", map);model.addAttribute("name", "   htTps://wWw.zHyD.mE   ");model.addAttribute("htmlText", "<span style=\"color: red;font-size: 16px;\">html内容</span>");model.addAttribute("num", 123.012);model.addAttribute("null", null);model.addAttribute("dateObj", new Date());model.addAttribute("bol", true);return FreemarkerUtil.parseTpl("index", model.asMap());
}

ok，访问/createHtml

freemarker

到此为止，本篇已详细介绍了freemarker的使用方法。

源码：
https://github.com/zhangyd-c/springboot-learning
https://gitee.com/yadong.zhang/springboot

这篇关于springboot整合Freemark模板(详尽版)的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1020130。

相关文章

Java学习手册之Filter和Listener使用方法

Java学习手册之Filter和Listener使用方法

《Java学习手册之Filter和Listener使用方法》：本文主要介绍Java学习手册之Filter和Listener使用方法的相关资料,Filter是一种拦截器,可以在请求到达Servl... 目录一、Filter（过滤器）1. Filter 的工作原理2. Filter 的配置与使用二、Listen
阅读更多...
Spring Boot中JSON数值溢出问题从报错到优雅解决办法

Spring Boot中JSON数值溢出问题从报错到优雅解决办法

《SpringBoot中JSON数值溢出问题从报错到优雅解决办法》：本文主要介绍SpringBoot中JSON数值溢出问题从报错到优雅的解决办法,通过修改字段类型为Long、添加全局异常处理和... 目录一、问题背景：为什么我的接口突然报错了？二、为什么会发生这个错误？1. Java 数据类型的“容量”限制
阅读更多...
Java对象转换的实现方式汇总

Java对象转换的实现方式汇总

《Java对象转换的实现方式汇总》：本文主要介绍Java对象转换的多种实现方式,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录Java对象转换的多种实现方式1. 手动映射（Manual Mapping）2. Builder模式3. 工具类辅助映
阅读更多...
SpringBoot请求参数接收控制指南分享

SpringBoot请求参数接收控制指南分享

《SpringBoot请求参数接收控制指南分享》：本文主要介绍SpringBoot请求参数接收控制指南,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录Spring Boot 请求参数接收控制指南1. 概述2. 有注解时参数接收方式对比3. 无注解时接收参数默认位置
阅读更多...
SpringBoot基于配置实现短信服务策略的动态切换

SpringBoot基于配置实现短信服务策略的动态切换

《SpringBoot基于配置实现短信服务策略的动态切换》这篇文章主要为大家详细介绍了SpringBoot在接入多个短信服务商（如阿里云、腾讯云、华为云）后,如何根据配置或环境切换使用不同的服务商,需... 目录目标功能示例配置（application.yml）配置类绑定短信发送策略接口示例：阿里云 & 腾
阅读更多...
SpringBoot项目中报错The field screenShot exceeds its maximum permitted size of 1048576 bytes.的问题及解决

SpringBoot项目中报错The field screenShot exceeds its maximum permitted size of 1048576 bytes.的问题及解决

《SpringBoot项目中报错ThefieldscreenShotexceedsitsmaximumpermittedsizeof1048576bytes.的问题及解决》这篇文章... 目录项目场景问题描述原因分析解决方案总结项目场景javascript提示：项目相关背景：项目场景：基于Spring
阅读更多...
Spring Boot 整合 SSE的高级实践(Server-Sent Events)

Spring Boot 整合 SSE的高级实践(Server-Sent Events)

《SpringBoot整合SSE的高级实践(Server-SentEvents)》SSE（Server-SentEvents）是一种基于HTTP协议的单向通信机制,允许服务器向浏览器持续发送实... 目录1、简述2、Spring Boot 中的SSE实现2.1 添加依赖2.2 实现后端接口2.3 配置超时时
阅读更多...
Spring Boot读取配置文件的五种方式小结

Spring Boot读取配置文件的五种方式小结

《SpringBoot读取配置文件的五种方式小结》SpringBoot提供了灵活多样的方式来读取配置文件,这篇文章为大家介绍了5种常见的读取方式,文中的示例代码简洁易懂,大家可以根据自己的需要进... 目录1. 配置文件位置与加载顺序2. 读取配置文件的方式汇总方式一：使用 @Value 注解读取配置方式二
阅读更多...
一文详解Java异常处理你都了解哪些知识

一文详解Java异常处理你都了解哪些知识

《一文详解Java异常处理你都了解哪些知识》：本文主要介绍Java异常处理的相关资料,包括异常的分类、捕获和处理异常的语法、常见的异常类型以及自定义异常的实现,文中通过代码介绍的非常详细,需要的朋... 目录前言一、什么是异常二、异常的分类2.1 受检异常2.2 非受检异常三、异常处理的语法3.1 try-
阅读更多...
Java中的@SneakyThrows注解用法详解

Java中的@SneakyThrows注解用法详解

《Java中的@SneakyThrows注解用法详解》：本文主要介绍Java中的@SneakyThrows注解用法的相关资料,Lombok的@SneakyThrows注解简化了Java方法中的异常... 目录前言一、@SneakyThrows 简介1.1 什么是 Lombok？二、@SneakyThrows
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2