Java AI智能編碼助手：通義靈碼安裝和使用指南

通義靈碼，作為智能編碼助手，可以在你進(jìn)行編碼工作時(shí)，為你提供行級(jí)/函數(shù)級(jí)實(shí)時(shí)續(xù)寫(xiě)、注釋生成代碼、單元測(cè)試生成、代碼優(yōu)化、注釋生成、代碼解釋、研發(fā)智能問(wèn)答、代碼問(wèn)題修復(fù)等輔助編碼工作的功能。

• 通義靈碼官網(wǎng)：https://tongyi.aliyun.com/lingma/
• 通義靈碼支持：JetBrains IDEs、Visual Studio Code、Visual Studio，及遠(yuǎn)程開(kāi)發(fā)場(chǎng)景（Remote SSH、Docker、WSL、Web IDE），安裝后登錄賬號(hào)即可開(kāi)始使用。

目前對(duì)于 Java，通義靈碼支持在多種文本編輯器或 IDE 上使用，接下來(lái)我們來(lái)詳細(xì)看看在 JetBrains IDEs、Visual Studio Code、Visual Studio 上的安裝與使用：

一、安裝指南

JetBrains IDEs 中安裝指南

本安裝步驟適用于 macOS、Windows 或 Linux 的 JetBrains IDEs 中安裝通義靈碼。

在 JetBrains IDEs 中安裝通義靈碼

Tips：以在 IntelliJ IDEA 中安裝通義靈碼為例。

方法 1：從插件市場(chǎng)安裝

1. 打開(kāi) IntelliJ IDEA 設(shè)置窗口，在插件市場(chǎng)中搜索 ?TONGYI Lingma?，找到通義靈碼后單擊安裝。
2. 安裝完成后，請(qǐng)重啟 IntelliJ IDEA。

方法 2：下載安裝包安裝

1. 單擊下方鏈接，下載 JetBrains IDEs 的 zip 安裝包；
   ? TONGYI Lingma - JetBrains
2. 下載完安裝包后，打開(kāi) IntelliJ IDEA 后，打開(kāi)設(shè)置，在插件管理的設(shè)置下拉菜單中單擊從本地安裝插件，選擇下載的 zip 文件后安裝。         
   
3. 安裝完成后，請(qǐng)重啟 IntelliJ IDEA。

登錄并開(kāi)啟智能編碼之旅

1. 重啟 IntelliJ IDEA 后，單擊側(cè)邊導(dǎo)航的通義靈碼，在通義靈碼助手的窗口單擊登錄按鈕。
2. 單擊登錄后，將前往登錄頁(yè)面，完成登錄后可進(jìn)入 IDE 客戶端開(kāi)始使用。登錄相關(guān)具體操作，可參考：登錄通義靈碼插件端。

Visual Studio Code 中安裝指南

本安裝步驟適用于 macOS、Windows 或 Linux 的 Visual Studio Code 中安裝通義靈碼。

在 Visual Studio Code 中安裝通義靈碼

方法 1：從插件市場(chǎng)安裝

說(shuō)明

單擊?Install?立即安裝，喚起 Visual Studio Code 插件市場(chǎng)直接安裝，安裝后請(qǐng)重啟 IDE，即可開(kāi)啟智能編碼之旅。

1. 打開(kāi) Visual Studio Code 擴(kuò)展窗口，搜索 ?TONGYI Lingma?，找到通義靈碼后單擊?Install?安裝。
2. 安裝完成后，請(qǐng)重啟 Visual Studio Code。

方法 2：下載安裝包安裝

1. 單擊下方鏈接，下載 Visual Studio Code 的 VSIX 安裝包；
   ? TONGYI Lingma-VS Code
2. 下載完安裝包后，打開(kāi) Visual Studio Code 后，單擊擴(kuò)展，單擊更多按鈕，在下拉菜單中單擊 從 VSIX 安裝，選擇下載的 VSIX 文件后安裝；



3. 安裝完成后，請(qǐng)重啟 Visual Studio Code。

登錄并開(kāi)啟智能編碼之旅

