FreeMarker中的日期时间处理

摘要: 在FreeMarker中经常会出现输出日期时间的错误，有时会让人摸不着头脑，深入了解它的处理机制后，相信不会再迷茫。

#1. FreeMarker中的日期时间格式设置
FreeMarker中可以分别对date、time、datetime三种类型的日期时间设置格式，例如：

config.setDateTimeFormat("yyyy-MM-dd HH:mm:ss");
config.setDateFormat("yyyy-MM-dd");
config.setTimeFormat("HH:mm:ss");

当我们对一个页面变量使用

?date

?time

?datetime

时就会分别按以上设置的对应格式显示。

#2. 什么情况下可以不使用

?date

?time

?datetime

FreeMarker会将

java.sql.Date

java.sql.Time

java.sql.Timestamp

类型的变量自动识别为

date

time

datetime

。所以当变量是以上三种类型时，FreeMarker会自动匹配设置的格式，不需要在变量的后面加上

?date

?time

?datetime

。

#3. 变量为

java.util.Date

类型时的困惑
FreeMarker无法自动识别

java.util.Date

类型应该显示哪种格式，这时需要明确的指定其要显示的格式，否则FreeMarker将会抛出异常。但有些时候我们发现

java.util.Date

类型的变量没有指定格式在页面也能正确显示，这是什么情况？例如：

@Entity
@Table(name = "Tmp_Company")
public class Company extends UuidEntity {
...
/** 成立日期 */
@Temporal(TemporalType.DATE)
private java.util.Date foundDate;
...
}

在查看页面使用

${company.foundDate}

时，没有指定格式却能够正确显示。这是因为

@Temporal(TemporalType.DATE)

注解让ORM框架在从数据库中取出数据后将

java.util.Date

类型自动转换成了

java.sql.Date

类型，这时FreeMarker会自动识别其格式。假如在这个业务实体类上加上

@Cache

注解，分别使用不同的缓存策略，还会出现更有意思的现象，这里就不展开说了。

#4. 结论
当变量类型是

java.sql.Date

java.sql.Time

java.sql.Timestamp

时，可以不用指定格式；当变量类型是

java.util.Date

时，指定格式才是最稳妥的办法。

#5. 补充
如果上例中的foundDate允许为null时，在页面怎么写才会不报错呢？

${foundDate?date!}
${(foundDate?date)!}
${foundDate!?date}
${(foundDate!)?date}

已经是很丑陋的写法了吧，但以上写法都是错误的，正确的只能这么写：

${(foundDate?string("yyyy-MM-dd"))!}