IDEA CodeGPT 使用教程
IDEA CodeGPT 使用教程
CodeGPT 是一个 IntelliJ IDEA 插件,可以利用 OpenAI(或自建 AI 模型)来帮助开发者完成代码编写、优化、调试、解释错误等任务。以下是详细的安装与配置教程。
1. 安装 CodeGPT 插件
方式 1:从插件市场安装
- 打开 IntelliJ IDEA,进入
Settings/Preferences
(Ctrl + Alt + S
)。 - 选择 Plugins,在右上角的搜索框输入
CodeGPT
。 - 找到
CodeGPT - ChatGPT/OpenAI
插件,并点击 Install。 - 安装完成后,重启 IDEA 使插件生效。
方式 2:手动安装
如果插件市场不可用,可以手动下载 .zip
或 .jar
文件:
- 从 JetBrains Plugin Repository 或 GitHub 下载插件。
- 在
Settings > Plugins
中点击 Install Plugin from Disk 选择下载的插件文件进行安装。
2. 配置 OpenAI API Key
CodeGPT 需要访问 OpenAI API,或者你可以配置 自建 OpenAI 服务 来替代官方 API。
方法 1:使用 OpenAI 官方 API
- 登录 OpenAI 平台 并获取 API Key。
- 在 IntelliJ IDEA 的
Settings > Tools > CodeGPT
中,找到 API Key 配置项。 - 填入 API Key 并保存。
方法 2:使用自建 OpenAI 接口
如果你运行了自己的 OpenAI 兼容 API(如 FastChat
、llama.cpp
或 OpenAI Proxy
),可以修改 API 地址:
- 在
Settings > Tools > CodeGPT
中,找到 API Base URL 配置项。 - 修改为你的自建 API 地址,例如:
http://your-openai-server/v1
- 在 API Key 处填入你的自建 API 访问密钥。
3. CodeGPT 主要功能
代码生成
- 在代码编辑器中输入注释或方法名,如:
// 生成一个 Java 方法来计算斐波那契数列
- 右键选择 “CodeGPT: Generate Code”,或使用快捷键
Alt + G
。 - CodeGPT 会自动生成代码,并插入到当前位置。
代码优化
- 选中需要优化的代码块,右键选择:
CodeGPT: Optimize Code
- CodeGPT 会提供优化后的版本,并解释优化点。
错误分析
- 选中错误代码,右键选择:
CodeGPT: Explain Error
- CodeGPT 会分析错误原因,并提供修复建议。
生成单元测试
- 选中一个函数或类,右键选择:
CodeGPT: Generate Unit Test
- CodeGPT 会根据代码结构自动生成单元测试(支持 JUnit、TestNG、Mockito)。
代码注释
- 选中代码后,右键选择:
CodeGPT: Add Comments
- CodeGPT 会自动生成详细的注释,适用于文档编写。
4. 配置高级选项
你可以在 Settings > Tools > CodeGPT
里调整以下配置:
- 默认 GPT 模型(如
gpt-4
、gpt-3.5-turbo
):"codegpt.model": "gpt-4"
- 限制最大 Token 以减少 API 费用:
"codegpt.maxTokens": 500
- 修改 CodeGPT UI 主题(支持 Dark 模式):
"codegpt.theme": "dark"
5. 常见问题
Q1: 为什么 CodeGPT 没有响应?
- 确保 API Key 正确,可以在浏览器测试
https://api.openai.com/v1/chat/completions
是否可访问。 - 如果使用自建 OpenAI,确认 API 服务器是否运行正常。
Q2: 如何降低 API 费用?
- 选择
gpt-3.5-turbo
而不是gpt-4
。 - 通过
max_tokens
限制 Token 消耗。 - 开启 缓存(CodeGPT 插件可能支持缓存,减少重复请求)。
Q3: IDEA 运行时出现性能问题?
- 可能是 CodeGPT 自动补全耗时较长,可以调整 API 请求超时时间:
"codegpt.timeout": 10
- 或者在
Settings > CodeGPT
里关闭 自动补全 选项,仅手动调用 AI 生成代码。
6. 总结
CodeGPT 为 IntelliJ IDEA 提供了强大的 AI 编程辅助功能,支持代码生成、优化、错误分析、单元测试生成等。建议结合 自建 OpenAI 服务 使用,以提升稳定性并降低 API 费用。
你已经在 VSCode 使用 CLine
插件,并尝试自建 OpenAI,如果你想在 IDEA 里也集成自己的 OpenAI 服务器,可以调整 CodeGPT API Base URL
进行适配。需要的话,我可以帮你编写一个 本地 OpenAI API 代理 来让 IDEA 和 VSCode 都能无缝使用它。