AI 命令指南

OpenAI 的 ChatGPT 等大型语言模型为使用 AI 生成代码提供了强大的解决方案。 ChatGPT 不仅接受了 Java 代码的训练，还接受了 Spring 开源生态系统中各种项目的训练。 这使 Spring CLI 能够使用针对特定用例量身定制的功能来增强应用程序，而传统教程无法提供这些功能。spring-doc.cn

使用一个简单的命令，您可以描述所需的功能，ChatGPT 会生成一个全面的文件，该文件提供实现目标的分步说明。 这就像为您的项目需求创建自定义教程。README.mdspring-doc.cn

CLI 还能够自动将生成的指令应用于您的代码库。spring-doc.cn

要开始使用，请使用以下命令：spring-doc.cn

spring ai add <Describe what functionality you want to add here> --preview

优化生成的解决方案通常需要修改描述的迭代。 该命令的选项可在不修改工程的情况下生成文件，以便您查看建议的更改。--previewspring ai addREADME.mdspring-doc.cn

对生成的 README.md 文件感到满意后，可以使用以下命令将其应用于代码库：spring-doc.cn

spring guide apply <Name of the guide markdown file>

为了进一步改进和准确性，您可以使用 --rewrite 选项让 ChatGPT 重写描述：spring-doc.cn

spring ai add <Description of functionality> --preview --rewrite

本页其余部分的详细文档提供了有关每个命令的全面信息。spring-doc.cn

随着我们继续探索 AI 技术的潜力，我们预计会进一步完善结果，以满足 Spring 项目的特定版本。

例

请考虑以下示例：spring-doc.cn

spring ai add "JPA functionality with an integration test. Include all Java code in the same package." --preview

此处是使用上一个命令创建的 README-ai-jpa.md 文件。spring-doc.cn

先决条件

在使用 AI 命令之前，请确保您拥有 OpenAI 的开发人员令牌。spring-doc.cn

为此，请在 OpenAI Signup 上创建一个帐户，并在 API Keys 中生成令牌。将密钥保存在您的主目录下命名的文件中（通常为 ）。.openai~/.openaispring-doc.cn

该文件应包含以下内容：spring-doc.cn

OPEN_AI_API_KEY=<paste your key here>

使用 ai add

该命令允许您将代码添加到使用 OpenAI 的 ChatGPT 生成的项目中。ai addspring-doc.cn

为此，请使用该选项提供您要添加的代码的简要描述，该命令会将请求发送到 OpenAI 的 API。--descriptionspring-doc.cn

默认情况下，此命令会修改您的代码库。spring-doc.cn

下面的清单显示了一个示例：spring-doc.cn

spring ai add "JPA functionality"

此命令将创建一个名为 README-ai-jpa.md 的文件，并将该文件中概述的更改应用于您的项目。spring-doc.cn

代码生成可能需要 3-4 分钟。

预览响应

使用该选项时，将生成一个文件，而无需对项目进行任何更改。 这样，您就可以查看文件并评估它是否提供了可接受的解决方案。--previewREADME-ai-jpa.mdspring-doc.cn

spring ai add "JPA functionality" --preview

此命令将创建一个名为 README-ai-jpa.md 的文件。 请记住，它不会修改您的项目，但它提供了查看内容并确定其是否适合您的特定要求的机会。spring-doc.cn

如果生成的指令满足您的需求，您可以使用命令将更改应用于您的代码库。spring guide apply README-ai-jpa.mdspring-doc.cn

迭代以获得所需的内容

如果您检查上一步中名为 README-ai-jpa.md 的文件，则可以看到它不包含任何测试。 我们始终建议将测试作为最佳实践，因此应更新提供的描述。spring-doc.cn

这是您在使用命令时得到的一般来回操作。ai addspring-doc.cn

例如，在前一种情况下，创建的代码缺少集成测试。运行具有以下描述的命令可获得所需的结果。spring-doc.cn

spring ai add "JPA functionality with an integration test. Include all Java code in the same package." --preview

以下是使用上一个命令创建的 README-ai-jpa.md 文件。spring-doc.cn

自动重写项目描述

为了从 AI 模型获得更好的结果，您可以选择让 AI 模型重写项目描述。有时，开发人员以速记或简洁的样式编写说明，这可能不会产生最佳结果。 使用该选项可让您要求 AI 模型重写描述，从而提供更清晰的意图并改进生成的代码。--rewritespring-doc.cn

请考虑以下示例：spring-doc.cn

spring ai add "JPA functionality" --preview --rewrite

The description has been rewritten to be: Please provide instructions for creating a Spring Java application that utilizes JPA functionality.

Generating code.  This will take a few minutes ...

以下是使用上一个命令创建的 README-ai-jpa.md 文件。spring-doc.cn

应用README

对生成的文件感到满意后，使用以下命令将其中描述的更改应用于您的代码库。READMEspring-doc.cn

spring guide apply README-ai-jpa.md