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

QueueServiceClientBuilder 类

包:

com.azure.storage.queue

Maven 项目:

com.azure:azure-storage-queue:12.19.1

• java.lang.Object
• • com.azure.storage.queue.QueueServiceClientBuilder

实现

AzureNamedKeyCredentialTrait<QueueServiceClientBuilder> AzureSasCredentialTrait<QueueServiceClientBuilder> ConfigurationTrait<QueueServiceClientBuilder> ConnectionStringTrait<QueueServiceClientBuilder> EndpointTrait<QueueServiceClientBuilder> HttpTrait<QueueServiceClientBuilder> TokenCredentialTrait<QueueServiceClientBuilder>

public final class QueueServiceClientBuilder
implements TokenCredentialTrait<QueueServiceClientBuilder>, ConnectionStringTrait<QueueServiceClientBuilder>, AzureNamedKeyCredentialTrait<QueueServiceClientBuilder>, AzureSasCredentialTrait<QueueServiceClientBuilder>, HttpTrait<QueueServiceClientBuilder>, ConfigurationTrait<QueueServiceClientBuilder>, EndpointTrait<QueueServiceClientBuilder>

此类提供 Fluent Builder API 来帮助配置和实例化 QueueServiceClient 和 ，调用 buildClient() 将构造 QueueServiceClient 的实例，而调用 buildAsyncClient() 则构造 QueueServiceAsyncClient QueueServiceAsyncClient的实例。

客户端需要 Azure 存储队列服务的终结点、共享名称和授权凭据。 endpoint(String endpoint) 为生成器提供终结点，并可能为生成器提供授权客户端的 SAS 令牌。

使用 SAS 令牌实例化同步队列服务客户端

QueueServiceClient client = new QueueServiceClientBuilder()
     .endpoint("https://${accountName}.queue.core.windows.net?${SASToken}")
     .buildClient();

使用 SAS 令牌实例化异步队列服务客户端

QueueServiceAsyncClient client = new QueueServiceClientBuilder()
     .endpoint("https://{accountName}.queue.core.windows.net?{SASToken}")
     .buildAsyncClient();

endpoint如果 不包含用于构造 SAS 令牌的查询参数，可将sasToken(String sasToken)这些参数与终结点一起使用。

使用 SAS 令牌实例化同步队列服务客户端

QueueServiceAsyncClient client = new QueueServiceClientBuilder()
     .endpoint("https://{accountName}.queue.core.windows.net")
     .sasToken("{SASTokenQueryParams}")
     .buildAsyncClient();

使用 SAS 令牌实例化异步队列服务客户端

QueueServiceAsyncClient client = new QueueServiceClientBuilder()
     .endpoint("https://{accountName}.queue.core.windows.net")
     .sasToken("{SASTokenQueryParams}")
     .buildAsyncClient();

对客户端进行身份验证的另一种方法 StorageSharedKeyCredential是使用 。 若要创建 StorageSharedKeyCredential，必须使用存储队列服务中的连接字符串。 使用 设置 StorageSharedKeyCredential connectionString(String connectionString)。 如果生成器同时具有 SAS 令牌和 StorageSharedKeyCredential，则授权发送到服务的请求时，首选 StorageSharedKeyCredential。

使用连接字符串实例化同步队列服务客户端。

String connectionString = "DefaultEndpointsProtocol=https;AccountName={name};"
     + "AccountKey={key};EndpointSuffix={core.windows.net}";
 QueueServiceClient client = new QueueServiceClientBuilder()
     .connectionString(connectionString)
     .buildClient();

使用连接字符串实例化异步队列服务客户端。

String connectionString = "DefaultEndpointsProtocol=https;AccountName={name};"
     + "AccountKey={key};EndpointSuffix={core.windows.net}";
 QueueServiceAsyncClient client = new QueueServiceClientBuilder()
     .connectionString(connectionString)
     .buildAsyncClient();

构造函数摘要

构造函数	说明
QueueServiceClientBuilder()	创建能够配置和构造 QueueServiceClient 和 QueueServiceAsyncClient的生成器实例。

方法摘要