1. 重啟 Visual Studio Code 后，單擊側(cè)邊導(dǎo)航的通義靈碼，在通義靈碼助手的窗口單擊登錄按鈕。
   Tips：如果安裝后在側(cè)邊導(dǎo)航上找不到通義靈碼入口，可鼠標(biāo)聚焦在側(cè)邊導(dǎo)航后右鍵查看，勾選通義靈碼后即可將插件入口配置在側(cè)邊導(dǎo)航上。
   
2. 單擊登錄后，將前往登錄頁(yè)面，完成登錄后可進(jìn)入 IDE 客戶端開(kāi)始使用。登錄相關(guān)具體操作，可參考：登錄通義靈碼插件端。

Visual Studio 中安裝指南

本安裝步驟適用于 Windows 10 及以上操作系統(tǒng)中安裝和使用通義靈碼。

在 Visual Studio 中安裝通義靈碼

方法 1：從插件市場(chǎng)安裝

1. 打開(kāi) Visual Studio 頂部擴(kuò)展-管理擴(kuò)展窗口，搜索 ?TONGYI Lingma?，找到通義靈碼后單擊安裝。
2. 安裝完成后，請(qǐng)重啟 Visual Studio。

方法 2：下載安裝包安裝

1. 單擊下方鏈接，下載 Visual Studio 的 VSIX 安裝包；
   ? TONGYI Lingma - Visual Studio 2022
   ? TONGYI Lingma - Visual Studio 2019
2. 關(guān)閉已經(jīng)打開(kāi)的 Visual Studio 2022 或 Visual Studio 2019；
3. 下載完安裝包后，找到該通義靈碼的安裝包（以 VSIX 為擴(kuò)展名），雙擊安裝包，按照安裝向?qū)Р僮骷纯伞?/li>

登錄并開(kāi)啟智能編碼之旅

1. 重啟 Visual Studio 后，單擊頂部導(dǎo)航工具
2. 單擊登錄后，將前往登錄頁(yè)面，完成登錄后可前往 IDE 客戶端開(kāi)始使用。登錄相關(guān)具體操作，可參考：登錄通義靈碼插件端。

二、功能展示

1. 代碼智能補(bǔ)全

1.1 行級(jí)/函數(shù)級(jí)實(shí)時(shí)補(bǔ)全

當(dāng)你在 IDE 編輯器區(qū)進(jìn)行代碼編寫(xiě)時(shí)，在開(kāi)啟自動(dòng)云端生成的模式下，通義靈碼會(huì)根據(jù)當(dāng)前代碼文件及相關(guān)代碼文件的上下文，自動(dòng)為你生成行級(jí)/函數(shù)級(jí)的代碼建議，此時(shí)你可以使用快捷鍵采納、廢棄，或查看不同的代碼建議。

同時(shí)，當(dāng)你在編碼的過(guò)程中，也可以通過(guò)快捷鍵 ??? ?P? 手動(dòng)觸發(fā)生成代碼建議。

編輯器中代碼建議相關(guān)操作的快捷鍵如下：

Tips：不同操作系統(tǒng)的快捷鍵配置可查看插件配置指南。

1.2 自然語(yǔ)言生成代碼

在編輯器中，可以直接通過(guò)自然語(yǔ)言的方式描述需要實(shí)現(xiàn)的需求，通義靈碼可以在編輯器中生成代碼建議，單擊 Tab 可直接采納。

2. 研發(fā)智能問(wèn)答

使用通義靈碼的智能問(wèn)答時(shí)，為了通義靈碼與你的對(duì)話能夠更友好、高效，希望你能夠在輸入問(wèn)題時(shí)：

• 選中代碼，開(kāi)始輸入你的問(wèn)題，通義靈碼將圍繞著選中代碼與你開(kāi)展對(duì)話；
• 精準(zhǔn)表達(dá)問(wèn)題，以及給出相對(duì)詳細(xì)的上下文輸入， 比如選中的代碼、日志、報(bào)錯(cuò)信息等；
• 多多互動(dòng)，告訴通義靈碼，所給出代碼建議或回答是否滿足你的預(yù)期，或生成內(nèi)容存在的具體瑕疵，通義靈碼也會(huì)不斷改進(jìn)。

