目录

什么是Freemarker?

常用的java模板引擎还有哪些？

环境搭建&&快速入门 

代码层级结构：

pom.xml如下

配置文件application.yml

创建实体类

创建模板

创建controller

创建启动类

测试

freemarker基础

基础语法种类

集合指令（List和Map）

实例代码：

运算符

比较运算符

逻辑运算符

空值处理

内建函数

静态化测试

需求分析

测试结果：​编辑 ​编辑

源码地址：

---

文末有gitee源码地址

什么是Freemarker?

        FreeMarker是一个用于生成文本输出（例如HTML网页）的模板引擎。 即一种基于模板和要改变的数据， 并用来生成输出文本(HTML网页，电子邮件，配置文件，源代码等)的通用工具。

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

常用的java模板引擎还有哪些？

Jsp、Freemarker、Thymeleaf 、Velocity 等。

1.Jsp 为 Servlet 专用，不能单独进行使用。

2.Thymeleaf 为新技术，功能较为强大，但是执行的效率比较低。

3.Velocity从2010年更新完 2.0 版本后，便没有在更新。Spring Boot 官方在 1.4 版本后对此也不在支持，虽然 Velocity 在 2017 年版本得到迭代，但为时已晚。 

那么直接进行代码实现，然后根据执行效果来学习freemarker的基础语法。

环境搭建&&快速入门 

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

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

代码层级结构：

pom.xml如下

    4.0.0
    
        org.springframework.boot
        spring-boot-starter-parent
        3.2.2
         
    
    com.example
    springboot-freemarker
    0.0.1-SNAPSHOT
    springboot-freemarker
    springboot-freemarker
    
        17
    
    
        
            org.springframework.boot
            spring-boot-starter-web
        
        
        
            org.springframework.boot
            spring-boot-starter-freemarker
        
        
            org.springframework.boot
            spring-boot-starter-test
        
        
        
            org.projectlombok
            lombok
        
        
        
            org.apache.commons
            commons-io
            1.3.2
        
        
            junit
            junit
            test
        
    
    
        
            
                org.springframework.boot
                spring-boot-maven-plugin
            
        
    

配置文件application.yml

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

解释一下配置文件

suffix: .ftl               #指定Freemarker模板文件的后缀名

    template-loader-path: classpath:/templates

读取源码发现

freemarker默认的suffix的格式为.ftlh,默认加载位置也是classpath:/templates。配置文件.ftl注释掉，然后将模板文件后缀改成ftlh也是可以访问的。因为是默认配置。

(你可以试试修改后缀和加载位置看能不能成功生成模板，验证一下)

创建实体类

package com.example.springbootfreemarker.entity;
import lombok.Data;
import java.util.Date;
@Data
public class Student {
    private String name;
    private int age;
    private Date birthday;
    private Float money;
}

创建模板

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

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

01-basic.ftl

<#--文章详情模板文件-->



    
    


普通文本 String 展示：


Hello ${stu.name!'-----------'} 


对象Student中的数据展示：

姓名：${(stu.name)!''}

年龄：${stu.age}

02-list.ftl

    
    


<#-- list 数据的展示 -->
展示list中的stu数据:





    <#if stus??>
        <#list stus as stu>
            <#if stu.name=='小红'>
                
            <#else >
                
    stus集合的大小：${stus?size}

    

        
序号
        
姓名
        
年龄
        
钱包
    

                    
${stu_index + 1}
                    
${stu.name}
                    
${stu.age}
                    
${stu.money}
                

                    
${stu_index + 1}
                    
${stu.name}
                    
${stu.age}
                    
${stu.money}
                
            
        
    

<#-- Map 数据的展示 -->
map数据的展示：



方式一：通过map['keyname'].property

输出stu1的学生信息：

姓名：${stuMap['stu1'].name}

年龄：${stuMap['stu1'].age}



方式二：通过map.keyname.property

输出stu2的学生信息：

姓名：${stuMap.stu2.name}

年龄：${stuMap.stu2.age}



遍历map中两个学生信息：


    <#list stuMap?keys as key>
        
            <#--索引index是从0开始的-->
            

    

        
序号
        
姓名
        
年龄
        
钱包
    
${key_index + 1}
            
${stuMap[key].name}
            
${stuMap[key].age}
            
${stuMap[key].money}
        
    


当前的日期为：${today?datetime}

