如何使用Intellij Platform SDK

Alex 11/21/2020 Intellij SDK

官方文档

官方示例：

https://github.com/JetBrains/intellij-sdk-code-samples (opens new window)

# 简单的插件工程

如图所示，我们可以使用 intellij IDEA 直接创建一个intellij Platform 插件

项目允许使用 Java 进行开发

基本工程目录

这是开发插件的最小工程，没有使用包管理器进行项目管理，所以如果需要外部依赖，则需要手动导入 jar 包

.
├── resources
│ └── META-INF
│     └── plugin.xml
├── src
└── project.iml

3 directories, 2 files

1
2
3
4
5
6
7
8

相关文件

文件	功能
project.iml	IDEA 的项目管理文件，无用
src/	源码目录，即插件的功能实现写在这里面
resources/META-INF/	配置资源目录，存放LOGO和配置文件等
resources/META-INF/plugin.xml	默认的插件配置文件，用于管理插件的名称、版本、依赖、简介、更新日志、以及各种注册钩子

# 高级插件工程（推荐）

在 Gradle 选项中，创建 Intellij Platform Plugin 项目。

该选项允许使用 Java 或 kotlin 进行开发

基本工程目录

这是开发插件的最小工程，使用gradle包管理器进行项目管理

仔细观察，工程结构与上方的简单结构基本是对应的，只是多了 gradle 相关的文件和java这个顶级包

test 是单元测试，先不做介绍

.
├── build.gradle
├── gradlew
├── gradlew.bat
├── settings.gradle
└── src
    ├── main
    │ ├── java
    │ └── resources
    │     └── META-INF
    │         └── plugin.xml
    └── test
        ├── java
        └── resources

1
2
3
4
5
6
7
8
9
10
11
12
13
14

以下文章完全基于高级插件工程进行介绍。

# 配置项

插件项目配置，即 Plugin.xml


<idea-plugin>
    <id>插件ID，不可与其他项目重复，只允许英文与数字</id>
    <name>插件名称，不可出现中文</name>
    <vendor email="联系方式" url="插件官网">组织或作者名称</vendor>
    <description>插件描述，至少40个字符，可使用 html</description>
    <depends>com.intellij.modules.platform</depends>
    <change-notes>更新日志，可使用 html</change-notes>

    <!-- 扩展配置，生命周期钩子、设置项、工具栏等均需要在这里配置 -->
    <extensions defaultExtensionNs="com.intellij">
        <!-- 生命周期钩子 -->
        <postStartupActivity implementation="" id=""/>
    </extensions>

    <!-- 动作配置，上节已经演示过 -->
    <actions>
        <!-- 配置动作组 -->
        <group id="" text="xxx" popup="true">
            <!-- 动作组的位置 -->
            <add-to-group group-id="ToolsMenu" anchor="first"/>
            <!-- 动作 -->
            <action id="Action ID" class="Action Class" text="动作名"></action>
        </group>

        <!-- 不加入组的单独动作 -->
        <action id="Action ID" class="Action Class" text="动作名">
            <add-to-group group-id="ToolsMenu" anchor="first"/>
        </action>
    </actions>

    <!-- 项目组件 -->
    <project-components>
        <component>
            <!-- 旧版生命周期钩子，已废弃 -->
            <implementation-class>Class</implementation-class>
        </component>
    </project-components>
</idea-plugin>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

# Hello World

我们开发一个简单的插件，实现在 intellij IDEA 使用弹出框显示 hello world

创建Action

首先在/src/main/java创建一个类并命名为Main，写入以下内容

import com.intellij.openapi.actionSystem.AnAction;
import com.intellij.openapi.actionSystem.AnActionEvent;
import com.intellij.openapi.ui.Messages;
import org.jetbrains.annotations.NotNull;

public class Main extends AnAction
{
    @Override
    public void actionPerformed(@NotNull AnActionEvent e)
    {
        Messages.showInfoMessage("Hello World", "INFO");
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14

注册Action

右键单击类名点击 Show Context Actions，或直接使用快捷键 Command + Enter。点击 Register Action 呼出以下菜单。

然后对 Main 类进行注册，将其注册成为 Action。

实际上可以简单的理解为，在顶部的工具栏中注册一个项目，在点击后调用我们写好的方法。

我现在的选项是，在Tools菜单的顶部，注册了一个名为 Hello World 的选项。

点击OK之后观察 plugin.xml 发现 actions 段多了以下内容，这便是注册菜单的实际行为，换言之我们完全可以不使用图形化的注册菜单，直接书写 xml 也能达到完全一致的效果。


<action id="Main" class="Main" text="Hello World" description="简单的 Hello World 示例">
    <add-to-group group-id="ToolsMenu" anchor="first"/>
</action>