1.什么是freemarker

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

目前企业中:主要用Freemarker做静态页面或是页面展示

2.Freemarker的使用方法

把freemarker的jar包添加到工程中。

2.1Maven工程添加依赖

<dependency>
  <groupId>org.freemarker</groupId>
  <artifactId>freemarker</artifactId>
  <version>2.3.23</version>
</dependency>

2.2非maven工程加入相应jar包到build path中

2.3原理:这里写图片描述

3.使用步骤:

第一步:创建一个Configuration对象,直接new一个对象。构造方法的参数就是freemarker对于的版本号。 
第二步:设置模板文件所在的路径。 
第三步:设置模板文件使用的字符集。一般就是utf-8. 
第四步:加载一个模板,创建一个模板对象。 
第五步:创建一个模板使用的数据集,可以是pojo也可以是map。一般是Map。 
第六步:创建一个Writer对象,一般创建一FileWriter对象,指定生成的文件名。 
第七步:调用模板对象的process方法输出文件。 
第八步:关闭流。

3.1模板:

放在WEN-INF/ftl/hello.ftl文件中: 
${hello}

3.2实现代码

    @org.junit.Test
    public void test() throws IOException, TemplateException {
        // 第一步:创建一个Configuration对象,直接new一个对象。构造方法的参数就是freemarker对于的版本号。
        Configuration configuration = new Configuration(Configuration.getVersion());
        // 第二步:设置模板文件所在的路径。
        configuration.setDirectoryForTemplateLoading(
                new File("D:\\Java\\Eclipse\\workspace_Test\\FreeMarker\\src\\main\\webapp\\WEB-INF\\ftl"));
        // 第三步:设置模板文件使用的字符集。一般就是utf-8.
        configuration.setDefaultEncoding("utf-8");
        // 第四步:加载一个模板,创建一个模板对象。
        Template template = configuration.getTemplate("hello.ftl");
        // 第五步:创建一个模板使用的数据集,可以是pojo也可以是map。一般是Map。
        Map dataModel = new HashMap();
        // 向数据集中添加数据
        dataModel.put("hello", "this is my first freemarker test.");
        // 第六步:创建一个Writer对象,一般创建一FileWriter对象,指定生成的文件名。
        Writer out = new FileWriter(new File("D:\\Java\\Eclipse\\workspace_Test\\FreeMarker\\out\\hello.html"));
        // 第七步:调用模板对象的process方法输出文件。
        template.process(dataModel, out);
        // 第八步:关闭流。
        out.close();
    }

4.模板的语法

4.1访问map中的key

${key}

4.2访问pojo中的属性

Student对象。学号、姓名、年龄 
${key.property} 
这里写图片描述

4.3取集合中的数据

循环使用格式:

<#list 要循环的数据 as 循环后的数据>
</#list>

如:

<#list studentList as student>
${student.id}/${studnet.name}
</#list>

这里写图片描述
这里写图片描述

4.4取循环中的下标

<#list studentList as student>
    ${student_index}
</#list>

这里写图片描述

4.5判断

<#if student_index % 2 == 0>
<#else>
</#if>

这里写图片描述

4.6日期类型格式化

直接取值:${date}(date是属性名)如果传来的是一个Date型数据会报错

${date?date} //2016-9-13
${date?time} //17:53:55
${date?datetime} //2016-9-13 17:53:55

4.7Null值的处理

如果直接取一个不存在的值(值为null)时会报异常 
${aaa} 
处理: aaa!”默认值”或者aaa!”默认值”或者{aaa! }代表空字符串 
这里写图片描述

4.8Include标签

<#include “模板名称”> //(相当于jstl中的包含)

这里写图片描述

5.Freemarker整合spring

5.1引入jar包:

Freemarker的jar包 
Spring web mvc 的jar包 
Sping context supportjar 包

<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>
    <groupId>top.yubaojin</groupId>
    <artifactId>FreeMarker</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>war</packaging>

    <dependencies>
        <!-- https://mvnrepository.com/artifact/org.springframework/spring-context-support -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context-support</artifactId>
            <version>4.3.13.RELEASE</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/org.springframework/spring-webmvc -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>4.3.13.RELEASE</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/org.freemarker/freemarker -->
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.23</version>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.tomcat.maven</groupId>
                <artifactId>tomcat7-maven-plugin</artifactId>
                <version>2.2</version>
                <configuration>
                    <path>/</path>
                    <port>8080</port>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

