在 JAX-RS 响应中使用 ISO-8601 日期

Question

我正在 GlassFish 4 上使用 Java EE 7 构建 RESTful Web 服务。在序列化包含 java.util.Date 对象的 POJO 时，不包括时区信息。

如何自定义对象序列化，以便 java.util.Dates 包含时区信息？

例如，而不是这个：

{
  "id": 1234,
  "foo": "2014-05-19T13:53:49.392"
}

我更喜欢这样：

{
  "id": 1234,
  "foo": "2014-05-19T13:53:49.392+09:30"
}

服务器的时区是 GMT + 09:30。

Answer 1

这是由 MOXy 中的 bug 引起的，它是 GlassFish 中 JAX-RS 的默认 JSON（反）序列化程序。

解决方法是将 JSON 提供程序切换到 Jackson。

第一步是将这些依赖项添加到构建中：

<!-- Provides JacksonFeature -->
<dependency>
    <groupId>org.glassfish.jersey.media</groupId>
    <artifactId>jersey-media-json-jackson</artifactId>
    <version>2.8</version>
    <scope>provided</scope>
</dependency>

<!-- Provides ObjectMapper and SerializationConfig -->
<dependency>
    <groupId>org.codehaus.jackson</groupId>
    <artifactId>jackson-mapper-asl</artifactId>
    <version>1.9.13</version>
    <type>jar</type>
</dependency>

下一步，添加 JacksonFeature 作为提供者，它将替换 MOXy 作为 JSON 序列化器：

@ApplicationPath("/api/1")
public class ApplicationConfig extends Application {

    @Override
    public Set<Class<?>> getClasses() {
        Set<Class<?>> resources = new java.util.HashSet<>();
        addRestResourceClasses(resources);

        // Add Jackson feature.
        resources.add(org.glassfish.jersey.jackson.JacksonFeature.class);

        return resources;
    }

    private void addRestResourceClasses(Set<Class<?>> resources) {
        // JAX-RS resource classes added here - maintained by NetBeans.
    }
}

Jackson 的默认行为是表示 java.util.Date 自纪元形式以来的毫秒数。要将其更改为 ISO-8601：

import java.text.SimpleDateFormat;
import java.util.TimeZone;
import javax.ws.rs.Produces;
import javax.ws.rs.ext.ContextResolver;
import javax.ws.rs.ext.Provider;
import org.codehaus.jackson.map.ObjectMapper;
import org.codehaus.jackson.map.SerializationConfig;

@Provider
@Produces("application/json")
public class JacksonConfigurator implements ContextResolver<ObjectMapper> {

    public JacksonConfigurator() {
        SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSZ");
        dateFormat.setTimeZone(TimeZone.getTimeZone("UTC"));
        mapper.setDateFormat(dateFormat);
        mapper.configure(SerializationConfig.Feature.WRITE_DATES_AS_TIMESTAMPS, false);
    }

    @Override
    public ObjectMapper getContext(Class<?> clazz) {
        return mapper;
    }

    private final ObjectMapper mapper = new ObjectMapper();
}