2.1 研發(fā)自由問(wèn)答

當(dāng)你編碼遇到問(wèn)題，缺乏具體解決思路時(shí)，可單擊 IDE 側(cè)邊工具導(dǎo)航或使用? ? L喚起通義靈碼智能問(wèn)答助手，無(wú)需離開(kāi) IDE 客戶端，即可快速獲得答案和解決思路。

2.2 代碼問(wèn)答

當(dāng)你對(duì)某段代碼有疑問(wèn)或期望針對(duì)代碼進(jìn)行一些問(wèn)題解決時(shí)，選中代碼后，在智能問(wèn)答窗口的輸入框中輸入你的問(wèn)題，通義靈碼將圍繞選中代碼與你開(kāi)展對(duì)話。

2.3 @workspace 本地工程問(wèn)答

當(dāng)你需要快速了解一個(gè)工程、查找工程內(nèi)的實(shí)現(xiàn)邏輯，或有新的訴求需要進(jìn)行代碼變更時(shí)，可以在智能問(wèn)答窗口中通過(guò) @ 可喚起 @workspace，選中后輸入你的問(wèn)題或訴求，通義靈碼可快速結(jié)合當(dāng)前倉(cāng)庫(kù)進(jìn)行工程理解、代碼查詢、代碼問(wèn)答等，同時(shí)可以通過(guò)自然語(yǔ)言描述需求，結(jié)合當(dāng)前工程生成簡(jiǎn)單需求或缺陷的整體修改建議和相關(guān)建議代碼。

2.4 @terminal 問(wèn)答

當(dāng)你遇到執(zhí)行指令不知道如何寫(xiě)，或者不清楚某個(gè)指令的意思時(shí)，可以在智能問(wèn)答窗口中通過(guò) ?@? 可喚起 ?@terminal?，選擇后使用自然語(yǔ)言描述你的需要指令訴求，通義靈碼將可以生成你需要的命令。生成指令后，你可以一鍵插入到 teminal 中進(jìn)行執(zhí)行或讓通義靈碼繼續(xù)解釋。當(dāng)然，你也可以在選擇 ?@terminal? 后，輸入指令讓通義靈碼生成指令解釋。

2.5 ?#team docs? 知識(shí)庫(kù)問(wèn)答（企業(yè)版）

當(dāng)你需要結(jié)合企業(yè)內(nèi)私域知識(shí)信息讓通義靈碼進(jìn)行回答時(shí)，可以在智能問(wèn)答窗口中通過(guò) ?#? 喚起 ?#team docs?，并輸入問(wèn)題，通義靈碼將結(jié)合企業(yè)知識(shí)庫(kù)（當(dāng)前用戶有權(quán)限的知識(shí)庫(kù)）對(duì)問(wèn)題進(jìn)行回答，在回復(fù)中也可以單擊查看引用的企業(yè)知識(shí)庫(kù)內(nèi)容。

2.6 清空會(huì)話上下文歷史記憶

當(dāng)你在會(huì)話中是，在智能問(wèn)答輸入框中輸入 ?/? 即可看到 ?/clear context? 指令，選擇后即可清空當(dāng)前會(huì)話的上下文歷史記憶。

2.7 新建會(huì)話

在智能問(wèn)答窗口中，單擊右上角的新建按鈕即可新建會(huì)話窗口，單擊后會(huì)話窗口將回到默認(rèn)狀態(tài)。

2.8 查看會(huì)話歷史

歷史會(huì)話功能幫助你檢索和回顧與通義靈碼的交流記錄，方便針對(duì)多次的建議進(jìn)行對(duì)比和選擇。不管你在哪個(gè) IDE 客戶端上、哪個(gè)工程中，均可以查看或搜索你和通義靈碼的歷史會(huì)話。

3. 智能生成指令

3.1 指令觸發(fā)方式

通義靈碼提供多處觸發(fā)單元測(cè)試生成、代碼解釋、生成代碼注釋、代碼優(yōu)化功能的入口，當(dāng)你選中的代碼后，有 3 種觸發(fā)方式：

