freemark 使用笔记

FreeMarker是一个用Java语言编写的模板引擎，它基于模板来生成文本输出。

FreeMarker是MVC模式中视图层的一个组建，它把页面设计和应用程序逻辑分离开来，使得页面模板的代码不受复杂程序代码的影响。

1. 添加所依赖的JAR包

<!--freemarker-->
<dependency>
	<groupId>org.freemarker</groupId>
	<artifactId>com.springsource.freemarker</artifactId>
	version>2.3.15</version>
</dependency>
 
<!--解析freemarker中的相关参数-->
<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-context-support</artifactId>
	<version>3.2.0.RELEASE</version>
</dependency>

2. Spring配置

2.1. Spring上下文

在/WEB_INF/目录下创建web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
         version="3.1">
    <display-name>FreeMarker</display-name>
    <context-param>
        <param-name>contextConfigLocation</param-name>
            <param-value>classpath:base-beans.xml</param-value>
    </context-param>
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
     
    <servlet>
        <servlet-name>Servlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:webmvc.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>Servlet</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>
</web-app>

2.2. 配置servlet和freemarker

在2.1节中，可以看到Servlet的配置文件是webmvc.xml，位于/resources/目录下：

<?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:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:util="http://www.springframework.org/schema/util"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util.xsd">

    <!--对web包中的所有类进行扫描，以完成Bean创建和自动依赖注入的功能 -->
    <context:component-scan base-package="com.sankuai.freemarker"/>
    <mvc:annotation-driven/>

    <!--定义一个视图解析器，它将逻辑视图名称解析为View对象，而该对象将渲染的任务委托给Web应用程序上下文中的一个模版。
    将视图逻辑名解析为 /WEB-INF/pages/${viewName}.jsp-->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/>
        <property name="prefix" value="/WEB-INF/views/"/>   <!-- 前缀 -->
        <property name="suffix" value=".jsp"/>  <!-- 后缀 -->
        <property name="order" value="1"/>
    </bean>

    <!-- 设置freeMarker的配置文件路径 -->
    <bean id="freemarkerConfiguration" class="org.springframework.beans.factory.config.PropertiesFactoryBean">
        <property name="location" value="classpath:freemarker.properties"/>
    </bean>
    <bean id="freeMarkerConfigurer" class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
        <!--需要 spring.context.support:3.2.0.RELEASE.jar  包来解析三个name-->
        <property name="templateLoaderPath" value="/WEB-INF/ftl/" /> <!--扫描.ftl的模板文件 -->
        <property name="freemarkerSettings" ref="freemarkerConfiguration"/> <!--加载freemarker的参数设定-->
        <property name="freemarkerVariables"> <!--设置一些常用的全局变量-->
            <map>
                <entry key="xml_escape" value-ref="fmXmlEscape"/>
            </map>
        </property>
    </bean>
    <bean id="fmXmlEscape" class="freemarker.template.utility.XmlEscape"/>
    <!-- 配置freeMarker视图解析器 -->
    <bean id="freeMarkerViewResolver" class="org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver">
        <property name="viewClass" value="org.springframework.web.servlet.view.freemarker.FreeMarkerView"/>
        <!--viewNames和suffix只能配一个 -->
        <!--<property name="viewNames" value="*.ftl"/>-->
        <property name="contentType" value="text/html; charset=utf-8"/>
        <property name="cache" value="true"/>
        <property name="prefix" value=""/>
        <property name="suffix" value=".ftl"/>
        <property name="order" value="0"/>
        <!--<property name="order" value="0">代表了第一个匹配的是freemarker的视图解析器，如果匹配不成功，则自动选择order=1的其他解析器 -->
        <!--<property name="exposeRequestAttributes" value="true" />-->
        <!--<property name="exposeSessionAttributes" value="true" />-->
        <property name="exposeSpringMacroHelpers" value="true" />
        <!-- exposeRequestAttributes和exposeSessionAttributes两个属性设置为true，表示请求和会话属性都被复制到模板的属性集中，可以使用
             FreeMarker的表达式语言来访问并显示。使用这些宏，必须设置FreeMarkerViewResolver的exposeSpringMacroHelpers属性为true  -->
    </bean>
</beans>

而在freeMarker的配置文件（freemarkerConfiguration）中，我们需要设定一些参数，位于/resources/freemarker.properties文件中：

tag_syntax=auto_detect
template_update_delay=2
default_encoding=UTF-8
output_encoding=UTF-8
locale=zh_CN
date_format=yyyy-MM-dd
time_format=HH:mm:ss
datetime_format=yyyy-MM-dd HH:mm:ss

3. 控制器与模板文件

Controller用于处理映射请求：

@Controller
@RequestMapping("")
public class IndexController {
    private static final Logger log = Logger.getLogger("index");
    @RequestMapping(value = "index", method = RequestMethod.GET)
    public String printWelcome(ModelMap model) {
        try {
            log.info("--------- hello!");
            model.addAttribute("message", "Spring MVC!");
            return "index";
        } catch (Exception ex) {
            log.warning(ex.getMessage());
            return "temp";
        }
    }
}

/**
 * FreeMarker示例控制器
 */
@Controller
@RequestMapping("/freeMarker")
public class FreeMarkerController {
    private static final Logger log = Logger.getLogger("freemarker");
    @RequestMapping("/hello.do")
    public String sayHello(ModelMap map) {
        log.info("say Hello ……");
        map.addAttribute("name", " World!");
        return "hello";
    }
    @RequestMapping("/hi.do")
    public String sayHi(ModelMap map) {
        log.info("say hi ……");
        map.put("name", "HI!");
        return "hi";
    }
}

下面编写WEB-INF/views目录下的jsp文件与WEB-INF/ftl目录下的模板文件：

<%@ page contentType="text/html;charset=ISO-8859-1" language="java" %>
<html>
<head>
    <title></title>
</head>
<body>
<h2>${message}</h2>
<a href="freeMarker/hello.do">say hello</a><br/>
<a href="freeMarker/hi.do">say hi</a><br/>
</body>
</html>

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>temp</title>
</head>
<body>
<h3>temp_${name }</h3>
</body>
</html>

<html>
<body>
<h1>Hello_freemarker ${name}</h1><br/>
${(1 == 1)?string("yes", "no")}
</body>
</html>

<html>
<body>
<h1>Hi_freemarker ${name}</h1><br/>
${(1 != 1)?string("yes", "no")}
</body>
</html>

项目文件的目录如下：

4. 运行

设置Boostrap启动容器

启动Bootstrap容器，打开本地网页（项目端口为3330）：

点“say hello"如下：

点“say hi"如下：

参考：Spring mvc与Freemarker学习, http://my.oschina.net/HuifengWang/blog/300461

posted @ 2017-04-13 14:03 tianyanfl 阅读(219) 评论(0) 收藏举报

刷新页面返回顶部

tianyanfl