Freemarker

什么是FreeMarker？

FreeMarker 是一款 模板引擎： 即一种基于模板和要改变的数据， 并用来生成输出文本(HTML网页，电子邮件，配置文件，源代码等)的通用工具。 它不是面向最终用户的，而是一个Java类库，是一款程序员可以嵌入他们所开发产品的组件。
模板编写为FreeMarker Template Language (FTL)。它是简单的，专用的语言， 不是 像PHP那样成熟的编程语言。 那就意味着要准备数据在真实编程语言中来显示，比如数据库查询和业务运算， 之后模板显示已经准备好的数据。在模板中，你可以专注于如何展现数据， 而在模板之外可以专注于要展示什么数据。

image.png

这种方式通常被称为 MVC (模型 视图 控制器) 模式，对于动态网页来说，是一种特别流行的模式。 它帮助从开发人员(Java 程序员)中分离出网页设计师(HTML设计师)。设计师无需面对模板中的复杂逻辑， 在没有程序员来修改或重新编译代码时，也可以修改页面的样式。
而FreeMarker最初的设计，是被用来在MVC模式的Web开发框架中生成HTML页面的，它没有被绑定到 Servlet或HTML或任意Web相关的东西上。它也可以用于非Web应用环境中。

FreeMarker和springboot整合

首先，pom.xml中导入freemarker的依赖：

        
            org.springframework.boot
            spring-boot-starter-freemarker
        

在application.properties(或yml)配置文件中加入freemarker相关配置：

#    freemarker静态资源配置
#       设定ftl文件路径
spring.freemarker.tempalte-loader-path=classpath:/templates
#        关闭缓存，及时刷新，上线生产环境需要修改为true
spring.freemarker.cache=false
spring.freemarker.charset=UTF-8
spring.freemarker.check-template-location=true
spring.freemarker.content-type=text/html
spring.freemarker.expose-request-attributes=true
spring.freemarker.expose-session-attributes=true
spring.freemarker.request-context-attribute=request
spring.freemarker.suffix=.ftl

这里指定了freemarker文件的路径是classpath/templates，在resources文件夹下的templates新建freemarker文件夹，并且在其中新建index.ftl（上面配置文件中已经指定了freemarker模板的文件后缀为ftl）：

    
    


hello,${var}

新建Controller包，新建FreeMarkerController类：