1. 在編輯器中，單擊右鍵找到通義靈碼功能操作入口，單擊對(duì)應(yīng)功能操作；
2. 在智能問(wèn)答中，直接單擊對(duì)應(yīng)功能操作；
3. 在智能問(wèn)答中，使用 ?/? 查看快捷指令，單擊對(duì)應(yīng)功能操作。

當(dāng)需要針對(duì)一個(gè)方法實(shí)現(xiàn)生成單元測(cè)試、代碼注釋、代碼解釋、代碼優(yōu)化時(shí)，無(wú)需選中代碼，可直接單擊函數(shù)上方的快捷入口觸發(fā)相關(guān)功能操作。

3.2 選擇指令后輸入回答要求

當(dāng)你選中代碼后，并通過(guò)在智能問(wèn)答窗口的輸入框輸入 ?/? 的方式選中指令后，可以繼續(xù)輸入附加的要求，比如：

• 選擇 ?/generate unit test?后，繼續(xù)輸入你對(duì)單元測(cè)試生成的要求，比如使用 JUnit 5生成；
• 選擇 ?/generate comment?后，繼續(xù)輸入生成注釋的要求，比如開(kāi)頭標(biāo)明日期，并用英文注釋。

3.3 指令一：解釋代碼

覆蓋各種編程語(yǔ)言，選中代碼后可自動(dòng)識(shí)別編程語(yǔ)言并生成代碼解釋?？缭秸Z(yǔ)言的邊界，讓你閱讀代碼更高效。

3.4 指令二：生成單元測(cè)試

支持根據(jù) JUnit、Mockito、Spring Test、unit test、pytest 等框架生成單元測(cè)試。

3.5 指令三：生成注釋

一鍵生成方法注釋及行間注釋，節(jié)省你寫(xiě)代碼注釋的時(shí)間，并能夠有效提升代碼可讀性。

3.6 指令四：代碼優(yōu)化

深度分析代碼及其上下文，迅速識(shí)別潛在的編碼問(wèn)題，從簡(jiǎn)單的語(yǔ)法錯(cuò)誤到復(fù)雜的性能瓶頸，均能夠指出問(wèn)題所在，并提供具體的優(yōu)化建議代碼。

3.7 生成回答后快捷操作

針對(duì)不同的指令生成回答后，在智能問(wèn)答區(qū)中，可以繼續(xù)根據(jù)訴求進(jìn)行操作，不同功能的對(duì)應(yīng)操作如下：

• 生成單元測(cè)試：
  • 采納單元測(cè)試代碼建議：支持一鍵插入、復(fù)制、或者新建代碼文件，可快速采納生成的單元測(cè)試代碼建議；
  • 更換單元測(cè)試框架：提供基于 JUnit、Mockito、Spring Test、unit test、pytest 等框架生成單元測(cè)試代碼建議，在回答完成后，可以根據(jù)需要切換框架重新生成；
  • 新建文件：支持一鍵保存單元測(cè)試代碼為新文件，方便進(jìn)行查看和修改。
• 生成代碼優(yōu)化建議：
  • 采納代碼優(yōu)化建議：針對(duì)優(yōu)化建議中的建議代碼，支持一鍵插入、復(fù)制，快速采納生成的建議代碼；
  • 查看 Diff：?jiǎn)螕舨榭?Diff 按鈕，將快速喚起 IDE Diff 查看窗口，快速了解建議和源代碼的變更；
• 生成代碼注釋：
  • 采納代碼注釋建議：支持一鍵插入、復(fù)制，可快速采納生成的代碼注釋建議；
  查看 Diff：?jiǎn)螕舨榭?Diff 按鈕，將快速喚起 IDE Diff 查看窗口，快速了解建議和源代碼的變更。
• 解釋代碼：
  • 支持重試、更詳細(xì)、更簡(jiǎn)單、中文/英文解釋的追問(wèn)。

4. 問(wèn)題修復(fù)建議

4.1 代碼問(wèn)題（Problem）一鍵修復(fù)

