在项目中使用Spring的注解，关于spring的注解，由两种注解方式，

基于注释（Annotation）的配置有越来越流行的趋势，Spring 2.5 顺应这种趋势，提供了完全基于注释配置 Bean、装配 Bean 的功能，您可以使用基于注释的 Spring IoC 替换原来基于 XML 的配置。本文通过实例详细讲述了 Spring 2.5 基于注释 IoC 功能的使用。

概述

注释配置相对于 XML 配置具有很多的优势：

• 它可以充分利用 Java 的反射机制获取类结构信息，这些信息可以有效减少配置的工作。如使用 JPA 注释配置 ORM 映射时，我们就不需要指定 PO 的属性名、类型等信息，如果关系表字段和 PO 属性名、类型都一致，您甚至无需编写任务属性映射信息——因为这些信息都可以通过 Java 反射机制获取。
• 注释和 Java 代码位于一个文件中，而 XML 配置采用独立的配置文件，大多数配置信息在程序开发完成后都不会调整，如果配置信息和 Java 代码放在一起，有助于增强程序的内聚性。而采用独立的 XML 配置文件，程序员在编写一个功能时，往往需要在程序文件和配置文件中不停切换，这种思维上的不连贯会降低开发效率。

因此在很多情况下，注释配置比 XML 配置更受欢迎，注释配置有进一步流行的趋势。Spring 2.5 的一大增强就是引入了很多注释类，现在您已经可以使用注释配置完成大部分 XML 配置的功能。在这篇文章里，我们将向您讲述使用注释进行 Bean 定义和依赖注入的内容。

使用 @Autowired 注释

Spring 2.5 引入了 @Autowired 注释，它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作。

Spring 通过一个 BeanPostProcessor 对 @Autowired 进行解析，所以要让 @Autowired 起作用必须事先在 Spring 容器中声明 AutowiredAnnotationBeanPostProcessor Bean。

在Spring中配置如下：

<!-- 该 BeanPostProcessor 将自动起作用，对标注 @Autowired 的 Bean 进行自动注入 -->
    <bean class="org.springframework.beans.factory.annotation.
        AutowiredAnnotationBeanPostProcessor"/>
当 Spring 容器启动时，AutowiredAnnotationBeanPostProcessor 将扫描 Spring 容器中所有 Bean，当发现 Bean 中拥有 @Autowired 注释时就找到和其匹配（默认按类型匹配）的 Bean，并注入到对应的地方中去。

按照上面的配置，Spring 将直接采用 Java 反射机制对 Boss 中的 car 和 office 这两个私有成员变量进行自动注入。所以对成员变量使用 @Autowired 后，您大可将它们的 setter 方法（setCar() 和 setOffice()）从 Boss 中删除。

当然，您也可以通过 @Autowired 对方法或构造函数进行标注，

当候选 Bean 数目不为 1 时的应对方法

在默认情况下使用 @Autowired 注释进行自动注入时，Spring 容器中匹配的候选 Bean 数目必须有且仅有一个。当找不到一个匹配的 Bean 时，Spring 容器将抛出 BeanCreationException 异常，并指出必须至少拥有一个匹配的 Bean。

当不能确定 Spring 容器中一定拥有某个类的 Bean 时，可以在需要自动注入该类 Bean 的地方可以使用 @Autowired(required = false)，这等于告诉 Spring：在找不到匹配 Bean 时也不报错。

一般情况下，使用 @Autowired 的地方都是需要注入 Bean 的，使用了自动注入而又允许不注入的情况一般仅会在开发期或测试期碰到（如为了快速启动 Spring 容器，仅引入一些模块的 Spring 配置文件），所以 @Autowired(required = false) 会很少用到。

和找不到一个类型匹配 Bean 相反的一个错误是：如果 Spring 容器中拥有多个候选 Bean，Spring 容器在启动时也会抛出 BeanCreationException 异常。

Spring 允许我们通过 @Qualifier 注释指定注入 Bean 的名称，这样歧义就消除了，可以通过下面的方法解决异常：

清单 13. 使用 @Qualifier 注释指定注入 Bean 的名称

            @Autowired
            public void setOffice(@Qualifier("office")Office office) {
            this.office = office;
            }
            

@Qualifier("office") 中的 office 是 Bean 的名称，所以 @Autowired 和 @Qualifier 结合使用时，自动注入的策略就从 byType 转变成 byName 了。@Autowired 可以对成员变量、方法以及构造函数进行注释，而 @Qualifier 的标注对象是成员变量、方法入参、构造函数入参。正是由于注释对象的不同，所以 Spring 不将 @Autowired 和 @Qualifier 统一成一个注释类。下面是对成员变量和构造函数入参进行注释的代码：

对成员变量进行注释：

对成员变量使用 @Qualifier 注释

            public class Boss {
            @Autowired
            private Car car;
            @Autowired
            @Qualifier("office")
            private Office office;
            …
            }
            

对构造函数入参进行注释：

清单 15. 对构造函数变量使用 @Qualifier 注释

            public class Boss {
            private Car car;
            private Office office;
            @Autowired
            public Boss(Car car , @Qualifier("office")Office office){
            this.car = car;
            this.office = office ;
            }
            }
            

@Qualifier 只能和 @Autowired 结合使用，是对 @Autowired 有益的补充。一般来讲，@Qualifier 对方法签名中入参进行注释会降低代码的可读性，而对成员变量注释则相对好一些。