修饰符和类型	方法和描述
QueueServiceClientBuilder	addPolicy(HttpPipelinePolicy pipelinePolicy) 添加 要 HttpPipelinePolicy 对发送的每个请求应用。
QueueServiceAsyncClient	buildAsyncClient() QueueServiceAsyncClient基于生成器中设置的选项创建 。
QueueServiceClient	buildClient() QueueServiceClient基于生成器中设置的选项创建 。
QueueServiceClientBuilder	clientOptions(ClientOptions clientOptions) 允许设置常见属性，例如应用程序 ID、标头、代理配置等。
QueueServiceClientBuilder	configuration(Configuration configuration) 设置用于在生成客户端期间检索环境配置值的配置对象。
QueueServiceClientBuilder	connectionString(String connectionString) 设置要连接到服务的连接字符串。
QueueServiceClientBuilder	credential(AzureNamedKeyCredential credential) AzureNamedKeyCredential设置用于授权发送到服务的请求的 。
QueueServiceClientBuilder	credential(AzureSasCredential credential) AzureSasCredential设置用于授权发送到服务的请求的 。
QueueServiceClientBuilder	credential(TokenCredential credential) TokenCredential设置用于授权发送到服务的请求的 。
QueueServiceClientBuilder	credential(StorageSharedKeyCredential credential) StorageSharedKeyCredential设置用于授权发送到服务的请求的 。
QueueServiceClientBuilder	endpoint(String endpoint) 设置客户端将与之交互的 Azure 存储队列实例的终结点。
static HttpLogOptions	getDefaultHttpLogOptions() 获取默认的存储允许列表日志标头和查询参数。
QueueServiceClientBuilder	httpClient(HttpClient httpClient) HttpClient设置用于向/从服务发送和接收请求的 。
QueueServiceClientBuilder	httpLogOptions(HttpLogOptions logOptions) 设置在 HttpLogOptions 向/从服务发送和接收请求时要使用的 。
QueueServiceClientBuilder	messageEncoding(QueueMessageEncoding messageEncoding) 设置队列消息编码。
QueueServiceClientBuilder	pipeline(HttpPipeline httpPipeline) HttpPipeline设置要用于服务客户端的 。
QueueServiceClientBuilder	processMessageDecodingError(Consumer<QueueMessageDecodingError> processMessageDecodingErrorHandler) 设置处理程序，该处理程序执行从队列接收消息或达到峰值时所需的任务，但无法解码。
QueueServiceClientBuilder	processMessageDecodingErrorAsync(Function<QueueMessageDecodingError,Mono<Void>> processMessageDecodingErrorAsyncHandler) 设置异步处理程序，该处理程序执行从队列接收消息或达到峰值时所需的任务，但无法解码。
QueueServiceClientBuilder	retryOptions(RetryOptions retryOptions) RetryOptions为通过客户端发出的所有请求设置 。
QueueServiceClientBuilder	retryOptions(RequestRetryOptions retryOptions) 为通过客户端发出的所有请求设置请求重试选项。
QueueServiceClientBuilder	sasToken(String sasToken) 设置用于授权发送到服务的请求的 SAS 令牌。
QueueServiceClientBuilder	serviceVersion(QueueServiceVersion version) 设置发出 QueueServiceVersion API 请求时使用的 。

方法继承自 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

构造函数详细信息

QueueServiceClientBuilder

public QueueServiceClientBuilder()

创建能够配置和构造 QueueServiceClient 和 QueueServiceAsyncClient的生成器实例。

方法详细信息

addPolicy

public QueueServiceClientBuilder addPolicy(HttpPipelinePolicy pipelinePolicy)

添加 要 HttpPipelinePolicy 对发送的每个请求应用。

注意： 了解 HttpTrait API 的优先顺序非常重要。 具体而言，如果 HttpPipeline 指定了 ，则这优先于特征中的所有其他 API，它们将被忽略。 HttpPipeline如果未指定，则根据提供给此特征的设置在内部构造 HTTP 管道。 此外，实现此特征的类型中可能存在其他 API，如果 HttpPipeline 指定 了 ，这些 API 也会被忽略，因此请务必参考实现此特征的类型的文档，以了解完整的一组影响。

Parameters:

pipelinePolicy - 一个 HttpPipelinePolicy。

Returns:

更新的 QueueServiceClientBuilder 对象

buildAsyncClient

public QueueServiceAsyncClient buildAsyncClient()

QueueServiceAsyncClient基于生成器中设置的选项创建 。 每次调用时，都会创建 一 QueueServiceAsyncClient 个新的 实例。

如果 pipeline(HttpPipeline httpPipeline) 设置了 ，则 pipeline 使用 和 endpoint(String endpoint) 创建 QueueServiceAsyncClient。 将忽略所有其他生成器设置。

Returns:

一个 QueueServiceAsyncClient，其中包含从生成器设置的选项。

buildClient

public QueueServiceClient buildClient()

QueueServiceClient基于生成器中设置的选项创建 。 每次调用时，都会创建 一 QueueServiceClient 个新的 实例。