當(dāng)你在編碼過(guò)程中出現(xiàn)代碼問(wèn)題（Problem）需要進(jìn)行修復(fù)時(shí)，通義靈碼可以一鍵給出修復(fù)建議，幫你快速修復(fù)代碼問(wèn)題?？梢酝ㄟ^(guò)編輯器中報(bào)錯(cuò)圖標(biāo)中下拉菜單中或 Problem 窗口中聚焦到報(bào)錯(cuò)信息后右鍵菜單中，單擊通義靈碼一鍵修復(fù)菜單，即可生成修復(fù)建議和相關(guān)建議代碼。

4.2 異常報(bào)錯(cuò)排查（IntelliJ IDEA）

在 IntelliJ IDEA 中，當(dāng)運(yùn)行出現(xiàn)異常報(bào)錯(cuò)時(shí)，在運(yùn)行標(biāo)準(zhǔn)輸出窗口中，即可看到通義靈碼的快捷操作按鈕，單擊后，通義靈碼將結(jié)合運(yùn)行代碼、異常堆棧等報(bào)錯(cuò)上下文，快速給出排查思路或修復(fù)建議。

4.3 執(zhí)行報(bào)錯(cuò)、編譯報(bào)錯(cuò)排查（Visual Studio Code）

在 Visual Studio Code 中，當(dāng) terminal 中執(zhí)行指令后報(bào)錯(cuò)、編譯或運(yùn)行后有大量報(bào)錯(cuò)，需要進(jìn)行解釋或修復(fù)時(shí)，可以選中報(bào)錯(cuò)信息，右鍵選擇使用通義靈碼一鍵解釋，也會(huì)為你生成相關(guān)命令解釋及問(wèn)題解決建議。

5. 提交信息生成

當(dāng)你有代碼變更需要提交，需要寫(xiě)提交信息時(shí)，可以通過(guò)通義靈碼一鍵生成 Git 提交信息，同時(shí)可以在插件設(shè)置中配置生成的語(yǔ)言（英文/中文）。

6. 離線單行補(bǔ)全

通義靈碼代碼補(bǔ)全默認(rèn)使用云端大模型進(jìn)行智能續(xù)寫(xiě)，當(dāng)網(wǎng)絡(luò)情況有限制時(shí)，可使用本地補(bǔ)全模式，單擊狀態(tài)欄圖標(biāo)切換至本地補(bǔ)全模式后，編輯器中進(jìn)行編碼時(shí)，通義靈碼會(huì)給出單行的代碼建議。

7. IntelliJ IDEA 中技術(shù)文檔和代碼片段搜索

在 IntelliJ IDEA 客戶端內(nèi)，如果你在編碼過(guò)程中有需要進(jìn)行技術(shù)資料檢索、代碼片段搜索時(shí)，無(wú)須離開(kāi) IDE，單擊側(cè)邊導(dǎo)航的通義靈碼，單擊搜索，即可開(kāi)始搜索。

8. 查看幫助和分享反饋

8.1 查看使用幫助

通義靈碼的智能問(wèn)答窗口中，可以通過(guò) 2 種方式查看使用幫助：

1. 通過(guò)智能問(wèn)答的 ?/help? 指令快捷查看使用幫助；
2. 單擊智能問(wèn)答窗口的幫助文檔入口，可以快速來(lái)到當(dāng)前幫助文檔知識(shí)庫(kù)。

8.2 反饋回答質(zhì)量

在智能問(wèn)答中，你可以對(duì)通義靈碼所生成的回答內(nèi)容進(jìn)行評(píng)價(jià)，支持點(diǎn)贊和點(diǎn)踩，以不斷優(yōu)化回答效果。

8.3 使用問(wèn)題反饋

當(dāng)你在使用的過(guò)程有任何疑問(wèn)、優(yōu)化建議、功能訴求等，均可在通義靈碼的智能問(wèn)答窗口單擊提交反饋，即可前往阿里云開(kāi)發(fā)者社區(qū)-通義靈碼問(wèn)答專區(qū)向我們提出問(wèn)題。

訪問(wèn)通義靈碼官網(wǎng)立即開(kāi)始使用