使用 JSR-250 的注释

Spring 不但支持自己定义的 @Autowired 的注释，还支持几个由 JSR-250 规范定义的注释，它们分别是 @Resource、@PostConstruct 以及 @PreDestroy。

@Resource

@Resource 的作用相当于 @Autowired，只不过 @Autowired 按 byType 自动注入，面 @Resource 默认按 byName 自动注入罢了。@Resource 有两个属性是比较重要的，分别是 name 和 type，Spring 将 @Resource 注释的 name 属性解析为 Bean 的名字，而 type 属性则解析为 Bean 的类型。所以如果使用 name 属性，则使用 byName 的自动注入策略，而使用 type 属性时则使用 byType 自动注入策略。如果既不指定 name 也不指定 type 属性，这时将通过反射机制使用 byName 自动注入策略。

Resource 注释类位于 Spring 发布包的 lib/j2ee/common-annotations.jar 类包中，因此在使用之前必须将其加入到项目的类库中。来看一个使用 @Resource 的例子：

清单 16. 使用 @Resource 注释的 Boss.java

            package com.baobaotao;
            import javax.annotation.Resource;
            public class Boss {
            // 自动注入类型为 Car 的 Bean
            @Resource
            private Car car;
            // 自动注入 bean 名称为 office 的 Bean
            @Resource(name = "office")
            private Office office;
            }
            

一般情况下，我们无需使用类似于 @Resource(type=Car.class) 的注释方式，因为 Bean 的类型信息可以通过 Java 反射从代码中获取。

要让 JSR-250 的注释生效，除了在 Bean 类中标注这些注释外，还需要在 Spring 容器中注册一个负责处理这些注释的 BeanPostProcessor：

<bean
            class="org.springframework.context.annotation.CommonAnnotationBeanPostProcessor"/>
            

CommonAnnotationBeanPostProcessor 实现了 BeanPostProcessor 接口，它负责扫描使用了 JSR-250 注释的 Bean，并对它们进行相应的操作。

@PostConstruct 和 @PreDestroy

Spring 容器中的 Bean 是有生命周期的，Spring 允许在 Bean 在初始化完成后以及 Bean 销毁前执行特定的操作，您既可以通过实现 InitializingBean/DisposableBean 接口来定制初始化之后 / 销毁之前的操作方法，也可以通过 <bean> 元素的 init-method/destroy-method 属性指定初始化之后 / 销毁之前调用的操作方法。关于 Spring 的生命周期，笔者在《精通 Spring 2.x—企业应用开发精解》第 3 章进行了详细的描述，有兴趣的读者可以查阅。

JSR-250 为初始化之后/销毁之前方法的指定定义了两个注释类，分别是 @PostConstruct 和 @PreDestroy，这两个注释只能应用于方法上。标注了 @PostConstruct 注释的方法将在类实例化后调用，而标注了 @PreDestroy 的方法将在类销毁之前调用。

清单 17. 使用 @PostConstruct 和 @PreDestroy 注释的 Boss.java

            package com.baobaotao;
            import javax.annotation.Resource;
            import javax.annotation.PostConstruct;
            import javax.annotation.PreDestroy;
            public class Boss {
            @Resource
            private Car car;
            @Resource(name = "office")
            private Office office;
            @PostConstruct
            public void postConstruct1(){
            System.out.println("postConstruct1");
            }
            @PreDestroy
            public void preDestroy1(){
            System.out.println("preDestroy1");
            }
            …
            }
            

您只需要在方法前标注 @PostConstruct 或 @PreDestroy，这些方法就会在 Bean 初始化后或销毁之前被 Spring 容器执行了。

我们知道，不管是通过实现 InitializingBean/DisposableBean 接口，还是通过 <bean> 元素的 init-method/destroy-method 属性进行配置，都只能为 Bean 指定一个初始化 / 销毁的方法。但是使用 @PostConstruct 和 @PreDestroy 注释却可以指定多个初始化 / 销毁方法，那些被标注 @PostConstruct 或 @PreDestroy 注释的方法都会在初始化 / 销毁时被执行。

通过以下的测试代码，您将可以看到 Bean 的初始化 / 销毁方法是如何被执行的：

清单 18. 测试类代码

            package com.baobaotao;
            import org.springframework.context.support.ClassPathXmlApplicationContext;
            public class AnnoIoCTest {
            public static void main(String[] args) {
            String[] locations = {"beans.xml"};
            ClassPathXmlApplicationContext ctx =
            new ClassPathXmlApplicationContext(locations);
            Boss boss = (Boss) ctx.getBean("boss");
            System.out.println(boss);
            ctx.destroy();// 关闭 Spring 容器，以触发 Bean 销毁方法的执行
            }
            }
            

这时，您将看到标注了 @PostConstruct 的 postConstruct1() 方法将在 Spring 容器启动时，创建 Boss Bean 的时候被触发执行，而标注了 @PreDestroy 注释的 preDestroy1() 方法将在 Spring 容器关闭前销毁 Boss Bean 的时候被触发执行。

回页首

使用 <context:annotation-config/> 简化配置

Spring 2.1 添加了一个新的 context 的 Schema 命名空间，该命名空间对注释驱动、属性文件引入、加载期织入等功能提供了便捷的配置。我们知道注释本身是不会做任何事情的，它仅提供元数据信息。要使元数据信息真正起作用，必须让负责处理这些元数据的处理器工作起来。

