模板引擎FreeMarker

2021-12-17 10:01:46 阅读：170 来源： 互联网

标签：stu2 stu1 FreeMarker freemarker stu 引擎模板 name

1 freemarker 介绍

FreeMarker 是一款模板引擎：即一种基于模板和要改变的数据，并用来生成输出文本(HTML网页，电子邮件，配置文件，源代码等)的通用工具。它不是面向最终用户的，而是一个Java类库，是一款程序员可以嵌入他们所开发产品的组件。

模板编写为FreeMarker Template Language (FTL)。它是简单的，专用的语言，不是像PHP那样成熟的编程语言。那就意味着要准备数据在真实编程语言中来显示，比如数据库查询和业务运算，之后模板显示已经准备好的数据。在模板中，你可以专注于如何展现数据，而在模板之外可以专注于要展示什么数据。
在这里插入图片描述
常用的java模板引擎还有哪些？

Jsp、Freemarker、Thymeleaf 、Velocity 等。
在这里插入图片描述

2 环境搭建&&快速入门

freemarker作为springmvc一种视图格式，默认情况下SpringMVC支持freemarker视图格式。

需要创建Spring Boot+Freemarker工程用于测试模板。

2.1创建测试工程

创建一个freemarker-demo 的测试工程专门用于freemarker的功能测试与模板的测试。

pom.xml如下

  <?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <parent>
            <artifactId>freemarker-test</artifactId>
            <groupId>com.test</groupId>
            <version>1.0-SNAPSHOT</version>
        </parent>
        <modelVersion>4.0.0</modelVersion>
    
        <artifactId>freemarker-demo</artifactId>
    
        <properties>
            <maven.compiler.source>8</maven.compiler.source>
            <maven.compiler.target>8</maven.compiler.target>
        </properties>
    
        <dependencies>
            <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>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
            </dependency>
            <!-- lombok -->
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
            </dependency>
    
            <!-- apache 对 java io 的封装工具库 -->
            <dependency>
                <groupId>org.apache.commons</groupId>
                <artifactId>commons-io</artifactId>
                <version>1.3.2</version>
            </dependency>
        </dependencies>
    
    </project>

2.2 配置文件

配置application.yml

   server:
      port: 8881 #服务端口
    spring:
      application:
        name: freemarker-demo #指定服务名
      freemarker:
        cache: false  #关闭模板缓存，方便测试
        settings:
          template_update_delay: 0 #检查模板更新延迟时间，设置为0表示立即检查，如果时间大于0会有缓存不方便进行模板测试
        suffix: .ftl               #指定Freemarker模板文件的后缀名

在这里插入图片描述

2.3创建模型类

在freemarker的测试工程下创建模型类型用于测试

package com.test.freemarker.entity;

import lombok.Data;

import java.util.Date;

@Data
public class Student {
    private String name;//姓名
    private int age;//年龄
    private Date birthday;//生日
    private Float money;//钱包
}

2.4 创建模板

在resources下创建templates，此目录为freemarker的默认模板存放目录。

在templates下创建模板文件 01-basic.ftl ，模板中的插值表达式最终会被freemarker替换成具体的数据。

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>Hello World!</title>
</head>
<body>
<b>普通文本 String 展示：</b><br><br>
Hello ${name} <br>
<hr>
<b>对象Student中的数据展示：</b><br/>
姓名：${stu.name}<br/>
年龄：${stu.age}
<hr>
</body>
</html>

在这里插入图片描述

2.5 创建controller

创建Controller类，向Map中添加name，最后返回模板文件。

  package com.xuecheng.test.freemarker.controller;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.client.RestTemplate;
    
    import java.util.Map;
    
    @Controller
    public class HelloController {
    
        @GetMapping("/basic")
        public String test(Model model) {
    
            //1.纯文本形式的参数
            model.addAttribute("name", "freemarker");
            //2.实体类相关的参数
            
            Student student = new Student();
            student.setName("小明");
            student.setAge(18);
            model.addAttribute("stu", student);
    
            return "01-basic";
        }
    }

