你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Azure Cosmos DB Java SDK v4 性能提示

项目
04/15/2024

适用范围： NoSQL

重要

本文中的性能提示仅适用于 Azure Cosmos DB Java SDK v4。请查看 Azure Cosmos DB Java SDK v4 发行说明、Maven 存储库、Azure Cosmos DB Java SDK v4 故障排除指南了解详细信息。如果你当前使用的是早于 v4 的版本，请参阅迁移到 Azure Cosmos DB Java SDK v4 指南，获取升级到 v4 的相关帮助。

Azure Cosmos DB 是一个快速、弹性的分布式数据库，可以在提供延迟与吞吐量保证的情况下无缝缩放。凭借 Azure Cosmos DB，无需对体系结构进行重大更改或编写复杂的代码即可缩放数据库。扩展和缩减操作就像执行单个 API 调用或 SDK 方法调用一样简单。但是，由于 Azure Cosmos DB 是通过网络调用访问的，因此，使用 Azure Cosmos DB Java SDK v4 时，可以通过客户端优化获得最高性能。

因此，如果询问“如何提高数据库性能？”，请考虑以下选项：

网络

将客户端并置在同一 Azure 区域内以提高性能

如果可能，请将任何调用 Azure Cosmos DB 的应用程序放在与 Azure Cosmos DB 数据库所在的相同区域中。通过大致的比较发现，在同一区域中对 Azure Cosmos DB 的调用可在 1-2 毫秒内完成，而美国西海岸和美国东海岸之间的延迟则 > 50 毫秒。根据请求采用的路由，各项请求从客户端传递到 Azure 数据中心边界时的此类延迟可能有所不同。通过确保在与预配 Azure Cosmos DB 终结点所在的同一 Azure 区域中调用应用程序，可能会实现最低的延迟。有关可用区域的列表，请参阅 Azure Regions（Azure 区域）。

Azure Cosmos DB 连接策略演示

与多区域 Azure Cosmos DB 帐户交互的应用需要配置首选位置，以确保请求进入并置区域。

启用加速网络以减少延迟和 CPU 抖动

强烈建议按照说明在 Windows（选中以获取说明）或 Linux（选中以获取说明）Azure VM 中启用加速网络，以最大程度提高性能（减少延迟和 CPU 抖动）。

如果不使用加速网络，则在 Azure VM 与其他 Azure 资源之间传输的 IO 可能会通过位于 VM 与其网卡之间的主机和虚拟交换机进行路由。在数据路径中以内联方式放置主机和虚拟交换机不仅会增加信道中的延迟和抖动，还会占用 VM 的 CPU 周期。通过加速网络，VM 可以直接与 NIC 连接，而无需中介。所有网络策略详细信息均在 NIC 的硬件中处理，会绕过主机和虚拟交换机。通常情况下，当启用加速网络后，应会降低延迟并提高吞吐量，同时会提高延迟一致性并降低 CPU 利用率。

限制：加速网络必须受 VM OS 支持，并且只能在已停止并解除分配 VM 的情况下启用。不能通过 Azure 资源管理器部署此 VM。应用服务未启用加速网络。

有关详细信息，请参阅 Windows 和 Linux 说明。

优化直接连接和网关连接配置

若要优化直接连接和网关模式连接配置，请参阅如何优化 java sdk v4 的连接配置。

SDK 用法

安装最新的 SDK

Azure Cosmos DB SDK 正在不断改进以提供最佳性能。若要确定最近的 SDK 改进，请访问 Azure Cosmos DB SDK。

在应用程序生存期内使用单一实例 Azure Cosmos DB 客户端

每个 Azure Cosmos DB 客户端实例都是线程安全的，可执行高效的连接管理和地址缓存。要通过 Azure Cosmos DB 客户端获得高效的连接管理和更好的性能，我们强烈建议在应用程序生存期内使用单个 Azure Cosmos DB 客户端实例。

使用应用程序所需的最低一致性级别

创建 CosmosClient 时，在未显式设置的情况下，所使用的默认一致性是“会话”。如果应用程序逻辑不要求“会话”一致性，请将“一致性”设置为“最终”。注意：建议在采用 Azure Cosmos DB 更改源处理器的应用程序中至少使用“会话”一致性。

使用异步 API 最大化预配的吞吐量

Azure Cosmos DB Java SDK v4 捆绑了两个 API：同步 API 和异步 API。大致说来，异步 API 用于实现 SDK 功能，而同步 API 则是一种精简的包装器，用于向异步 API 发出阻止调用。这与较旧的 Azure Cosmos DB Async Java SDK v2 和 Azure Cosmos DB Sync Java SDK v2 都不同，前者只支持异步，后者只支持同步并且具有不同的实现。