如果 pipeline(HttpPipeline httpPipeline) 设置了 ，则 pipeline 使用 和 endpoint(String endpoint) 创建 QueueServiceClient。 将忽略所有其他生成器设置。

Returns:

一个 QueueServiceClient，其中包含从生成器设置的选项。

clientOptions

public QueueServiceClientBuilder clientOptions(ClientOptions clientOptions)

允许设置常见属性，例如应用程序 ID、标头、代理配置等。请注意，建议使用类的 HttpClientOptions 实例 (基类的子类 ClientOptions) 调用此方法。 HttpClientOptions 子类提供更多适用于 HTTP 客户端的配置选项，适用于实现此 HttpTrait 接口的任何类。

注意： 了解 HttpTrait API 的优先顺序非常重要。 具体而言，如果 HttpPipeline 指定了 ，则这优先于特征中的所有其他 API，它们将被忽略。 HttpPipeline如果未指定，则根据提供给此特征的设置在内部构造 HTTP 管道。 此外，实现此特征的类型中可能存在其他 API，如果 HttpPipeline 指定 了 ，这些 API 也会被忽略，因此请务必参考实现此特征的类型的文档，以了解完整的一组影响。

Parameters:

clientOptions - 配置的实例 HttpClientOptions。

Returns:

更新的 QueueServiceClientBuilder 对象

configuration

public QueueServiceClientBuilder configuration(Configuration configuration)

设置用于在生成客户端期间检索环境配置值的配置对象。

Parameters:

configuration - 用于检索环境配置的配置存储区。

Returns:

更新的 QueueServiceClientBuilder 对象

connectionString

public QueueServiceClientBuilder connectionString(String connectionString)

设置要连接到服务的连接字符串。

Parameters:

connectionString - 存储帐户的连接字符串。

Returns:

更新的 QueueServiceClientBuilder

credential

public QueueServiceClientBuilder credential(AzureNamedKeyCredential credential)

AzureNamedKeyCredential设置用于授权发送到服务的请求的 。

Parameters:

credential - AzureNamedKeyCredential.

Returns:

更新的 QueueServiceClientBuilder

credential

public QueueServiceClientBuilder credential(AzureSasCredential credential)

AzureSasCredential设置用于授权发送到服务的请求的 。

Parameters:

credential - AzureSasCredential 用于授权发送到服务的请求。

Returns:

更新的 QueueServiceClientBuilder

credential

public QueueServiceClientBuilder credential(TokenCredential credential)

TokenCredential设置用于授权发送到服务的请求的 。 有关正确使用 TokenCredential 类型的更多详细信息，请参阅 Azure SDK for Java 标识和身份验证文档。

Parameters:

credential - TokenCredential 用于授权发送到服务的请求。

Returns:

更新的 QueueServiceClientBuilder

credential

public QueueServiceClientBuilder credential(StorageSharedKeyCredential credential)

StorageSharedKeyCredential设置用于授权发送到服务的请求的 。

Parameters:

credential - StorageSharedKeyCredential.

Returns:

更新的 QueueServiceClientBuilder

endpoint

public QueueServiceClientBuilder endpoint(String endpoint)

设置客户端将与之交互的 Azure 存储队列实例的终结点。

在尝试生成 SAS 令牌以对发送到服务的请求进行身份验证时，将分析终结点的查询参数。

Parameters:

endpoint - 要向其发送服务请求以及从中接收响应的 Azure 存储队列实例的 URL。

Returns:

更新的 QueueServiceClientBuilder 对象

getDefaultHttpLogOptions

public static HttpLogOptions getDefaultHttpLogOptions()

获取默认的存储允许列表日志标头和查询参数。

Returns:

默认 http 日志选项。

httpClient

public QueueServiceClientBuilder httpClient(HttpClient httpClient)

HttpClient设置用于向/从服务发送和接收请求的 。

注意： 请务必了解 HttpTrait API 的优先顺序。 具体而言，如果 HttpPipeline 指定了 ，则这优先于特征中的所有其他 API，它们将被忽略。 HttpPipeline如果未指定，则将基于提供给此特征的设置在内部构造 HTTP 管道。 此外，实现此特征的类型中可能存在其他 API，如果指定 了 ， HttpPipeline 则也会忽略这些 API，因此请务必参考实现此特征的类型的文档以了解完整的含义集。

Parameters:

httpClient - 要 HttpClient 用于请求的 。

Returns:

更新的 QueueServiceClientBuilder 对象

httpLogOptions

public QueueServiceClientBuilder httpLogOptions(HttpLogOptions logOptions)

