Stable API
在此页面上
注意
Stable API 功能需要 MongoDB Server 5.0 或更高版本。
Overview
在本指南中，您可以了解如何在连接到stable API MongoDB部署时指定 兼容性。
Stable API功能会强制服务器以与您指定的API版本兼容的行为来运行操作。 使用 Stable API可确保服务器响应一致，并为应用程序提供长期的API稳定性。
以下部分介绍如何为 客户端启用和自定义stable API MongoDB。有关 的更多信息，包括其支持的命令列表，请参阅stable API stable APIMongoDB Server手册中的 。
启用stable API
要启用stable API ，请执行以下步骤：
构造一个
ServerApi对象并指定stable API版本。 您必须使用ServerApiVersion枚举中定义的stable API版本。使用
MongoClientSettings.Builder类构造一个MongoClientSettings对象。使用
MongoClients.create()方法实例化MongoClient，并将MongoClientSettings实例作为参数传递。
以下代码示例展示了如何指定stable API版本 1：
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 }
使用 Stable API创建MongoClient实例后，使用客户端运行的所有命令都将使用指定的 Stable API配置。 如果必须使用备用配置运行命令，请创建新的MongoClient 。
配置stable API
下表描述了ServerApi.Builder类的可链式方法，您可以使用这些方法自定义 Stable API的行为。
选项名称 | 说明 |
|---|---|
strict() | Optional. When true, if you call a command that isn't part of
the declared API version, the driver raises an exception.Default: false |
deprecationErrors() | Optional. When true, if you call a command that is deprecated in the
declared API version, the driver raises an exception.Default: false |
以下代码示例展示了如何通过在ServerApi.Builder上链接方法来配置ServerApi的实例：
ServerApi serverApi = ServerApi.builder() .version(ServerApiVersion.V1) .strict(true) .deprecationErrors(true) .build();
故障排除
服务器上无法识别的字段“apiVersion”
如果您指定API版本并连接到不支持Stable API的MongoDB服务器，则Java Reactive Streams驾驶员会引发此异常。 确保您连接到运行MongoDB Server v 5.0或更高版本的部署。
已提供 apiStrict:true，但命令 <operation> 不在API版本中
如果您的MongoClient运行的操作不在您指定的 Stable API版本中，则Java Reactive Streams驾驶员会引发此异常。 要避免此错误，请使用指定 Stable API版本支持的替代操作，或在构造ServerApi对象时将strict选项设立为False 。
API 文档
有关将 Stable API与Java Reactive Streams驾驶员结合使用的更多信息，请参阅以下API文档：