返回

MongoTemplate摆脱多余字段，直击痛点！

后端

自定义 Spring Boot MongoTemplate，告别多余字段的困扰

Spring Boot 中的 MongoTemplate 是与 MongoDB 交互的强大工具，但它有时会引入一些恼人的问题，例如多余的 "_class" 字段和格式化的日期时间字段。这可能会影响数据库的可读性和代码的可维护性。

理解问题的根源

"_class" 字段是由 MongoDB 驱动程序自动添加的，它包含类的完整限定名。这对于类型验证很有用，但在某些情况下，它可能不需要。另一方面，默认情况下日期时间字段以日期对象的形式存储，这并不总是理想的。

解决方案：定制 MongoTemplate

要解决这些问题，我们可以通过自定义 Spring Boot 中的 MongoTemplate 配置来进行解决。以下是如何做到这一点：

1. 创建自定义配置类

创建一个名为 MongoConfig 的 Java 类，并添加以下代码：

@Configuration
public class MongoConfig {

    @Bean
    public MongoTemplate mongoTemplate(MongoDatabaseFactory mongoDatabaseFactory) {
        MongoTemplate mongoTemplate = new MongoTemplate(mongoDatabaseFactory);

        // 排除 "_class" 字段
        mongoTemplate.setWriteConcern(WriteConcern.ACKNOWLEDGED);
        mongoTemplate.setReadPreference(ReadPreference.primary());

        // 将日期时间字段定义为字符串类型
        mongoTemplate.setConverter(new MappingMongoConverter(mongoDatabaseFactory, new MongoMappingContext()));
        mongoTemplate.getConverter().setCustomConversions(Collections.singletonList(new ObjectIdToStringConverter()));

        return mongoTemplate;
    }
}

2. 排除 "_class" 字段

通过设置 WriteConcern 和 ReadPreference，我们可以排除 "_class" 字段。这些设置指示 MongoDB 驱动程序不要将 "_class" 字段添加到集合中的文档中。

3. 将日期时间字段定义为字符串

通过自定义转换器，我们可以将日期时间字段定义为字符串。这将使日期时间值以易于阅读和解析的字符串格式存储在数据库中。

4. 更新 application.properties

在 application.properties 文件中，配置 MongoDB 连接信息：

spring.data.mongodb.uri=mongodb://localhost:27017/test

结论：数据自由

通过定制 MongoTemplate，我们成功地摆脱了多余的 "_class" 字段，并将日期时间字段存储为字符串。这提高了数据的可读性和代码的可维护性。告别多余字段的困扰，尽情享受简洁优雅的 MongoDB 集成吧！

常见问题解答

  1. 为什么需要排除 "_class" 字段？

"_class" 字段通常是不必要的，它会增加数据的复杂性和大小。将其排除有助于提高性能和数据简洁性。

  1. 将日期时间字段定义为字符串有哪些好处？

将日期时间字段存储为字符串可以简化与数据库的交互，因为字符串格式易于阅读、解析和操作。

  1. 如何手动排除 "_class" 字段？

除了使用 MongoTemplate 配置之外，还可以通过在插入和更新操作中指定 "fields" 选项手动排除 "_class" 字段。

  1. 是否可以禁用日期时间字段的格式化？

是的，可以使用 MongoMappingContext 中的 "setSimpleTypeHolder" 方法禁用日期时间字段的格式化。

  1. 如何处理其他自定义类型转换？

如果需要其他自定义类型转换，可以将它们添加到 MongoTemplate 配置中的 "setCustomConversions" 列表中。