01-basic.ftl，使用插值表达式填充数据

  <!DOCTYPE html>
    <html>
    <head>
        <meta charset="utf-8">
        <title>Hello World!</title>
    </head>
    <body>
    <b>普通文本 String 展示：</b><br><br>
    Hello ${name} <br>
    <hr>
    <b>对象Student中的数据展示：</b><br/>
    姓名：${stu.name}<br/>
    年龄：${stu.age}
    <hr>
    </body>
    </html>

在这里插入图片描述

2.6创建启动类

package com.test.freemarker;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class FreemarkerDemotApplication {
    public static void main(String[] args) {
        SpringApplication.run(FreemarkerDemotApplication.class,args);
    }
}

2.7 测试

请求：http://localhost:8881/basic
在这里插入图片描述

3. freemarker基础

3.1 基础语法种类

1、注释，即<#-- -->，介于其之间的内容会被freemarker忽略

<#--我是一个freemarker注释-->

2、插值（Interpolation）：即 ${..} 部分,freemarker会用真实的值代替${..}

  Hello ${name}

3、FTL指令：和HTML标记类似，名字前加#予以区分，Freemarker会解析标签中的表达式或逻辑。

<# >FTL指令</#>

4、文本，仅文本信息，这些不是freemarker的注释、插值、FTL指令的内容会被freemarker忽略解析，直接输出内容。

  注释：
    <#--不能被看到--> 发布之后，客户端看不到内容
    <!--看到你了哦--> 发布之后，客户端可以看到内容

3.2 集合指令（List和Map）

1、数据模型：

在HelloController中新增如下方法：

@GetMapping("/list")
public String list(Model model){

    //------------------------------------
    Student stu1 = new Student();
    stu1.setName("小强");
    stu1.setAge(18);
    stu1.setMoney(1000.86f);
    stu1.setBirthday(new Date());

    //小红对象模型数据
    Student stu2 = new Student();
    stu2.setName("小红");
    stu2.setMoney(200.1f);
    stu2.setAge(19);

    //将两个对象模型数据存放到List集合中
    List<Student> stus = new ArrayList<>();
    stus.add(stu1);
    stus.add(stu2);

    //向model中存放List集合数据
    model.addAttribute("stus",stus);

    //------------------------------------

    //创建Map数据
    HashMap<String,Student> stuMap = new HashMap<>();
    stuMap.put("stu1",stu1);
    stuMap.put("stu2",stu2);
    // 3.1 向model中存放Map数据
    model.addAttribute("stuMap", stuMap);

    return "02-list";
}

2、模板：

在templates中新增02-list.ftl文件

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>Hello World!</title>
</head>
<body>
    
<#-- list 数据的展示 -->
<b>展示list中的stu数据:</b>
<br>
<br>
<table>
    <tr>
        <td>序号</td>
        <td>姓名</td>
        <td>年龄</td>
        <td>钱包</td>
    </tr>
</table>
<hr>
    
<#-- Map 数据的展示 -->
<b>map数据的展示：</b>
<br/><br/>
<a href="###">方式一：通过map['keyname'].property</a><br/>
输出stu1的学生信息：<br/>
姓名：<br/>
年龄：<br/>
<br/>
<a href="###">方式二：通过map.keyname.property</a><br/>
输出stu2的学生信息：<br/>
姓名：<br/>
年龄：<br/>

<br/>
<a href="###">遍历map中两个学生信息：</a><br/>
<table>
    <tr>
        <td>序号</td>
        <td>姓名</td>
        <td>年龄</td>
        <td>钱包</td> 
    </tr>
</table>
<hr>
 
</body>
</html>

List指令格式：
在这里插入图片描述

   # ${k_index}：得到循环的下标，使用方法是在stu后边加"_index"，它的值是从0开始

