Spring Boot 项目中自定义 MySQL Datetime 数据显示时区
在 Spring Boot 应用中，MySQL datetime 类型数据默认使用服务器时区显示。为满足不同用户时区需求，需要自定义显示时区。
解决方案：
本方案通过自定义 Jackson 序列化器实现。
-
创建自定义 Jackson 序列化器： 编写一个继承自
StdSerializer的自定义序列化器，重写serialize方法。该方法负责根据用户时区格式化日期时间数据。 -
注册自定义序列化器： 通过
@Bean注解创建一个Jackson2ObjectMapperBuilderbean，并使用serializerByType方法注册自定义序列化器，使其应用于所有Date类型字段。 -
获取用户时区： 在自定义序列化器中，您可以通过
HttpServletRequest对象获取客户端的时区信息 (例如，从请求头Accept-Language或自定义头中提取)。 如果没有用户时区信息，则使用默认时区。
示例代码：
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.ser.std.StdSerializer;
import org.springframework.boot.autoconfigure.jackson.Jackson2ObjectMapperBuilderCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.TimeZone;
@Configuration
public class DateTimeConfig {
@Bean
@Primary
public Jackson2ObjectMapperBuilderCustomizer customizer(HttpServletRequest request) {
return builder -> builder.serializerByType(Date.class, new CustomDateSerializer(request));
}
public static class CustomDateSerializer extends StdSerializer {
private final HttpServletRequest request;
public CustomDateSerializer(HttpServletRequest request) {
super(Date.class);
this.request = request;
}
@Override
public void serialize(Date value, JsonGenerator gen, SerializerProvider provider) throws IOException {
TimeZone timeZone = getTimeZone(request); // 获取用户时区，如果没有则使用默认时区
SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
dateFormat.setTimeZone(timeZone);
gen.writeString(dateFormat.format(value));
}
private TimeZone getTimeZone(HttpServletRequest request) {
// 从请求头或其他地方获取用户时区信息
String timeZoneStr = request.getHeader("X-Timezone"); // 例如，自定义请求头 "X-Timezone"
if (timeZoneStr != null) {
return TimeZone.getTimeZone(timeZoneStr);
} else {
return TimeZone.getDefault(); // 使用默认时区
}
}
}
}
注意：
- 数据库中的
datetime数据类型保持不变。 - 此自定义序列化器仅在序列化和反序列化过程中生效，不影响数据库数据。
- 需要在你的项目中引入
javax.servlet包，并确保HttpServletRequest可以被注入到customizer方法中。 这通常需要依赖于 Spring MVC 或类似的框架。 你可以根据你的项目结构调整代码。 例如，如果你的DateTimeConfig类不是在 Spring MVC 的上下文中，你需要寻找其他方法来获取HttpServletRequest对象。
此方案提供了更灵活的时区处理方式，允许根据用户请求动态调整 datetime 数据的显示时区。 记得替换 "X-Timezone" 为你实际使用的请求头名称。
