freemarker简介_动力节点Java学院整理

时间:2022-02-09 09:10:40

FreeMarker是一个模板引擎,一个基于模板生成文本输出的通用工具,使用纯Java编写 

FreeMarker被设计用来生成HTML Web页面,特别是基于MVC模式的应用程序 

虽然FreeMarker具有一些编程的能力,但通常由Java程序准备要显示的数据,由FreeMarker生成页面,通过模板显示准备的数据。

FreeMarker不是一个Web应用框架,而适合作为Web应用框架一个组件 

FreeMarker与容器无关,因为它并不知道HTTP或Servlet;FreeMarker同样可以应用于非Web应用程序环境 

FreeMarker更适合作为Model2框架(如Struts)的视图组件,你也可以在模板中使用JSP标记库 

FreeMarker是免费的 

1、通用目标 

能够生成各种文本:HTML、XML、RTF、Java源代码等等 

易于嵌入到你的产品中:轻量级;不需要Servlet环境 

插件式模板载入器:可以从任何源载入模板,如本地文件、数据库等等 

你可以按你所需生成文本:保存到本地文件;作为Email发送;从Web应用程序发送它返回给Web浏览器 

2、强大的模板语言 

所有常用的指令:include、if/elseif/else、循环结构 

在模板中创建和改变变量 

几乎在任何地方都可以使用复杂表达式来指定值 

命名的宏,可以具有位置参数和嵌套内容 

名字空间有助于建立和维护可重用的宏库,或者将一个大工程分成模块,而不必担心名字冲突 

输出转换块:在嵌套模板片段生成输出时,转换HTML转义、压缩、语法高亮等等;你可以定义自己的转换 

3、通用数据模型 

freeMarker不是直接反射到Java对象,Java对象通过插件式对象封装,以变量方式在模板中显示 

你可以使用抽象(接口)方式表示对象(JavaBean、XML文档、SQL查询结果集等等),告诉模板开发者使用方法,使其不受技术细节的打扰 

4、为Web准备 

  • 在模板语言中内建处理典型Web相关任务(如HTML转义)的结构 
  • 能够集成到Model2 Web应用框架中作为JSP的替代 
  • 支持JSP标记库 
  • 为MVC模式设计:分离可视化设计和应用程序逻辑;分离页面设计员和程序员 

5、智能的国际化和本地化 

  • 字符集智能化(内部使用UNICODE) 
  • 数字格式本地化敏感 
  • 日期和时间格式本地化敏感 
  • 非US字符集可以用作标识(如变量名) 
  • 多种不同语言的相同模板 

6、强大的XML处理能力 

<#recurse> 和<#visit>指令(2.3版本)用于递归遍历XML树 

在模板中清楚和直觉的访问XML对象模型 

Helloworld

新建一个WEB工程,下载(我使用的是freemarker-2.3.20)freemarker并导入freemarker.jar,在WEB-INF下新建文件夹templates用于存放模版文件

在templates下新建test.ftl,这是示例模版文件。内容就是HTML内容,里面带有一个标记符,用于将来进行变量替换,内容如下:

?
1
2
3
4
5
6
7
8
<html>
 <head>
    <title>freemarker测试</title>
  </head>
  <body>
    <h1>${message},${name}</h1>
  </body>
</html>

新建一个Servlet,用于请求设置变量,并处理模版的输出:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
package com.test.servlet;
import java.io.IOException;
import java.io.Writer;
import java.util.HashMap;
import java.util.Map;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import freemarker.template.Configuration;
import freemarker.template.Template;
import freemarker.template.TemplateException;
@SuppressWarnings("serial")
public class HelloFreeMarkerServlet extends HttpServlet {
  // 负责管理FreeMarker模板的Configuration实例
  private Configuration cfg = null;
  public void init() throws ServletException {
    // 创建一个FreeMarker实例
    cfg = new Configuration();
    // 指定FreeMarker模板文件的位置
    cfgsetServletContextForTemplateLoading(getServletContext(),
        "/WEB-INF/templates");
  }
  @SuppressWarnings("unchecked")
  public void doPost(HttpServletRequest request, HttpServletResponse response)
      throws ServletException, IOException {
    // 建立数据模型
    Map root = new HashMap();
    root.put("message", "hello world");
    root.put("name", "java小强");
    // 获取模板文件
    Template t = cfg.getTemplate("test.ftl");
    // 使用模板文件的Charset作为本页面的charset
    // 使用text/html MIME-type
    responsesetContentType("text/html; charset=" + tgetEncoding());
    Writer out = response.getWriter();
    // 合并数据模型和模板,并将结果输出到out中
    try {
      tprocess(root, out); // 往模板里写数据
    } catch (TemplateException e) {
      e.printStackTrace();
    }
  }
  public void doGet(HttpServletRequest request, HttpServletResponse response)
      throws ServletException, IOException {
    doPost(request, response);
  }
  public void destroy() {
    super.destroy();
  }
}

注意要在你的web.xml中配置该Servlet:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
  http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
  <servlet>
    <servlet-name>hello</servlet-name>
    <servlet-class>
      com.test.servlet.HelloFreeMarkerServlet
    </servlet-class>
  </servlet>
  <servlet-mapping>
    <servlet-name>hello</servlet-name>
    <url-pattern>/hello</url-pattern>
  </servlet-mapping>
  <welcome-file-list>
    <welcome-file>index.jsp</welcome-file>
  </welcome-file-list>
</web-app>

为了方便测试,访问工程直接跳转到Servlet,对主页index.jsp做一个简单修改:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%
String path = request.getContextPath();
String basePath = request.getScheme()+"://"+request.getServerName()
+":"+request.getServerPort()+path+"/";
%>
<html>
 <body>
  <%
  String mypath = "hello";
  response.sendRedirect(basePath + mypath);
  %>
 </body>
</html>