Java AWS SDK开发者指南：全面集成与服务示例

需积分: 40 187 浏览量更新于2024-07-17 收藏 1.55MB PDF 举报

AWS开发SDK是Amazon Web Services (AWS)为Java开发者提供的官方工具包，它包含了全面的API接口，使得开发者能够轻松地利用AWS的各种云服务。这份文档是针对Java开发者的详尽指南，涵盖了从安装、配置到实际应用的所有关键步骤。首先，文档强调了版权和商标使用规则，指出Amazon的商标和标识只能在与Amazon产品和服务相关的情况下使用，并且不能误导或贬低亚马逊。其他非亚马逊拥有的商标属于各自的权益人。接下来的章节列表展示了该文档的结构： 1. **适用于Java的AWS开发工具包2.0-开发人员预览**：这部分可能介绍了新版本的功能特性及开发人员可以期待的改进。 2. **其他文档和资源**：这部分提供了与AWS开发工具包相关的其他辅助材料，如Eclipse IDE的支持说明，这有助于开发者在集成环境中更高效地工作。 3. **开发适用于Android的AWS应用程序**：针对Android平台的开发者，文档可能介绍了如何在移动应用中整合AWS服务。 4. **查看开发工具包的修订历史记录**：了解每个版本的更新和变更，对于跟踪和解决问题很有帮助。 5. **构建早期版本开发工具包的Java参考文档**：提供历史版本的开发工具包的详细API参考，帮助开发者查阅旧版本的功能。 6. **入门**：这部分可能是基础指南，介绍如何注册AWS账户，创建IAM用户，以及如何为后续开发做准备。 7. **设置AWSSDK for Java**：这部分详细讲解如何在项目中集成开发工具包，包括下载、解压、旧版本的安装和新环境的搭建。 8. **使用Maven或Gradle**：介绍了如何通过这两种流行的构建工具来管理和构建AWS SDK项目，包括配置为依赖项、重新构建项目等。 9. **使用AWSSDK for Java**：深入介绍了如何通过SDK进行AWS服务的开发，包括最佳实践，比如使用Amazon S3（云存储服务）创建服务客户端，以及如何获取客户端生成器以实现异步操作。这份文档是开发人员不可或缺的参考资料，涵盖了AWS Java SDK的核心概念、安装流程、服务集成以及常见开发场景的最佳实践。无论是初次接触AWS还是经验丰富的开发者，都能从中找到所需的信息，提升在AWS平台上开发应用的能力。

适用于 Java 的 AWS 开发工具包开发人员指南

使用 AWS SDK for Java 进行 AWS 开发的最佳实践

使用 AWS SDK for Java

使用 AWS SDK for Java 进行编程的重要常规信息，适用于可与开发工具包结合使用的所有服务。

有关特定于服务的编程信息和示例 (用于 Amazon EC2、Amazon S3、Amazon SWF 等等)，请参阅适用于

Java 的 AWS 开发工具包示例 (p. 32)。

主题

• 使用 AWS SDK for Java 进行 AWS 开发的最佳实践 (p. 11)

• 创建服务客户端 (p. 12)

• 使用 AWS 凭证 (p. 14)

• AWS 区域选择 (p. 17)

• 异常处理 (p. 19)

• 异步编程 (p. 20)

• 记录 AWS SDK for Java 调用 (p. 22)

• 客户端配置 (p. 25)

• 访问控制策略 (p. 26)

• 设置 DNS 名称查找的 JVM TTL (p. 28)

• 为 AWS SDK for Java 启用指标 (p. 28)

使用 AWS SDK for Java 进行 AWS 开发的最佳实践

以下最佳实践可帮助您避免在使用 AWS SDK for Java 开发 AWS 应用程序时遇到问题和麻烦。这些最佳实

践已按服务分类整理。

Amazon S3

避免 ResetExceptions

当您使用流 (通过 AmazonS3 客户端或 TransferManager) 将对象上传到 Amazon S3 时，可能遇到网络连接

或超时问题。默认情况下，AWS SDK for Java 将尝试通过以下方式尝试重试失败的传输：先在传输开始前

标记输入流，然后在重试前重新设置它。