而我们前面所介绍的 AutowiredAnnotationBeanPostProcessor 和 CommonAnnotationBeanPostProcessor 就是处理这些注释元数据的处理器。但是直接在 Spring 配置文件中定义这些 Bean 显得比较笨拙。Spring 为我们提供了一种方便的注册这些 BeanPostProcessor 的方式，这就是 <context:annotation-config/>。请看下面的配置：

清单 19. 调整 beans.xml 配置文件

            <?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"
            xsi:schemaLocation="http://www.springframework.org/schema/beans
            http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
            http://www.springframework.org/schema/context
            http://www.springframework.org/schema/context/spring-context-2.5.xsd">
            <context:annotation-config/>
            <bean id="boss" class="com.baobaotao.Boss"/>
            <bean id="office" class="com.baobaotao.Office">
            <property name="officeNo" value="001"/>
            </bean>
            <bean id="car" class="com.baobaotao.Car" scope="singleton">
            <property name="brand" value=" 红旗 CA72"/>
            <property name="price" value="2000"/>
            </bean>
            </beans>
            

<context:annotationconfig/> 将隐式地向 Spring 容器注册 AutowiredAnnotationBeanPostProcessor、CommonAnnotationBeanPostProcessor、PersistenceAnnotationBeanPostProcessor 以及 equiredAnnotationBeanPostProcessor 这 4 个 BeanPostProcessor。

在配置文件中使用 context 命名空间之前，必须在 <beans> 元素中声明 context 命名空间。

回页首

使用 @Component

虽然我们可以通过 @Autowired 或 @Resource 在 Bean 类中使用自动注入功能，但是 Bean 还是在 XML 文件中通过 <bean> 进行定义 —— 也就是说，在 XML 配置文件中定义 Bean，通过 @Autowired 或 @Resource 为 Bean 的成员变量、方法入参或构造函数入参提供自动注入的功能。能否也通过注释定义 Bean，从 XML 配置文件中完全移除 Bean 定义的配置呢？答案是肯定的，我们通过 Spring 2.5 提供的 @Component 注释就可以达到这个目标了。

下面，我们完全使用注释定义 Bean 并完成 Bean 之间装配：

清单 20. 使用 @Component 注释的 Car.java

            package com.baobaotao;
            import org.springframework.stereotype.Component;
            @Component
            public class Car {
            …
            }
            

仅需要在类定义处，使用 @Component 注释就可以将一个类定义了 Spring 容器中的 Bean。下面的代码将 Office 定义为一个 Bean：

清单 21. 使用 @Component 注释的 Office.java

            package com.baobaotao;
            import org.springframework.stereotype.Component;
            @Component
            public class Office {
            private String officeNo = "001";
            …
            }
            

这样，我们就可以在 Boss 类中通过 @Autowired 注入前面定义的 Car 和 Office Bean 了。

清单 22. 使用 @Component 注释的 Boss.java

            package com.baobaotao;
            import org.springframework.beans.factory.annotation.Autowired;
            import org.springframework.beans.factory.annotation.Required;
            import org.springframework.beans.factory.annotation.Qualifier;
            import org.springframework.stereotype.Component;
            @Component("boss")
            public class Boss {
            @Autowired
            private Car car;
            @Autowired
            private Office office;
            …
            }
            

@Component 有一个可选的入参，用于指定 Bean 的名称，在 Boss 中，我们就将 Bean 名称定义为“boss”。一般情况下，Bean 都是 singleton 的，需要注入 Bean 的地方仅需要通过 byType 策略就可以自动注入了，所以大可不必指定 Bean 的名称。

在使用 @Component 注释后，Spring 容器必须启用类扫描机制以启用注释驱动 Bean 定义和注释驱动 Bean 自动注入的策略。Spring 2.5 对 context 命名空间进行了扩展，提供了这一功能，请看下面的配置：

清单 23. 简化版的 beans.xml

            <?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"
            xsi:schemaLocation="http://www.springframework.org/schema/beans
            http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
            http://www.springframework.org/schema/context
            http://www.springframework.org/schema/context/spring-context-2.5.xsd">
            <context:component-scan base-package="com.baobaotao"/>
            </beans>
            

这里，所有通过 <bean> 元素定义 Bean 的配置内容已经被移除，仅需要添加一行 <context:component-scan/> 配置就解决所有问题了——Spring XML 配置文件得到了极致的简化（当然配置元数据还是需要的，只不过以注释形式存在罢了）。<context:component-scan/> 的 base-package 属性指定了需要扫描的类包，类包及其递归子包中所有的类都会被处理。

<context:component-scan/> 还允许定义过滤器将基包下的某些类纳入或排除。Spring 支持以下 4 种类型的过滤方式，通过下表说明：

表 1. 扫描过滤方式

下面是一个简单的例子：

<context:component-scan base-package="com.baobaotao">
            <context:include-filter type="regex"
            expression="com\.baobaotao\.service\..*"/>
            <context:exclude-filter type="aspectj"
            expression="com.baobaotao.util..*"/>
            </context:component-scan>
            

值得注意的是 <context:component-scan/> 配置项不但启用了对类包进行扫描以实施注释驱动 Bean 定义的功能，同时还启用了注释驱动自动注入的功能（即还隐式地在内部注册了 AutowiredAnnotationBeanPostProcessor 和 CommonAnnotationBeanPostProcessor），因此当使用 <context:component-scan/> 后，就可以将 <context:annotation-config/> 移除了。

