示例工程教程后端【免费下载链接】aws-doc-sdk-examplesWelcome to the AWS Code Examples Repository. This repo contains code examples used in the AWS documentation, AWS SDK Developer Guides, and more. For more information, see the Readme.md file below.项目地址https://gitcode.com/gh_mirrors/aw/aws-doc-sdk-examples点击查看免费下载导读本篇文章围绕 AWS 文档代码示例仓库aws-doc-sdk-examples中 Java V2 代码示例的「Hello」示例生成规范展开系统讲解如何在 javav2/example_code 目录下为每一个 AWS 服务生成最小可运行的入门示例。这类 Hello 示例的价值在于不依赖任何辅助 Action 类、不引入额外复杂度仅用 AWS SDK for Java V2 的原生客户端完成一次最基本的 API 调用即可验证凭证、区域与服务连通性是开发者接入任何新 AWS 服务的标准起点。读完本文你将掌握 Hello 示例的强制前置步骤、统一代码骨架、按服务类型列表型 / 状态型 / 计算型的分类实现套路、错误处理规范、Maven 构建配置与测试验收标准并能对照仓库中已落地的真实示例逐行理解设计取舍。一、Hello 示例是什么定位与强制要求在 AWS 代码示例仓库的 Java V2 体系中Hello 示例承担着「服务连通性冒烟测试」的角色。文档steering_docs/java-tech/hello.md明确了它的四项核心定位MANDATORY强制性每一个 AWS 服务都必须包含一个 Hello 场景它是服务接入的起点示例Simplicity极简必须是该服务最基础、最小化的示例不做任何业务扩展Standalone独立必须能独立运行不依赖其他示例模块Direct Client直连客户端直接使用 AWS SDK 客户端调用服务 API不经过任何 actions 封装类。这一设计与仓库中的「Action / Scenario」示例体系形成互补——Action 示例封装单个操作、Scenario 示例串联业务流而 Hello 示例则是三者中最小的一环专注于「能连上、能调通、有输出」。二、强制前置步骤生成代码前的知识库咨询规范把「写代码前的调研」标注为CRITICAL关键步骤要求在任何代码生成之前按顺序完成以下四步列出可用知识库调用ListKnowledgeBases()查看当前可咨询的知识库清单查询编码规范REQUIRED向coding-standards-KB知识库查询Java-code-example-standards对齐仓库统一的 Java 编码风格命名、注释、包结构查询实现模式REQUIRED向Java-premium-KB知识库查询Java implementation patterns复用已被验证过的代码组织方式AWS 服务调研REQUIRED通过search_documentation检索「[AWS Service] 是什么、其关键 API 操作有哪些」再通过read_documentation精读对应服务的最新开发者指南页面确认该服务最基础的 API 操作。规范特别强调跳过知识库咨询将导致错误INCORRECT的代码结构。也就是说Hello 示例虽小但它对 API 选型、命名、结构的一致性是硬要求不能凭直觉随意编写。三、标准文件结构Hello 示例在仓库中的目录布局遵循严格的 Maven 风格约定javav2/example_code/{service}/ ├── src/main/java/com/example/{service}/ │ └── Hello{Service}.java # Hello example file以仓库实际文件验证S3 示例位于 HelloS3.java包名为com.example.s3IAM 示例位于 HelloIAM.java包名为com.example.iamAmazon Keyspaces 示例位于 HelloKeyspaces.java注意其包名缩写为keyspace单数形式服务目录名仍为keyspaces。从源码结构看com.example.{service}是仓库统一的包命名基准类名统一采用Hello{Service}的 PascalCase 形式如HelloS3、HelloIAM、HelloSNS、HelloBatch。四、Hello 示例的通用代码骨架规范给出了一套可直接套用的模板占位符{service}、{Service}需按目标服务替换核心要素如下4.1 头部与文档注释每个文件以 Apache-2.0 许可头开头并附带标准化的运行说明注释// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 package com.example.{service}; import software.amazon.awssdk.regions.Region; import software.amazon.awssdk.services.{service}.{Service}Client; import software.amazon.awssdk.services.{service}.model.*; import software.amazon.awssdk.core.exception.SdkException; /** * Before running this Java V2 code example, set up your development * environment, including your credentials. * * For more information, see the following documentation topic: * * https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html * * This example shows how to get started with {AWS Service} by {basic operation description}. */4.2 主方法参数解析与客户端构建主方法统一采用「命令行参数校验 → 构建客户端 → 调用 hello 方法 → 关闭客户端」的五段式结构// snippet-start:[{service}.java2.hello.main] public class Hello{Service} { public static void main(String[] args) { final String usage Usage: region Where: region - The AWS region (for example, us-east-1). ; if (args.length ! 1) { System.out.println(usage); System.exit(1); } String region args[0]; Region awsRegion Region.of(region); {Service}Client {service}Client {Service}Client.builder() .region(awsRegion) .build(); hello{Service}({service}Client); {service}Client.close(); }该结构在仓库中有两个典型变体命令行参数版HelloSSM.java 接收 AWS 账号 ID 参数用于过滤文档属主HelloService.java 接收 namespace 参数如AWS/EC2。固定区域版更多示例直接使用枚举常量省去参数交互如 HelloS3.java 使用Region.US_EAST_1、HelloIAM.java 使用全局区域Region.AWS_GLOBALIAM 为全局服务、HelloGlue.java 同样固定Region.US_EAST_1。4.3 hello 方法最基础操作的调用与结果输出规范要求将核心调用独立成hello{Service}({Service}Client)方法包含「构建最小请求 → 同步调用 → 输出问候与结果 → 分类捕获异常」四部分public static void hello{Service}({Service}Client {service}Client) { try { // Perform the most basic operation for this service {BasicOperation}Request request {BasicOperation}Request.builder() .build(); {BasicOperation}Response response {service}Client.{basicOperation}(request); System.out.println(Hello, {AWS Service}!); // Display appropriate result information if (response.has{ResultField}()) { System.out.println(Found response.{resultField}().size() {resources}.); response.{resultField}().forEach(resource - System.out.println( - resource.{resourceName}()) ); } else { System.out.println({AWS Service} is available and ready to use.); } } catch ({Service}Exception e) { System.err.println({AWS Service} error occurred: e.awsErrorDetails().errorMessage()); System.exit(1); } catch (SdkException e) { System.err.println(SDK error occurred: e.getMessage()); System.exit(1); } } } // snippet-end:[{service}.java2.hello.main]4.4 snippet 标签约定整个类体必须包裹在// snippet-start:[{service}.java2.hello.main]与// snippet-end:[{service}.java2.hello.main]之间这是仓库文档抽取机制的标识约定。真实示例中可见一致的标签例如 HelloS3.java 使用s3.java2.hello.main、HelloIAM.java 使用iam.java2.hello.main、HelloKeyspaces.java 使用keyspaces.java2.hello.main。五、按服务类型的 Hello 实现分类规范将 AWS 服务按「最基础操作」的性质分为三类各自有独立的实现套路。这一分类直接决定了 Hello 示例调用哪个 API、输出什么内容。5.1 列表型服务List-Based Services适用于以「列举主资源」为最基本操作的存储与数据库类服务如 S3、DynamoDB、Keyspaces、SNS、SQS、Glue。public static void hello{Service}({Service}Client {service}Client) { try { List{Resources}Request request List{Resources}Request.builder().build(); List{Resources}Response response {service}Client.list{Resources}(request); System.out.println(Hello, {AWS Service}!); System.out.println(Found response.{resources}().size() {resources}.); response.{resources}().forEach(resource - System.out.println( - resource.{resourceName}()) ); } catch ({Service}Exception e) { System.err.println({AWS Service} error: e.awsErrorDetails().errorMessage()); System.exit(1); } }仓库中的典型实现S3列桶HelloS3.java 调用s3.listBuckets()逐行输出Bucket NameIAM列策略HelloIAM.java 调用iam.listPolicies()输出Policy NameKeyspaces列 keyspaceHelloKeyspaces.java 在请求中设置.maxResults(10)后调用listKeyspaces()输出 keyspace 名称Glue列作业HelloGlue.java 使用.maxResults(10)后调用listJobs()输出作业名称列表。5.2 状态型服务Status-Based Services适用于以「查询服务状态 / 配置」为最基本操作的安全与治理类服务如 GuardDuty、Config、Control Tower 等。public static void hello{Service}({Service}Client {service}Client) { try { Get{Service}StatusRequest request Get{Service}StatusRequest.builder().build(); Get{Service}StatusResponse response {service}Client.get{Service}Status(request); System.out.println(Hello, {AWS Service}!); System.out.println(Service status: response.status()); System.out.println({AWS Service} is ready to use.); } catch ({Service}Exception e) { System.err.println({AWS Service} error: e.awsErrorDetails().errorMessage()); System.exit(1); } }仓库中的典型实现HelloControlTower.java 使用listBaselinesPaginator列出全部可用 baseline并输出「N baseline(s) retrieved」及名称列表它还对AccessDeniedException错误码做了专门分支提示见下文错误处理章节。5.3 计算型服务Compute Services适用于以「列实例 / 列函数 / 列集群 / 描述区域」为最基本操作的计算类服务如 EC2、Lambda、Redshift、Batch。public static void hello{Service}({Service}Client {service}Client) { try { Describe{Resources}Request request Describe{Resources}Request.builder() .maxResults(10) .build(); Describe{Resources}Response response {service}Client.describe{Resources}(request); System.out.println(Hello, {AWS Service}!); System.out.println(Found response.{resources}().size() {resources}.); response.{resources}().forEach(resource - System.out.println( - resource.{resourceId}() ( resource.state() )) ); } catch ({Service}Exception e) { System.err.println({AWS Service} error: e.awsErrorDetails().errorMessage()); System.exit(1); } }仓库中的典型实现HelloRedshift.java 使用describeClustersPaginator()流式遍历全部集群输出Cluster identifier与status字段完全对应规范中「资源 ID 状态」的输出模式。5.4 进阶变体分页器与异步客户端从仓库源码结构看部分 Hello 示例在基础骨架之上引入了分页器Paginator与异步Async客户端两种进阶写法这是对规范「极简」原则的有益补充读者可根据服务 API 形态择优使用同步分页器HelloSNS.java 用listTopicsPaginator()配合stream().flatMap(...)拉取全部 topicHelloRedshift.java 与 HelloControlTower.java 也采用同样模式HelloService.java 使用listMetricsPaginator过滤指定 namespace 的指标。显式手动分页HelloSSM.java 演示了do-whilenextToken的手动翻页配合maxResults(20)与DocumentFilter(keyOwner, valueawsAccount)按账号过滤文档并累加计数防止无限翻页。异步客户端HelloBatch.java 使用BatchAsyncClient与listJobsPaginator的subscribe回调收集作业并展示了NettyNioAsyncHttpClient的超时配置connectionTimeout、readTimeout、writeTimeout均为 60 秒、ClientOverrideConfiguration的apiCallTimeout(2 分钟)/apiCallAttemptTimeout(90 秒)以及RetryPolicy.numRetries(3)。这是仓库中唯一引入异步 HTTP 客户端定制的 Hello 示例适合高并发场景参考。六、错误处理规范规范要求 Hello 示例必须同时捕获两类异常并给出了标准模式try { // AWS operation response {service}Client.operation(request); } catch ({Service}Exception e) { // Service-specific errors String errorCode e.awsErrorDetails().errorCode(); switch (errorCode) { case UnauthorizedOperation: System.err.println(You dont have permission to access {AWS Service}.); break; case InvalidParameterValue: System.err.println(Invalid parameter provided to {AWS Service}.); break; default: System.err.println({AWS Service} error: e.awsErrorDetails().errorMessage()); } System.exit(1); } catch (SdkException e) { // General SDK errors (network, credentials, etc.) System.err.println(SDK error: e.getMessage()); System.exit(1); }分层语义如下{Service}Exception服务级异常表示 AWS 服务端返回的错误。通过e.awsErrorDetails().errorCode()获取错误码、e.awsErrorDetails().errorMessage()获取错误消息可按错误码做分支处理如UnauthorizedOperation提示权限不足、InvalidParameterValue提示参数非法。SdkExceptionSDK 级异常覆盖网络故障、凭证缺失、序列化等客户端问题统一输出e.getMessage()后退出。真实示例中的落地情况HelloControlTower.java 专门对AccessDeniedException错误码输出「请确认权限」的可读提示其余错误输出通用消息——正是错误码分支模式的实例化HelloS3.java、HelloKeyspaces.java、HelloService.java、HelloSNS.java 均捕获各自的{Service}Exception并输出awsErrorDetails().errorMessage()后System.exit(1)。注意仓库中部分早期示例如 HelloIAM.java 的listPolicies与 HelloGlue.java未包裹 try-catch属于历史写法新生成的示例应以规范中的标准错误处理模式为准。七、验证要求与通用模式7.1 六项验证硬指标规范为 Hello 示例设定了明确的验收清单✅必须无错误运行在拥有正确凭证的前提下✅必须优雅处理凭证问题凭证缺失应落入 SDK 异常分支而非崩溃✅必须输出有意义的运行结果✅必须直接使用 AWS SDK 客户端调用不经过 actions 封装✅必须包含正确的 snippet 标签✅必须支持以命令行参数传入 region✅必须正确关闭客户端资源client.close()。7.2 通用模式清单客户端创建统一采用{Service}Client.builder().region(awsRegion).build()区域优先由命令行参数或枚举常量指定对服务级与 SDK 级异常做全面处理输出信息面向用户友好可读如Hello, {AWS Service}!、Found N resources命令行参数校验严格参数个数不符即打印 usage 并System.exit(1)客户端资源在主方法中关闭保持最小复杂度——不引入额外类、不叠加无关操作遵循 Java 命名规范类名 PascalCase、方法名 camelCase。八、构建配置pom.xml 依赖声明规范的 Build Configuration 部分要求在pom.xml中显式声明对应服务的 SDK 模块占位版本号由统一的 BOM 属性管理dependency groupIdsoftware.amazon.awssdk/groupId artifactId{service}/artifactId version${aws.java.sdk.version}/version /dependency仓库真实配置印证了这一结构且更推荐 BOM 统一版本管理的方式。以 iam/pom.xml 为例通过dependencyManagement引入software.amazon.awssdk:bom:2.35.10typepom、scopeimport使各服务模块无需逐一写版本号服务依赖直接声明 artifactId如iam、s3、sts、dynamodb、secretsmanager、sso、ssooidc、accessanalyzer版本统一由 BOM 锁定构建环境固定 Java 21java.version、maven.compiler.source/target均为 21并使用maven-surefire-plugin:3.5.2支撑 JUnit 5 测试junit-jupiter:5.11.4额外引入log4j-bom:2.20.0及其 core/slf4j 桥接实现用于日志输出管理。对单个 Hello 示例而言最小化 pom 只需保留 BOM 依赖管理 目标服务模块依赖 编译器配置即可运行。九、运行方式与前置条件Hello 示例的运行依赖标准 AWS SDK for Java V2 开发环境环境准备安装 JDK仓库示例面向 Java 21见 iam/pom.xml 的java.version配置与 Maven凭证配置通过标准凭证链环境变量、共享 credentials 文件或 IAM Role配置可用的 AWS 凭证这正是每个示例文件头注释中强调的「Before running...set up your development environment, including your credentials」编译运行在服务目录下执行mvn package编译然后运行主类。以 IAM 示例为例可执行mvn -q exec:java -Dexec.mainClasscom.example.iam.HelloIAM或使用仓库提供的 run_example.sh 脚本若示例依赖命令行参数如 HelloSSM.java 需要 AWS 账号、HelloService.java 需要 namespace则按 usage 提示传参。十、测试验收要求规范的 Testing Requirements 对 Hello 示例提出了五条运行级验收标准✅必须无编译错误✅必须能在有效 AWS 凭证下运行✅必须优雅处理非法 regionregion 解析或服务拒绝时应走异常分支并给出可读错误✅空结果时必须输出恰当内容对应模板中的{AWS Service} is available and ready to use.分支✅出错时必须干净退出统一System.exit(1)不产生悬空资源或静默失败。这些验收点与第七节的验证指标共同构成 Hello 示例的「可测试性」底线无论结果为空、凭证失效还是 region 非法程序都必须以可预期的输出或退出码结束这正是冒烟测试类示例应有的行为特征。十一、总结Hello 示例的工程价值从 steering_docs/java-tech/hello.md 的规范到 javav2/example_code 下 27 个已落地的 Hello 实现可以提炼出 Hello 示例的完整工程画像结构统一固定包名com.example.{service}、固定类名Hello{Service}、固定的「主方法 hello 方法 snippet 标签」三段式骨架模式按服务类型收敛列表型调用list*并输出资源清单、状态型调用状态查询并输出可用性、计算型调用describe*并输出资源 ID 与状态错误处理分层服务异常按错误码分支、SDK 异常兜底网络与凭证问题复杂度受控默认不引入 actions 类与额外依赖分页器与异步客户端仅按需选用验收可量化编译、运行、参数、空结果、退出码五条测试指标全部可自动或半自动核验。对于任何计划为 AWS 服务新增 Java V2 示例的开发者Hello 示例既是接入门槛最低的「连通性探针」也是后续编写 Action 与 Scenario 示例前的规范化起点。建议在动手前严格完成文档第二部分的四步知识库调研再套用第四至第六部分的模板与错误处理骨架最后对照第七、十部分的验证清单逐项自检。赞分享示例工程教程后端【免费下载链接】aws-doc-sdk-examplesWelcome to the AWS Code Examples Repository. This repo contains code examples used in the AWS documentation, AWS SDK Developer Guides, and more. For more information, see the Readme.md file below.项目地址https://gitcode.com/gh_mirrors/aw/aws-doc-sdk-examples点击查看免费下载相关推荐AWS SDK for Java v2依赖注入Spring Boot集成最佳实践AWS SDK for Java v2依赖注入Spring Boot集成最佳实践 引言 在现代Java应用开发中Spring Boot已成为构建企业级应用的后端AWS SDK for Java v2 的 Reactive Streams 实现规范SimplePublisher、TCK 验证与背压设计AWS SDK for Java v2 的 Reactive Streams 实现规范SimplePublisher、TCK 验证与背压设计 AWS SDK后端AWS SDK for Java V2 终极指南从零掌握云服务集成AWS SDK for Java V2 终极指南从零掌握云服务集成 还在为AWS云服务集成而头疼吗 AWS SDK for Java V2作为新一代的云后端上一篇Hoarder 到 Karakeep 迁移完全指南Docker 镜像切换与裸机迁移实战下一篇基于 Kilo 仓库的 Todo 驱动开发流程从计划到验证的完整实践指南创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考