开始使用 Java 创建项目管理 AWS 构造库模块在中管理依赖关系 Java AWS CDK Java 中的成语构建和运行CDK应用程序

AWS CDK 在 Java 中使用

Java 是完全支持的客户端语言 AWS CDK ，被认为是稳定的。你可以使用熟悉的工具用 Java 开发 AWS CDK 应用程序，包括JDK（甲骨文或开放JDK发行版，例如 Amazon Corretto）和 Apache Maven。

AWS CDK 支持 Java 8 及更高版本。但是，我们建议您尽量使用最新版本，因为该语言的更高版本包含了特别便于开发 AWS CDK 应用程序的改进。例如，Java 9 引入了该Map.of()方法（一种声明哈希映射的便捷方法，该哈希映射将在中 TypeScript写成对象文字）。Java 10 使用var关键字引入了局部类型推断。

注意

本开发人员指南中的大多数代码示例都适用于 Java 8。有几个示例使用Map.of()；这些示例包括注释，指出它们需要 Java 9。

您可以使用任何文本编辑器或可以读取 Mav IDE en 项目的 Java 来处理您的 AWS CDK 应用程序。我们在本指南中提供了 Eclipse 提示，但是 IntelliJ IDEA 和其他人IDEs可以导入 Maven 项目 NetBeans，并且可以用来在 Java 中开发应用程序。 AWS CDK

可以用 Java 以外的JVM托管语言（例如 Kotlin、Groovy、Clojure 或 Scala）编写 AWS CDK 应用程序，但体验可能不是特别习惯，我们无法为这些语言提供任何支持。

开始使用 Java

要使用 AWS CDK，您必须拥有 AWS 账户和凭证，并已安装 Node.js 和 AWS CDK Toolkit。请参阅开始使用 AWS CDK。

Java AWS CDK 应用程序需要 Java 8 (v1.8) 或更高版本。我们推荐 Amazon Cor retto，但你可以使用任何JDK公开发行版或 Oracle 的发行版。JDK你还需要使用 Apache Maven 3.5 或更高版本。你也可以使用诸如 Gradle 之类的工具，但是 AWS CDK Toolkit 生成的应用程序框架是 Maven 项目。

注意

第三方语言弃用：语言版本仅在供应商或社区共享EOL（生命周期结束）之前才受支持，如有更改，恕不另行通知。

创建项目

您可以通过在空目录cdk init中调用来创建新 AWS CDK 项目。使用该--language选项并指定java：


mkdir my-project
cd my-project
cdk init app --language java

cdk init使用项目文件夹的名称来命名项目的各种元素，包括类、子文件夹和文件。文件夹名称中的连字符将转换为下划线。但是，除此之外，名称应遵循 Java 标识符的形式；例如，它不应以数字开头或包含空格。

生成的项目包括对 software.amazon.awscdk Maven 包的引用。它及其依赖项由 Maven 自动安装。

如果您使用的是IDE，则现在可以打开或导入项目。例如，在 Eclipse 中，选择 “文件” > “导入” > “Maven” > “现有的 Maven 项目”。确保将项目设置设置为使用 Java 8 (1.8)。

管理 AWS 构造库模块

使用 Maven 安装组software.amazon.awscdk中的 AWS 构造库软件包。大多数构造都在构件中，默认情况下aws-cdk-lib，该构件会添加到新的 Java 项目中。仍在开发更高级别CDK支持的服务的模块位于单独的 “实验性” 包中，并以其服务名称的简短版本（无 AWS 或 Amazon 前缀）命名。搜索 Maven 中央存储库以查找所有库 AWS CDK 和 AWS 构造模块库的名称。

注意

Java 版的《CDKAPI参考资料》还显示了软件包名称。

某些服务的 AWS 构造库支持位于多个命名空间中。例如，Amazon Route 53 的功能分为software.amazon.awscdk.route53route53-patternsroute53resolver、、和route53-targets。

主 AWS CDK 包以 Java 代码导入为software.amazon.awscdk。 AWS 构造库中各种服务的模块位于其下，其命名software.amazon.awscdk.services与它们的 Maven 包名称类似。例如，Amazon S3 模块的命名空间是software.amazon.awscdk.services.s3。

我们建议您为每个 Java 源文件中使用的每个 C AWS onstruct Library 类编写单独的 Java import 语句，并避免导入通配符。您始终可以在不使用import语句的情况下使用类型的完全限定名称（包括其命名空间）。

如果您的应用程序依赖于实验包，请编辑您的项目pom.xml并在<dependencies>容器中添加新<dependency>元素。例如，以下<dependency>元素指定了 CodeStar 实验构造库模块：


<dependency>
    <groupId>software.amazon.awscdk</groupId>
    <artifactId>codestar-alpha</artifactId>
    <version>2.0.0-alpha.10</version>
</dependency>

提示

如果你使用 JavaIDE，它可能具有管理 Maven 依赖关系的功能。但是，我们建议您pom.xml直接进行编辑，除非您绝对确定其功能与您手工操作IDE的功能相匹配。

在中管理依赖关系 Java

