Freemarker实例教程
原创作品,允许转载,转载时请务必以超链接形式标明文章 原始出处 、作者信息和本人声明。否则将追究法律责任。
作者:永恒の_☆ 地址:http://blog.csdn.net/chenghui0317/article/details/7832474
一、Freemarker的介绍
Freemarker 是一款模板引擎,是一种基于模版生成静态文件的通用 工具,它是为java程序员提供的一个开发包,或者说是一个类库,它不是面向最终用户的,而是为程序员提供了一款可以嵌入他们开发产品的应用程序。
Freemarker 是使用纯java编写的,为了提高页面的访问速度,需要把页面静态化, 那么Freemarker就是被用来生成html页面。
到目前为止,Freemarker使用越来越广泛,不光光只是它强大的生成技术,而且它能够与spring进行很好的集成。
现在开始一层层揭开它的神秘面纱。。
二、Freemarker的准备条件
freemarker.2.3.16.jar 下载地址:http://download.csdn.net/detail/ch656409110/4494067 (这个jar包其实在struts2里面)
三、Freemarker生成静态页面的原理
Freemarker 生成静态页面,首先需要使用自己定义的模板页面,这个模板页面可以是最最普通的html,也可以是嵌套freemarker中的 取值表达式, 标签或者自定义标签等等,然后后台读取这个模板页面,解析其中的标签完成相对应的操作, 然后采用键值对的方式传递参数替换模板中的的取值表达式,做完之后 根据配置的路径生成一个新的html页面, 以达到静态化访问的目的。
四、Freemarker提供的标签
Freemarker提供了很多有用 常用的标签,Freemarker标签都是<#标签名称>这样子命名的,${value} 表示输出变量名的内容 ,具体如下:
1、list:该标签主要是进行迭代服务器端传递过来的List集合,比如:
- <#list nameList as names>
- ${names}
- </#list>
name是list循环的时候取的一个循环变量,freemarker在解析list标签的时候,等价于:
- for (String names : nameList) {
- System.out.println(names);
- }
2、if: 该标签主要是做if判断用的,比如:
- <#if (names=="陈靖仇")>
- 他的武器是: 十五~~
- </#if>
这个是条件判断标签,要注意的是条件等式必须用括号括起来, 等价于:
- if(names.equals("陈靖仇")){
- System.out.println("他的武器是: 十五~~");
- }
3、include:该标签用于导入文件用的。
- <#include "include.html"/>
这个导入标签非常好用,特别是页面的重用。
另外在静态文件中可以使用${} 获取值,取值方式和el表达式一样,非常方便。
下面举个例子(static.html):
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <html>
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
- <title>Insert title here</title>
- </head>
- <body>
- 描述:${description}
- <br/>
- 集合大小:${nameList?size}
- <br/>
- 迭代list集合:
- <br/>
- <#list nameList as names>
- 这是第${names_index+1}个人,叫做:<label style="color:red">${names}</label>
- if判断:
- <br/>
- <#if (names=="陈靖仇")>
- 他的武器是: 十五~~
- <#elseif (names=="宇文拓")> <#--注意这里没有返回而是在最后面-->
- 他的武器是: 轩辕剑~·
- <#else>
- 她的绝招是:蛊毒~~
- </#if>
- <br/>
- </#list>
- 迭代map集合:
- <br/>
- <#list weaponMap?keys as key>
- key--->${key}<br/>
- value----->${weaponMap[key]!("null")}
- <#--
- fremarker 不支持null, 可以用! 来代替为空的值。
- 其实也可以给一个默认值
- value-----${weaponMap[key]?default("null")}
- 还可以 在输出前判断是否为null
- <#if weaponMap[key]??></#if>都可以
- -->
- <br/>
- </#list>
- include导入文件:
- <br/>
- <#include "include.html"/>
- </body>
- </html>
实际代码:
- package com.chenghui.test;
- import java.io.File;
- import java.io.FileOutputStream;
- import java.io.IOException;
- import java.io.OutputStreamWriter;
- import java.io.Writer;
- import java.util.ArrayList;
- import java.util.HashMap;
- import java.util.List;
- import java.util.Map;
- import freemarker.template.Configuration;
- import freemarker.template.DefaultObjectWrapper;
- import freemarker.template.Template;
- import freemarker.template.TemplateException;
- public class CreateHtml {
- public static void main(String[] args) {
- try {
- //创建一个合适的Configration对象
- Configuration configuration = new Configuration();
- configuration.setDirectoryForTemplateLoading(new File("D:\\project\\webProject\\WebContent\\WEB-INF\\template"));
- configuration.setObjectWrapper(new DefaultObjectWrapper());
- configuration.setDefaultEncoding("UTF-8"); //这个一定要设置,不然在生成的页面中 会乱码
- //获取或创建一个模版。
- Template template = configuration.getTemplate("static.html");
- Map<String, Object> paramMap = new HashMap<String, Object>();
- paramMap.put("description", "我正在学习使用Freemarker生成静态文件!");
- List<String> nameList = new ArrayList<String>();
- nameList.add("陈靖仇");
- nameList.add("玉儿");
- nameList.add("宇文拓");
- paramMap.put("nameList", nameList);
- Map<String, Object> weaponMap = new HashMap<String, Object>();
- weaponMap.put("first", "轩辕剑");
- weaponMap.put("second", "崆峒印");
- weaponMap.put("third", "女娲石");
- weaponMap.put("fourth", "神农鼎");
- weaponMap.put("fifth", "伏羲琴");
- weaponMap.put("sixth", "昆仑镜");
- weaponMap.put("seventh", null);
- paramMap.put("weaponMap", weaponMap);
- Writer writer = new OutputStreamWriter(new FileOutputStream("success.html"),"UTF-8");
- template.process(paramMap, writer);
- System.out.println("恭喜,生成成功~~");
- } catch (IOException e) {
- e.printStackTrace();
- } catch (TemplateException e) {
- e.printStackTrace();
- }
- }
- }
这样子基本上可以算的上可以简单的去做一点简单的生成了,但是要在实际中去运用,还是差的很远的,因为freemarker给的标签完全满足不了我们的需要,这时候就需要自定义标签来完成我们的需求了。。
五、Freemarker自定义标签
Freemarker自定义标签就是自己写标签,然后自己解析,完全由自己来控制标签的输入输出,极大的为程序员提供了很大的发挥空间。
基于步骤:
以前写标签需要在<后加# ,但是freemarker要识别自定义标签需要在后面加上@,然后后面可以定义一些参数,当程序执行template.process(paramMap, out);,就会去解析整个页面的所有的freemarker标签。
自定义标签 需要自定义一个类,然后实现TemplateDirectiveModel,重写execute方法,完成获取参数,根据参数do something等等。。
将自定义标签与解析类绑定在一起需要在paramMap中放入该解析类的实例,存放的key与自定义标签一致即可。。
注意:在自定义标签中,如果标签内什么也没有,开始标签和结束标签绝对不能再同一行,不然会报错 freemarker.log.JDK14LoggerFactory$JDK14Logger error
我曾经上当过,这是freemarker 存在的bug。
下面是static.html的例子:
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <html>
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
- <title>Insert title here</title>
- </head>
- <body>
- <#--自定义变量-->
- <#assign num='hehe'/>
- ${num}
- <br/>
- 自定义标签
- <@content name="chenghui" age="120">
- ${output}
- ${append}
- </@content>
- </body>
- </html>
下面是上面的static.html模板的解析类:
- package com.chenghui.test;
- import static freemarker.template.ObjectWrapper.DEFAULT_WRAPPER;
- import java.io.IOException;
- import java.io.Writer;
- import java.util.Map;
- import freemarker.core.Environment;
- import freemarker.template.TemplateDirectiveBody;
- import freemarker.template.TemplateDirectiveModel;
- import freemarker.template.TemplateException;
- import freemarker.template.TemplateModel;
- import freemarker.template.TemplateModelException;
- import freemarker.template.TemplateNumberModel;
- import freemarker.template.TemplateScalarModel;
- /**
- * 自定义标签解析类
- * @author Administrator
- *
- */
- public class ContentDirective implements TemplateDirectiveModel{
- private static final String PARAM_NAME = "name";
- private static final String PARAM_AGE = "age";
- @Override
- public void execute(Environment env, Map params,TemplateModel[] loopVars,
- TemplateDirectiveBody body) throws TemplateException, IOException {
- if(body==null){
- throw new TemplateModelException("null body");
- }else{
- String name = getString(PARAM_NAME, params);
- Integer age = getInt(PARAM_AGE, params);
- //接收到参数之后可以根据做具体的操作,然后将数据再在页面中显示出来。
- if(name!=null){
- env.setVariable("output", DEFAULT_WRAPPER.wrap("从ContentDirective解析类中获得的参数是:"+name+", "));
- }
- if(age!=null){
- env.setVariable("append", DEFAULT_WRAPPER.wrap("年龄:"+age));
- }
- Writer out = env.getOut();
- out.write("从这里输出可以再页面看到具体的内容,就像document.writer写入操作一样。<br/>");
- body.render(out);
- /*
- 如果细心的话,会发现页面上是显示out.write()输出的语句,然后再输出output的内容,
- 可见 在body在解析的时候会先把参数放入env中,在页面遇到对应的而来表单时的才会去取值
- 但是,如果该表单时不存在,就会报错, 我觉得这里freemarker没有做好,解析的时候更加会把错误暴露在页面上。
- 可以这样子弥补${output!"null"},始终感觉没有el表达式那样好。
- */
- }
- }
- /**
- * 获取String类型的参数的值
- * @param paramName
- * @param paramMap
- * @return
- * @throws TemplateModelException
- */
- public static String getString(String paramName, Map<String, TemplateModel> paramMap) throws TemplateModelException{
- TemplateModel model = paramMap.get(paramName);
- if(model == null){
- return null;
- }
- if(model instanceof TemplateScalarModel){
- return ((TemplateScalarModel)model).getAsString();
- }else if (model instanceof TemplateNumberModel) {
- return ((TemplateNumberModel)model).getAsNumber().toString();
- }else{
- throw new TemplateModelException(paramName);
- }
- }
- /**
- *
- * 获得int类型的参数
- * @param paramName
- * @param paramMap
- * @return
- * @throws TemplateModelException
- */
- public static Integer getInt(String paramName, Map<String, TemplateModel> paramMap) throws TemplateModelException{
- TemplateModel model = paramMap.get(paramName);
- if(model==null){
- return null;
- }
- if(model instanceof TemplateScalarModel){
- String str = ((TemplateScalarModel)model).getAsString();
- try {
- return Integer.valueOf(str);
- } catch (NumberFormatException e) {
- throw new TemplateModelException(paramName);
- }
- }else if(model instanceof TemplateNumberModel){
- return ((TemplateNumberModel)model).getAsNumber().intValue();
- }else{
- throw new TemplateModelException(paramName);
- }
- }
- }
然后再前面的实际代码中加上:
- //自定义标签解析
- paramMap.put("content", new ContentDirective());
这样子基本上可以使用,freemarker完成自定义标签了,解决一写简单的业务逻辑, 但是在实际的项目中不可能这样子去做,因为还没有和spring进行集成使用,每次都需要在解析的时候把解析类的实例放进去。。
Freemarker实例教程的更多相关文章
- 图解CSS3制作圆环形进度条的实例教程
圆环形进度条制作的基本思想还是画出基本的弧线图形,然后CSS3中我们可以控制其旋转来串联基本图形,制造出部分消失的效果,下面就来带大家学习图解CSS3制作圆环形进度条的实例教程 首先,当有人说你能不能 ...
- Python导出Excel为Lua/Json/Xml实例教程(三):终极需求
相关链接: Python导出Excel为Lua/Json/Xml实例教程(一):初识Python Python导出Excel为Lua/Json/Xml实例教程(二):xlrd初体验 Python导出E ...
- Python导出Excel为Lua/Json/Xml实例教程(二):xlrd初体验
Python导出Excel为Lua/Json/Xml实例教程(二):xlrd初体验 相关链接: Python导出Excel为Lua/Json/Xml实例教程(一):初识Python Python导出E ...
- Python导出Excel为Lua/Json/Xml实例教程(一):初识Python
Python导出Excel为Lua/Json/Xml实例教程(一):初识Python 相关链接: Python导出Excel为Lua/Json/Xml实例教程(一):初识Python Python导出 ...
- 详解Linux交互式shell脚本中创建对话框实例教程_linux服务器
本教程我们通过实现来讲讲Linux交互式shell脚本中创建各种各样对话框,对话框在Linux中可以友好的提示操作者,感兴趣的朋友可以参考学习一下. 当你在终端环境下安装新的软件时,你可以经常看到信息 ...
- Solr 4.0 部署实例教程
Solr 4.0 部署实例教程 Solr 4.0的入门基础教程,先说一点部署之后肯定会有人用solrj,solr 4.0好像添加了不少东西,其中CommonsHttpSolrServer这个类改名为H ...
- React 入门实例教程(转载)
本人转载自: React 入门实例教程
- 分享本年度最佳的15个 Photoshop 实例教程
毫无疑问,Photoshop 是任何其类型的设计相关工作的最佳工具.有这么多东西,你可以用它来设计,发挥你的想象力,一切皆有可能. 现在,几乎所有的封面图像都会用 Photoshop 来修饰. 您可能 ...
- 值得 Web 开发人员学习的20个 jQuery 实例教程
这篇文章挑选了20个优秀的 jQuery 实例教程,这些 jQuery 教程将帮助你把你的网站提升到一个更高的水平.其中,既有网站中常用功能的的解决方案,也有极具吸引力的亮点功能的实现方法,相信通过对 ...
随机推荐
- HYSBZ - 3676
模板题.问你一个串里最大的值(回文子串*出现次数) /* gyt Live up to every day */ #include<cstdio> #include<cmath> ...
- ssh定义、操作
Secure Shell(縮寫为SSH)SSH為一项建立在应用层和传输层基础上的安全协议,为计算机上的Shell(壳层)提供安全的传输和使用环境. 传统的网络服务程序,如rsh.FTP.POP和Tel ...
- Python中subprocess 模块 创建并运行一个进程
python的subprocess模块,看到官方声明里说要尽力避免使用shell=True这个参数,于是测试了一下: from subprocess import call import shlex ...
- 2018.11.01 NOIP训练 木棒分组(搜索+剪枝)
传送门 测试搜索的时候状态定义错了233. 我们把木棒从大到小排序. 然后保证每一组搜到的木棒出现的长度是从大到小递减的. 直接定义现在搜的木棒从什么位置开始,当前这一组的总长度,之前几组的总长度. ...
- __getitem__()、__setitem__()与__delitem__()
# 如果想要运用[]取值,可以实现__getitem__() # 想要运用[]设值,可以实现__setitem__() # 若想通过del与[]来删除,可以实现__delitem__() class ...
- Typecho 官方文档 接口介绍
官方开发文档实在是太潦草了 Widget_Archive 接口 参数 描述 indexHandle $archive Widget_Archive对象 $select Typecho_Db_Query ...
- 20155205 2016-2017-2 《Java程序设计》第9周学习总结
20155205 2016-2017-2 <Java程序设计>第9周学习总结 教材学习内容总结 第十六章 JDBC简介 厂商在实现JDBC驱动程序时,依方式可将驱动程序分为四种类型: JD ...
- WordPress-Word图片上传插件整合教程-Xproer.WordPaster
插件下载(PHP):wordpress 3.7.1, 说明:由于许多插件可能使用相同钩子,导致冲突,所以提供手支方式整合. 1.上传插件目录. 说明:WordPress 3.7.1 使用的是TinyM ...
- 1.9yield方法
yield()方法的作用放弃当前的cpu资源,将他让给其他的任务去占用cpu的执行时间,但放弃的时间不确定,有可能刚放弃,马上又获得cpu时间片 测试 package com.cky.thread; ...
- leetcode - [7]Binary Tree Preorder Traversal
Given a binary tree, return the preorder traversal of its nodes' values. For example:Given binary tr ...