5.2创建整合spring的配置文件

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"
    xmlns:context="http://www.springframework.org/schema/context"
    xmlns:mvc="http://www.springframework.org/schema/mvc"
    xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.3.xsd
        http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.3.xsd
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.3.xsd">
    <!-- 配置注解驱动 -->
    <mvc:annotation-driven />
    <!-- freemarker整合spring中 -->
    <bean id="freemarkerConfig"
        class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
        <property name="templateLoaderPath" value="/WEB-INF/ftl/" />
        <property name="defaultEncoding" value="UTF-8" />
    </bean>
    <!-- 配置包扫描器,扫描@Controller注解的类 -->
    <context:component-scan base-package="top.yubaojin.controller" />
</beans>      

5.3web文件

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://java.sun.com/xml/ns/javaee"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
    version="2.5">
    <display-name>FreeMarker</display-name>
    <!-- 前端控制器 -->
    <servlet>
        <servlet-name>freemarker</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!-- contextConfigLocation不是必须的, 如果不配置contextConfigLocation, springmvc的配置文件默认在:WEB-INF/servlet的name+"-servlet.xml" -->
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:springmvc.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>freemarker</servlet-name>
        <!-- 拦截所有请求jsp除外 -->
        <url-pattern>/</url-pattern>
    </servlet-mapping>
</web-app>

5.4编写测试Controller

请求的url:/test 
参数:无 
返回值:ok (String, 需要使用@ResponseBody) 
业务逻辑: 
1、从spring容器中获得FreeMarkerConfigurer对象。 
2、从FreeMarkerConfigurer对象中获得Configuration对象。 
3、使用Configuration对象获得Template对象。 
4、创建数据集 
5、创建输出文件的Writer对象。 
6、调用模板对象的process方法,生成文件。 
7、关闭流。

package top.yubaojin.controller;

import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.Writer;
import java.util.HashMap;
import java.util.Map;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer;

import freemarker.template.Configuration;
import freemarker.template.Template;
import freemarker.template.TemplateException;

@Controller
public class FreeMarkerController {

    @Autowired
    private FreeMarkerConfigurer freeMarkerConfigurer;

    @RequestMapping("/test")
    @ResponseBody
    public String test() throws IOException, TemplateException {
        // 1、从spring容器中获得FreeMarkerConfigurer对象。
        // 2、从FreeMarkerConfigurer对象中获得Configuration对象。
        Configuration configuration = freeMarkerConfigurer.getConfiguration();
        // 3、使用Configuration对象获得Template对象。
        Template template = configuration
                .getTemplate("hello.ftl");
        // 4、创建数据集
        Map dataModel = new HashMap();
        dataModel.put("hello", "1000");
        // 5、创建输出文件的Writer对象。
        //需要手动在D:/Java/Eclipse/workspace_Test/FreeMarker/下创建out目录
        File file = new File("D:/Java/Eclipse/workspace_Test/FreeMarker/out/spring-freemarker.html");
    /*  if(!file.exists()) {
            file.createNewFile();
        }*/
        Writer out = new FileWriter(file);
        // 6、调用模板对象的process方法,生成文件。
        template.process(dataModel, out);
        // 7、关闭流。
        out.close();
        return "OK";
    }
}

6.测试

6.1配置Tomcat插件运行maven build

这里写图片描述

6.2浏览器请求测试

这里写图片描述 
结果:这里写图片描述

6.3查看结果

这里写图片描述

7.网页静态化方案

输出文件的名称:商品id+“.html” 
输出文件的路径:工程外部的任意目录。 
网页访问:使用nginx访问网页。在此方案下tomcat只有一个作用就是生成静态页面。 
工程部署:可以把taotao-item-web部署到多个服务器上。 
生成静态页面的时机:商品添加后,生成静态页面。可以使用Activemq,订阅topic(商品添加) 
这里写图片描述

Logo

权威|前沿|技术|干货|国内首个API全生命周期开发者社区

更多推荐