在 Java 中，依赖关系是在 Maven 中指定pom.xml并使用 Maven 安装的。<dependencies>容器包含每个包的<dependency>元素。以下是典型pom.xml的 CDK Java 应用程序的部分。


<dependencies>
    <dependency>
        <groupId>software.amazon.awscdk</groupId>
        <artifactId>aws-cdk-lib</artifactId>
        <version>2.14.0</version>
    </dependency>
    <dependency>
        <groupId>software.amazon.awscdk</groupId>
        <artifactId>appsync-alpha</artifactId>
        <version>2.10.0-alpha.0</version>
    </dependency>
</dependencies>

提示

许多 Java IDEs 都集成了 Maven 支持和可视化pom.xml编辑器，您可能会发现它们便于管理依赖关系。

Maven 不支持依赖项锁定。尽管可以在中指定版本范围pom.xml，但我们建议您始终使用精确的版本，以保持构建的可重复性。

Maven 会自动安装传递依赖项，但每个软件包只能安装一个副本。选择POM树中指定的最高版本；应用程序总是决定安装哪个版本的软件包。

每当你构建 (mvn compile) 或打包 (mvn package) 项目时，Maven 都会自动安装或更新你的依赖项。每次运行CDK工具包时，它都会自动执行此操作，因此通常无需手动调用 Maven。

AWS CDK Java 中的成语

道具

所有 C AWS onstruct Library 类都使用三个参数进行实例化：定义构造的作用域（构造树中的父级）、id 和 props（构造函数用来配置其创建的资源的键/值对）。其他类和方法也使用 “属性包” 模式作为参数。

在 Java 中，道具是使用生成器模式表示的。每种构造类型都有相应的道具类型；例如，Bucket构造（代表 Amazon S3 存储桶）将的实例作为其道具。BucketProps

该BucketProps类（就像每个 Constru AWS ct Library 道具类一样）有一个名Builder为的内部类。该BucketProps.Builder类型提供了设置BucketProps实例各种属性的方法。每个方法都返回Builder实例，因此可以链接方法调用以设置多个属性。在链的尽头，你调build()用实际生成BucketProps对象。


Bucket bucket = new Bucket(this, "MyBucket", new BucketProps.Builder()
                           .versioned(true)
                           .encryption(BucketEncryption.KMS_MANAGED)
                           .build());

构造和其他以类似 props 的对象作为最终参数的类提供了捷径。该类有自己Builder的，可以一步实例化它和它的 props 对象。这样，你就不必显式实例化（例如）BucketProps和 aBucket，也不需要导入 props 类型。


Bucket bucket = Bucket.Builder.create(this, "MyBucket")
                           .versioned(true)
                           .encryption(BucketEncryption.KMS_MANAGED)
                           .build();

从现有构造派生自己的构造时，可能需要接受其他属性。我们建议您遵循这些构建器模式。但是，这并不像子类化构造类那么简单。你必须自己提供这两个新Builder职业的活动部分。你可能更愿意让你的构造接受一个或多个额外的参数。如果参数是可选的，则应提供其他构造函数。

通用结构

在某些情况下APIs， AWS CDK 使用 JavaScript 数组或非类型化对象作为方法的输入。（例如， AWS CodeBuild参见BuildSpec.fromObject()的方法。）在 Java 中，这些对象表示为java.util.Map<String, Object>。如果值都是字符串，则可以使用Map<String, String>。

Java 不像其他一些语言那样提供为此类容器编写文字的方法。在 Java 9 及更高版本中 java.util.Map.of()，您可以使用其中一个调用方便地定义最多十个条目的映射。


java.util.Map.of(
    "base-directory", "dist",
    "files", "LambdaStack.template.json"
 )

要创建包含十个以上条目的地图，请使用java.util.Map.ofEntries()。

如果您使用的是 Java 8，则可以提供与这些方法类似的自己的方法。

JavaScript 数组在 Java List<String> 中以List<Object>或的形式表示。该方法便java.util.Arrays.asList于定义短 List s。


List<String> cmds = Arrays.asList("cd lambda", "npm install", "npm install typescript")

缺失值

在 Java 中，诸如道具之类的 AWS CDK 对象中的缺失值用表示。null在对任何可能的值进行任何操作之前，必须对其进行显式测试，以确保它包含一个值。nullJava 不像其他一些语言那样具有 “语法糖” 来帮助处理空值。你可能会发现 Apac ObjectUtil h defaultIfNulle 在某些情况下firstNonNull很有用。或者，也可以编写自己的静态辅助方法，以便更轻松地处理潜在的空值并提高代码的可读性。

构建和运行CDK应用程序

在运行您的应用程序之前 AWS CDK 会自动对其进行编译。但是，手动构建应用程序以检查错误和运行测试可能会很有用。你可以在你的IDE（例如，在 Eclipse 中按下 Control-B），也可以在项目的根目录mvn compile下在命令提示符下发出命令来执行此操作。

在命令提示符mvn test下运行您编写的所有测试。

Javascript 在您的浏览器中被禁用或不可用。

要使用 Amazon Web Services 文档，必须启用 Javascript。请参阅浏览器的帮助页面以了解相关说明。

文档惯例

在 Python 中

在 C# 中