Amazon Q Developer - 在 IDE 中
您可以在 IDE 中使用 Amazon Q Developer 来了解 AWS 并获得开发帮助。它为解答 AWS 开发问题、生成和更新代码、安全扫描和优化代码等领域提供指导和支持。
支持的 IDE 和可用功能
下表介绍了 Amazon Q 支持的 IDE 以及每个 IDE 中功能的可用性和限制。
IDE | 支持的功能 |
---|---|
JetBrains IDE | 聊天 聊天中的工作区上下文 内联建议 代码转换代理 软件开发代理 安全扫描 自定义 |
Visual Studio Code | 聊天 聊天中的工作区上下文 内联建议 代码转换代理 软件开发代理 安全扫描 自定义 |
Visual Studio | 聊天 内联建议:C、C++ 和 C# 安全扫描:C# |
AWS 编码环境 | 内联建议 |
安装 Amazon Q
要在集成开发环境 (IDE) 中设置 Amazon Q Developer,请完成以下步骤
下载 Amazon Q
要开始使用,请下载适用于您的 Amazon Q 扩展或插件IDE:
- 在 Visual Studio Code 中下载 Amazon Q
- 在 JetBrains IDE 中下载 Amazon Q
- 在 AWS Toolkit for Visual Studio 中下载 Amazon Q
登录 Amazon Q
要登录并进行身份验证,请完成以下步骤:
- 先决条件:选择支持的 IDE 版本
- 在 JetBrains IDE 中进行身份验证
- 在 Visual Studio Code 中进行身份验证
- 在 Visual 中进行身份验证Studio
- 使用 IAM 主体进行身份验证
- 了解 AWS 编码环境
先决条件
Amazon Q 在 Visual Studio Code 中以扩展形式提供,在 JetBrains 中以插件形式提供,在 AWS Toolkit for Visual Studio 中也提供。
- Amazon Q 支持的 Visual Studio Code 最低版本为 1.85.0。
- Amazon Q 支持的 JetBrains IDE 最低版本为 232.1。JetBrains 版本 232、233 和 241 也受支持。
- Amazon Q 仅支持适用于 Windows 的 Visual Studio。支持的 Visual Studio 最低版本为 Visual Studio 2022 版本 17.7。所有 Visual Studio 2022 版本均受支持。
在 JetBrains IDE 中验证身份
要在 JetBrains IDE 中验证 Amazon Q Developer,请按照以下步骤操作:
- 在 JetBrains IDE 中安装 Amazon Q IDE 插件。
- 选择 IDE 中的 Amazon Q 图标。
- 按照浏览器中的说明使用 Builder ID 进行验证。
- 要开始使用 Amazon Q,请选择 Amazon Q 图标与 Amazon Q 聊天,或从 IDE 底部的导航栏中选择 Amazon Q。
在 VS Code 中验证身份
要验证 Amazon Q VS Code 中的开发人员请按照以下步骤操作:
- 在 VS Code 中安装 Amazon Q IDE 扩展。
- 选择 IDE 中的 Amazon Q 图标。
- 按照浏览器中的说明使用 Builder ID 进行身份验证。
- 要开始使用 Amazon Q,请选择 Amazon Q 图标与 Amazon Q 聊天,或从 IDE 底部的导航栏中选择 Amazon Q。
在 Visual Studio 中进行身份验证
要在 VS Code 中对 Amazon Q 开发人员进行身份验证,请按照以下步骤操作:
- 在 AWS Toolkit 入门连接 UI 中选择 Amazon Q 开发人员径向以访问身份验证选项。
- 在"我正在使用"中单击"注册"或"登录"我自己使用 Amazon Q Developer 部分以打开使用 AWS Builder ID 登录对话框。
- 选择继续浏览器按钮以在您的默认 Web 浏览器中打开 AWS 授权请求站点。
- 按照 Web 浏览器中的提示进行操作。授权完成后,您将收到通知,然后您可以关闭浏览器并返回 Visual Studio。
使用 IAM 主体进行身份验证
您不能使用 IAM 凭证或角色在 IDE 中向 Amazon Q Developer 进行身份验证。相反,请使用 IAM Identity Center 或 Builder ID 中的凭证。
了解 AWS 编码环境
要充分利用 Amazon Q Developer,请订阅 Pro 并通过 Visual Studio、Visual Studio Code 中的扩展或 JetBrains 中的插件使用它。
讨论代码
通过单击 JetBrains/VS Code 中的图标或转到 Visual Studio 中的查看 > Amazon Q 聊天,开始在您的 IDE 中与 Amazon Q 聊天。然后,输入您的问题。Amazon Q 使用当前打开的文件作为上下文,包括语言和文件路径。
聊天命令
您可以在聊天面板中输入以下命令来访问 Amazon Q 功能,具体取决于您的 IDE。
- /transform:使用此命令可更新整个项目的代码语言版本。
- /dev:使用此命令可获取使用 Amazon Q 开发功能的实施计划
- /clear:使用此命令可清除当前对话。
- /help:使用此命令可查看 Amazon Q 可以和不能做什么的概述、示例问题和快速命令。
生成内联建议
Amazon Q 会在您编写时提供实时代码建议。它会根据您现有的代码和注释生成建议,范围从单行注释到完整形成的函数。只需开始编写代码,Amazon Q 就会根据您当前和之前的输入开始提出建议。
转换代码
Amazon Q 开发人员代理会就地升级您的代码语言版本,转换 JetBrains 中的模块和 Visual Studio Code 中的项目/工作区。
步骤 1:先决条件
在开始代码转换作业之前,请确保满足以下先决条件:
- 您的项目是基于 Maven 构建的 Java 8 或 Java 11 项目。
- 您的项目已在 IDE 中使用 Maven 成功构建。用于代码转换的 Amazon Q Developer Agent 支持 Maven 3.8 或更高版本。
- 您的项目源 JDK 在本地可用,并且是您的源代码版本。
- 您的项目在 55 分钟或更短的时间内构建完成。
- 您的项目配置正确,并且指定了正确的 JDK 版本。
- 请注意,如果您的项目需要访问私有网络资源(例如 VPC 或本地网络),Amazon Q 代码转换将无法进行。
- 您的项目未使用在 Java 项目中打包除 Java 之外的语言的插件。
- 您的本地网络允许上传到 Amazon Q 用于转换代码的 Amazon S3 存储桶。
- maven-compiler-plugin 的最低编译器版本为 v13.13.0。
步骤 2:配置您的项目
要配置您的项目,请使用以下信息来了解您正在使用的 IDE。
在 JetBrains 中:要在 JetBrains 中配置您的项目,您可能需要指定以下项目和模块设置。
- 项目 SDK:用于编译项目的 JDK。
- 项目语言级别:项目中使用的 Java 版本。
- 模块 SDK:用于编译模块的 JDK。
- 模块语言级别:模块中使用的 Java 版本。
- Maven Runner JRE:用于构建模块的 JDK。
在 VS Code 中:要在 VS Code 中配置项目,项目必须包含以下内容:
- 项目根文件夹中的 pom.xml 文件
- 项目目录中的 .java 文件
步骤 3:转换代码
按照以下步骤升级代码项目或模块:
- 打开模块并确保成功构建。
- 单击 Amazon Q 徽标并在聊天面板中输入 /transform。
- 选择要升级的项目并单击转换。
- 在转换详细信息选项卡上查看进度。
- 验证升级后的代码并查看差异。
- 通过选择更新的文件并单击确定来接受更改。
- 查看转换摘要以了解详细信息和后续步骤。"
开发软件
通过打开新项目或现有项目并在 Amazon Q 聊天面板中输入 /dev,开始使用 Agent 进行软件开发。这将打开一个新的聊天选项卡,您可以在其中与代理交互以生成功能的新代码。
要使用 IDE 中的软件开发代理执行任务,请完成以下步骤。
- 在您的 IDE 中,打开要开发功能的新项目或现有项目或工作区。
- 选择 Amazon Q 图标以打开 Amazon Q 聊天面板。
- 通过在聊天面板中输入 /dev,然后输入任务描述或要解决的问题,获取 Amazon Q 生成的代码。您可以提供简要概述或添加更多详细信息,Amazon Q 将根据您的描述和项目代码生成代码。
- 将打开一个新选项卡。如果您还没有输入任务或问题的描述,请输入。
- Amazon Q 为您的任务生成代码,提供其正在采取的步骤以及正在使用或更新的文件的摘要。此过程通常需要几分钟。
- Amazon Q 生成代码后,会提供包含建议更改的文件列表。选择一个文件以查看更改后的文件差异。
- 要接受更改并更新代码,请选择"插入代码"。
- 更新代码后,Amazon Q 会提示您开始执行新任务。
扫描代码
Amazon Q 通过扫描代码库中的漏洞和问题来帮助提高代码安全性和质量。您可以启动完整扫描或启用自动扫描以在编码时检测问题。当 Amazon Q 发现问题时,它会提供描述和建议的修复,有时甚至会应用自动修复来更新您的代码文件。
扫描类型
以下是 Amazon Q 检测到的安全和质量问题类型。
- 代码安全扫描:Amazon Q Developer 提供了一系列安全功能来帮助提高代码的安全性和质量。这些功能包括代码扫描以查找安全漏洞和质量问题、静态应用程序安全测试 (SAST)、机密检测以及代码升级和建议。此外,Amazon Q Developer 还会扫描基础设施即代码 (IaC) 是否存在安全漏洞和策略违规。
- 代码质量扫描:Amazon Q 通过检测影响可维护性和效率的问题来帮助提高代码质量。它会针对各种质量问题(包括性能、机器学习规则和 AWS 最佳实践)生成调查结果,以确保您的代码库符合质量和效率标准。
支持的语言
Amazon Q Developer 在其各种功能和能力中为多种编程语言提供支持。
内联建议支持的语言
就训练数据的质量而言,支持最多的编程语言是:
- Java
- Python
- JavaScript
- TypeScript
- C#
- Go
- PHP
- Rust
- Kotlin
- SQL
- C++
- C
基础设施即代码支持最多的 (IaC) 语言有:
- JSON (AWS CloudFormation)
- YAML (AWS CloudFormation)
- HCL (Terraform)
- CDK (Typescript、Python)
Amazon Q 还支持以下代码生成:
- Ruby
- Shell
- Scala
Cose 转换支持的语言
用于代码转换的 Amazon Q 开发人员代理支持将代码从 Java 8 或 Java 11 升级到 Java 17。
安全扫描支持的语言
Amazon Q 安全扫描支持以下语言版本:
- Java - Java 17 及更早版本
- JavaScript - ECMAScript 2021 及更早版本
- Python - Python 3.11 及更早版本,属于 Python 3 系列
- C# - 所有版本(建议使用 .NET 6.0 及更高版本)
- TypeScript - 所有版本
- Ruby - Ruby 2.7 和 3.2
- Go - Go 1.18
- C - C11 及更早版本
- C++ - C++17 及更早版本
- PHP - PHP 8.2 及更早版本
- Kotlin - Kotlin 2.0.0 及更早版本
- Scala - Scala 3.2.2 及更早版本
- JSX - React 17 及更早版本
- 基础设施即代码 (IaC) 语言
- AWS CloudFormation - 2010-09-09
- Terraform - 1.6.2 及更早版本
- AWS CDK - TypeScript 和 Python
以下语言和版本的扫描可自动修复代码:
- Java - Java 17 及更早版本
- JavaScript - ECMAScript 2021 及更早版本
- Python - Python 3.11 及更早版本,属于 Python 3 系列
- C# - 所有版本(建议使用 .NET 6.0 及更高版本)
- TypeScript - 所有版本
- 基础设施即代码 (IaC) 语言
- AWS CloudFormation - 2010-09-09
- Terraform - 1.6.2 及更早版本
- AWS CDK - TypeScript 和 Python