API 的选择在客户端初始化期间确定；CosmosAsyncClient 支持异步 API，而 CosmosClient 支持同步 API。

异步 API 可实现非阻止 IO，如果你的目标是在向 Azure Cosmos DB 发出请求时最大化吞吐量，则它是最佳选择。

如果希望或需要在对每个请求的响应中阻止某个 API，或者如果同步操作是应用程序中的主导模式，则使用同步 API 可能是正确的选择。例如，在吞吐量并不重要的情况下，若要在微服务应用程序中将数据持久保存到 Azure Cosmos DB，则可以使用同步 API。

请注意，同步 API 吞吐量会随请求响应时间的增加而降低，而异步 API 可能会使硬件的全部带宽功能饱和。

使用同步 API 时，进行地理并置可以获得更高且更一致的吞吐量（请参阅将客户端并置在同一 Azure 区域内以提高性能），但应不会超过异步 API 可获得的吞吐量。

某些用户可能还不熟悉 Project Reactor，这是用于实现 Azure Cosmos DB Java SDK v4 异步 API 的响应式流框架。如果存在此问题，建议你阅读我们的简介性文章：Reactor Pattern Guide（Reactor 模式指南），然后查看此响应式编程简介，自行熟悉相关内容。如果你已将 Azure Cosmos DB 与异步接口一起使用，并且所使用的 SDK 是 Azure Cosmos DB Async Java SDK v2，则可能已熟悉 ReactiveX/RxJava，但不确定 Project Reactor 中的更改。在这种情况下，请查看我们的 Reactor 与RxJava 指南以熟悉相关内容。

以下代码片段演示了如何分别针对异步 API 或同步 API 操作初始化 Azure Cosmos DB 客户端：

异步
Sync

Java SDK V4 (Maven com.azure::azure-cosmos) 异步 API


CosmosAsyncClient client = new CosmosClientBuilder()
        .endpoint(HOSTNAME)
        .key(MASTERKEY)
        .consistencyLevel(CONSISTENCY)
        .buildAsyncClient();

Java SDK V4 (Maven com.azure::azure-cosmos) 同步 API


CosmosClient client = new CosmosClientBuilder()
        .endpoint(HOSTNAME)
        .key(MASTERKEY)
        .consistencyLevel(CONSISTENCY)
        .buildClient();

增大客户端工作负荷

如果以高吞吐量级别进行测试，客户端应用程序可能成为瓶颈，因为计算机的 CPU 或网络利用率将达到上限。如果达到此上限，可以跨多个服务器横向扩展客户端应用程序以继续进一步推送 Azure Cosmos DB 帐户。

一个好的经验法则是，在任何给定的服务器上，CPU 利用率都不超过 50%，以保持较低的延迟。

使用相应的计划程序（避免窃取事件循环 IO Netty 线程）

Azure Cosmos DB Java SDK 的异步功能基于 netty 非阻止 IO。 SDK 使用固定数量的 IO netty 事件循环线程（数量与计算机提供的 CPU 核心数相同）来执行 IO 操作。 API 返回的 Flux 会将结果发送到某个共享 IO 事件循环 netty 线程上。因此，切勿阻塞共享的 IO 事件循环 netty 线程。针对 IO 事件循环 netty 线程执行 CPU 密集型工作或者阻塞操作可能导致死锁，或大大减少 SDK 吞吐量。

例如，以下代码针对事件循环 IO netty 线程执行 CPU 密集型工作：


Mono<CosmosItemResponse<CustomPOJO>> createItemPub = asyncContainer.createItem(item);
createItemPub.subscribe(
        itemResponse -> {
            //this is executed on eventloop IO netty thread.
            //the eventloop thread is shared and is meant to return back quickly.
            //
            // DON'T do this on eventloop IO netty thread.
            veryCpuIntensiveWork();
        });

收到结果后，应避免在事件循环 IO netty 线程上对结果执行任何 CPU 密集型操作。你可以改为提供自己的计划程序，以便提供自己的线程来运行工作，如下所示（需要 import reactor.core.scheduler.Schedulers）。


Mono<CosmosItemResponse<CustomPOJO>> createItemPub = asyncContainer.createItem(item);
createItemPub
        .publishOn(Schedulers.parallel())
        .subscribe(
                itemResponse -> {
                    //this is now executed on reactor scheduler's parallel thread.
                    //reactor scheduler's parallel thread is meant for CPU intensive work.
                    veryCpuIntensiveWork();
                });

