Freemarker快速入门

1. Freemarker介绍

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

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

2.常用的java模板引

常用的java模板引擎还有 Jsp、Freemarker、Thymeleaf 、Velocity 等。

• Jsp 为 Servlet 专用，不能单独进行使用。
• Thymeleaf 为新技术，功能较为强大，但是执行的效率比较低。
• Velocity从2010年更新完 2.0 版本后，便没有在更新。Spring Boot 官方在 1.4 版本后对此也不在支持，虽然 Velocity 在 2017 年版本得到迭代，但为时已晚。

Freemarker技术的功能可以和JSP一样，都可以实现动态技术。

JSP  VS Freemarker

• 相同点：都可以作为动态技术去使用
• 不同点：Freemarker可以作为静态化技术去使用，而JSP不行。

3. SpringBoot快速入门Freemarker

【步骤零】创建项目

创建freemarker-learn,并导入对应依赖到pom.xml

• 完整项目结果

• pom.xml 依赖

<?xml versinotallow="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">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <artifactId>spring-boot-starter-parent</artifactId>
        <groupId>org.springframework.boot</groupId>
        <version>2.7.15</version>
    </parent>
    <groupId>com.zbbmeta</groupId>
    <artifactId>freemarker-learn</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>11</maven.compiler.source>
        <maven.compiler.target>11</maven.compiler.target>
    </properties>

    <dependencies>
<!--        web-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
<!--        freemarker-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-freemarker</artifactId>
        </dependency>
<!--        lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
<!--        test-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
        </dependency>
    </dependencies>
</project>

【步骤一】创建项目引导类

在java目录下创建com.zbbmeta.freemarker包，在其包下创建FreemarkerApplication引导类

package com.zbbmeta.freemarker;

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

/**
 * @author maguobin
 * @description: TODO
 */
@SpringBootApplication
public class FreemarkerApplication {
    public static void main(String[] args) {
        SpringApplication.run(FreemarkerApplication.class,args);
    }
}

【步骤二】配置文件

在resources目录下创建application.yml文件，内容如下

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

【步骤三】 配置实体类

在com.zbbmeta.freemarker.entity包下创建Student类

package com.zbbmeta.freemarker.entity;

import lombok.Data;

import java.util.Date;

/**
 * @author springboot葵花宝典
 * @description: TODO
 */
@Data
public class Student {
    private String name;//姓名
    private int age;//年龄
    private Date birthday;//生日
    private Float money;//钱包
}

【步骤四】 创建freemarker的FileController接口类

在com.zbbmeta.freemarker.controller包下创建FStudentController接口类

package com.zbbmeta.freemarker.controller;

import com.zbbmeta.freemarker.entity.Student;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;


import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.List;

/**
 * @author maguobin
 * @description: TODO
 */
@Controller //用于跳转页面，而非返回json数据
@RequestMapping("/student")
public class StudentController {
    /**
     * 入门
     */
    @GetMapping
    public String hello(Model model){

        //存储数据
        model.addAttribute("name","jack");

        Student student = new Student();
        student.setName("如花");
        model.addAttribute("student",student);

        //路径：prefix+student+suffix
        //classpath:/templates/student.ftl
        return "student";//返回展示数据的页面名称
    }
}

【步骤六】 Freemarker模板显示数据

在resources下建立templates目录，在templates目录下创建student.ftl模板文件

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>Hello World!</title>
</head>
<body>
name属性值：${name}

<hr/>

学生的姓名：${student.name}
</body>
</html>

【步骤七】 测试

启动项目，访问：http://localhost:8881/student

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

4. Freemarker语法基础

4.1. 基础语法种类

• 
  

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

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

• 
  

1. 插值（Interpolation）：即部分会用真实的值代替{..}

Hello ${name}

• 
  

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

<# >FTL指令</#>

• 
  

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

<#--freemarker中的普通文本-->
  我是一个普通的文本

4.2 FTL指令- list

list指令格式：

<#list></#list>

示例:

<#list stus as stu>
    <tr>
        <td>${stu_index+1}</td>
        <td>${stu.name}</td>
        <td>${stu.age}</td>
        <td>${stu.money}</td>
        <td>${stu.birthday?string("yyyy年MM月dd日")}</td>
    </tr>
</#list>

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

list代码实现

• 
  

1. 在StudentController添加以下接口

@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);
    stu2.setBirthday(new Date());

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

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

• 
  

1. 添加list.ftl

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>语法学习</title>
</head>
<body>
<h2>遍历List集合</h2>
<table border="1">
    <tr>
        <td>序号</td>
        <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>
            <td>${stu.birthday?string("yyyy年MM月dd日")}</td>
        </tr>

    </#list>
</table>
</body>
</html>

• 
  

1. 测试结果

处理日期类型：

• 显示年月日: ${today?date}
• 显示时分秒：${today?time}
• 显示日期+时间：${today?datetime}
• 自定义格式化：${today?string("yyyy年MM月")}

4.3 FTL指令- if判断

if 指令即判断指令，是常用的FTL指令，freemarker在解析时遇到if会进行判断，条件为真则输出if中间的内容，否则跳过内容不再输出。

if指令格式：

<#if ><#else></#if>

示例:

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

<#list stus as stu>
    <#if stu.name=='小红'>
        <tr style="color: red">
            <td>${stu_index+1}</td>
            <td>${stu.name}</td>
            <td>${stu.age}</td>
            <td>${stu.money}</td>
            <td>${stu.birthday?string("yyyy年MM月dd日")}</td>
        </tr>
    <#else>
        <tr>
            <td>${stu_index+1}</td>
            <td>${stu.name}</td>
            <td>${stu.age}</td>
            <td>${stu.money}</td>
            <td>${stu.birthday?string("yyyy年MM月dd日")}</td>
        </tr>
    </#if>

</#list>

• 
  

2. 测试结果

4.3 FTL指令- map

map指令格式：

<#list userMap?keys as key>
  key:${key}--value:${userMap["${key}"]}
  
</#list>

获取map中的值：

map['keyname'].property
//或者
map.keyname.property

map代码实现

• 
  

1. 在StudentController添加以下接口

@GetMapping("/map")
public String map(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);
    stu2.setBirthday(new Date());

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

    return "map";
}

• 
  

1. 添加map.ftl

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>语法学习</title>
</head>
<body>

<h2>遍历Map集合</h2>
<table border="1">
    <tr>
        <td>姓名</td>
        <td>年龄</td>
        <td>钱包</td>
        <td>生日</td>
    </tr>
    <#list stuMap?keys as key>
        <tr>
            <td>${stuMap[key].name}</td>
            <td>${stuMap[key].age}</td>
            <td>${stuMap[key].money}</td>
            <td>${stuMap[key].birthday?string("yyyy年MM月dd日")}</td>
        </tr>
    </#list>


</table>
</body>
</html>

• 
  

1. 测试结果

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

4.4 FTL指令- 空值判断

• 
  

1. 判断某变量是否存在使用 "??"

用法为:variable??,如果该变量存在,返回true,否则返回false   a?? -> a!=null

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

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

• 
  

1. 缺失变量默认值使用 "!"

使用!要以指定一个默认值，当变量为空时显示默认值

例： ${name!''}表示如果name为空显示空字符串

如果是嵌套对象则建议使用（）括起来

例：${(stu.bestFriend.name)!''}表示，如果stu或bestFriend或name为空默认显示空字符