freemarker API demo

FreeMarker 是一款模板引擎:一种基于模板的、用来生成输出文本(任何来自于HTML格式的文本用来自动生成源代码)的通用工具。它是为Java 程序员提供的一个开发包或者说是类库。它不是面向最终用户,而是为程序员提供的可以嵌入他们开发产品的一款应用程序。

FreeMarker 的设计实际上是被用来生成HTML 网页,尤其是通过基于实现了MVC(ModelView Controller,模型-视图-控制器)模式的Servlet 应用程序。使MVC 模式的动态网页的构思使得你可以将前端设计者(编写HTML)从程序员中分离出来。所有人各司其职,发挥其擅长的一面。网页设计师可以改写页面的显示效果而不受程序员编译代码的影响,因为应用程序的逻辑(Java 程序)和页面设计(FreeMarker 模板)已经分开了。页面模板代码不会受到复杂的程序代码影响。这种分离的思想即便对一个程序员和页面设计师是同一个人的项目来说都是非常有用的,因为分离使得代码保持简洁而且便于维护。

尽管FreeMarker 也有编程能力,但它也不是像PHP 那样的一种全面的编程语言。反而,Java 程序准备的数据来显示(比如SQL 查询),FreeMarker 仅仅使用模板生成文本页面来呈现已经准备好的数据。

freemarker说白了就是一个模板生成工具,模板+数据模型=输出。

一下为API中简单demo.

API与所需JAR在 http://download.youkuaiyun.com/detail/wangxuewei111/5248999

首先创建数据模型 UpperCaseTransform(根据该模型,可将传进来的字符串变成大写)

 1 package com.wang;
 2 
 3 import java.io.*;
 4 import java.util.*;
 5 import freemarker.template.TemplateTransformModel;
 6 
 7 class UpperCaseTransform implements TemplateTransformModel {
 8     public Writer getWriter(Writer out, Map args) {
 9         return new UpperCaseWriter(out);
10     }
11 
12     private class UpperCaseWriter extends Writer {
13         private Writer out;
14 
15         UpperCaseWriter(Writer out) {
16             this.out = out;
17         }
18 
19         public void write(char[] cbuf, int off, int len) throws IOException {
20             out.write(new String(cbuf, off, len).toUpperCase());
21         }
22 
23         public void flush() throws IOException {
24             out.flush();
25         }
26 
27         public void close() {
28         }
29     }
30 }

编写test1.ftl模板

<#--将一下字符串转换成大写-->
blah1
<@upperCase>
blah2
blah3
</@upperCase>
blah4

<#--显示用户和链接-->
<html>
<head>
<title>Welcome!</title>
</head>
<body>
<h1>Welcome ${user}!</h1>
<p>Our latest product:
<a href="${latestProduct.url}">${latestProduct.name}</a>!
</body>
</html>

编写main方法Test

 1 package com.wang;
 2 
 3 import freemarker.template.*;
 4 import java.util.*;
 5 import java.io.*;
 6 
 7 public class Test {
 8     public static void main(String[] args) throws Exception {
 9         /* 一般在应用的整个生命周期中你仅需要执行一下代码一次 */
10         /* 创建一个合适的configuration */
11         Configuration cfg = new Configuration();
12         cfg.setDirectoryForTemplateLoading(new File(
13                 "D:"+File.separator+"wang"));
14         cfg.setObjectWrapper(new DefaultObjectWrapper());
15         /* 而以下代码你通常会在一个应用生命周期中执行多次 */
16         /* 获取或创建一个模版 */
17         Template temp = cfg.getTemplate("test1.ftl");
18         /* 创建一个数据模型Create a data model */
19         Map root = new HashMap();
20         root.put("upperCase", new UpperCaseTransform());
21         root.put("user", "Big Joe");
22         Map latest = new HashMap();
23         root.put("latestProduct", latest);
24         latest.put("url", "products/greenmouse.html");
25         latest.put("name", "green mouse");
26         SimpleHash root1 = new SimpleHash();
27         //放置一个简单的String 对象
28         root1.put("theString", "wombat");
29         //放置任意的一个java objects:
30         root1.put("theObject", new TestObject("green mouse",
31         1200));
32         /* 合并数据模型和模版 */
33         Writer out = new OutputStreamWriter(System.out);
34     temp.process(root, out);
35         out.flush();
36     }
37 }

控制台输出:

=========================================================

此外,freemarker中还有自己的标签,如模板中<#-- -->即为注释标签,有时间整理出来添加。

FreeMarker官方参考文档总共有四份,它们分别是  Designer's Guide(网上已有翻译,主要从FreeMarker 的概念上介绍)  Programmer's Guide(本文档所以翻译的部分,主要从框架的设计方面介绍)  XML Processing Guide(对XML数据模型处理的介绍)  Reference(FreeMarker 的参考文档,语言使用介绍) 中文翻译之所以选择 Programmer's Guide 是因为个人觉得该部分对如何实现 FreeMarker 进行了比较深入的阐述。有助于读者很好的了解其运作机制,以及去理解其他 模板引擎(如Velocity)的工作机理。 注:由于原文档部分内容直译可能难于被读者理解,所以有些地方采用意译为主,因此在翻译用词上 难 免 可 能 会 有 出 入 , 大 家 对 翻 译 的 内 容 有 任 何 意 见 都 可 以 给 我 直 接 发 邮 件 告 知 motomagice@yahoo.com.cn 目录 前言.........................................................................3 一、快速入门..............................................................4 1.1、创建配置实例..............................................................................4 1.2、创建数据模型(Data Model) ..........................................................4 1.3、获取模版(template) ..................................................................5 1.4、把模版与数据模型合并...................................................................6 1.5、完整的代码 ................................................................................6 二、数据模型(Data Model) ..........................................7 2.1、基础类型...................................................................................7 2.2、Scalar类型(单值对应的Data Model)...............................................8 2.3、容器类型...................................................................................8 2.4、方法变量...................................................................................9 2.5、转换器变量 .............................................................................. 10 2.6、节点变量................................................................................. 12 2.7、对象包裹................................................................................. 12 三、配置(Configuration)........................................... 15 3.1、基础....................................................................................... 15 3.2、共享变量................................................................................. 15 3.3、配置参数................................................................................. 16 3.4、加载模板................................................................................. 17 3.5、异常处理................................................................................. 19 四、其它说明............................................................ 20 4.1、变量....................................................................................... 20 4.2、字符编码................................................................................. 20 4.3、多线程.................................................................................... 21 4.5、Bean 包裹................................................................................ 21
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值