对于 AI 代理:可在 https://www.mongodb.com/zh-cn/docs/llms.txt 获取文档索引—通过在任何 URL 路径后添加 .md 可获取所有页面的 Markdown 版本。

文档数据格式:POJO

在本指南中,您可以了解如何存储和检索由简单的旧 Java 对象 (POJO) 建模的数据。POJO 通常用于数据封装,这是将业务逻辑与数据表示分开的做法。

提示

要了解有关 POJO 的更多信息,请参阅 简单 Java 对象(POJO)的维基百科文章。

本指南中的示例说明了如何执行以下任务:

  • 配置驱动程序,对 POJO 进行序列化和反序列化

  • 对使用 POJO 建模的数据进行 CRUD 操作

本指南中的各个部分使用以下示例 POJO 类,它描述了花朵的特征:

public class Flower { private ObjectId id; private String name; private List<String> colors; private Boolean isBlooming; private Float height; // public empty constructor needed for retrieving the POJO public Flower() { } public Flower(String name, Boolean isBlooming, Float height, List<String> colors) { this.name = name; this.isBlooming = isBlooming; this.height = height; this.colors = colors; } public ObjectId getId() { return id; } public void setId(ObjectId id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } public Boolean getIsBlooming() { return isBlooming; } public void setIsBlooming(Boolean isBlooming) { this.isBlooming = isBlooming; } public Float getHeight() { return height; } public void setHeight(Float height) { this.height = height; } public List<String> getColors() { return colors; } public void setColors(List<String> colors) { this.colors = colors; } @Override public String toString() { return "\nFlower {\n\tid: " + id + "\n\tname: " + name + "\n\tcolors: " + colors + "\n\tisBlooming: " + isBlooming + "\n\theight: " + height + "\n}"; }}

在定义 POJO 以在 MongoDB 中存储和检索数据时,请使用以下准则:

  • POJO 类不能实现接口或继承框架中的类。

  • 放入您要存储和检索数据的所有字段,并确保它们没有标记为 static 或 transient。

  • 如果您按照 JavaBean 命名约定在您的 POJO 中包含了公共 getter 或 setter 方法,驱动程序将在序列化或反序列化数据时调用这些方法。如果您省略了一个公共属性字段的 getter 或 setter 方法,驱动程序将直接访问或赋值给这些字段。

要将驱动程序配置为使用 POJO,您必须指定以下组件:

  • PojoCodecProvider 具有定义如何在 POJO 和 BSON 格式之间编码和解码数据的编解码器的实例。提供者还指定编解码器适用于哪些 POJO 类或包。

  • CodecRegistry 包含编解码器和其他相关信息的实例。

  • MongoDatabase 或配置为使用 CodecRegistry 的 MongoCollection 实例。

  • MongoCollection 使用绑定到 TDocument 泛型类型的 POJO 文档类创建的实例。

执行以下步骤以满足上一节中定义的配置要求:

  1. 配置 PojoCodecProvider。在此示例中,我们使用PojoCodecProvider.Builder的automatic(true)设置将编解码器应用于任何类及其属性。

    CodecProvider pojoCodecProvider = PojoCodecProvider.builder().automatic(true).build();

    注意

    编解码器提供商还包含其他对象,例如进一步定义序列化行为的ClassModel和Convention实例。有关编解码器提供商和自定义的更多信息,请参阅POJO 自定义指南。

  2. 将 PojoCodecProvider 实例添加到 CodecRegistry 中。CodecRegistry 允许您指定一个或多个编解码器提供程序来对 POJO 数据进行编码。在本例中,我们调用了以下方法:

    • fromRegistries() 将多个 CodecRegistry 实例合并为一个实例

    • getDefaultCodecRegistry() 从编解码器提供商列表中检索 CodecRegistry 实例

    • fromProviders() 从 PojoCodecProvider 创建一个 CodecRegistry 实例

    以下代码说明了如何实例化 CodecRegistry:

