Freemarker使用--备忘录

╰半夏微凉° 2024-02-18 16:47 54阅读 0赞

## 1 Freemarker ##

### 1.1 什么是freemarker ###

FreeMarker是一个用Java语言编写的模板引擎，它基于模板来生成文本输出。FreeMarker与Web容器无关，即在Web运行时，它并不知道Servlet或HTTP。它不仅可以用作表现层的实现技术，而且还可以用于生成XML，JSP或Java 等。

### 1.2 Freemarker的使用方法 ###

第一步：把freemarker的jar包添加到工程中

第二步：freemarker的运行不依赖web容器，可以在java工程中运行。创建一个测试方法进行测试。

第三步：创建一个Configration对象

第四步：告诉config对象模板文件存放的路径。

第五步：设置config的默认字符集。一般是utf-8

第六步：从config对象中获得模板对象。需要制定一个模板文件的名字。

第七步：创建模板需要的数据集。可以是一个map对象也可以是一个pojo，把模板需要的数据都放入数据集。

第八步：创建一个Writer对象，指定生成的文件保存的路径及文件名。

第九步：调用模板对象的process方法生成静态文件。需要两个参数数据集和writer对象。

第十步：关闭writer对象。

### 1.3 代码实现 ###

<table> 
 <tbody> 
 <tr> 
 <td> public class FreeMarkerTest { &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; @Test &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; public void testFreeMarker() throws Exception { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 第一步：把freemarker的jar包添加到工程中 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 第二步：freemarker的运行不依赖web容器，可以在java工程中运行。创建一个测试方法进行测试。 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 第三步：创建一个Configuration对象 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Configuration configuration = new Configuration(Configuration.getVersion()); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 第四步：告诉config对象模板文件存放的路径。 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; configuration.setDirectoryForTemplateLoading(new File("D:\\workspaces-itcast\\JaveEE18\\taotao-portal\\src\\main\\webapp\\WEB-INF\\ftl")); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 第五步：设置config的默认字符集。一般是utf-8 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; configuration.setDefaultEncoding("utf-8"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 第六步：从config对象中获得模板对象。需要制定一个模板文件的名字。 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Template template = configuration.getTemplate("first.ftl"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 第七步：创建模板需要的数据集。可以是一个map对象也可以是一个pojo，把模板需要的数据都放入数据集。 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Map root = new HashMap&lt;&gt;(); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; root.put("hello", "hello freemarker"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 第八步：创建一个Writer对象，指定生成的文件保存的路径及文件名。 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Writer out = new FileWriter(new File("D:\\temp\\html\\hello.html")); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 第九步：调用模板对象的process方法生成静态文件。需要两个参数数据集和writer对象。 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; template.process(root, out); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 第十步：关闭writer对象。 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; out.flush(); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; out.close(); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; } } </td> 
 </tr> 
 </tbody> 
</table>

模板：

$\{hello\}

### 1.4 Freemarker模板的写法 ###

#### 1.4.1 取简单数据类型数据 ####

使用EL表达式。

$\{hello\}

#### 1.4.2 包装数据类型 ####

模板：

<table> 
 <tbody> 
 <tr> 
 <td> &lt;html&gt; &lt;head&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;title&gt;${title}&lt;/title&gt; &lt;/head&gt; &lt;body&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;label&gt;学号：&lt;/label&gt;${student.id}&lt;br&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;label&gt;姓名：&lt;/label&gt;${student.name}&lt;br&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;label&gt;住址：&lt;/label&gt;${student.address}&lt;br&gt; &lt;/body&gt; &lt;/html&gt; </td> 
 </tr> 
 </tbody> 
</table>

#### 1.4.3 历遍集合/数组 ####

List<Person> persons = newArrayList<Person>();

省略….

页面中内容

<\#list persons as p>

$\{p.id\}/$\{p.name\}

</\#list>

#### 1.4.4 获得当前迭代的索引 ####

List<Person> list = newArrayList<Person>();

获取当前选代的索引:

<\#list persons as p>

$\{p\_index\}

</\#list>

#### 1.4.5 模板中判断条件 ####

<\#if 判断条件>

<\#else>

</\#if>

逻辑运算符（== != || &&）

#### 1.4.6 日期类型格式化 ####

默认格式

1：date

$\{cur\_time?date\}

2：datetime

$\{cur\_time?datetime\}

3：time

$\{cur\_time?time\}

自定义格式

$\{cur\_time?string("yyyy-MM-ddHH:mm:ss")\}

#### 1.4.7 处理null值 ####

root.put(“val”,null);

解决办法

1:null 变空串

$\{val!\} $\{val!"这里是空"\}

2:为Null时给默认值

$\{val!“我是默认值"\}

3、<\#if curdate ??>

当前日期:$\{curdate?string("yyyy/MM/ddHH:mm:ss")\}

<\#else>

curdate属性为null

</\#if>

#### 1.4.8 Include ####

将另一个页面引入本页面时可用以下命令完成

<\#include"/include/head.html">

### 1.5 项目中使用freemarker ###

使用freemarker整合spring。把Configuration交给spring容器管理。

依赖的jar包：

<groupId>org.springframework</groupId>

<artifactId>spring-context-support</artifactId>

<version>4.1.3.RELEASE</version>

</dependency>

<groupId>org.freemarker</groupId>

<artifactId>freemarker</artifactId>

</dependency>

#### 1.5.1 Spring配置文件 ####

<table> 
 <tbody> 
 <tr> 
 <td> &lt;bean id="freemarkerConfig" &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer"&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;property name="templateLoaderPath" value="/WEB-INF/ftl/" /&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;property name="defaultEncoding" value="UTF-8" /&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;/bean&gt; </td> 
 </tr> 
 </tbody> 
</table>

#### 1.5.2 静态文件生成的时机 ####

1、当用户第一次访问时生成静态文件。不推荐使用。

2、当后台添加、编辑商品时生成静态网页。

此时，需要taotao-portal发布服务，供后台系统调用，当后台添加或者修改商品时调用此服务。此时taotao-portal的功能就是生成静态页面。

#### 1.5.3 发布生成页面的服务 ####

1、获得数据的方式还是通过调用rest发布的服务获得数据。

2、生成静态页面。

3、响应生成成功。

#### 1.5.4 Service ####

获得参数：商品id，根据商品id调用rest发布的服务，获得商品数据（商品基本信息、商品描述、商品规格参数），生成静态页面。返回成功。

参数：商品id

返回值：TaotaoResult

<table> 
 <tbody> 
 <tr> 
 <td> @Service public class StaticPageServiceImpl implements StaticPageService { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; @Autowired &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; private ItemService itemService; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; @Autowired &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; private FreeMarkerConfigurer freeMarkerConfigurer; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; @Value("${STATIC_PAGE_PATH}") &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; private String STATIC_PAGE_PATH; &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; @Override &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; public TaotaoResult genItemHtml(Long itemId) throws Exception { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; //商品基本信息 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; TbItem tbItem = itemService.getItemById(itemId); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; //商品描述 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; String itemDesc = itemService.getItemDescById(itemId); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; //规格参数 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; String itemParam = itemService.getItemParamById(itemId); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; //生成静态页面 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Configuration configuration = freeMarkerConfigurer.getConfiguration(); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Template template = configuration.getTemplate("item.ftl"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; //创建一个数据集 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Map root = new HashMap&lt;&gt;(); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; //向数据集中添加属性 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; root.put("item", tbItem); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; root.put("itemDesc", itemDesc); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; root.put("itemParam", itemParam); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; //创建一个Writer对象 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Writer out = new FileWriter(new File(STATIC_PAGE_PATH + itemId + ".html")); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; //生成静态文件 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; template.process(root, out); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; out.flush(); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; out.close(); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; return TaotaoResult.ok(); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; } &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp; } </td> 
 </tr> 
 </tbody> 
</table>

#### 1.5.5 Freemarker模板 ####

#### 1.5.6 Controller ####

接收商品id，调用Service生成静态页面。返回json数据。

参数：商品id

返回值：TaotaoResult

<table> 
 <tbody> 
 <tr> 
 <td> @Controller public class StaticPageController { &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; @Autowired &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; private StaticPageService staticPageService; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; @RequestMapping("/gen/item/{itemId}") &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; @ResponseBody &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; public TaotaoResult genItemPage(@PathVariable Long itemId) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; try { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; TaotaoResult result = staticPageService.genItemHtml(itemId); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; returnresult; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; } catch (Exception e) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; e.printStackTrace(); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; return TaotaoResult.build(500, ExceptionUtil.getStackTrace(e)); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; } &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; } } </td> 
 </tr> 
 </tbody> 
</table>