如何在Java REST API响应中动态修改返回时间的时区？

完全可以通过自定义Jackson序列化器+请求时区上下文传递的方式实现需求，不需要在注解里硬编码固定时区，具体实现步骤如下：

前置约定 #

前端请求接口时在请求头携带用户的标准IANA时区ID（例如Asia/Kolkata对应IST、America/New_York对应EDT），请求头命名为X-Timezone，避免使用三个字母的时区缩写（如IST存在多义性，会导致解析错误）。

实现步骤 #

1. 编写时区上下文持有类 #

用ThreadLocal存储当前请求的时区信息，隔离不同请求的时区数据，避免线程安全问题：

import java.time.ZoneId;
import java.time.ZoneOffset;
import java.util.Optional;

public class TimezoneContextHolder {
    private static final ThreadLocal<ZoneId> TIMEZONE_HOLDER = new ThreadLocal<>();

    // 存储当前请求时区
    public static void setTimezone(ZoneId zoneId) {
        TIMEZONE_HOLDER.set(zoneId);
    }

    // 获取当前请求时区，默认返回UTC
    public static ZoneId getTimezone() {
        return Optional.ofNullable(TIMEZONE_HOLDER.get()).orElse(ZoneOffset.UTC);
    }

    // 请求结束后清除数据，避免内存泄漏
    public static void clear() {
        TIMEZONE_HOLDER.remove();
    }
}

2. 编写时区解析过滤器 #

实现Servlet过滤器，在请求进入接口前解析请求头的时区信息，存入上下文，请求结束后自动清除：

import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
import org.springframework.web.filter.OncePerRequestFilter;
import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.time.ZoneId;

@Component
public class TimezoneParseFilter extends OncePerRequestFilter {
    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
        try {
            String timezoneHeader = request.getHeader("X-Timezone");
            if (StringUtils.hasText(timezoneHeader)) {
                // 非法时区ID直接使用默认UTC，避免报错
                try {
                    ZoneId zoneId = ZoneId.of(timezoneHeader);
                    TimezoneContextHolder.setTimezone(zoneId);
                } catch (Exception ignored) {}
            }
            filterChain.doFilter(request, response);
        } finally {
            TimezoneContextHolder.clear();
        }
    }
}

3. 自定义动态时区日期序列化器 #

替换原有固定时区的@JsonFormat注解，实现序列化时动态读取当前请求的时区转换时间：

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.ZoneId;
import java.time.format.DateTimeFormatter;

public class DynamicZoneDateTimeSerializer extends StdSerializer<Instant> {
    // 如果你的实体类中时间字段是ZonedDateTime/LocalDateTime，修改泛型和构造方法入参即可
    public DynamicZoneDateTimeSerializer() {
        super(Instant.class);
    }

    @Override
    public void serialize(Instant value, JsonGenerator gen, SerializerProvider provider) throws IOException {
        ZoneId userZone = TimezoneContextHolder.getTimezone();
        DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")
                .withZone(userZone);
        gen.writeString(formatter.format(value));
    }
}

4. 注解绑定序列化器 #

在你的返回实体类的call_time对应字段上，绑定自定义序列化器即可：

import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import lombok.Data;
import java.time.Instant;

@Data
public class CallSummary {
    private Long id;
    private String number;
    // 替换原有@JsonFormat注解
    @JsonSerialize(using = DynamicZoneDateTimeSerializer.class)
    private Instant callTime;
}

可选简化方案 #

如果项目中所有返回的时间字段都需要按用户时区转换，不需要单独控制某个字段，可以直接自定义Jackson的ObjectMapper全局配置，结合上下文时区实现全局转换，不需要单独给字段加注解。

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