    // Include the following static imports before your class definitionimport static com.mongodb.MongoClientSettings.getDefaultCodecRegistry;import static org.bson.codecs.configuration.CodecRegistries.fromProviders;import static org.bson.codecs.configuration.CodecRegistries.fromRegistries; ... CodecRegistry pojoCodecRegistry = fromRegistries(getDefaultCodecRegistry(), fromProviders(pojoCodecProvider));
  3. 配置 MongoDatabase 或 MongoCollection 实例以使用 CodecRegistry 中的编解码器。您可以配置一个数据库或集合以指定编解码器。

    在该示例中,我们使用 withCodecRegistry() 方法在名为 sample_pojos 的 MongoDatabase 上设置了 CodecRegistry。

    MongoClient mongoClient = MongoClients.create(uri);MongoDatabase database = mongoClient.getDatabase("sample_pojos").withCodecRegistry(pojoCodecRegistry);
  4. 将 POJO 类作为文档类参数传递给 getCollection() 调用,并将其指定为 MongoCollection 实例的类型参数,如以下代码中所示:

    MongoCollection<Flower> collection = database.getCollection("flowers", Flower.class);

在将 MongoCollection 实例配置为使用 Flower POJO 后,您可以对 POJO 建模的数据执行 CRUD 操作。

该示例说明了如何使用 Flower POJO 执行以下操作:

  • 将 Flower 实例插入到 flowers 集合中

  • 更新集合中的文档

  • 删除集合中的文档

  • 查找并输出集合中的所有文档

// Insert three Flower instancesFlower roseFlower = new Flower("rose", false, 25.4f, Arrays.asList(new String[] {"red", "pink"}));Flower daisyFlower = new Flower("daisy", true, 21.1f, Arrays.asList(new String[] {"purple", "white"}));Flower peonyFlower = new Flower("peony", false, 19.2f, Arrays.asList(new String[] {"red", "green"}));collection.insertMany(Arrays.asList(roseFlower, daisyFlower, peonyFlower)); // Update a documentcollection.updateOne( Filters.lte("height", 22), Updates.addToSet("colors", "pink")); // Delete a documentcollection.deleteOne(Filters.eq("name", "rose")); // Return and print all documents in the collectionList<Flower> flowers = new ArrayList<>();collection.find().into(flowers);System.out.println(flowers);

该示例输出以下内容:

[Flower { id: 65b178ffa38ac42044ca1573 name: daisy colors: [purple, white, pink] isBlooming: true height: 21.1},Flower { id: 65b178ffa38ac42044ca1574 name: peony colors: [red, green] isBlooming: false height: 19.2}]

注意

默认, PojoCodecProvider会忽略 POJO 中设置为null的字段。有关如何指定此行为的更多信息,请参阅POJO 自定义指南。

有关本节中提到的方法和类的详情,请参阅以下 API 文档:

本节回答在MongoDB中存储 POJO 时可能出现的问题。

不会, PojoCodecProvider会自动生成 ObjectId。

是的。使用 @BsonId 注释包含多个值的字段,以将其用作复合键。以下示例定义了一个具有 code 和 date 字段的 EntityKey 类,然后将其用作 Entity POJO 中的 _id字段:

public static class EntityKey { @BsonCreator public EntityKey(@BsonProperty("code") String code, @BsonProperty("date") Date date) { this.code = code; this.date = date; } // getters} public static class Entity { @BsonId private final EntityKey key; @BsonCreator public Entity(@BsonProperty("key") EntityKey key) { this.key = key; } // getters and setters}

是的,通过使用鉴别器。有关更多信息,请参阅 POJO 自定义指南的鉴别器部分。

不可以。原生POJO 编解码器假定每个字段的 getter 和 setter 具有相同的修饰符。

例如,以下方法会在编码期间引发异常:

private String getField();public String setField(String x);

此异常意味着您必须为该类注册一个编解码器,因为不存在任何编解码器。