如果流不支持标记和重置操作，则开发工具包将在出现临时故障并支持重试时引发 ResetException。

最佳实践

建议您使用支持标记和重置操作的流。

避免 ResetException 的最可靠方式是使用 File 或 FileInputStream 提供数据，因为它们可由 AWS SDK for

Java 处理，不受标记和重置限制的约束。

如果流不是 FileInputStream 但支持标记和重置操作，您可以使用 RequestClientOptions 的 setReadLimit

方法设置标记限制。其默认值为 128KB。将读取限制值设置为比流大小多 1 个字节的值将可靠地避免

ResetException。

适用于 Java 的 AWS 开发工具包开发人员指南

创建服务客户端

例如，如果流的最大预期大小为 100000 字节，则将读取限制设置为 100001 (100000 + 1) 字节。标记和重

置操作将始终适用于 100000 字节或更少的字节。请注意，这可能会导致一些流将该数量的字节缓冲到内存

中。

创建服务客户端

要提交请求至 Amazon Web Services，您首先要创建一个服务客户端对象。推荐的方法是使用服务客户端生

成器。

每个 AWS 服务都有一个服务接口，提供与服务 API 中各项操作对应的方法。例如，Amazon DynamoDB

的服务接口名为 AmazonDynamoDB。每个服务接口都有对应的客户端生成器，可用于构建服务接口的实

施。DynamoDB 的客户端生成器类名为 AmazonDynamoDBClientBuilder。

获取客户端生成器

要获取客户端生成器的实例，使用下例中所示的静态工厂方法 standard。

AmazonDynamoDBClientBuilder builder = AmazonDynamoDBClientBuilder.standard();

获得生成器以后，可以使用生成器 API 中的多个常用 setter 来自定义客户端的属性。例如，您可以按以下方

法设置自定义区域和自定义凭证提供程序。

AmazonDynamoDB ddb = AmazonDynamoDBClientBuilder.standard()

.withRegion(Regions.US_WEST_2)

.withCredentials(new ProfileCredentialsProvider("myProfile"))

.build();

Note

常用的 withXXX 方法会返回 builder 对象，由此可以将方法调用组合起来，这样不仅方便而且代

码更加便于阅读。在配置需要的属性后，可以调用 build 方法创建客户端。创建的客户端不可更

改，而且对 setRegion 或 setEndpoint 的所有调用都会失败。

生成器可以使用相同配置创建多个客户端。在编写应用程序时，请注意生成器可变而且是非线程安全的。

以下代码使用生成器作为客户端实例的工厂。

