Using FreeMarker templates (FTL)- Tutorial

Table of Contents

FreeMarker Tutorial. This tutorial explains how can you define FreeMarker templates and how can you generate output based on these templates. It also demonstrates the usage of macros.

1. Introduction to FreeMarker

FreeMarker is a Java-based template engine which can be used in stand-alone or servlet-based Java programs.

In FreeMarker you define templates, which are text files that contain the desired output, except that they contain placeholders like ${name}, and even some logic like conditionals, loops, etc. In your Java program you supply the actual values for these placeholders and the final output is generated based on this input.

The input of templates is a bunch of named variables that you usually provide as a Map<String, Object> (the Map entries will be the variables) or as a JavaBean (the JavaBean properties will be the variables). The variable values can be simple strings, numbers and such primitive values, but also lists, maps, or arbitrary Java objects whose methods you can call from the template. Note that when accessing JavaBean properties, myObject.myProperty syntax should be used instead ofmyObject.getMyProperty().

The output of templates is written into a Writer that you provide, so it can go into a HTTP response (for dynamic web pages), into a local file, into a String, etc.

It is configurable from where FreeMarker reads the templates; commonly used options are loading from a file-system directory, from the class-path, from the servlet context ( WEB-INF/templates or such), or even from a database table. It’s also possible to "load" templates directly from String objects.
2. Installation of FreeMarker
To use FreeMarker download the latest version of it from the following webpage and add it to the classpath of your Java project.
http://freemarker.org/freemarkerdownload.html
3. Eclipse Integration
FreeMarker code completion and syntax highlighting is part of the JBoss Tools. Add the following update site to your Eclipse installation via Help ▸ Install New Software…
http://download.jboss.org/jbosstools/updates/stable/kepler/
4. Basic example
Create a new Java project called com.vogella.freemarker.first. Create a new folder called lib and add the Freemarker library to it. Add this library to the classpath for your project.

If you don’t know how to achieve that, please see the Eclipse IDE Tutorial for instructions on the required steps.
Create a new folder called templates inside the folder of the com.vogella.freemarker.first package. Inside that, create the following file with name helloworld.ftl.
<html>

<head>

  <title>${title}

</head>

<body>

  <h1>${title}</h1>

  <p>${exampleObject.name} by ${exampleObject.developer}</p>

  <ul>

    <#list systems as system>

      <li>${system_index + }. ${system.name} from ${system.developer}</li>

    </#list>

  </ul>

</body>

</html>
Create the following class which demonstrates the usage of Java objects in templates.
package com.vogella.freemarker.first;

public class ValueExampleObject {

        private String name;

        private String developer;

        public ValueExampleObject(String name, String developer) {

                this.name = name;

                this.developer = developer;

        }

        public String getName() {

                return name;

        }

        public String getDeveloper() {

                return developer;

        }

}
Create the following class which creates the input for this template and creates the output.
package com.vogella.freemarker.first;

import java.io.File;

import java.io.FileWriter;

import java.io.OutputStreamWriter;

import java.io.Writer;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.List;

import java.util.Locale;

import java.util.Map;

import freemarker.template.Configuration;

import freemarker.template.Template;

import freemarker.template.TemplateExceptionHandler;

import freemarker.template.Version;

public class MainTest {

        public static void main(String[] args) throws Exception {

                // 1. Configure FreeMarker

                //

                // You should do this ONLY ONCE, when your application starts,

                // then reuse the same Configuration object elsewhere.

                Configuration cfg = new Configuration();

                // Where do we load the templates from:

                cfg.setClassForTemplateLoading(MainTest.class, "templates");

                // Some other recommended settings:

                cfg.setIncompatibleImprovements(new Version(, , ));

                cfg.setDefaultEncoding("UTF-8");

                cfg.setLocale(Locale.US);

                cfg.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER);

                // 2. Proccess template(s)

                //

                // You will do this for several times in typical applications.

                // 2.1. Prepare the template input:

                Map<String, Object> input = new HashMap<String, Object>();