```package com.example.springboot.Controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * Created by Administrator on 2019/5/11.
 */
@Controller
@RequestMapping("/ftl")
public class FreeMarkerController {

    @RequestMapping("/index")
    public String index(ModelMap modelMap){
        modelMap.addAttribute("var","FreeMarker");
        return "freemarker/index";
    }

}

这里的ModelMap就相当于SpringMVC中的ModelAndView，其中的很多方法也很类似，我们这里返回的字符串就是freemarker模板的路径，不用写后缀，因为配置文件中已经指定了后缀为.ftl
浏览器发起请求，得到结果：

image.png

这样，SpringBoot整合freemarker就好了。

FreeMarker的一些基本语法

• 取值

Freemarker中通过${}方式取值

    
    


FreeMarker取值

    

        整型: ${int}
    
    

        长整型: ${long}
    
    

        字符串: ${str}
    

在controller中添加方法

    @RequestMapping(value = "/list")
    public String list(ModelMap modelMap){
        modelMap.addAttribute("int",1000);
        modelMap.addAttribute("long",100000000L);
        modelMap.addAttribute("str","freemarker");
     return "freemarker/list";
    }

浏览器请求结果：

image.png

注意：在Freemarker中无法输出Boolean类型，直接输出会报如下错误：

image.png

可以用bool?string('true','false')来进行格式化

• Date类型的格式化

Date类型是非常常见的一种数据格式，Freemarker中是无法进行直接输出的，要对Date类型进行格式化。
Freemarker中格式化是以date?string('yyyy-MM-dd')这种方式实现的。

• null和不存在的变量的取值

在开发中常常遇到空值的情况，在Freemarker中直接通过 {}取空值或者不存在的变量会报错。此时可以用!来进行空值判断，如${null!'我是空值'},其中！会判断变量是不是为空，如果变量为空就输出后面的默认值。(开发中可以在变量后面加！，避免Freemarker报错)

• 变量的赋值和运算

Freemarker中支持变量运算

<#assign var = 100>
var = ${var}

var + 100 = ${var+100}

如上代码中，通过<#assign var = 100>定义一个变量var = 100，在${var+100}中进行了变量的加法运算

image.png

• 自定义对象取值

Freemarker中对于对象取值的方式是通过 . 来实现的，前面说！可以判断变量是否为空，但是只判断最近的一个变量，在这种object.val中就无法判断，可以用（object.val）!来判断。

• List和Map的遍历

在controller中添加list和map

       List list = new ArrayList();
       list.add("Java");
       list.add("python");
       list.add("php");
       modelMap.addAttribute("list",list);
       Map map = new HashMap();
       map.put("java","hello,java");
       map.put("python","hello,python");
       map.put("php","hello,php");
       modelMap.put("map",map);

在ftl中遍历

<#list list as item>
    ${item}


<#list map?keys as key>
    ${key}:${map[key]}

浏览器中访问

image.png

• if语法

Freemarker中表达式都是<#+表达式，Freemarker的if表达式和Java中类似。

<#assign var = 999>
<#if var == 999>
    var = 999
<#elseif var == 888>
    var = 888
<#else >
    var = 111

• switch语法

Freemarker和Java一样支持switch语法

<#switch var>
    <#case 10>
    10
        <#break >
    <#case 11>
    11
        <#break >
    <#case 12>
    12
        <#break >
    <#default>

• 字符串的基本操作指令

字符串常用的内建函数

1. 字符串连接 +

<#assign vara = 'abc'>
<#assign varb = 'efg'>
${vara+varb}

2. substring

<#assign varc = 'asdfghjkl'>
${varc?substring(2,5)}

3. length

<#assign varc = 'asdfghjkl'>
${varc?length}

4. 大小写

<#assign varc = 'asdfghjkl'>
${varc?upper_case}

<#assign varc = 'asdfghjkl'>
${varc?lower_case}

• Freemarker的自定义函数

整数排序sort_int
首先定义一个类并实现TemplateMethodModelEx

package com.example.springboot.util;

import freemarker.template.SimpleSequence;
import freemarker.template.TemplateMethodModelEx;
import freemarker.template.TemplateModelException;

import java.math.BigDecimal;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;

/**
 * Created by Administrator on 2019/5/12.
 */
public class SortMethod implements TemplateMethodModelEx {

    @Override
    public Object exec(List list) throws TemplateModelException {

        SimpleSequence simpleSequence = (SimpleSequence) list.get(0);
      //SimpleSequence 是Freemarker里的数据类型代表数组或list，Java从Freemarker取值时不能直接强转
      //必须先用Freemarker的数据类型取出来然后进行转换
        List lists = simpleSequence.toList();
        Collections.sort(lists, new Comparator() {
            @Override
            public int compare(BigDecimal o1,BigDecimal o2){
                return o1.intValue()-o2.intValue();//升序
            }

        });
        return lists;
    }
}

上面就实现了一个自定义的函数，那么怎么去使用呢？可以通过controller传到Freemarker页面

 @RequestMapping(value = "/sortint")
   public String testFunction(ModelMap modelMap){
       modelMap.addAttribute("sort_int",new SortMethod());
       return "freemarker/sortint";
   }

传到页面之后的调用和Java中调用方法的方式有点类似

    
    


<#assign myList = [2,1,3,4,7,5,8,6,9]>
未排序
<#list myList as item>
    ${item}


已排序
<#list sort_int(myList) as item>
${item}

结果如下

image.png

• List常用函数

上面介绍自定义的排序函数，其实Freemarker里面已经实现了排序函数,通过<#list myList?sort as item>来调用

    
    


<#assign myList = [2,1,3,4,7,5,8,6,9]>
未排序
<#list myList as item>
    ${item}


已排序
<#list myList?sort as item>
${item}

还有许多函数如 逆序排序<#list myList?sort？reverse as item>，取list长度{myList[3]}等等......

• 其他常用的内建函数

cap_first 首字母变大写
ends_with 以...结尾
contains 包含
date 把字符串转成date
datetime 把字符串转成datetime
time 把字符串转成time
？string('0.##') 把字符串变成两位小数
is_string is_number 判断变量是不是string是不是number