默认情况下通过 @Component 定义的 Bean 都是 singleton 的，如果需要使用其它作用范围的 Bean，可以通过 @Scope 注释来达到目标，如以下代码所示：

清单 24. 通过 @Scope 指定 Bean 的作用范围

            package com.baobaotao;
            import org.springframework.context.annotation.Scope;
            …
            @Scope("prototype")
            @Component("boss")
            public class Boss {
            …
            }
            

这样，当从 Spring 容器中获取 boss Bean 时，每次返回的都是新的实例了。

回页首

采用具有特殊语义的注释

Spring 2.5 中除了提供 @Component 注释外，还定义了几个拥有特殊语义的注释，它们分别是：@Repository、@Service 和 @Controller。在目前的 Spring 版本中，这 3 个注释和 @Component 是等效的，但是从注释类的命名上，很容易看出这 3 个注释分别和持久层、业务层和控制层（Web 层）相对应。虽然目前这 3 个注释和 @Component 相比没有什么新意，但 Spring 将在以后的版本中为它们添加特殊的功能。所以，如果 Web 应用程序采用了经典的三层分层结构的话，最好在持久层、业务层和控制层分别采用 @Repository、@Service 和 @Controller 对分层中的类进行注释，而用 @Component 对那些比较中立的类进行注释。

回页首

注释配置和 XML 配置的适用场合

是否有了这些 IOC 注释，我们就可以完全摒除原来 XML 配置的方式呢？答案是否定的。有以下几点原因：

• 注释配置不一定在先天上优于 XML 配置。如果 Bean 的依赖关系是固定的，（如 Service 使用了哪几个 DAO 类），这种配置信息不会在部署时发生调整，那么注释配置优于 XML 配置；反之如果这种依赖关系会在部署时发生调整，XML 配置显然又优于注释配置，因为注释是对 Java 源代码的调整，您需要重新改写源代码并重新编译才可以实施调整。
• 如果 Bean 不是自己编写的类（如 JdbcTemplate、SessionFactoryBean 等），注释配置将无法实施，此时 XML 配置是唯一可用的方式。
• 注释配置往往是类级别的，而 XML 配置则可以表现得更加灵活。比如相比于 @Transaction 事务注释，使用 aop/tx 命名空间的事务配置更加灵活和简单。

所以在实现应用中，我们往往需要同时使用注释配置和 XML 配置，对于类级别且不会发生变动的配置可以优先考虑注释配置；而对于那些第三方类以及容易发生调整的配置则应优先考虑使用 XML 配置。Spring 会在具体实施 Bean 创建和 Bean 注入之前将这两种配置方式的元信息融合在一起。

回页首

小结

Spring 在 2.1 以后对注释配置提供了强力的支持，注释配置功能成为 Spring 2.5 的最大的亮点之一。合理地使用 Spring 2.5 的注释配置，可以有效减少配置的工作量，提高程序的内聚性。但是这并不意味着传统 XML 配置将走向消亡，在第三方类 Bean 的配置，以及那些诸如数据源、缓存池、持久层操作模板类、事务管理等内容的配置上，XML 配置依然拥有不可替代的地位。

什么叫控制反转呢？套用好莱坞的一句名言就是：你呆着别动，到时我会找你。
什么意思呢？就好比一个皇帝和太监
有一天皇帝想宠幸某个美女，于是跟太监说，今夜我要宠幸美女
皇帝往往不会告诉太监，今晚几点会回宫，会回哪张龙床，他只会告诉太监他要哪位美女
其它一切都交由太监去安排，到了晚上皇帝回宫时，自然会有美女出现在皇帝的龙床上
这就是控制反转，而把美女送到皇帝的寝宫里面去就是注射
太监就是是框架里面的注射控制器类BeanFactory，负责找到美女并送到龙床上去
整个后宫可以看成是Spring框架，美女就是Spring控制下的JavaBean
而传统的模式就是一个饥渴男去找小姐出台
找领班，帮助给介绍一个云云，于是领班就开始给他张罗
介绍一个合适的给他，完事后，再把小姐还给领班，下次再来
这个过程中，领班就是查询上下文Context，领班的一个职能就是给客户找到他们所要的小姐
这就是lookup()方法，领班手中的小姐名录就是JNDI//Java Naming and Directory Interface
小姐就是EJB，饥渴男是客户端，青楼是EJB容器
看到区别了么？

饥渴男去找小姐出台很麻烦，不仅得找，用完后还得把小姐给还回去

而皇帝爽翻了，什么都不用管，交给太监去处理，控制权转移到太监手中去了而不是皇帝，

必要时候由太监给注射进去就可以了

（1）模板 + 数据模型 = 输出

FreeMarker基于设计者和程序员是具有不同专业技能的不同个体的观念他们是分工劳动的：
设计者专注于表示——创建HTML文件、图片、Web页面的其它可视化方面；
程序员创建系统，生成设计页面要显示的数据。
经常会遇到的问题是：在Web页面（或其它类型的文档）中显示的信息在设计页面时是无效的，是基于动态数据的。在这里，你可以在HTML（或其它要输出的文本）中加入一些特定指令，FreeMarker会在输出页面给最终用户时，用适当的数据替代这些代码。

