部署和使用指南
本指南提供完整的部署和使用說明,幫助您設置后端服務并在VSCode、Eclipse和IntelliJ中使用相應的插件。這個解決方案基于vLLM提供AI編碼輔助,支持英語、中文和日文。
前提條件
- 操作系統:Linux、macOS或Windows(推薦Linux以獲得最佳vLLM性能)。
- 硬件:GPU(推薦NVIDIA,至少8GB VRAM)以運行vLLM模型。
- 軟件:
- Python 3.10+(后端服務)。
- Node.js(VSCode擴展開發,可選)。
- Java JDK 11+(Eclipse和IntelliJ插件)。
- Hugging Face賬號(下載模型)。
- 模型:示例使用
codellama/CodeLlama-7b-Python-hf
,可以替換為其他代碼模型。
1. 后端服務部署
步驟1:克隆倉庫并安裝依賴
假設有一個項目目錄:
git clone <your-repo> # 或手動創建backend目錄
cd backend
pip install -r requirements.txt
步驟2:配置環境變量
在 server.py
中,設置 MODEL_NAME
環境變量:
export MODEL_NAME="codellama/CodeLlama-7b-Python-hf" # 或其他模型
步驟3:啟動服務
python server.py
- 服務將在
http://0.0.0.0:8000
運行。 - 檢查健康:訪問
http://localhost:8000/api/health
,應返回"status": "healthy"
。
步驟4:多語言配置
- 服務自動根據請求頭
Accept-Language
切換語言。 - 支持
en
、zh-CN
、ja
。如果未匹配,回退到英文。
故障排除
- 模型加載失敗:確保GPU可用和Hugging Face token設置(如果需要私有模型)。
- 端口占用:修改
uvicorn.run
中的端口。 - 依賴問題:使用虛擬環境
venv
安裝。
2. VSCode擴展安裝和使用
安裝
- 打開VSCode,導航到擴展視圖。
- 搜索 “Coding Agent”(或從源代碼打包:
vsce package
生成.vsix
文件,然后安裝)。 - 安裝后,重啟VSCode。
使用
- 命令:
Agent: Complete Code
(Ctrl+Shift+Space):在光標處補全代碼。Agent: Generate Code
(Ctrl+Shift+G):輸入描述生成代碼。Agent: Explain Code
(Ctrl+Shift+E):解釋選中文本。Agent: Refactor Code
(Ctrl+Shift+R):重構選中文本。Agent: Debug Code
(Ctrl+Shift+D):調試整個文檔。Agent: Generate Tests
(Ctrl+Shift+T):為選中文本生成測試。
- 狀態欄:顯示連接狀態。如果顯示 “Cannot connect”,檢查后端服務。
- 語言:自動基于VSCode設置切換(en, zh-CN, ja)。
配置
- 編輯
settings.json
:無額外配置,后端URL固定為http://localhost:8000
。
3. Eclipse插件安裝和使用
安裝
- 從源代碼構建:使用Eclipse PDE導出插件JAR。
- 在Eclipse中:Help > Install New Software > Add > Local > 選擇JAR。
- 重啟Eclipse。
使用
- 菜單:Coding Agent > [命令]。
- 快捷鍵:如 Ctrl+Shift+Space 用于補全。
- 命令 與VSCode類似:補全、生成、解釋、重構、調試、生成測試。
- 輸出:結果顯示在消息對話框或新編輯器中。
- 語言:基于系統Locale自動切換。
配置
- 后端URL在
ApiClient.java
中硬編碼,可修改為自定義。
4. IntelliJ插件安裝和使用
安裝
- 從源代碼構建:使用Gradle
gradle build
生成ZIP。 - 在IntelliJ中:Settings > Plugins > Install Plugin from Disk > 選擇ZIP。
- 重啟IntelliJ。
使用
- 右鍵菜單:Coding Agent > [命令]。
- 命令 與其他IDE類似。
- 輸出:使用彈出窗口顯示解釋/調試結果。
- 語言:基于系統語言自動切換。
配置
- 添加OkHttp依賴到
build.gradle
:dependencies {implementation "com.squareup.okhttp3:okhttp:4.10.0" }
- 后端URL在
ApiClient.java
中硬編碼。
5. 總體使用說明
- 啟動順序:先啟動后端服務,再打開IDE。
- 多語言支持:插件和后端會根據系統/IDE語言自動適應。提示和響應會相應本地化。
- 自定義:
- 更改模型:在
server.py
中修改MODEL_NAME
。 - 添加語言:擴展
locales
目錄和i18n邏輯。
- 更改模型:在
- 性能提示:對于大型模型,確保GPU內存充足。調整
max_tokens
以控制響應長度。 - 安全注意:這是一個本地服務,無需互聯網,但確保模型許可合規。
6. 故障排除
- 連接失敗:檢查防火墻、端口8000是否開放,后端日志。
- 模型錯誤:驗證vLLM版本兼容模型。
- 語言不匹配:手動設置系統語言或請求頭。
- 插件不響應:檢查控制臺日志,重啟IDE。
如果遇到問題,請檢查日志或擴展代碼。未來可以添加更多功能,如自定義提示或更多IDE支持。