根据工作的类型，应该使用相应的现有 Reactor 计划程序来执行工作。请阅读 Schedulers。

要进一步了解项目 Reactor 的线程和计划模型，请参阅 Project Reactor 的博客文章。

有关 Azure Cosmos DB Java SDK v4 的详细信息，请参阅 GitHub 上 Azure SDK for Java 单存储库的 Azure Cosmos DB 目录。

优化应用程序中的日志记录设置

出于各种原因，应在生成高请求吞吐量的线程中添加日志记录。如果你的目标是使用此线程生成的请求使容器的预配吞吐量完全饱和，则日志记录优化可以极大地提升性能。

配置异步记录器

生成请求的线程的总体延迟计算必然会考虑到同步记录器延迟的因素。建议使用异步记录器（例如 log4j2），以便将日志记录开销与高性能应用程序线程分开。

禁用 netty 的日志记录

Netty 库日志记录非常琐碎，因此需要将其关闭（在配置中禁止登录可能并不足够），以避免产生额外的 CPU 开销。如果不处于调试模式，请一起禁用 netty 日志记录。因此，如果要使用 Log4j 来消除 netty 中 org.apache.log4j.Category.callAppenders() 产生的额外 CPU 开销，请将以下行添加到基代码：

org.apache.log4j.Logger.getLogger("io.netty").setLevel(org.apache.log4j.Level.OFF);

OS 打开文件资源限制

某些 Linux 系统（例如 Red Hat）对打开的文件数和连接总数施加了上限。运行以下命令以查看当前限制：

ulimit -a

打开的文件数 (nofile) 需要足够大，以便为配置的连接池大小和 OS 打开的其他文件留出足够的空间。可以修改此参数，以增大连接池大小。

打开 limits.conf 文件：

vim /etc/security/limits.conf

添加/修改以下行：

* - nofile 100000

在点写入中指定分区键

若要提高点写入的性能，请在点写入 API 调用中指定项分区键，如下所示：

异步
Sync

Java SDK V4 (Maven com.azure::azure-cosmos) 异步 API

asyncContainer.createItem(item,new PartitionKey(pk),new CosmosItemRequestOptions()).block();

Java SDK V4 (Maven com.azure::azure-cosmos) 同步 API

syncContainer.createItem(item,new PartitionKey(pk),new CosmosItemRequestOptions());

而不是仅提供项实例，如下所示：

异步
Sync

Java SDK V4 (Maven com.azure::azure-cosmos) 异步 API

asyncContainer.createItem(item).block();

Java SDK V4 (Maven com.azure::azure-cosmos) 同步 API

syncContainer.createItem(item);

后者是受支持的，但会增加应用程序的延迟；SDK 必须分析项并提取分区键。

查询操作

有关查询操作，请参阅查询的性能提示。

索引策略

从索引中排除未使用的路径以加快写入速度

Azure Cosmos DB 的索引策略允许使用索引路径（setIncludedPaths 和 setExcludedPaths）指定要在索引中包括或排除的文档路径。在事先知道查询模式的方案中，使用索引路径可改善写入性能并降低索引存储空间，因为索引成本与索引的唯一路径数目直接相关。例如，以下代码演示如何使用“*”通配符从索引编制中纳入和排除文档的整个部分（也称为子树）。


CosmosContainerProperties containerProperties = new CosmosContainerProperties(containerName, "/lastName");

// Custom indexing policy
IndexingPolicy indexingPolicy = new IndexingPolicy();
indexingPolicy.setIndexingMode(IndexingMode.CONSISTENT);

// Included paths
List<IncludedPath> includedPaths = new ArrayList<>();
includedPaths.add(new IncludedPath("/*"));
indexingPolicy.setIncludedPaths(includedPaths);

// Excluded paths
List<ExcludedPath> excludedPaths = new ArrayList<>();
excludedPaths.add(new ExcludedPath("/name/*"));
indexingPolicy.setExcludedPaths(excludedPaths);

containerProperties.setIndexingPolicy(indexingPolicy);

ThroughputProperties throughputProperties = ThroughputProperties.createManualThroughput(400);

database.createContainerIfNotExists(containerProperties, throughputProperties);
CosmosAsyncContainer containerIfNotExists = database.getContainer(containerName);

有关索引的详细信息，请参阅 Azure Cosmos DB 索引策略。

吞吐量

测量和优化较低的每秒请求单位使用量