先来解释一下freemaker的基本语法了，
<# ... > 中存放所有freemaker的内容，之外的内容全部原样输出。
<@ ... /> 是函数调用
两个定界符内的内容中，第一个符号表示指令或者函数名，其后的跟随参数。freemaker提供的控制包括如下：
<#if condition><#elseif condition><#else> 条件判断
<#list hash_or_seq as var> 遍历hash表或者collection（freemaker称作sequence）的成员
<#macro name param1 param2 ... ><#nested param> 宏，无返回参数
<#function name param1 param2><#return val>函数，有返回参数
var?member_function(...) 用函数对var进行转换，freemaker称为build-ins。实际内部实现类似member_function(var, ...)
stringA[M .. N] 取子字符串，类似substring(stringA, M, N)
{key:value, key2:value2 ...} 直接定义一个hash表
[item0, item1, item2 ...] 直接定义一个序列
hash0[key0] 存取hash表中key对应的元素
seq0[5] 存取序列指定下标的元素
<@function1 param0 param1 ... /> 调用函数function1
<@macro0 param0 param1 ; nest_param0 nest_param1 ...> nest_body </@macro> 调用宏，并处理宏的嵌套
<#assign var = value > 定义变量并初始化
<#local var = value> 在 macro 或者 function 中定义局部变量并初始化
<#global var = value > 定义全局变量并初始化
${var} 输出并替换为表达式的值
<#visit xmlnode> 调用macro匹配xmlnode本身及其子节点
<#recurse xmlnode> 调用macro匹配xmlnode的子节点

下面是一个例子：

<html>

<head>

<title>Welcome!</title>

</head>

<body>

<h1>Welcome ${user}!</h1>

<p>Our latest product:

<a href="${latestProduct.url}">${latestProduct.name}</a>!

</body>

</html>  

下面是一个可能的数据模型：

(root)

|

+- user = "Big Joe"

|

+- latestProduct

|

+- url = "products/greenmouse.html"

|

+- name = "green mouse"

2、数据模型

（1）基础

在快速入门中介绍了在模板中使用的三种基本对象类型：scalars、hashes 和sequences，其实还可以有其它更多的能力：

• scalars：存储单值

• hashes：充当其它对象的容器，每个都关联一个唯一的查询名字

• sequences：充当其它对象的容器，按次序访问

• 方法：通过传递的参数进行计算，以新对象返回结果

• 用户自定义FTL标记：宏和变换器

通常每个变量只具有上述的一种能力，但一个变量可以具有多个上述能力，如下面的例子：

(root)

|

+- mouse = "Yerri"

|

+- age = 12

|

+- color = "brown">  

${mouse}       <#-- use mouse as scalar -->

${mouse.age}   <#-- use mouse as hash -->

${mouse.color} <#-- use mouse as hash -->  

Yerri

12

brown  

（2）Scalar变量

Scalar变量存储单值，可以是：

• 字符串：简单文本，在模板中使用引号（单引号或双引号）括起

• 数字：在模板中直接使用数字值

• 日期：存储日期/时间相关的数据，可以是日期、时间或日期-时间（Timestamp）；通常情况，日期值由程序员加到数据模型中，设计者只需要显示它们

• 布尔值：true或false，通常在<#if …>标记中使用

（3）hashes 、sequences和集合

有些变量不包含任何可显示的内容，而是作为容器包含其它变量，者有两种类型：

• hashes：具有一个唯一的查询名字和它包含的每个变量相关联

• sequences：使用数字和它包含的每个变量相关联，索引值从0开始

集合变量通常类似sequences，除非无法访问它的大小和不能使用索引来获得它的子变量；集合可以看作只能由<#list …>指令使用的受限sequences

（4）方法

方法变量通常是基于给出的参数计算值。

下面的例子假设程序员已经将方法变量avg放到数据模型中，用来计算数字平均值：

The average of 3 and 5 is: ${avg(3, 5)}

The average of 6 and 10 and 20 is: ${avg(6, 10, 20)}

The average of the price of python and elephant is: 

${avg(animals.python.price, animals.elephant.price)}

（5）宏和变换器

宏和变换器变量是用户自定义指令（自定义FTL标记），会在后面讲述这些高级特性

（6）节点

节点变量表示为树型结构中的一个节点，通常在XML处理中使用，会在后面的专门章节中讲

3、模板

（1）整体结构

模板使用FTL（FreeMarker模板语言）编写，是下面各部分的一个组合：

• 文本：直接输出
• Interpolation：由${和}，或#{和}来限定，计算值替代输出
• FTL标记：FreeMarker指令，和HTML标记类似，名字前加#予以区分，不会输出
• 注释：由<#--和-->限定，不会输出

下面是以一个具体模板例子：

<html>

<head>

<title>Welcome!</title>

</head>

<body>

<#-- Greet the user with his/her name -->

<h1>Welcome ${user}!</h1>

<p>We have these animals:

<ul>

<#list animals as being>

<li>${being.name} for ${being.price} Euros

</#list>

</ul>

</body>

</html>  

注意事项：

• FTL区分大小写，所以list是正确的FTL指令，而List不是；${name}和${NAME}是不同的

• Interpolation只能在文本中使用

• FTL标记不能位于另一个FTL标记内部，例如：

<#if <#include 'foo'>='bar'>...</if>

