IntelliJ IDEA是JetBrains旗下的一款功能強大的Java整合開發環境（IDE），以其強大的外掛支援和靈活的定製功能著稱。透過開發外掛，開發者能夠為IDEA增加定製功能，提升生產力，並滿足團隊特定的需求。本指南將帶你深入瞭解如何從零開始開發一個完整的IntelliJ IDEA外掛。
1. 開發環境的準備
在開始外掛開發之前，首先需要設定好開發環境。以下是詳細步驟：
安裝IntelliJ IDEA Ultimate版：儘管你可以使用社羣版開發外掛，但Ultimate版提供了更多的功能支援，如對更多語言和框架的支援，這對複雜外掛的開發十分有用。
安裝JDK：外掛開發通常使用JDK 8或更高版本，建議使用JDK 11或17以獲得更好的效能和功能支援。
安裝Gradle：Gradle是推薦的構建工具，雖然Maven也可用，但Gradle的靈活性和指令碼化支援使其更適合外掛開發。
確保你安裝的工具版本都與最新的IntelliJ IDEA版本相容，以避免不必要的相容性問題。
2. 建立和配置外掛專案
IntelliJ IDEA提供了快捷的專案模板，幫助開發者快速啟動外掛專案。以下是具體步驟：
新建專案：啟動IntelliJ IDEA，選擇“New Project” -> “IntelliJ Platform Plugin”。
專案配置：設定專案名稱、位置、JDK版本。你可以選擇Java或Kotlin作為主要開發語言，Kotlin是JetBrains推薦的語言，因其簡潔的語法和強大的特性。
外掛模組配置：IDE自動為你配置IntelliJ Platform SDK，它包含了外掛開發所需的所有依賴和API。你可以選擇需要支援的IDE版本，並根據需要新增額外的模組，如
UI Designer或DevKit.
3. 理解外掛專案的基本結構
瞭解外掛專案的結構有助於你快速找到需要修改的地方：
plugin.xml：外掛的核心配置檔案，定義了外掛的後設資料、擴充套件點（Extension Points）、元件和服務。你在開發過程中會經常編輯此檔案。src/：存放外掛的原始碼。你可以根據需要建立多個包來組織程式碼。resources/：用於存放非程式碼資源，如外掛圖示、國際化資原始檔、模板檔案、UI佈局檔案等。
<idea-plugin> <id>com.example.myplugin</id> <name>My Plugin</name> <version>1.0.0</version> <vendor email="developer@example.com" url="https://example.com">My Company</vendor> <!-- 定義外掛的擴充套件點和功能 --> <extensions defaultExtensionNs="com.intellij"> <!-- 擴充套件點如Actions, ProjectComponent等 --> </extensions> <!-- 定義外掛的依賴 --> <depends>com.intellij.modules.platform</depends> </idea-plugin>
4. 開發一個功能豐富的外掛
爲了更深入瞭解外掛開發的過程，我們將建立一個具有以下功能的外掛：
在工具選單中新增一個新的選單項“Say Hello”。
單擊選單項時，彈出一個對話方塊，顯示“Hello World”。
在對話方塊中允許使用者輸入文字，並顯示使用者輸入的文字。
將使用者輸入的資料儲存在本地檔案中，以便在下次啟動IDE時恢復。
4.1 定義Action
首先，我們在plugin.xml中定義一個新的Action。這是外掛的基礎功能點，它將出現在IDEA的工具選單中。
<extensions defaultExtensionNs="com.intellij"> <actions> <action id="MyPlugin.HelloWorldAction" class="com.example.plugin.HelloWorldAction" text="Say Hello" description="Says Hello World"> <add-to-group group-id="ToolsMenu" anchor="last"/> </action> </actions> </extensions>
4.2 實現Action類
然後，在src/目錄下建立com.example.plugin.HelloWorldAction類，實現Action的功能。
package com.example.plugin;
import com.intellij.openapi.actionSystem.AnAction;
import com.intellij.openapi.actionSystem.AnActionEvent;
import com.intellij.openapi.ui.Messages;
public class HelloWorldAction extends AnAction {
@Override
public void actionPerformed(AnActionEvent e) {
String name = Messages.showInputDialog(e.getProject(),
"What is your name?",
"Input Your Name",
Messages.getQuestionIcon());
if (name != null && !name.trim().isEmpty()) {
Messages.showMessageDialog(e.getProject(),
"Hello " + name + "!",
"Greeting",
Messages.getInformationIcon());
// Save name to a local file for future use
saveNameToFile(name);
}
}
private void saveNameToFile(String name) {
// Implement the logic to save name to a local file
}
}
4.3 持久化資料
爲了在IDE重新啟動後恢復用戶數據，可以將資料持久化到本地檔案或IDE的持久化儲存中。以下是將資料儲存在使用者目錄下的一個簡單實現：
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Paths;
public class HelloWorldAction extends AnAction {
private static final String FILE_PATH = System.getProperty("user.home") + "/.idea-plugin-data.txt";
@Override
public void actionPerformed(AnActionEvent e) {
String name = Messages.showInputDialog(e.getProject(),
"What is your name?",
"Input Your Name",
Messages.getQuestionIcon());
if (name != null && !name.trim().isEmpty()) {
Messages.showMessageDialog(e.getProject(),
"Hello " + name + "!",
"Greeting",
Messages.getInformationIcon());
saveNameToFile(name);
}
}
private void saveNameToFile(String name) {
try (FileWriter writer = new FileWriter(FILE_PATH)) {
writer.write(name);
} catch (IOException ex) {
ex.printStackTrace();
}
}
private String loadNameFromFile() {
try {
return new String(Files.readAllBytes(Paths.get(FILE_PATH)));
} catch (IOException ex) {
ex.printStackTrace();
return "";
}
}
}
4.4 執行和除錯外掛
爲了測試你的外掛，使用Gradle的runIde任務。這將啟動一個新的IntelliJ例項，並載入你的外掛。你可以在新的例項中使用你的外掛，並透過斷點和日誌除錯它。
tasks.named("runIde").configure {
jvmArgs = ["-Xmx2g", "-XX:+HeapDumpOnOutOfMemoryError"]
}
透過修改jvmArgs，你可以為外掛除錯提供更多的記憶體，或啟用更詳細的日誌。
5. 擴充套件外掛功能
除了基本的UI互動和資料持久化，你還可以為外掛新增更多功能，例如：
程式碼補全：提供智慧提示和程式碼補全功能。
檔案模板：定義自定義的程式碼模板，幫助快速生成常用程式碼。
自定義檢視：在IDE中建立獨立的工具視窗或對話方塊，顯示外掛的特定資訊。
外部工具整合：與外部工具或服務整合，如CI/CD系統或資料庫。
5.1 新增程式碼補全
假設你要為特定的檔案型別提供程式碼補全，首先需要定義一個擴充套件點，在plugin.xml中新增：
<extensions defaultExtensionNs="com.intellij"> <completion.contributor language="JAVA" implementationClass="com.example.plugin.MyCompletionContributor"/> </extensions>
然後，建立MyCompletionContributor類，實現程式碼補全邏輯：
package com.example.plugin;
import com.intellij.codeInsight.completion.CompletionContributor;
import com.intellij.codeInsight.completion.CompletionParameters;
import com.intellij.codeInsight.completion.CompletionProvider;
import com.intellij.codeInsight.completion.CompletionResultSet;
import com.intellij.util.ProcessingContext;
import org.jetbrains.annotations.NotNull;
public class MyCompletionContributor extends CompletionContributor {
public MyCompletionContributor() {
extend(CompletionType.BASIC, PlatformPatterns.psiElement(), new CompletionProvider<>() {
@Override
protected void addCompletions(@NotNull CompletionParameters parameters,
@NotNull ProcessingContext context,
@NotNull CompletionResultSet result) {
result.addElement(LookupElementBuilder.create("myCustomCompletion"));
}
});
}
}
5.2 自定義檢視
要建立一個自定義工具視窗，可以使用ToolWindowFactory：
package com.example.plugin;
import com.intellij.openapi.project.DumbAware;
import com.intellij.openapi.wm.ToolWindow;
import com.intellij.openapi.wm.ToolWindowFactory;
import com.intellij.ui.content.Content;
import com.intellij.ui.content.ContentFactory;
public class MyToolWindowFactory implements ToolWindowFactory, DumbAware {
@Override
public void createToolWindowContent(Project project, ToolWindow toolWindow) {
MyToolWindow myToolWindow = new MyToolWindow(toolWindow);
ContentFactory contentFactory = ContentFactory.SERVICE.getInstance();
Content content = contentFactory.createContent(myToolWindow.getContent(), "", false);
toolWindow.getContentManager().addContent(content);
}
}
6. 外掛釋出和維護
一旦外掛開發完成，你可以將外掛釋出到JetBrains Plugin Repository，供其他開發者使用。
6.1 打包外掛
使用Gradle的buildPlugin任務將外掛打包成.zip檔案：
./gradlew buildPlugin
生成的.zip檔案將位於build/distributions/目錄下。
6.2 釋出外掛
註冊並登入到JetBrains Plugin Repository，建立新的外掛頁面，上傳外掛包，並填寫相關資訊，如外掛描述、版本歷史、支援的IDE版本等。釋出後，外掛會經過JetBrains的稽覈，稽覈透過後即在商店中上架。
6.3 持續維護和更新
釋出後，定期更新和維護外掛非常重要。保持與IntelliJ IDEA更新同步，及時修復相容性問題，新增新功能，並根據使用者反饋最佳化外掛。
7. 總結
IntelliJ IDEA外掛開發是一項極具挑戰但又充滿樂趣的任務。本文詳細介紹了從開發環境配置、外掛專案建立、功能實現到外掛釋出的完整流程，並擴充套件了外掛開發的高階功能。透過這些步驟，你可以開發出功能強大且使用者友好的IDE外掛，提升自己和團隊的開發效率。