Map指令格式：
在这里插入图片描述
实例代码：

   <!DOCTYPE html>
    <html>
    <head>
        <meta charset="utf-8">
        <title>Hello World!</title>
    </head>
    <body>
        
    <#-- list 数据的展示 -->
    <b>展示list中的stu数据:</b>
    <br>
    <br>
    <table>
        <tr>
            <td>序号</td>
            <td>姓名</td>
            <td>年龄</td>
            <td>钱包</td>
        </tr>
        <#list stus as stu>
            <tr>
                <td>${stu_index+1}</td>
                <td>${stu.name}</td>
                <td>${stu.age}</td>
                <td>${stu.money}</td>
            </tr>
        </#list>
    
    </table>
    <hr>
        
    <#-- Map 数据的展示 -->
    <b>map数据的展示：</b>
    <br/><br/>
    <a href="###">方式一：通过map['keyname'].property</a><br/>
    输出stu1的学生信息：<br/>
    姓名：${stuMap['stu1'].name}<br/>
    年龄：${stuMap['stu1'].age}<br/>
    <br/>
    <a href="###">方式二：通过map.keyname.property</a><br/>
    输出stu2的学生信息：<br/>
    姓名：${stuMap.stu2.name}<br/>
    年龄：${stuMap.stu2.age}<br/>
    
    <br/>
    <a href="###">遍历map中两个学生信息：</a><br/>
    <table>
        <tr>
            <td>序号</td>
            <td>姓名</td>
            <td>年龄</td>
            <td>钱包</td>
        </tr>
        <#list stuMap?keys as key >
            <tr>
                <td>${key_index + 1}</td>
                <td>${stuMap[key].name}</td>
                <td>${stuMap[key].age}</td>
                <td>${stuMap[key].money}</td>
            </tr>
        </#list>
    </table>
    <hr>
     
    </body>
    </html>

3.3 if指令

if 指令即判断指令，是常用的FTL指令，freemarker在解析时遇到if会进行判断，条件为真则输出if中间的内容，否则跳过内容不再输出。
在这里插入图片描述
1、数据模型：

使用list指令中测试数据模型，判断名称为小红的数据字体显示为红色。

2、模板：

<table>
    <tr>
        <td>姓名</td>
        <td>年龄</td>
        <td>钱包</td>
    </tr>
    <#list stus as stu>
        <tr>
            <td >${stu.name}</td>
            <td>${stu.age}</td>
            <td >${stu.mondy}</td>
        </tr>
    </#list>

</table>

实例代码：

#在freemarker中，判断是否相等，=与==是一样的

  <table>
        <tr>
            <td>姓名</td>
            <td>年龄</td>
            <td>钱包</td>
        </tr>
        <#list stus as stu >
            <#if stu.name='小红'>
                <tr style="color: red">
                    <td>${stu_index}</td>
                    <td>${stu.name}</td>
                    <td>${stu.age}</td>
                    <td>${stu.money}</td>
                </tr>
                <#else >
                <tr>
                    <td>${stu_index}</td>
                    <td>${stu.name}</td>
                    <td>${stu.age}</td>
                    <td>${stu.money}</td>
                </tr>
            </#if>
        </#list>
    </table>

3、输出：

姓名为“小强”则字体颜色显示为红色。
在这里插入图片描述

3.4 运算符

1、算数运算符

FreeMarker表达式中完全支持算术运算,FreeMarker支持的算术运算符包括:

加法： +
减法： -
乘法： *
除法： /
求模 (求余)： %

模板代码

<b>算数运算符</b>
<br/><br/>
    100+5 运算：  ${100 + 5 }<br/>
    100 - 5 * 5运算：${100 - 5 * 5}<br/>
    5 / 2运算：${5 / 2}<br/>
    12 % 10运算：${12 % 10}<br/>
<hr>

除了 + 运算以外，其他的运算只能和 number 数字类型的计算。

