AI命令指南

像OpenAI的ChatGPT这样的大型语言模型为利用AI生成代码提供了强大的解决方案。 ChatGPT 不仅接受 Java 代码训练,还参与 Spring 开源生态系统中的多个项目。 这使得Spring CLI能够增强应用,提供针对特定用例量身定制的功能,超出传统教程所能提供的范围。spring-doc.cadn.net.cn

只需一个简单的命令,你就能描述所需的功能,ChatGPT就会生成一个全面的功能README.md提供逐步指导以实现目标的文件。这就像为你的项目需求制作一个定制教程。spring-doc.cadn.net.cn

CLI还能自动将生成的指令应用到你的代码库中。spring-doc.cadn.net.cn

开始时,请使用以下命令:spring-doc.cadn.net.cn

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

对生成的解进行细化通常需要多次修改描述。 这--预览选项春季 AI ADD命令生成README.md提交时不修改你的项目,这样你就能查看拟议的修改内容。spring-doc.cadn.net.cn

一旦你对生成的 README.md 文件满意,就可以用以下命令将其应用到你的代码库中:spring-doc.cadn.net.cn

spring guide apply <Name of the guide markdown file>

为了进一步改进和准确性,你可以通过 --rewrite 选项让 ChatGPT 重写描述:spring-doc.cadn.net.cn

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

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

随着我们不断探索AI技术的潜力,预计将进一步完善成果,以满足春季项目的特定版本。

示例

请考虑以下例子:spring-doc.cadn.net.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.cadn.net.cn

前提条件

在使用AI命令之前,确保你有OpenAI的开发Tokens。spring-doc.cadn.net.cn

方法是在 OpenAI 注册处创建账户,并在 API 密钥处生成Tokens。将密钥保存在名为.openai通常在你的主目录下(通常)~/.openai).spring-doc.cadn.net.cn

文件应包含以下内容:spring-doc.cadn.net.cn

OPEN_AI_API_KEY=<paste your key here>

使用 AI 添加

AI ADDcommand可以让你为你的项目添加代码,这些代码是利用OpenAI的ChatGPT生成的。spring-doc.cadn.net.cn

为此,请通过以下方式简要描述你想添加的代码--描述选项,命令将请求发送到OpenAI的API。spring-doc.cadn.net.cn

默认情况下,这个命令会修改你的代码库。spring-doc.cadn.net.cn

以下列表展示了一个示例:spring-doc.cadn.net.cn

spring ai add "JPA functionality"

这个命令会创建一个叫 README-ai-jpa.md 的文件,并将文件中列出的更改应用到你的项目中。spring-doc.cadn.net.cn

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

回应预览

当你使用--预览选项,AREADME-ai-jpa.md文件生成时不对项目做任何修改。这让你可以查看文件并评估其是否提供了可接受的解决方案。spring-doc.cadn.net.cn

spring ai add "JPA functionality" --preview

该命令创建一个名为 README-ai-jpa.md 的文件。请记住,它不会修改你的项目,但提供了审查内容并判断其是否适合具体需求的机会。spring-doc.cadn.net.cn

如果生成的指令符合你的需求,你可以通过使用春季指南应用 README-ai-jpa.md命令。spring-doc.cadn.net.cn

不断迭代以获得你想要的效果

如果您查看上一步称为 README-ai-jpa.md 的文件,可以看到它没有包含任何测试。我们始终建议将测试纳入最佳实践,因此提供的描述应当更新。spring-doc.cadn.net.cn

这是你在与AI ADD命令。spring-doc.cadn.net.cn

例如,在上一个案例中,创建的代码缺少集成测试。运行带有以下描述的命令得到了预期结果。spring-doc.cadn.net.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.cadn.net.cn

自动重写项目描述

为了在 AI 模型中获得更好的结果,你可以选择让 AI 模型重写项目描述。有时,开发者会用简略或简洁的风格写描述,这可能无法产生最佳结果。使用--重写选项允许你让AI模型重写描述,提供更清晰的意图并改进生成的代码。spring-doc.cadn.net.cn

请考虑以下例子:spring-doc.cadn.net.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.cadn.net.cn

应用阅读

一旦你对生成的结果满意阅读文件,通过以下命令将其中描述的更改应用到你的代码库中。spring-doc.cadn.net.cn

spring guide apply README-ai-jpa.md