SpringBoot Data mongo查询结果中带有枚举值但值不为name时如何正确反序列化

最新推荐文章于 2024-09-22 10:27:59 发布

原创最新推荐文章于 2024-09-22 10:27:59 发布 · 2.4k 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#java #spring #mongodb #enum

Java 专栏收录该内容

1 篇文章

订阅专栏

本文介绍如何在SpringBoot项目中使用MongoDB时，解决枚举类型转换问题。通过自定义Converter和MongoCustomConversions，实现从数据库的int类型到Java枚举类型的自动转换。

在使用spring boot data mongo查询mongodb的时候，因为需要维持原有db中的数据，且原有数据中存在大量的int类型枚举值，在将查询结果转化为对象时无法转换成功，查询后得出以下通过Converter达到目的的方法。

枚举类如下：

@AllArgsConstructor
public enum Week {
    MONDAY(1, "周一"),
    TUESDAY(2, "周二"),
    WEDNESDAY(3, "周二"),
    THURSDAY(4, "周四"),
    FRIDAY(5, "周五");

    private final int value;

    private final String desc;

    public int value() {
        return value;
    }

    public String desc() {
        return desc;
    }

    public static Week valueOf(int value) {
        for (Week week : Week.values()) {
            if (week.value == value) {
                return week;
            }
        }
        return null;
    }

    @Override
    public String toString() {
        return Integer.toString(value);
    }
}

若数据库中存储的值为1，需要转化为枚举MONDAY，直接通过指定Mongo查询结果的对象会自动调用枚举自带的valueOf(String name)，无法自动直接转化成功，需要做如下两个步骤：

创建转化的Converter

import org.springframework.core.convert.converter.Converter;

public class Integer2WeekConverter implements Converter<Integer, Week> {
    @Override
    public Week convert(Integer integer) {
        return Week.valueOf(integer);
    }
}

其中的泛型Integer, Week指的是从Interger类型转为Week类型，convert方法就是会在转化过程自动调用的方法。
2. 创建配置类，自定义MongoCustomConversions

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.mongodb.MongoDbFactory;
import org.springframework.data.mongodb.core.convert.*;

import java.util.Arrays;

@Configuration
public class MongoDBConfig {

    @Autowired
    MongoDbFactory mongoDbFactory;

    @Bean
    public MongoCustomConversions mongoCustomConversions() {
        return new MongoCustomConversions(
                Arrays.asList(new Integer2WeekConverter()));
    }
}

该步骤是自定义MongoCustomConversions，注册我们自定义的Converter

完成以上步骤，Mongo在将查询结果转换成指定对象的时候，若发现有字段需要从Interger类型转换为Week枚举时，会自动调用Converter方法，需要注意的是要确保Mongo内的数据类型和我们左边指定的类型一致，比如int32对应Integer，int64对应Long，如果对应出错，则不会触发调用。