2、比较运算符
在这里插入图片描述
= 和 == 模板代码

   <!DOCTYPE html>
    <html>
    <head>
        <meta charset="utf-8">
        <title>Hello World!</title>
    </head>
    <body>
    
        <b>比较运算符</b>
        <br/>
        <br/>
    
        <dl>
            <dt> =/== 和 != 比较：</dt>
            <dd>
                <#if "xiaoming" == "xiaoming">
                    字符串的比较 "xiaoming" == "xiaoming"
                </#if>
            </dd>
            <dd>
                <#if 10 != 100>
                    数值的比较 10 != 100
                </#if>
            </dd>
        </dl>
    
        <dl>
            <dt>其他比较</dt>
            <dd>
                <#if 10 gt 5 >
                    形式一：使用特殊字符比较数值 10 gt 5
                </#if>
            </dd>
        </dl>
    
        <br/>
    <hr>
    </body>
    </html>

Controller 的数据模型代码

 @GetMapping("operation")
    public String testOperation(Model model) {
        //构建 Date 数据
        Date now = new Date();
        model.addAttribute("date1", now);
        model.addAttribute("date2", now);
        
        return "03-operation";
    }

3、逻辑运算符

逻辑与:&&
逻辑或:||
逻辑非:!

逻辑运算符只能作用于布尔值,否则将产生错误。

模板代码

<b>逻辑运算符</b>
    <br/>
    <br/>
    <#if (10 lt 12 )&&( 10  gt  5 )  >
        (10 lt 12 )&&( 10  gt  5 )  显示为 true
    </#if>
    <br/>
    <br/>
    <#if !false>
        false 取反为true
    </#if>
<hr>

3.5 空值处理

1、判断某变量是否存在使用 “??”

用法为:variable??,如果该变量存在,返回true,否则返回false

例：为防止stus为空报错可以加上判断如下：

  <#if stus??>
        <#list stus as stu>
        ......
        </#list>
    </#if>

2、缺失变量默认值使用 “!”

使用!要以指定一个默认值，当变量为空时显示默认值
例： ${name!’’}表示如果name为空显示空字符串。
如果是嵌套对象则建议使用（）括起来
例： ${(stu.bestFriend.name)!’’}表示，如果stu或bestFriend或name为空默认显示空字符串。

3.6 内建函数

内建函数语法格式： 变量+?+函数名称

1、集合的大小

${集合名?size}

2、日期格式化

显示年月日: ${today?date}

显示时分秒：${today?time}

显示日期+时间：${today?datetime}

自定义格式化： ${today?string("yyyy年MM月")}

3、内建函数c

model.addAttribute(“point”, 102920122);

point是数字型，使用${point}会显示这个数字的值，每三位使用逗号分隔。

如果不想显示为每三位分隔的数字，可以使用c函数将数字型转成字符串输出

${point?c}

4、将json字符串转成对象

一个例子：

其中用到了 assign标签，assign的作用是定义一个变量。

  <#assign text="{'bank':'工商银行','account':'10101920201920212'}" />
    <#assign data=text?eval />
    开户行：${data.bank}  账号：${data.account}

内建函数模板页面：

   <!DOCTYPE html>
    <html>
    <head>
        <meta charset="utf-8">
        <title>inner Function</title>
    </head>
    <body>
    
        <b>获得集合大小</b><br>
    
        集合大小：${stus?size}
        <hr>
    
    
        <b>获得日期</b><br>
    
        显示年月日: ${today?date}       <br>
    
        显示时分秒：${today?time}<br>
    
        显示日期+时间：${today?datetime}<br>
    
        自定义格式化：  ${today?string("yyyy年MM月")}<br>
    
        <hr>
    
        <b>内建函数C</b><br>
        没有C函数显示的数值：${point} <br>
    
        有C函数显示的数值：${point?c}
    
        <hr>
    
        <b>声明变量assign</b><br>
        <#assign text="{'bank':'工商银行','account':'10101920201920212'}" />
        <#assign data=text?eval />
        开户行：${data.bank}  账号：${data.account}
    
    <hr>
    </body>
    </html>