public class DynamoDBClientFactory {

private final AmazonDynamoDBClientBuilder builder =

AmazonDynamoDBClientBuilder.standard()

.withRegion(Regions.US_WEST_2)

.withCredentials(new ProfileCredentialsProvider("myProfile"));

public AmazonDynamoDB createClient() {

return builder.build();

}

生成器还显示 ClientConfiguration、RequestMetricCollector 以及自定义 RequestHandler2 列表的常用

setter。

以下给出将覆盖所有可配置属性的完整示例。

AmazonDynamoDB ddb = AmazonDynamoDBClientBuilder.standard()

适用于 Java 的 AWS 开发工具包开发人员指南

创建异步客户端

.withRegion(Regions.US_WEST_2)

.withCredentials(new ProfileCredentialsProvider("myProfile"))

.withClientConfiguration(new ClientConfiguration().withRequestTimeout(5000))

.withMetricsCollector(new MyCustomMetricsCollector())

.withRequestHandlers(new MyCustomRequestHandler(), new MyOtherCustomRequestHandler)

.build();

创建异步客户端

AWS SDK for Java 的每个服务均有异步客户端 (除了 Amazon S3 之外)，且每个服务有相应的异步客户端生

成器。

使用默认 ExecutorService 创建异步 DynamoDB 客户端

AmazonDynamoDBAsync ddbAsync = AmazonDynamoDBAsyncClientBuilder.standard()

.withRegion(Regions.US_WEST_2)

.withCredentials(new ProfileCredentialsProvider("myProfile"))

.build();

除了同步客户端生成器支持的配置选项外，使用异步客户端可以设置自定义的 ExecutorFactory，以更改异步

客户端使用的 ExecutorService。ExecutorFactory 是一个功能接口，所以它能够与 Java 8 lambda 表

达式和方法参考进行互操作。

使用自定义执行程序创建异步客户端

AmazonDynamoDBAsync ddbAsync = AmazonDynamoDBAsyncClientBuilder.standard()

.withExecutorFactory(() -> Executors.newFixedThreadPool(10))

.build();

使用 DefaultClient

同步和异步客户端生成器都包含名为 defaultClient 的另一个工厂方法。该方法使用默认配置创建服

务客户端，即使用默认提供程序链加载凭证和 AWS 区域。如果不能根据运行应用程序的环境确定凭证或

区域，则对 defaultClient 的调用失败。有关如何确定凭证和区域的更多信息，请参阅使用 AWS 凭

证 (p. 14)和 AWS 区域选择 (p. 17)。

创建默认服务客户端

AmazonDynamoDB ddb = AmazonDynamoDBClientBuilder.defaultClient();

客户端生命周期

开发工具包中的服务客户端是线程安全的，而且为了获得最佳性能，应该将其作为永久对象。每个客户端自

己有连接池资源，当客户端收集到垃圾时相应资源会关闭。要显式关闭客户端，请调用 shutdown 方法。在

调用 shutdown 后，会释放所有客户端资源且客户端不可用。

关闭客户端

AmazonDynamoDB ddb = AmazonDynamoDBClientBuilder.defaultClient();

ddb.shutdown();

// Client is now unusable

适用于 Java 的 AWS 开发工具包开发人员指南

使用 AWS 凭证

要向 Amazon Web Services 提交请求，您必须为 AWS SDK for Java 提供 AWS 凭证。您可以通过下列方式

来执行此操作：

• 使用默认凭证提供程序链 (推荐).

• 使用特定的凭证提供程序或提供程序链 (或创建您自己的)。

• 自行提供凭证。这些凭证可以是根账户凭证、IAM 凭证或从 AWS STS 获取的临时凭证。

Important

出于安全考虑，强烈建议您使用 IAM 用户而非根账户来进行 AWS 访问。有关更多信息，请参阅

IAM User Guide 中的 IAM 最佳实践。

使用默认凭证提供程序链

在初始化新服务客户端而不提供任何参数时，AWS SDK for Java 将尝试使用由

DefaultAWSCredentialsProviderChain 类实施的默认凭证提供程序链来查找 AWS 凭证。默认凭证提供程序

链将按此顺序查找凭证：

1. 环境变量 – AWS_ACCESS_KEY_ID 和 AWS_SECRET_ACCESS_KEY。AWS SDK for Java 使用

EnvironmentVariableCredentialsProvider 类加载这些凭证。

2. Java 系统属性 – aws.accessKeyId 和 aws.secretKey。AWS SDK for Java 使用

SystemPropertiesCredentialsProvider 加载这些凭证。

3. 默认凭证配置文件 – 通常位于 ~/.aws/credentials (此位置可能因平台而异)，此凭证文件由多个

AWS 开发工具包和 AWS CLI 共享。AWS SDK for Java 使用 ProfileCredentialsProvider 加载这些凭证。

您可以使用由 AWS CLI 提供的 aws configure 命令创建凭证文件，也可以使用文本编辑器编辑文件来

创建它。有关凭证文件格式的信息，请参阅 AWS 凭证文件格式 (p. 15)。

4. Amazon ECS 容器凭证 – 如果设置了环境变量 AWS_CONTAINER_CREDENTIALS_RELATIVE_URI，则从

Amazon ECS 加载凭证。AWS SDK for Java 使用 ContainerCredentialsProvider 加载这些凭证。

5. 实例配置文件凭证 – 在 EC2 实例上使用，并通过 Amazon EC2 元数据服务传送。AWS SDK for Java 使

用 InstanceProfileCredentialsProvider 加载这些凭证。

Note

仅在未设置 AWS_CONTAINER_CREDENTIALS_RELATIVE_URI 时使用实例配置文件凭证。有关

更多信息，请参阅 EC2ContainerCredentialsProviderWrapper。

设置凭证

要使用 AWS 凭证，必须在上述位置中的至少一个位置设置该凭证。有关设置凭证的信息，请参阅以下主

题：

• 有关在环境或默认凭证配置文件中指定凭证，请参阅设置用于开发的 AWS 凭证和区域 (p. 6)。

• 要设置 Java 系统属性，请参阅官方 Java 教程网站中的系统属性教程。

• 要设置和使用与 EC2 实例一起使用的实例配置文件凭证，请参阅使用 IAM 角色授予对 Amazon EC2 上的

AWS 资源的访问权 (p. 52)。

设置备用凭证配置文件

默认情况下，AWS SDK for Java 使用默认配置文件，但可通过几种方式自定义源自凭证文件的配置文件。

适用于 Java 的 AWS 开发工具包开发人员指南

使用默认凭证提供程序链

您可以使用 AWS 配置文件环境变量来更改开发工具包所加载的配置文件。

例如，在 Linux, macOS, or Unix 上，您可运行以下命令来将配置文件更改为 myProfile。

export AWS_PROFILE="myProfile"

在 Windows 上，您将使用以下配置文件。

set AWS_PROFILE="myProfile"

设置 AWS_PROFILE 环境变量将影响所有正式支持的 AWS 开发工具包和工具 (包括 AWS CLI 和 AWS CLI

for PowerShell) 的凭证加载。如果只需要更改 Java 应用程序的配置文件，则可改用系统属性 aws.profile。

Note

环境变量优先于系统属性。

设置备用凭证文件位置

AWS SDK for Java 会自动从默认凭证文件位置加载 AWS 凭证。但是，您也可以通过在

AWS_CREDENTIAL_PROFILES_FILE 环境变量中设置凭证文件的完整路径来指定位置。

您可以使用此功能临时更改 AWS SDK for Java 查找凭证文件的位置 (例如，通过使用命令行设置此变量)。

或者，您也可以在您的用户环境或系统环境中设置该环境变量，在用户范围或系统范围内对其进行更改。

覆盖默认凭证文件位置

• 将 AWS_CREDENTIAL_PROFILES_FILE 环境变量设置为 AWS 凭证文件的位置。

• 在 Linux, macOS, or Unix 上，请使用 export ：

export AWS_CREDENTIAL_PROFILES_FILE=path/to/credentials_file

• 在 Windows 上，请使用 set ：

set AWS_CREDENTIAL_PROFILES_FILE=path/to/credentials_file

AWS 凭证文件格式

在使用 aws configure 命令创建 AWS 凭证文件时，该命令将采用以下格式创建一个文件。

[default]

aws_access_key_id={YOUR_ACCESS_KEY_ID}

aws_secret_access_key={YOUR_SECRET_ACCESS_KEY}

[profile2]

aws_access_key_id={YOUR_ACCESS_KEY_ID}

aws_secret_access_key={YOUR_SECRET_ACCESS_KEY}

在方括号中指定配置文件名 (例如：[default])，后跟该配置文件中的可配置字段作为键值对。您的凭证文

件可包含多个配置文件，可使用 aws configure --profile PROFILE_NAME 选择要配置的配置文件

来添加或编辑这些配置文件。

您可以指定其他字段，例如 aws_session_token、metadata_service_timeout 和

metadata_service_num_attempts。无法使用 CLI 配置这些文件 - 如果您想使用这些文件，则必须手动

编辑它们。有关配置文件及其可用字段的更多信息，请参阅 AWS CLI User Guide 中的配置 AWS 命令行。

剩余167页未读，继续阅读

prafliewen

粉丝: 0
资源: 4

Java AWS SDK开发者指南：全面集成与服务示例

Amazon S3 开发指南--中文

aws java sdk 引用到的jar

aws-sdk-unity：已归档：统一的aws sdk现在作为dotnet的aws sdk的一部分分发：

AWS SDK和AWS IoT Device SDK有什么关系

aws-java-sdk-core

在使用AWS Java SDK S3进行开发时，如何通过Maven配置项目的依赖，并且附上上传文件到S3的Java代码示例？

aws-sdk-cpp x64 1.11

uniapp不使用aws-sdk上传图片到aws上

software.amazon.awssdk s3 api文档

aws sdk for java - 1.12

最新资源