设置在 HttpLogOptions 向/从服务发送和接收请求时要使用的 。 logLevel如果未提供 ，则设置 的默认值HttpLogDetailLevel#NONE。

注意： 请务必了解 HttpTrait API 的优先顺序。 具体而言，如果 HttpPipeline 指定了 ，则这优先于特征中的所有其他 API，它们将被忽略。 HttpPipeline如果未指定，则将基于提供给此特征的设置在内部构造 HTTP 管道。 此外，实现此特征的类型中可能存在其他 API，如果指定 了 ， HttpPipeline 则也会忽略这些 API，因此请务必参考实现此特征的类型的文档以了解完整的含义集。

Parameters:

logOptions - 在 HttpLogOptions 向/从服务发送和接收请求时要使用的 。

Returns:

更新的 QueueServiceClientBuilder 对象

messageEncoding

public QueueServiceClientBuilder messageEncoding(QueueMessageEncoding messageEncoding)

设置队列消息编码。

Parameters:

messageEncoding - QueueMessageEncoding.

Returns:

更新的 QueueServiceClientBuilder 对象

pipeline

public QueueServiceClientBuilder pipeline(HttpPipeline httpPipeline)

HttpPipeline设置要用于服务客户端的 。

注意： 请务必了解 HttpTrait API 的优先顺序。 具体而言，如果 HttpPipeline 指定了 ，则这优先于特征中的所有其他 API，它们将被忽略。 HttpPipeline如果未指定，则将基于提供给此特征的设置在内部构造 HTTP 管道。 此外，实现此特征的类型中可能存在其他 API，如果指定 了 ， HttpPipeline 则也会忽略这些 API，因此请务必参考实现此特征的类型的文档以了解完整的含义集。

endpoint(String endpoint)设置 时pipeline不会忽略 。

Parameters:

httpPipeline - HttpPipeline 用于发送服务请求和接收响应。

Returns:

更新的 QueueServiceClientBuilder 对象

processMessageDecodingError

public QueueServiceClientBuilder processMessageDecodingError(Consumer processMessageDecodingErrorHandler)

设置处理程序，该处理程序执行从队列接收消息或达到峰值时所需的任务，但无法解码。

当队列预期是确定 QueueMessageEncoding 的，但有另一个生成者未按预期方式编码消息时，可能会收到此类消息或达到峰值。 即队列包含具有不同编码的消息。

QueueMessageDecodingError 包含 QueueClient 已接收消息 getQueueMessageItem() 的队列以及 原始正文的 或 getPeekedMessageItem() ，即不会尝试解码，以便可以检查正文，就像已从队列收到的那样。

处理程序不会尝试从队列中删除消息。 因此，此类处理应包含在处理程序本身中。

处理程序将由由此 QueueServiceClient 生成器创建或 QueueServiceAsyncClient 生成的所有队列客户端共享。

建议将此处理程序用于同步 QueueClient。

示例代码

String connectionString = "DefaultEndpointsProtocol=https;AccountName={name};"
     + "AccountKey={key};EndpointSuffix={core.windows.net}";

 Consumer<QueueMessageDecodingError> processMessageDecodingErrorHandler =
     (queueMessageDecodingFailure) -> {
         QueueMessageItem queueMessageItem = queueMessageDecodingFailure.getQueueMessageItem();
         PeekedMessageItem peekedMessageItem = queueMessageDecodingFailure.getPeekedMessageItem();
         if (queueMessageItem != null) {
             System.out.printf("Received badly encoded message, messageId=%s, messageBody=%s",
                 queueMessageItem.getMessageId(),
                 queueMessageItem.getBody().toString());
             queueMessageDecodingFailure
                 .getQueueClient()
                 .deleteMessage(queueMessageItem.getMessageId(), queueMessageItem.getPopReceipt());
         } else if (peekedMessageItem != null) {
             System.out.printf("Peeked badly encoded message, messageId=%s, messageBody=%s",
                 peekedMessageItem.getMessageId(),
                 peekedMessageItem.getBody().toString());
         }
     };

 QueueServiceClient client = new QueueServiceClientBuilder()
     .connectionString(connectionString)
     .processMessageDecodingError(processMessageDecodingErrorHandler)
     .buildClient();

Parameters:

processMessageDecodingErrorHandler - 处理程序。

Returns:

更新的 QueueServiceClientBuilder 对象

processMessageDecodingErrorAsync

public QueueServiceClientBuilder processMessageDecodingErrorAsync(Function<>> processMessageDecodingErrorAsyncHandler)

设置异步处理程序，该处理程序执行从队列接收消息或达到峰值时所需的任务，但无法解码。