当前的日期为：${today?string("yyyy年MM月")}
-----------------------------------------------------

<#--${point?c}-->

创建controller

package com.example.springbootfreemarker.controller;
import com.example.springbootfreemarker.entity.Student;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import java.util.*;
//不能使用@RestController，因为是返回视图
@Controller
public class HelloController {
    @GetMapping("/basic")
    public String hello(Model model){
        //存储一个字符串
//        model.addAttribute("name","freemarker");
        //stu
        Student student = new Student();
        student.setName("小明");
        student.setAge(18);
        //存储一个对象
        model.addAttribute("stu",student);
        return "01-basic";
    }
    @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 stus = new ArrayList<>();
        stus.add(stu1);
        stus.add(stu2);
        //向model中存放List集合数据
        model.addAttribute("stus",stus);
        //map数据
        Map stuMap = new HashMap<>();
        stuMap.put("stu1",stu1);
        stuMap.put("stu2",stu2);
        model.addAttribute("stuMap",stuMap);
        //日期
        model.addAttribute("today",new Date());
        //长数值
        model.addAttribute("point",38473897438743L);
        return "02-list";
    }
}

创建启动类

package com.example.springbootfreemarker;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class SpringbootFreemarkerApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringbootFreemarkerApplication.class, args);
    }
}

测试

启动项目：

 请求1：http://127.0.0.1:10000/list  请求2：http://127.0.0.1:10000/basic

测试结果1：

测试结果2：

freemarker基础

基础语法种类

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

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

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

Hello ${name}

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

<# >FTL指令

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

<#if >

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

<#--freemarker中的普通文本-->

我是一个普通的文本

集合指令（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 stus = new ArrayList<>();
    stus.add(stu1);
    stus.add(stu2);
    //向model中存放List集合数据
    model.addAttribute("stus",stus);
    //------------------------------------
    //创建Map数据
    HashMap 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文件

    
    


    
<#-- list 数据的展示 -->
展示list中的stu数据:





    

        
序号
        
姓名
        
年龄
        
钱包
    


    
<#-- Map 数据的展示 -->
map数据的展示：



方式一：通过map['keyname'].property

输出stu1的学生信息：

姓名：

年龄：



方式二：通过map.keyname.property

输出stu2的学生信息：

姓名：

年龄：



遍历map中两个学生信息：


    

        
序号
        
姓名
        
年龄
        
钱包
 
    


 

实例代码：

    
    


    
<#-- list 数据的展示 -->
展示list中的stu数据:





    <#list stus as stu>
        

    

        
序号
        
姓名
        
年龄
        
钱包
    

            
${stu_index+1}
            
${stu.name}
            
${stu.age}
            
${stu.money}
        
    


    
<#-- Map 数据的展示 -->
map数据的展示：



方式一：通过map['keyname'].property

输出stu1的学生信息：

姓名：${stuMap['stu1'].name}

年龄：${stuMap['stu1'].age}



方式二：通过map.keyname.property

输出stu2的学生信息：

姓名：${stuMap.stu2.name}

年龄：${stuMap.stu2.age}



遍历map中两个学生信息：


    <#list stuMap?keys as key >
        

    

        
序号
        
姓名
        
年龄
        
钱包
    

            
${key_index}
            
${stuMap[key].name}
            
${stuMap[key].age}
            
${stuMap[key].money}
        
    


 

运算符

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

• 加法： +

• 减法： -

• 乘法： *

• 除法： /

