AI 命令指南
OpenAI 的 ChatGPT 等大型语言模型为使用 AI 生成代码提供了强大的解决方案。ChatGPT 不仅经过 Java 代码训练,还经过 Spring 开源生态系统中的各种项目训练。这使得 Spring CLI 能够通过针对特定用例定制的功能来增强应用程序,这超出了传统教程所能提供的范围。
使用一个简单的命令,您可以描述所需的功能,ChatGPT 会生成一个全面的 README.md 文件,其中提供实现目标的逐步说明。这就像为您的项目需求创建定制教程一样。
CLI 还能够自动将生成的指令应用于您的代码库。
要开始使用,请使用以下命令
spring ai add <Describe what functionality you want to add here> --preview
完善生成的解决方案通常需要反复修改描述。spring ai add 命令的 --preview 选项会生成 README.md 文件,而不会修改您的项目,让您可以查看建议的更改。
一旦您对生成的 README.md 文件满意,您可以使用以下命令将其应用于您的代码库
spring guide apply <Name of the guide markdown file>
为了进一步改进和提高准确性,您可以使用 --rewrite 选项让 ChatGPT 重写描述
spring ai add <Description of functionality> --preview --rewrite
本页其余部分的详细文档提供了每个命令的全面信息。
| 随着我们继续探索 AI 技术的潜力,我们预计将进一步完善结果,以适应特定版本的 Spring 项目。 |
示例
考虑以下示例
spring ai add "JPA functionality with an integration test. Include all Java code in the same package." --preview
这里是使用前一个命令创建的 README-ai-jpa.md 文件。
使用 ai add
ai add 命令允许您使用 OpenAI 的 ChatGPT 生成代码并将其添加到您的项目中。
为此,请使用 --description 选项提供您要添加的代码的简要描述,命令会将请求发送到 OpenAI 的 API。
默认情况下,此命令会修改您的代码库。
以下列表显示了一个示例
spring ai add "JPA functionality"
此命令会创建一个名为 README-ai-jpa.md 的文件,并将该文件中概述的更改应用于您的项目。
| 代码生成可能需要 3-4 分钟。 |
预览响应
当您使用 --preview 选项时,会生成一个 README-ai-jpa.md 文件,而不会对项目进行任何更改。这让您可以查看文件并评估它是否提供了可接受的解决方案。
spring ai add "JPA functionality" --preview
此命令会创建一个名为 README-ai-jpa.md 的文件。请记住,它不会修改您的项目,但它提供了审查内容并确定其是否适合您的特定要求的机会。
如果生成的说明符合您的需求,您可以使用 spring guide apply README-ai-jpa.md 命令将更改应用于您的代码库。
迭代以获得您想要的结果
如果您查看上一步中名为 README-ai-jpa.md 的文件,您会发现它没有包含任何测试。我们始终建议将测试作为最佳实践,因此应更新提供的描述。
这是在使用 ai add 命令时常见的来回操作。
例如,在前面的例子中,创建的代码缺少集成测试。使用以下描述运行命令得到了预期的结果。
spring ai add "JPA functionality with an integration test. Include all Java code in the same package." --preview
这是使用前一个命令创建的 README-ai-jpa.md 文件。
自动重写项目描述
为了从 AI 模型中获得更好的结果,您可以选择让 AI 模型重写项目描述。有时,开发人员会以简写或简洁的风格编写描述,这可能不会产生最佳结果。使用 --rewrite 选项可以要求 AI 模型重写描述,从而提供更清晰的意图并改进生成的代码。
考虑以下示例
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 文件。