• 注释可以位于FTL标记和Interpolation内部，如下面的例子：

<h1>Welcome ${user <#-- The name of user -->}!</h1>

<p>We have these animals:

<ul>

<#list <#-- some comment... --> animals as <#-- again... --> being>

...  

• 余的空白字符会在模板输出时移除

（2）指令

在FreeMarker中，使用FTL标记引用指令。有三种FTL标记，这和HTML标记是类似的：

• 开始标记：<#directivename parameters>

• 结束标记：</#directivename>

• 空内容指令标记：<#directivename parameters/>

有两种类型的指令：预定义指令和用户定义指令。

用户定义指令要使用@替换#，如<@mydirective>...</@mydirective>（会在后面讲述）。

FTL标记不能够交叉，而应该正确的嵌套，如下面的代码是错误的：

<ul>

<#list animals as being>

<li>${being.name} for ${being.price} Euros

<#if use = "Big Joe">

(except for you)

</#list>

</#if> <#-- WRONG! -->

</ul>  

FreeMarker会忽略FTL标记中的空白字符，如下面的例子：

<#list

animals       as

being

>

${being.name} for ${being.price} Euros

</#list    >  

（3）表达式

直接指定值

• 字符串

如果包含特殊字符需要转义，如下面的例子：

${"It's \"quoted\" and

this is a backslash: \\"}



${'It\'s "quoted" and

this is a backslash: \\'} 

It's "quoted" and

this is a backslash: \



It's "quoted" and

this is a backslash: \ 

有一类特殊的字符串称为raw字符串，被认为是纯文本，其中的\和{等不具有特殊含义，该类字符串在引号前面加r，下面是一个例子：

${r"${foo}"}



${r"C:\foo\bar"}  

${foo}



C:\foo\bar  

• 数字

直接输入，不需要引号

精度数字使用“.”分隔，不能使用分组符号

目前版本不支持科学计数法，所以“1E3”是错误的

不能省略小数点前面的0，所以“.5”是错误的

数字8、+8、08和8.00都是相同的

• 布尔值

true和false，不使用引号

• 序列

由逗号分隔的子变量列表，由方括号限定，下面是一个例子：

<#list ["winter", "spring", "summer", "autumn"] as x>

${x}

</#list> 

winter

spring

summer

autumn

[2 + 2, [1, 2, 3, 4], "whatnot"]

可以定义反递增的数字范围，如5..2

• 散列（hash）

{"name":"green mouse", "price":150}

获取变量

• 顶层变量： ${variable}，变量名只能是字母、数字、下划线、$、@和#的组合，且不能以数字开头

• 从散列中获取数据

可以使用点语法或方括号语法，假设有下面的数据模型：

(root)

|

+- book

|   |

|   +- title = "Breeding green mouses"

|   |

|   +- author

|       |

|       +- name = "Julia Smith"

|       |

|       +- info = "Biologist, 1923-1985, Canada"

|

+- test = "title" 

book.author.name

book["author"].name

book.author.["name"]

book["author"]["name"]

• 从序列获得数据：和散列的方括号语法语法一样，只是方括号中的表达式值必须是数字；注意：第一个项目的索引是0

序列片断：使用[startIndex..endIndex]语法，从序列中获得序列片断（也是序列）；startIndex和endIndex是结果为数字的表达式

• 特殊变量：FreeMarker内定义变量，使用.variablename语法访问

字符串操作

• Interpolation（或连接操作）

可以使用${..}（或#{..}）在文本部分插入表达式的值，例如：

${"Hello ${user}!"}



${"${user}${user}${user}${user}"}  

${"Hello " + user + "!"}



${user + user + user + user}

<#if ${isBig}>Wow!</#if>



<#if "${isBig}">Wow!</#if>

<#if isBig>Wow!</#if>

• 子串

例子（假设user的值为“Big Joe”）：

${user[0]}${user[4]}



${user[1..4]}

BJ



ig J 

• 连接操作：和字符串一样，使用+，下面是一个例子：

<#list ["Joe", "Fred"] + ["Julia", "Kate"] as user>

- ${user}

</#list>

- Joe

- Fred

- Julia

- Kate

• 连接操作：和字符串一样，使用+，如果具有相同的key，右边的值替代左边的值，例如：

<#assign ages = {"Joe":23, "Fred":25} + {"Joe":30, "Julia":18}>

- Joe is ${ages.Joe}

- Fred is ${ages.Fred}

- Julia is ${ages.Julia}  

- Joe is 30

- Fred is 25

- Julia is 18  

• ＋、－、×、／、％，下面是一个例子：

${x * x - 100}

${x / 2}

${12 % 10}

-75

2.5

2  

${3 * "5"} <#-- WRONG! -->  

${3 + "5"}  

35

${(x/2)?int}

${1.1?int}

${1.999?int}

${-1.1?int}

${-1.999?int}

2

1

1

-1

-1

• 比较操作符

使用=（或==，完全相等）测试两个值是否相等，使用!= 测试两个值是否不相等

=和!=两边必须是相同类型的值，否则会产生错误，例如<#if 1 = "1">会引起错误

Freemarker是精确比较，所以对"x"、"x "和"X"是不相等的

对数字和日期可以使用<、<=、>和>=，但不能用于字符串

由于Freemarker会将>解释成FTL标记的结束字符，所以对于>和>=可以使用括号来避免这种情况，例如<#if (x > y)>

另一种替代的方法是，使用lt、lte、gt和gte来替代<、<=、>和>=

• 逻辑操作符

&&（and）、||（or）、!（not），只能用于布尔值，否则会产生错误

例子：

<#if x < 12 && color = "green">

We have less than 12 things, and they are green.

</#if>

<#if !hot> <#-- here hot must be a boolean -->

It's not hot.

</#if>  

• 内建函数

内建函数的用法类似访问散列的子变量，只是使用“?”替代“.”，下面列出常用的一些函数

• • 字符串使用的：

html：对字符串进行HTML编码

cap_first：使字符串第一个字母大写

lower_case：将字符串转换成小写

upper_case：将字符串转换成大写

trim：去掉字符串前后的空白字符

• • 序列使用的：

size：获得序列中元素的数目

• • 数字使用的：

int：取得数字的整数部分（如-1.9?int的结果是-1）

例子（假设test保存字符串"Tom & Jerry"）：

${test?html}

${test?upper_case?html}

Tom & Jerry

TOM & JERRY  

• 操作符优先顺序

（4）Interpolation

Interpolation有两种类型：

1. 通用Interpolation：${expr}

1. 数字Interpolation：#{expr}或#{expr; format}

注意：Interpolation只能用于文本部分

• 通用Interpolation

插入字符串值：直接输出表达式结果

插入数字值：根据缺省格式（由#setting指令设置）将表达式结果转换成文本输出；可以使用内建函数string格式化单个Interpolation，下面是一个例子：

<#setting number_format="currency"/>

<#assign answer=42/>

${answer}

${answer?string}  <#-- the same as ${answer} -->

${answer?string.number}

${answer?string.currency}

${answer?string.percent} 

$42.00

$42.00

42

$42.00

4,200%

${lastUpdated?string("yyyy-MM-dd HH:mm:ss zzzz")}

${lastUpdated?string("EEE, MMM d, ''yy")}

${lastUpdated?string("EEEE, MMMM dd, yyyy, hh:mm:ss a '('zzz')'")}  

2003-04-08 21:24:44 Pacific Daylight Time

Tue, Apr 8, '03

Tuesday, April 08, 2003, 09:24:44 PM (PDT)

<#assign foo=true/>

${foo?string("yes", "no")}

yes

• 数字Interpolation的#{expr; format}形式可以用来格式化数字，format可以是：

mX：小数部分最小X位

MX：小数部分最大X位

例子：

<#-- If the language is US English the output is: -->

<#assign x=2.582/>

<#assign y=4/>

#{x; M2}   <#-- 2.58 -->

#{y; M2}   <#-- 4    -->

#{x; m1}   <#-- 2.6 -->

#{y; m1}   <#-- 4.0 -->

#{x; m1M2} <#-- 2.58 -->

#{y; m1M2} <#-- 4.0  -->  

4、杂项

（1）用户定义指令

宏和变换器变量是两种不同类型的用户定义指令，它们之间的区别是宏是在模板中使用macro指令定义，而变换器是在模板外由程序定义，这里只介绍宏

• 基本用法

宏是和某个变量关联的模板片断，以便在模板中通过用户定义指令使用该变量，下面是一个例子：

<#macro greet>

<font size="+2">Hello Joe!</font>

</#macro>  

<@greet></@greet>

<@greet/>

• 参数

在macro指令中可以在宏变量之后定义参数，如：

<#macro greet person>

<font size="+2">Hello ${person}!</font>

</#macro> 

<@greet person="Fred"/> and <@greet person="Batman"/> 

  <font size="+2">Hello Fred!</font>



and   <font size="+2">Hello Batman!</font>

宏的参数是FTL表达式，所以下面的代码具有不同的意思：

<@greet person=Fred/>

可以有多参数，下面是一个例子：

<#macro greet person color>

<font size="+2" color="${color}">Hello ${person}!</font>

</#macro> 

<@greet person="Fred" color="black"/> 

<@greet color="black" person="Fred"/>

<@greet person="Fred" color="black" background="green"/>

<@greet person="Fred"/>

<#macro greet person color="black">

<font size="+2" color="${color}">Hello ${person}!</font>

</#macro>  

宏的参数是局部变量，只能在宏定义中有效

• 嵌套内容

用户定义指令可以有嵌套内容，使用<#nested>指令执行指令开始和结束标记之间的模板片断

例子：

<#macro border>

<table border=4 cellspacing=0 cellpadding=4><tr><td>

<#nested>

</tr></td></table>

</#macro>  

<@border>The bordered text</@border>

  <table border=4 cellspacing=0 cellpadding=4><tr><td>

The bordered text

</tr></td></table>

<#nested>指令可以被多次调用，例如：

<#macro do_thrice>

<#nested>

<#nested>

<#nested>

</#macro>

<@do_thrice>

Anything.

</@do_thrice>  

  Anything.

Anything.

Anything. 

  <table border=4 cellspacing=0 cellpadding=4><tr><td>

<ul>

<li><font size="+2">Hello Joe!</font>

<li><font size="+2">Hello Joe!</font>

<li><font size="+2">Hello Joe!</font>

</ul>

</tr></td></table>  

<#macro repeat count>

<#local y = "test">

<#list 1..count as x>

${y} ${count}/${x}: <#nested>

</#list>

</#macro>

<@repeat count=3>${y?default("?")} ${x?default("?")} ${count?default("?")}</@repeat>

    test 3/1: ? ? ?

test 3/2: ? ? ?

test 3/3: ? ? ?

<#macro repeat count>

<#list 1..count as x>

<#nested x, x/2, x==count>

</#list>

</#macro>

<@repeat count=4 ; c, halfc, last>

${c}. ${halfc}<#if last> Last!</#if>

</@repeat>  

  1. 0.5

2. 1

3. 1.5

4. 2 Last!

<#assign x = "plain">

1. ${x}  <#-- we see the plain var. here -->

<@test/>

6. ${x}  <#-- the value of plain var. was not changed -->

<#list ["loop"] as x>

7. ${x}  <#-- now the loop var. hides the plain var. -->

<#assign x = "plain2"> <#-- replace the plain var, hiding does not mater here -->

8. ${x}  <#-- it still hides the plain var. -->

</#list>

9. ${x}  <#-- the new value of plain var. -->

<#macro test>

2. ${x}  <#-- we still see the plain var. here -->

<#local x = "local">

3. ${x}  <#-- now the local var. hides it -->

<#list ["loop"] as x>

4. ${x}  <#-- now the loop var. hides the local var. -->

</#list>

5. ${x}  <#-- now we see the local var. again -->

</#macro>  

1. plain

2. plain

3. local

4. loop

5. local

6. plain

7. loop

8. loop

9. plain2

<#list ["loop 1"] as x>

${x}

<#list ["loop 2"] as x>

${x}

<#list ["loop 3"] as x>

${x}

</#list>

${x}

</#list>

${x}

</#list>

  loop 1

loop 2

loop 3

loop 2

loop 1 

<#assign user = "Joe Hider">

${user}          <#-- prints: Joe Hider -->

${.globals.user} <#-- prints: Big Joe -->  

<#macro copyright date>

<p>Copyright (C) ${date} Julia Smith. All rights reserved.

<br>Email: ${mail}</p>

</#macro>  

<#assign mail = "jsmith@acme.com"> 

<#import "/lib/my_test.ftl" as my>

<#assign mail="fred@acme.com">

<@my.copyright date="1999-2002"/>

${my.mail}

${mail}  

  <p>Copyright (C) 1999-2002 Julia Smith. All rights reserved.

<br>Email: jsmith@acme.com</p>

jsmith@acme.com

fred@acme.com  

<#import "/lib/my_test.ftl" as my>

${my.mail}

<#assign mail="jsmith@other.com" in my>

${my.mail}  

jsmith@acme.com

jsmith@other.com  

<#macro copyright date>

<p>Copyright (C) ${date} ${user}. All rights reserved.</p>

</#macro>

<#assign mail = "${user}@acme.com">   

<#import "/lib/my_test.ftl" as my>

<@my.copyright date="1999-2002"/>

${my.mail}   

  <p>Copyright (C) 1999-2002 Fred. All rights reserved.</p>

Fred@acme.com   





补充（静态方法的调用）：



方法1：

##定义配置文件 freemarkerstatic.properties 

_Validator=com.longyou.util.Validator 

_Functions=com.longyou.util.Functions 

_EscapeUtils=com.longyou.util.EscapeUtils 

/调用代码 

${_Functions.toUpperCase("Hello")}<br> 

${_EscapeUtils.escape("狼的原野")}



方法2：

${stack.findValue("@package.ClassName@method")}





补充：常用语法

EG.一个对象BOOK

1.输出 ${book.name}

空值判断：${book.name?if_exists },

${book.name?default(‘xxx’)}//默认值xxx

${ book.name!"xxx"}//默认值xxx

日期格式：${book.date?string('yyyy-MM-dd')}

数字格式：${book?string.number}--20

${book?string.currency}--<#-- $20.00 -->

${book?string.percent}—<#-- 20% -->

插入布尔值：

<#assign foo=ture />

${foo?string("yes","no")} <#-- yes -->

2．逻辑判断

a:

<#if condition>...

<#elseif condition2>...

<#elseif condition3>......

<#else>...

其中空值判断可以写成<#if book.name?? >

b:

<#switch value>

<#case refValue1>

...

<#break>

<#case refValue2>

...

<#break>

...

<#case refValueN>

...

<#break>

<#default>

...

3．循环读取

<#list sequence as item>

...

空值判断<#if bookList?size = 0>

e.g.

<#list employees as e>

${e_index}. ${e.name}

输出:

1. Readonly

2. Robbin

freemarker的Eclipse插件

• If you use Eclipse 2.x:
  1. Open the Window menu, then Open Perspective -> Install/Update
  2. Click with the right mouse button on the Feature Updates view, then select New -> Site Bookmark
  3. In the displayed dialog box, type "FreeMarker" for Name and "http://www.freemarker.org/eclipse/update" for URL. Leave the "Bookmark type" radio buttons on "Eclipse update site".
  4. Click Finish
  5. Open the tree node under the newly created update site named "FreeMarker", select the "FreeMarker X.Y.Z" feature, and install it using the Install now button in the preview pane.
• If you use Eclipse 3.x:
  1. Help -> Software updates -> Find and install....
  2. Choose "Search for new features to install".
  3. Click Add Update Site..., and type "FreeMarker" for Name and "http://www.freemarker.org/eclipse/update" for URL.
  4. Check the box of the "FreeMarker" feature.
  5. "Next"-s until it is installed...