                input.put("title", "Vogella example");

                input.put("exampleObject", new ValueExampleObject("Java object", "me"));

                List<ValueExampleObject> systems = new ArrayList<ValueExampleObject>();

                systems.add(new ValueExampleObject("Android", "Google"));

                systems.add(new ValueExampleObject("iOS States", "Apple"));

                systems.add(new ValueExampleObject("Ubuntu", "Canonical"));

                systems.add(new ValueExampleObject("Windows7", "Microsoft"));

                input.put("systems", systems);

                // 2.2. Get the template

                Template template = cfg.getTemplate("helloworld.ftl");

                // 2.3. Generate the output

                // Write output to the console

                Writer consoleWriter = new OutputStreamWriter(System.out);

                template.process(input, consoleWriter);

                // For the sake of example, also write output into a file:

                Writer fileWriter = new FileWriter(new File("output.html"));

                try {

                        template.process(input, fileWriter);

                } finally {

                        fileWriter.close();

                }

        }

}
5. Useful FTL tricks
5.1. Reuse common template fragments

When you find yourself copy-pasting common parts between templates a lot, you should probably use macros.
Continuing our last example, create a new folder called lib inside the templates directory, and there create a file called utils.ftl, with this content:
<#macro page>

  <html>

  <head>

    <title>${title}

  </head>

  <body>

    <h1>${title}</h1>

    <#-- This processes the enclosed content:  -->

    <#nested>

  </body>

  </html>

</#macro>

<#macro otherExample p1 p2>

  <p>The parameters were: ${p1}, ${p2}</p>

</#macro>
Now you can simplify helloworld.ftl like this:
<#import "lib/utils.ftl" as u>

<@u.page>

  <p>${exampleObject.name} by ${exampleObject.developer}</p>

  <ul>

    <#list systems as system>

      <li>${system_index + }. ${system.name} from ${system.developer}</li>

    </#list>

  </ul>

  <#-- Just another example of using a macro: -->

  <@u.otherExample p1= p2= />

</@u.page>
Another way of reusing template fragments is moving the common fragment into its own ftl file. Then just insert it with <#include "lib/myfragment.ftl">. This is less flexible than macros, but simpler in concept: it mimics copy-pasting.
5.2. Variables
You can define and assign content to variables inside the FTL files for easy reuse.
<#assign var_link = "http://www.vogella.com/people/larsvogel.html">

<a href="${var_link}">About Lars Vogel</a>
5.3. Handling null/undefined values
FreeMarker requires you to provide an explicit default for variables, so avoid values that are null or undefined:


<p>Color: ${color!'N/A'}</p>



<#if color??>

  <p>Color: ${color}</p>

</#if>
5.4. Escape
When generating HTML, it’s important to escape <, &, etc. in values that were not meant to store HTML and can contain these problematic characters. You can apply such escaping like ${message?html}. You can also ask FreeMarker to add ?html to all ${} -s in a section like this:
<#escape x as x?html>

  <p>Sender: ${from}

  <p>Title: ${title}

  <p>Message: ${body}

</#escape>
It’s important to understand that #escape only affects the ${} bits that are inside the enclosed section in the template file when you look at it in a text editor. That means, ${} embracements which are in other templates or macros called from there, won’t be affected.

转载自：http://www.vogella.com/tutorials/FreeMarker/article.html

Using FreeMarker templates (FTL)- Tutorial的更多相关文章