Azure Cosmos DB 提供一组丰富的数据库操作，包括 UDF 的关系和层次查询、存储过程和触发 – 所有都在数据库集合的文档上操作。与这些操作关联的成本取决于完成操作所需的 CPU、IO 和内存。与考虑和管理硬件资源不同的是，可以考虑将请求单位 (RU) 作为所需资源的单个措施，以执行各种数据库操作和服务应用程序请求。

吞吐量是基于为每个容器设置的请求单位数量预配的。请求单位消耗以每秒速率评估。如果应用程序的速率超过了为其容器预配的请求单位速率，则会受到限制，直到该速率降到容器的预配级别以下。如果应用程序需要较高级别的吞吐量，可以通过预配更多请求单位来增加吞吐量。

查询的复杂性会影响操作使用的请求单位数量。谓词数、谓词性质、UDF 数目和源数据集的大小都会影响查询操作的成本。

若要测量任何操作（创建、更新或删除）的开销，请检查 x-ms-request-charge 标头来测量这些操作占用的请求单位数。也可以在 ResourceResponse<T> 或 FeedResponse<T> 中找到等效的 RequestCharge 属性。

异步
Sync

Java SDK V4 (Maven com.azure::azure-cosmos) 异步 API

CosmosItemResponse<CustomPOJO> response = asyncContainer.createItem(item).block();

response.getRequestCharge();

Java SDK V4 (Maven com.azure::azure-cosmos) 同步 API

CosmosItemResponse<CustomPOJO> response = syncContainer.createItem(item);

response.getRequestCharge();

在此标头中返回的请求费用是预配吞吐量的一小部分。例如，如果预配了 2000 RU/s，上述查询返回 1000 个 1KB 文档，则操作成本为 1000。因此在一秒内，服务器在对后续请求进行速率限制之前，只接受两个此类请求。有关详细信息，请参阅请求单位和请求单位计算器。

处理速率限制/请求速率太大

客户端尝试超过帐户保留的吞吐量时，服务器的性能不会降低，并且不会使用超过保留级别的吞吐量容量。服务器将抢先结束 RequestRateTooLarge（HTTP 状态代码 429）的请求并返回 x-ms-retry-after-ms 标头，该标头指示重新尝试请求前用户必须等待的时间量（以毫秒为单位）。

HTTP Status 429,
Status Line: RequestRateTooLarge
x-ms-retry-after-ms :100

SDK 全部都会隐式捕获此响应，并遵循服务器指定的 retry-after 标头，并重试请求。除非多个客户端同时访问帐户，否则下次重试就会成功。

如果多个客户端一直以高于请求速率的方式累积运行，则客户端当前在内部设置为 9 的默认重试计数可能无法满足需要；在这种情况下，客户端就会向应用程序引发 CosmosClientException，其状态代码为 429。可以通过在 ThrottlingRetryOptions 实例上使用 setMaxRetryAttemptsOnThrottledRequests() 来更改默认重试计数。默认情况下，如果请求继续以高于请求速率的方式运行，则会在 30 秒的累积等待时间后返回 CosmosClientException 和状态代码 429。即使当前的重试计数小于最大重试计数（默认值 9 或用户定义的值），也会发生这种情况。

尽管自动重试行为有助于改善大多数应用程序的复原能力和可用性，但是在执行性能基准测试时可能会造成冲突（尤其是在测量延迟时）。如果实验达到服务器限制并导致客户端 SDK 静默重试，则客户端观测到的延迟会剧增。若要避免性能实验期间出现延迟高峰，可以测量每个操作返回的费用，并确保请求以低于保留请求速率的方式运行。有关详细信息，请参阅请求单位。

针对小型文档进行设计以提高吞吐量

给定操作的请求费用（请求处理成本）与文档大小直接相关。大型文档的操作成本高于小型文档的操作成本。理想情况下，应将应用程序和工作流的项大小设计为 1 KB 左右，或相似的等级或数量级。对于延迟敏感的应用程序，应避免出现大项 - 几 MB 的文档会降低应用程序的速度。

后续步骤

若要深入了解如何设计应用程序以实现缩放和高性能，请参阅 Azure Cosmos DB 中的分区和缩放。

尝试为迁移到 Azure Cosmos DB 进行容量计划？可以使用有关现有数据库群集的信息进行容量规划。

如果你只知道现有数据库群集中的 vCore 和服务器数量，请阅读根据 vCore 或 vCPU 数量估算请求单位数
若知道当前数据库工作负载的典型请求速率，请阅读使用 Azure Cosmos DB 容量计划工具估算请求单位

Azure Cosmos DB Java SDK v4 性能提示

网络

优化直接连接和网关连接配置

SDK 用法

查询操作

索引策略

吞吐量

后续步骤

其他资源