在SpringMVC中使用Jackson并格式化时间

在spring MVC 3中，要实现REST风格的JSON服务，最简单的方式是使用

@ResponseBody

注解。该注解会自动把返回的对象，序列化为JSON。

来看一个最简单的例子。这个例子先使用Spring 3.0.5 + Jackson1.7.1。Jackson是Spring使用的JSON序列化/反序列化第三方库。

pom.xml 的主要内容如下

<!-- Spring Framework Dependencies -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>3.0.5.RELEASE</version>
</dependency>

<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>3.0.5.RELEASE</version>
</dependency>

<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-orm</artifactId>
<version>3.0.5.RELEASE</version>
</dependency>

<!-- jackson json -->
<dependency>
<groupId>org.codehaus.jackson</groupId>
<artifactId>jackson-mapper-asl</artifactId>
<version>1.7.1</version>
</dependency>

再定义了一个 POJO 对象 TestParams，由Controller的doTestQuery方法中返回该对象。

public  class TestParams {
private Date formatTime;
private Date originTime;
private int i;
public Date getFormatTime() {
return formatTime;
}
public Date getOriginTime() {
return originTime;
}
public int getI() {
return i;
}
public void setFormatTime(Date formatTime) {
this.formatTime = formatTime;
}
public void setOriginTime(Date originTime) {
this.originTime = originTime;
}
public void setI(int i) {
this.i = i;
}

}

@ResponseBody
@RequestMapping(value="/test", method=RequestMethod.GET)
public Object doTestQuery() {
TestParams params = new TestParams();
params = new TestParams();
Date now = new Date();
params.setFormatTime(now);
params.setOriginTime(now);

return params;
}

请求示例URL ，浏览器返回

{
"formatTime": 1412509897631,
"originTime": 1412509897631,
"i": 0
}

并且返回的报文内容类型也是妥妥的：

Content-Type:application/json;charset=UTF-8

只是时间看起来挺别扭。

默认情况下Jackson将

Java.util.Date

序列化为

epoch timestamp

，并且时区使用的是 GMT标准时间，而非本地时区。


如果你开发过跨大洲跨时区的web站点，就会知道上面的话是实践出真知。

那么当我想要一个可读性良好的时间格式，该怎么做呢？

在Jackson1.x时代，可以扩展

JsonSerializer

，来实现一个格式化时间的

JsonDateSerializer

，并在注解中引用这个类

@JsonSerialize(using=JsonDateSerializer.class)
public Date getDate() {
return date;
}

具体可以参见《How to Serialize Java.util.Date with Jackson JSON Processor / Spring 3.0》。

这种方法让人爱不起来，又弱又麻烦的感觉。

进一步查询，发现有一个注解

@JsonFormat

可以方便的格式化时间字段。

但这个注解看了下只在 Jackson2 才有。于是我陷入了Spring 版本和Jackson2的迷思中，一番折腾。

如果不想使用

@JsonFormat

注解，

jackson-mapper-asl

仍然可以使用1.x的版本，来搭配 Spring 3.x系列。

如果想使用

@JsonFormat

注解，需要将Spring升级到 3.1.2 以上。
并且要将Jackson的jar包更换为2.x系列的（和1.x系列相比，包名都换了）。

升级后的pom.xml如下：

<!-- Spring Framework Dependencies -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>3.2.4.RELEASE</version>
</dependency>

<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context-support</artifactId>
<version>3.2.4.RELEASE</version>
</dependency>

<dependency>
<groupId>org.springframework<groupId>
<artifactId>spring-webmvc</artifactId>
<version>3.2.4.RELEASE</version>
</dependency>

<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-orm</artifactId>
<version>3.2.4.RELEASE</version>
</dependency>

<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
<version>2.2.3</version>
</dependency>

<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
<version>2.2.3</version>
</dependency>

<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.2.3</version>
</dependency>

这时候可以在 TestParams 愉快地加上注解

@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
private Date formatTime;

再次访问测试URL，返回JSON对象如下

{
"formatTime": "2014-10-05 20:20:15",
"originTime": 1412511615062,
"i": 0
}

参考链接

Jackson FAQ: Date Handling

How to Serialize Java.util.Date with Jackson JSON Processor / Spring 3.0

Backport “Use Jackson 2.0 for Jackson based json processing such as MappingJacksonJsonView”

Notes on upgrading Jackson from 1.9 to 2.0