当队列预期是确定 QueueMessageEncoding 的，但有另一个生成者未按预期方式编码消息时，可能会收到此类消息或达到峰值。 即队列包含具有不同编码的消息。

QueueMessageDecodingError 包含 QueueAsyncClient 已接收消息 getQueueMessageItem() 的队列以及 原始正文的 或 getPeekedMessageItem() ，即不会尝试解码，以便可以检查正文，就像已从队列收到的那样。

处理程序不会尝试从队列中删除消息。 因此，此类处理应包含在处理程序本身中。

处理程序将由由此 QueueServiceClient 生成器创建或 QueueServiceAsyncClient 生成的所有队列客户端共享。

建议将此处理程序用于异步 QueueAsyncClient。

示例代码

String connectionString = "DefaultEndpointsProtocol=https;AccountName={name};"
     + "AccountKey={key};EndpointSuffix={core.windows.net}";

 Function<QueueMessageDecodingError, Mono<Void>> processMessageDecodingErrorHandler =
     (queueMessageDecodingFailure) -> {
         QueueMessageItem queueMessageItem = queueMessageDecodingFailure.getQueueMessageItem();
         PeekedMessageItem peekedMessageItem = queueMessageDecodingFailure.getPeekedMessageItem();
         if (queueMessageItem != null) {
             System.out.printf("Received badly encoded message, messageId=%s, messageBody=%s",
                 queueMessageItem.getMessageId(),
                 queueMessageItem.getBody().toString());
             return queueMessageDecodingFailure
                 .getQueueAsyncClient()
                 .deleteMessage(queueMessageItem.getMessageId(), queueMessageItem.getPopReceipt());
         } else if (peekedMessageItem != null) {
             System.out.printf("Peeked badly encoded message, messageId=%s, messageBody=%s",
                 peekedMessageItem.getMessageId(),
                 peekedMessageItem.getBody().toString());
             return Mono.empty();
         } else {
             return Mono.empty();
         }
     };

 QueueServiceClient client = new QueueServiceClientBuilder()
     .connectionString(connectionString)
     .processMessageDecodingErrorAsync(processMessageDecodingErrorHandler)
     .buildClient();

Parameters:

processMessageDecodingErrorAsyncHandler - 处理程序。

Returns:

更新的 QueueServiceClientBuilder 对象

retryOptions

public QueueServiceClientBuilder retryOptions(RetryOptions retryOptions)

RetryOptions为通过客户端发出的所有请求设置 。

注意： 请务必了解 HttpTrait API 的优先顺序。 具体而言，如果 HttpPipeline 指定了 ，则这优先于特征中的所有其他 API，它们将被忽略。 HttpPipeline如果未指定，则将基于提供给此特征的设置在内部构造 HTTP 管道。 此外，实现此特征的类型中可能存在其他 API，如果指定 了 ， HttpPipeline 则也会忽略这些 API，因此请务必参考实现此特征的类型的文档以了解完整的含义集。

设置此项与使用 是互斥的 retryOptions(RequestRetryOptions retryOptions)。 请考虑使用 retryOptions(RequestRetryOptions retryOptions) 来同时设置特定于存储的选项。

Parameters:

retryOptions - 要 RetryOptions 用于通过客户端发出的所有请求的 。

Returns:

更新的 QueueServiceClientBuilder 对象

retryOptions

public QueueServiceClientBuilder retryOptions(RequestRetryOptions retryOptions)

为通过客户端发出的所有请求设置请求重试选项。 设置此项与使用 是互斥的 retryOptions(RetryOptions retryOptions)。

Parameters:

retryOptions - RequestRetryOptions.

Returns:

更新的 QueueServiceClientBuilder 对象。

sasToken

public QueueServiceClientBuilder sasToken(String sasToken)

设置用于授权发送到服务的请求的 SAS 令牌。

Parameters:

sasToken - 用于对请求进行身份验证的 SAS 令牌。 此字符串应仅为 (带或不带前导“？”的查询参数) 而不是完整 URL。

Returns:

更新的 QueueServiceClientBuilder

serviceVersion

public QueueServiceClientBuilder serviceVersion(QueueServiceVersion version)

设置发出 QueueServiceVersion API 请求时使用的 。

如果未提供服务版本，将使用的服务版本将是基于正在使用的客户端库版本的最新已知服务版本。 如果未指定服务版本，更新到较新版本的客户端库可能会移动到较新的服务版本。

以特定服务版本为目标可能还意味着该服务将为较新的 API 返回错误。

Parameters:

version - QueueServiceVersion 发出请求时要使用的服务的 。

Returns:

更新的 QueueServiceClientBuilder 对象