[Freemarker] - 使用struts的component调用freemarker的ftl模板方法
struts中的component标签,可以用来调用freemarker的ftl模板文件,使用component标签传参可以这样写: 使用property方式写法: <s:component t ...
freemarker（FTL）常见语法大全
[转载]freemarker(FTL)常见语法大全 FreeMarker的插值有如下两种类型:1,通用插值${expr};2,数字格式化插值:#{expr}或#{expr;format} ${boo ...
FreeMarker之FTL指令
assign指令此指令用于在页面上定义一个变量 (1)定义简单类型: <#assign linkman="周先生"> 联系人:${linkman} (2)定义对象类型 ...
freemarker【FTL】常见语法大全
FreeMarker的插值有如下两种类型:1,通用插值${expr};2,数字格式化插值:#{expr}或#{expr;format} ${book.name?if_exists } //用于判断如果 ...
JAVAWEB使用FreeMarker利用ftl把含有图片的word模板生成word文档，然后打包成压缩包进行下载
这是写的另一个导出word方法:https://www.cnblogs.com/pxblog/p/13072711.html 引入jar包,freemarker.jar.apache-ant-zip- ...
修改freemarker的ftl时，不重启tomcat的办法（使用了springMVC）
一.在使用Freemarker 时,需要在spring-mvc.xml 配置文件中作如下配置:  <bean id="f ...
FTL(FreeMarker)基础
FreeMarker标签使用一.FreeMarker模板文件主要有4个部分组成1.文本,直接输出的部分2.注释,即<#--...-->格式不会输出3.插值(Interpolation):即 ...
Freemarker 程序开发
Freemarker 程序开发现在web开发中,多使用freemarker 来描述页面.通常会使用的macro来定义各种组件,从而达到UI组件的复用.结合使用其它的指定,可快速的描述一个html页面 ...
Spring MVC 学习总结（七）——FreeMarker模板引擎与动态页面静态化
模板引擎可以让程序实现界面与数据分离,业务代码与逻辑代码的分离,这就提升了开发效率,良好的设计也使得代码复用变得更加容易.一般的模板引擎都包含一个模板解析器和一套标记语言,好的模板引擎有简洁的语法规则 ...

随机推荐

Python学习笔记（一）python基础与函数
1.python基础 1.1输入与输出输出用print加上字符串,就可以打印指定的文字或数字 >>> print 'hello, world' hello, world > ...
docker 组件(c/s)
Docker 组件 1. docker client : docker的客户端 2. docker server : docker daemon的主要组成部分,接受用户通过docker client发 ...
CentOS 7 安装字体库 & 中文字体
前言报表中发现有中文乱码和中文字体不整齐(重叠)的情况,首先考虑的就是操作系统是否有中文字体,在CentOS 7中发现输入命令查看字体列表是提示命令无效: 如上图可以看出,不仅没有中文字体,连字体 ...
Docker入门简介
Docker的概念什么是Docker? Docker是一个开源平台,包含:容器引擎和Docker Hub注册服务器 Docker容器引擎:可以将开发者打包他们的应用和依赖包到一个可一直的容器中,然后 ...
sys.argv
import sys i=0 print len(sys.argv) while i < len(sys.argv): print 'sys.argv[%d]:%s' %(i,sys.argv[ ...
[Android Tips] 19. Android Studio Plugins
Code Generation GsonFormat json 字符串生成实体类 https://github.com/zzz40500/GsonFormat Android Parcelable C ...
composer--------------通过composer.json下载laravel包----barryvdh/laravel-debugbar
1.去Packagist网站https://packagist.org/packages/barryvdh/laravel-debugbar#dev-master找到
How to use umbraco datetime property editor
When I was using Umbraco datetime property editor, I met with a problem that the editor must be firs ...
linux定时任务的设置 crontab 配置指南
为当前用户创建cron服务 1. 键入 crontab -e 编辑crontab服务文件例如文件内容如下: */2 * * * * /bin/sh /home/admin/jiaoben/bu ...
sqlserver中DATE类型的数据转化 CONVERT
主要描述的是SQL Server使用convert取得datetime日期数据的实际操作流程,在实际操作中用SQL Server数据库中用convert来获取datetime日期数据,以下实例包含各种 ...

Using FreeMarker templates (FTL)- Tutorial

1. Introduction to FreeMarker

2. Installation of FreeMarker

3. Eclipse Integration

4. Basic example

5. Useful FTL tricks

5.1. Reuse common template fragments

5.2. Variables

5.3. Handling null/undefined values

5.4. Escape

Using FreeMarker templates (FTL)- Tutorial的更多相关文章

随机推荐

热门专题