稳定的 API

概述

在本指南中，您可以了解如何在连接到MongoDB部署时指定稳定API兼容性。

稳定API功能强制服务器使用与您指定的API版本兼容的行为执行操作。使用稳定API确保服务器响应的一致性，并为您的应用程序提供长期API稳定性。

以下部分描述了如何为您的MongoDB客户端启用和自定义稳定API。有关稳定API的更多信息，包括它支持的命令列表，请参阅稳定API MongoDB服务器手册。

启用稳定API

要启用稳定API，请执行以下步骤

1. 构建一个ServerApi对象，并指定一个稳定API版本。您必须使用在ServerApiVersion枚举中定义的稳定API版本。

2. 使用MongoClientSettings.Builder类构建一个MongoClientSettings对象。

3. 使用MongoClients.create()方法实例化一个MongoClient，并将您的MongoClientSettings实例作为参数传递。

以下代码示例显示了如何指定版本1的稳定API

ServerApi serverApi = ServerApi.builder()
        .version(ServerApiVersion.V1)
        .build();
// Replace the placeholder with your Atlas connection string
String uri = "<connection string URI>";
MongoClientSettings settings = MongoClientSettings.builder()
        .applyConnectionString(new ConnectionString(uri))
        .serverApi(serverApi)
        .build();
try (MongoClient mongoClient = MongoClients.create(settings)) {
    // Perform client operations here
}

一旦创建了一个带有稳定API的MongoClient实例，您使用该客户端运行的所有命令都将使用指定的稳定API配置。如果您必须使用替代配置运行命令，请创建一个新的MongoClient。

配置稳定的API

下表描述了ServerApi.Builder类的可链式方法，您可以使用这些方法来自定义稳定API的行为。

以下代码示例展示了如何通过链式调用ServerApi.Builder的方法来配置ServerApi实例。

ServerApi serverApi = ServerApi.builder()
    .version(ServerApiVersion.V1)
    .strict(true)
    .deprecationErrors(true)
    .build();

故障排除

API 文档

有关使用 Java Reactive Streams 驱动程序与稳定 API 的更多信息，请参阅以下 API 文档

• ServerApi

• ServerApi.Builder

• ServerApiVersion

• ServerAddress

• MongoClientSettings

• MongoClientSettings.Builder

• MongoClients