Spring Web如何自定义RestController对Instant类型的格式化规则

Spring MVC 默认使用 Jackson 完成请求/响应的 JSON 序列化反序列化，针对你提出的三个实现方向，直接给出结论和可落地方案：

1. 类似@ExceptionHandler的全局类型转换机制 #

存在，这是最推荐的实现方式，通过自定义Jackson序列化器即可全局指定Instant类型的序列化规则，一次配置所有接口生效，不影响原有请求参数的解析逻辑。

1. 编写固定输出3位毫秒的ISO-8601格式序列化器：

   import com.fasterxml.jackson.core.JsonGenerator;
   import com.fasterxml.jackson.databind.SerializerProvider;
   import com.fasterxml.jackson.databind.ser.std.StdSerializer;
   import java.io.IOException;
   import java.time.Instant;
   import java.time.ZoneOffset;
   import java.time.format.DateTimeFormatter;
   
   public class MillisecondInstantSerializer extends StdSerializer<Instant> {
       private static final DateTimeFormatter ISO_FMT = DateTimeFormatter
               .ofPattern("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")
               .withZone(ZoneOffset.UTC);
   
       public MillisecondInstantSerializer() {
           super(Instant.class);
       }
   
       @Override
       public void serialize(Instant value, JsonGenerator gen, SerializerProvider provider) throws IOException {
           gen.writeString(ISO_FMT.format(value));
       }
   }
   

2. 全局注册到Spring的Jackson转换器中，Spring Boot项目直接添加配置类即可：

   import org.springframework.boot.autoconfigure.jackson.Jackson2ObjectMapperBuilderCustomizer;
   import org.springframework.context.annotation.Bean;
   import org.springframework.context.annotation.Configuration;
   
   @Configuration
   public class JacksonConfig {
       @Bean
       public Jackson2ObjectMapperBuilderCustomizer instantSerializerCustomizer() {
           return builder -> builder.serializers(new MillisecondInstantSerializer());
       }
   }
   

配置完成后，所有响应中Instant类型的输出都会自动转为带3位毫秒的格式，即你期望的2022-02-03T15:00:00.000Z，毫秒位不足时会自动补零，原有请求中Instant类型的解析逻辑完全不受影响。

2. 响应内容后置拦截方案 #

技术上可以实现，通过自定义ResponseBodyAdvice拦截所有@RestController的返回值，在JSON序列化完成、响应发送前做字符串替换或内容改写，但强烈不推荐：

• 该方案需要遍历整个响应JSON结构匹配日期字段，性能差
• 容易出现字符串误替换、特殊格式匹配错误的问题
• 维护成本远高于原生序列化配置，仅适合做跨字段的全局响应统一包装，不适合单类型格式化场景。

3. 注解标注实现方案 #

完全可以，适合不需要全局生效、仅个别字段/接口需要特殊格式的场景：

• 字段级粒度：直接在响应DTO的对应字段上添加序列化注解，指定使用自定义序列化器即可，不需要全局配置

  import com.fasterxml.jackson.databind.annotation.JsonSerialize;
  import java.time.Instant;
  
  public class OrderRespDto {
      // 其他业务字段
      @JsonSerialize(using = MillisecondInstantSerializer.class)
      private Instant payTime;
  }
  

• 如果你不想编写自定义序列化器，也可以直接通过Spring Boot配置文件全局指定日期格式，注意该配置会对所有时间类型（Date、LocalDateTime等）生效，如果项目中其他时间类型有独立格式要求不要用这种方式：

  spring:
    jackson:
      date-format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
      time-zone: UTC
  

内容的提问来源于stack exchange，提问作者selamba