• 求模 (求余)： %

  模板代码

  算数运算符

  
  
  

      100+5 运算：  ${100 + 5 }
  

      100 - 5 * 5运算：${100 - 5 * 5}
  

      5 / 2运算：${5 / 2}
  

      12 % 10运算：${12 % 10}
  

  ---

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

  比较运算符

  • =或者==:判断两个值是否相等.

  • !=:判断两个值是否不等.

  • >或者gt:判断左边值是否大于右边值

  • >=或者gte:判断左边值是否大于等于右边值

  • <或者lt:判断左边值是否小于右边值

  • <=或者lte:判断左边值是否小于等于右边值

    = 和 == 模板代码

    
    
    
        
        
    
    
        比较运算符
        
    
        
    
        
    
            
     =/== 和 != 比较：
            
    
                <#if "xiaoming" == "xiaoming">
                    字符串的比较 "xiaoming" == "xiaoming"
                
            
            
    
                <#if 10 != 100>
                    数值的比较 10 != 100
                
            
        
        
    
            
    其他比较
            
    
                <#if 10 gt 5 >
                    形式一：使用特殊字符比较数值 10 gt 5
                
            
            
    
                <#-- 日期的比较需要通过?date将属性转为data类型才能进行比较 -->
                <#if (date1?date >= date2?date)>
                    形式二：使用括号形式比较时间 date1?date >= date2?date
                
            
        
        
    
    
    
    

    Controller 的 数据模型代码

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

    比较运算符注意

    • =和!=可以用于字符串、数值和日期来比较是否相等

    • =和!=两边必须是相同类型的值,否则会产生错误

    • 字符串 "x" 、"x " 、"X"比较是不等的.因为FreeMarker是精确比较

    • 其它的运行符可以作用于数字和日期,但不能作用于字符串

    • 使用gt等字母运算符代替>会有更好的效果,因为 FreeMarker会把>解释成FTL标签的结束字符

    • 可以使用括号来避免这种情况,如:<#if (x>y)>

      逻辑运算符

      • 逻辑与:&&

      • 逻辑或:||

      • 逻辑非:!

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

        模板代码

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

        空值处理

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

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

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

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

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

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

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

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

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

          内建函数

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

          1、和到某个集合的大小

          ${集合名?size}

          2、日期格式化

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

          3、内建函数

          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}

          模板代码：

          
          
          
              
              
          
          
              获得集合大小
          
              集合大小：
              
          
              获得日期
          
              显示年月日:      
          
              显示时分秒：
          
              显示日期+时间：
          
              自定义格式化：  
          
              
          
              内建函数C
          
              没有C函数显示的数值： 
          
              有C函数显示的数值：
              
          
              声明变量assign
          
          
          
          

          内建函数模板页面：

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

          内建函数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 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";
          }

          上面自己有时间可以融合在测试类进行验证一下。

          静态化测试

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

          需求分析

          使用freemarker原生Api将页面生成html文件，本节测试html文件生成的方法：
          

          在test下创建测试类

          package com.example.springbootfreemarker;
          import com.example.springbootfreemarker.entity.Student;
          import freemarker.template.Configuration;
          import freemarker.template.Template;
          import freemarker.template.TemplateException;
          import org.junit.jupiter.api.Test;
          import org.junit.runner.RunWith;
          import org.springframework.beans.factory.annotation.Autowired;
          import org.springframework.boot.test.context.SpringBootTest;
          import org.springframework.test.context.junit4.SpringRunner;
          import java.io.FileWriter;
          import java.io.IOException;
          import java.util.*;
          @SpringBootTest
          @RunWith(SpringRunner.class)
          class SpringbootFreemarkerApplicationTests {
              @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:/list1.html"));
              }
              private Map getData() {
                  Map 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 stus = new ArrayList<>();
                  stus.add(stu1);
                  stus.add(stu2);
                  //向map中存放List集合数据
                  map.put("stus", stus);
                  //创建Map数据
                  HashMap stuMap = new HashMap<>();
                  stuMap.put("stu1", stu1);
                  stuMap.put("stu2", stu2);
                  //向map中存放Map数据
                  map.put("stuMap", stuMap);
                  /**
                   * 1如果变量没有被定义或传递到模板中就会报错；
                   * 2today变量的值为null或缺失;
                   * freemarker.core.InvalidReferenceException: The following has evaluated to null or missing:
                   * ==> today  [in template "02-list.ftl" at line 79, column 10]
                   *
                   * ----
                   * Tip: If the failing expression is known to legally refer to something that's sometimes null or missing, either specify a default value like myOptionalVar!myDefault, or use <#if myOptionalVar??>when-present<#else>when-missing. (These only cover the last step of the expression; to cover the whole expression, use parenthesis: (myOptionalVar.foo)!myDefault, (myOptionalVar.foo)??
                   * ----
                   *
                   * ----
                   * FTL stack trace ("~" means nesting-related):
                   * 	- Failed at: ${today?datetime}  [in template "02-list.ftl" at line 79, column 8]
                   * */
                  // 2.1 添加日期
          //        Date date = null;
                  Date date = new Date();
                  map.put("today", date);
                  //返回Map
                  return map;
              }
          
          }
          

          测试结果：
          
          
          
          
          

          
          源码地址：

          https://gitee.com/sophisticatedxin/springboot-freemarker.git

          直接拉取即可测试。