使用Spring Boot>=2.0.1将ZonedDateTime保存到MongoDB时出现CodeConfigurationException。发布

Question

我只需对官方的Spring Boot指南进行少量修改，就可以重现我的问题，以便使用MongoDB访问数据，请参阅https://github.com/thokrae/spring-data-mongo-zoneddatetime.

将java.time.ZonedDateTime字段添加到Client类后，运行指南中的示例代码会失败并出现CodecConfigurationException：

顾客java：

    public String lastName;
    public ZonedDateTime created;

    public Customer() {

输出：

...
Caused by: org.bson.codecs.configuration.CodecConfigurationException`: Can't find a codec for class java.time.ZonedDateTime.
at org.bson.codecs.configuration.CodecCache.getOrThrow(CodecCache.java:46) ~[bson-3.6.4.jar:na]
at org.bson.codecs.configuration.ProvidersCodecRegistry.get(ProvidersCodecRegistry.java:63) ~[bson-3.6.4.jar:na]
at org.bson.codecs.configuration.ChildCodecRegistry.get(ChildCodecRegistry.java:51) ~[bson-3.6.4.jar:na]

这可以通过将Spring Boot版本从2.0.5. RELEASE更改为2.0.1来解决。pom.xml中的RELEASE：

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.1.RELEASE</version>
    </parent>

现在，异常消失了，包括ZonedDateTime字段在内的客户对象被写入MongoDB。

我在spring data mongodb项目中提交了一个bug（DATAMONGO-2106），但我理解，如果不想改变这种行为，或者改变这种行为的优先级很高，我也会理解。

最好的解决方法是什么？当duckduckgoing查找异常消息时，我发现有几种方法，如注册自定义编解码器、自定义转换器或使用Jackson JSR 310。我不希望向我的项目中添加自定义代码来处理来自java的类。时间包。

Answer 1

正如Oliver Drotbohm本人在DATAMONGO-2106中所述，Spring Data MongoDB从未支持具有时区的持久日期时间类型。

以下是已知的解决方法：

>

使用不带时区的日期时间类型，例如java。时间瞬间（通常建议只在后端使用UTC，但我必须扩展一个遵循不同方法的现有代码库。）

编写自定义转换器并通过扩展AbstractMongoConfiguration注册它。请参阅我的测试存储库中的分支转换器以获取运行示例。

@Component
@WritingConverter
public class ZonedDateTimeToDocumentConverter implements Converter<ZonedDateTime, Document> {
    static final String DATE_TIME = "dateTime";
    static final String ZONE = "zone";

    @Override
    public Document convert(@Nullable ZonedDateTime zonedDateTime) {
        if (zonedDateTime == null) return null;

        Document document = new Document();
        document.put(DATE_TIME, Date.from(zonedDateTime.toInstant()));
        document.put(ZONE, zonedDateTime.getZone().getId());
        document.put("offset", zonedDateTime.getOffset().toString());
        return document;
    }
}

@Component
@ReadingConverter
public class DocumentToZonedDateTimeConverter implements Converter<Document, ZonedDateTime> {

    @Override
    public ZonedDateTime convert(@Nullable Document document) {
        if (document == null) return null;

        Date dateTime = document.getDate(DATE_TIME);
        String zoneId = document.getString(ZONE);
        ZoneId zone = ZoneId.of(zoneId);

        return ZonedDateTime.ofInstant(dateTime.toInstant(), zone);
    }
}

@Configuration
public class MongoConfiguration extends AbstractMongoConfiguration {

    @Value("${spring.data.mongodb.database}")
    private String database;

    @Value("${spring.data.mongodb.host}")
    private String host;

    @Value("${spring.data.mongodb.port}")
    private int port;

    @Override
    public MongoClient mongoClient() {
        return new MongoClient(host, port);
    }

    @Override
    protected String getDatabaseName() {
        return database;
    }

    @Bean
    public CustomConversions customConversions() {
        return new MongoCustomConversions(asList(
                new ZonedDateTimeToDocumentConverter(),
                new DocumentToZonedDateTimeConverter()
        ));
    }
}

编写自定义编解码器。至少在理论上是这样。我的编解码器测试分支在使用Spring Boot 2.0.5时无法解组数据，而在使用Spring Boot 2.0.1时工作正常。

public class ZonedDateTimeCodec implements Codec<ZonedDateTime> {

    public static final String DATE_TIME = "dateTime";
    public static final String ZONE = "zone";

    @Override
    public void encode(final BsonWriter writer, final ZonedDateTime value, final EncoderContext encoderContext) {
        writer.writeStartDocument();
        writer.writeDateTime(DATE_TIME, value.toInstant().getEpochSecond() * 1_000);
        writer.writeString(ZONE, value.getZone().getId());
        writer.writeEndDocument();
    }

    @Override
    public ZonedDateTime decode(final BsonReader reader, final DecoderContext decoderContext) {
        reader.readStartDocument();
        long epochSecond = reader.readDateTime(DATE_TIME);
        String zoneId = reader.readString(ZONE);
        reader.readEndDocument();

        return ZonedDateTime.ofInstant(Instant.ofEpochSecond(epochSecond / 1_000), ZoneId.of(zoneId));
    }

    @Override
    public Class<ZonedDateTime> getEncoderClass() {
        return ZonedDateTime.class;
    }
}

@Configuration
public class MongoConfiguration extends AbstractMongoConfiguration {

    @Value("${spring.data.mongodb.database}")
    private String database;

    @Value("${spring.data.mongodb.host}")
    private String host;

    @Value("${spring.data.mongodb.port}")
    private int port;

    @Override
    public MongoClient mongoClient() {
        return new MongoClient(host + ":" + port, createOptions());
    }

    private MongoClientOptions createOptions() {
        CodecProvider pojoCodecProvider = PojoCodecProvider.builder()
                .automatic(true)
                .build();

        CodecRegistry registry = CodecRegistries.fromRegistries(
                createCustomCodecRegistry(),
                MongoClient.getDefaultCodecRegistry(),
                CodecRegistries.fromProviders(pojoCodecProvider)
        );

        return MongoClientOptions.builder()
                .codecRegistry(registry)
                .build();
    }

    private CodecRegistry createCustomCodecRegistry() {
        return CodecRegistries.fromCodecs(
                new ZonedDateTimeCodec()
        );
    }

    @Override
    protected String getDatabaseName() {
        return database;
    }
}