MongoDB 与 Java 实体类型 LocalTime 时区转换问题解决方案

在使用 Spring Boot 开发应用时，经常会遇到 MongoDB 与 Java 实体类型 LocalTime 时区转换问题。特别是当我们存储时间数据时，MongoDB 默认使用 UTC 时区，而 Java 的 LocalTime 类型则使用本地时区。这可能会导致读取和写入数据时出现时区转换问题。

问题描述

假设我们有一个 Java 实体类 User，其中有一个 createTime 字段，类型为 LocalDateTime。当我们将 User 对象存储到 MongoDB 时，MongoDB 会将 createTime 字段存储为 UTC 时区的时间。然而，当我们读取数据时，Java 会自动将 UTC 时区的时间转换为本地时区的时间，这可能会导致时区不一致的问题。

解决方案

为了解决这个问题，我们可以通过配置 MongoTemplate 来禁用时区转换。下面是解决方案的代码示例：

java 复制代码

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.convert.converter.Converter;
import org.springframework.data.convert.ReadingConverter;
import org.springframework.data.convert.WritingConverter;
import org.springframework.data.mongodb.core.MongoTemplate;
import org.springframework.data.mongodb.core.convert.DefaultDbRefResolver;
import org.springframework.data.mongodb.core.convert.MappingMongoConverter;
import org.springframework.data.mongodb.core.convert.MongoCustomConversions;
import org.springframework.data.mongodb.core.mapping.MongoMappingContext;
import org.springframework.data.mongodb.MongoDatabaseFactory;

import java.time.LocalDateTime;
import java.time.ZoneOffset;
import java.util.Arrays;
import java.util.Date;

@Configuration
public class MongoTemplateConfig {

    @Bean
    public MongoTemplate mongoTemplate(MongoDatabaseFactory factory, MongoMappingContext context) {
        MappingMongoConverter converter = new MappingMongoConverter(
                new DefaultDbRefResolver(factory), context);

        // 关键配置：禁用时区转换
        converter.setCustomConversions(mongoCustomConversions());
        converter.afterPropertiesSet();

        return new MongoTemplate(factory, converter);
    }

    @Bean
    public MongoCustomConversions mongoCustomConversions() {
        return new MongoCustomConversions(Arrays.asList(
                new DateToLocalDateTimeConverter()/*,
                new LocalDateTimeToDateConverter()*/
        ));
    }

    /**
     * 读取转换器：将 Date 类型转换为 LocalDateTime 类型
     * 在从 MongoDB 读取数据时使用
     */
    @ReadingConverter
    public static class DateToLocalDateTimeConverter implements Converter<Date, LocalDateTime> {
        @Override
        public LocalDateTime convert(Date source) {
            // 直接使用 UTC 时区，不进行时区转换
            return source.toInstant().atZone(ZoneOffset.UTC).toLocalDateTime();
        }
    }

    /**
     * 写入转换器：将 LocalDateTime 类型转换为 Date 类型
     * 在向 MongoDB 写入数据时使用
     */
   /* @WritingConverter
    public static class LocalDateTimeToDateConverter implements Converter<LocalDateTime, Date> {
        @Override
        public Date convert(LocalDateTime source) {
            // 假定 LocalDateTime 已经是 UTC 时间
            return Date.from(source.atZone(ZoneOffset.UTC).toInstant());
        }
    }*/
}

在上述代码中，我们定义了一个 MongoTemplateConfig 类，用于配置 MongoTemplate。我们创建了一个 MappingMongoConverter 实例，并设置了自定义的转换器 mongoCustomConversions()。这个转换器包含了两个转换器：DateToLocalDateTimeConverter 和 LocalDateTimeToDateConverter。

DateToLocalDateTimeConverter 转换器用于读取 MongoDB 数据时，将 Date 类型转换为 LocalDateTime 类型。我们在转换过程中直接使用 UTC 时区，不进行时区转换。

LocalDateTimeToDateConverter 转换器用于写入 MongoDB 数据时，将 LocalDateTime 类型转换为 Date 类型。我们假定 LocalDateTime 已经是 UTC 时间，因此直接将其转换为 Date 类型。

总结

通过上述配置，我们可以解决 MongoDB 与 Java 实体类型 LocalTime 时区转换问题。我们定义了一个自定义的转换器，用于读取和写入 MongoDB 数据时进行时区转换。这种解决方案可以确保我们的应用程序中的时间数据保持一致的时区。