内建函数Controller数据模型：

   @GetMapping("innerFunc")
    public String testInnerFunc(Model model) {
        //1.1 小强对象模型数据
        Student stu1 = new Student();
        stu1.setName("小强");
        stu1.setAge(18);
        stu1.setMoney(1000.86f);
        stu1.setBirthday(new Date());
        //1.2 小红对象模型数据
        Student stu2 = new Student();
        stu2.setName("小红");
        stu2.setMoney(200.1f);
        stu2.setAge(19);
        //1.3 将两个对象模型数据存放到List集合中
        List<Student> stus = new ArrayList<>();
        stus.add(stu1);
        stus.add(stu2);
        model.addAttribute("stus", stus);
        // 2.1 添加日期
        Date date = new Date();
        model.addAttribute("today", date);
        // 3.1 添加数值
        model.addAttribute("point", 102920122);
        return "04-innerFunc";
    }

4 静态化测试

之前的测试都是SpringMVC将Freemarker作为视图解析器（ViewReporter）来集成到项目中，工作中，有的时候需要使用Freemarker原生Api来生成静态内容，下面一起来学习下原生Api生成文本文件。

4.1 需求分析

使用freemarker原生Api将页面生成html文件，本节测试html文件生成的方法：
在这里插入图片描述

4.2 静态化测试

根据模板文件生成html文件

①：修改application.yml文件，添加以下模板存放位置的配置信息，完整配置如下：

server:
  port: 8881 #服务端口
spring:
  application:
    name: freemarker-demo #指定服务名
  freemarker:
    cache: false  #关闭模板缓存，方便测试
    settings:
      template_update_delay: 0 #检查模板更新延迟时间，设置为0表示立即检查，如果时间大于0会有缓存不方便进行模板测试
    suffix: .ftl               #指定Freemarker模板文件的后缀名
    template-loader-path: classpath:/templates   #模板存放位置

②：在test下创建测试类

 package com.test.freemarker.test;
    
    @SpringBootTest(classes = FreemarkerDemoApplication.class)
    @RunWith(SpringRunner.class)
    public class FreemarkerTest {
    
        @Autowired
        private Configuration configuration;
    
        @Test
        public void test() throws IOException, TemplateException {
            //freemarker的模板对象，获取模板
            Template template = configuration.getTemplate("02-list.ftl");
            Map params = getData();
            //合成
            //第一个参数 数据模型
            //第二个参数  输出流
            template.process(params, new FileWriter("d:/list.html"));
        }
    
        private Map getData() {
            Map<String, Object> map = new HashMap<>();
    
            //小强对象模型数据
            Student stu1 = new Student();
            stu1.setName("小强");
            stu1.setAge(18);
            stu1.setMoney(1000.86f);
            stu1.setBirthday(new Date());
    
            //小红对象模型数据
            Student stu2 = new Student();
            stu2.setName("小红");
            stu2.setMoney(200.1f);
            stu2.setAge(19);
    
            //将两个对象模型数据存放到List集合中
            List<Student> stus = new ArrayList<>();
            stus.add(stu1);
            stus.add(stu2);
    
            //向map中存放List集合数据
            map.put("stus", stus);
    
    
            //创建Map数据
            HashMap<String, Student> stuMap = new HashMap<>();
            stuMap.put("stu1", stu1);
            stuMap.put("stu2", stu2);
            //向map中存放Map数据
            map.put("stuMap", stuMap);
    
            //返回Map
            return map;
        }
    }

标签：stu2,stu1,FreeMarker,freemarker,stu,引擎,模板,name
来源： https://blog.csdn.net/qq_45228323/article/details/121237487

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9

模板引擎FreeMarker

1 freemarker 介绍

2 环境搭建&&快速入门

2.1创建测试工程

2.2 配置文件

2.3创建模型类

2.4 创建模板

2.5 创建controller

2.6创建启动类

2.7 测试

3. freemarker基础

3.1 基础语法种类

3.2 集合指令（List和Map）

3.3 if指令

3.4 运算符

3.6 内建函数

4 静态化测试

4.1 需求分析

4.2 静态化测试