在 IntelliJ IDEA 中创建一个新的 IntelliJ Platform 插件项目(IntelliJ Plugin Project),有几下方式:
一、使用官方模板(GitHub Clone)
1、复用模板
JetBrains 提供了一个官方的 IntelliJ Platform Plugin Template,你可以克隆这个仓库:
git clone https://github.com/JetBrains/intellij-platform-plugin-template.git
然后在 IntelliJ IDEA 中打开这个项目,它已经包含了所有必要的依赖和配置。
2、设置正确的jdk
进入Project Settings--Modules,查看module sdk,如果是默认的jdk,需要改成plugin的sdk
MyIntelliJPlugin/
│── .github/ # GitHub Actions CI/CD 配置
│── .gradle/ # Gradle 缓存(运行后生成)
│── .idea/ # IntelliJ IDEA 项目配置(IDE 相关)
│── build/ # 编译输出目录(运行后生成)
│── gradle/ # Gradle wrapper(自动管理 Gradle 版本)
│── src/ # 主要的源代码目录
│ ├── main/
│ │ ├── java/ # Java 源代码(如果使用 Kotlin,则是 kotlin/)
│ │ │ └── com/example/plugin/
│ │ │ ├── MyPlugin.java # 插件的主类
│ │ │ ├── MyAction.java # 示例 Action(按钮/菜单)
│ │ │ ├── MyService.java # 示例服务
│ │ ├── resources/ # 资源文件
│ │ │ ├── META-INF/
│ │ │ │ ├── plugin.xml # 插件的核心配置文件
│ │ │ │ ├── pluginIcon.svg # 插件的图标
│ │ │ ├── messages/ # 本地化(国际化)字符串
│ │ │ │ ├── MyBundle.properties
│ │ │ ├── icons/ # 插件的图标资源
│ │ │ │ ├── myIcon.svg
│ ├── test/ # 测试代码目录
│── .gitignore # Git 忽略文件
│── build.gradle.kts # Gradle 构建脚本(Kotlin DSL)
│── settings.gradle.kts # Gradle 设置
│── gradlew # 用于运行 Gradle 的 shell 脚本(Linux/macOS)
│── gradlew.bat # 用于运行 Gradle 的批处理脚本(Windows)
│── README.md # 项目说明文档
二、手动创建一个 IntelliJ 插件项目
1. 创建一个普通的 Gradle 项目
-
File → New → Project
-
选择 Gradle
-
选择 Java 或 Kotlin
-
配置项目名和路径
2. 编辑 build.gradle.kts
,添加 IntelliJ Platform Plugin 依赖
在 build.gradle.kts
中,添加 IntelliJ Platform 插件依赖,然后 刷新 Gradle 使其生效。
plugins {
id("org.jetbrains.intellij") version "1.14.1"
}
intellij {
version.set("2023.2") // 替换为你的 IntelliJ 版本
type.set("IC") // IntelliJ Community 版本(IC)或 Ultimate 版本(IU)
}
示例:
idea 2023.2.8+jdk17
1、创建一个插件工程
选择 File | New | Project,或者选择Project Structure--Modules--New Module 创建一个新工程,
左侧栏中选择 IntelliJ Platform Plugin 工程类型即可
生成后,查看项目结构:
其中plugin.xml:
<!-- Plugin Configuration File. Read more: https://plugins.jetbrains.com/docs/intellij/plugin-configuration-file.html -->
<idea-plugin>
<!-- Unique identifier of the plugin. It should be FQN. It cannot be changed between the plugin versions. -->
<id>com.test.my_test_tool</id>
<!-- Public plugin name should be written in Title Case.
Guidelines: https://plugins.jetbrains.com/docs/marketplace/plugin-overview-page.html#plugin-name -->
<name>My_test_tool</name>
<!-- A displayed Vendor name or Organization ID displayed on the Plugins Page. -->
<vendor email="support@yourcompany.com" url="https://www.yourcompany.com">YourCompany</vendor>
<!-- Description of the plugin displayed on the Plugin Page and IDE Plugin Manager.
Simple HTML elements (text formatting, paragraphs, and lists) can be added inside of <![CDATA[ ]]> tag.
Guidelines: https://plugins.jetbrains.com/docs/marketplace/plugin-overview-page.html#plugin-description -->
<description><![CDATA[
Enter short description for your plugin here.<br>
<em>most HTML tags may be used</em>
]]></description>
<!-- Product and plugin compatibility requirements.
Read more: https://plugins.jetbrains.com/docs/intellij/plugin-compatibility.html -->
<depends>com.intellij.modules.platform</depends>
<!-- Extension points defined by the plugin.
Read more: https://plugins.jetbrains.com/docs/intellij/plugin-extension-points.html -->
<extensions defaultExtensionNs="com.intellij">
</extensions>
</idea-plugin>
三、使用 IntelliJ IDEA 自带的插件模板
1. 打开 IntelliJ IDEA
如果已经打开了一个项目,可以通过 File → New → Project 打开新建项目窗口。
2. 选择 "IntelliJ Platform Plugin"
在 "New Project" 窗口中:
-
左侧菜单 选择 "IntelliJ Platform Plugin"
-
右侧确保 Gradle 或 Maven 被选中(推荐 Gradle)
-
点击 Next
3. 配置项目信息
-
Project Name(项目名称): 例如
MyIntelliJPlugin
-
Project Location(项目存放路径): 选择合适的位置
-
Build System(构建工具): 推荐选择 Gradle
-
Language(语言): 选择 Java 或 Kotlin
-
Gradle DSL: 选择 Kotlin DSL(推荐) 或 Groovy
-
IntelliJ Platform Plugin SDK: 选择本机已安装的 IntelliJ IDEA 版本
4. 点击 Finish,等待项目初始化
IntelliJ IDEA 会自动下载依赖并初始化项目。
四、说明
无论使用哪种方式创建工程,默认的都是kotlin语言即只有src/main/kotlin
目录,而没有 src/main/java
目录。默认情况下,IntelliJ IDEA 会为 Kotlin 项目创建 src/main/kotlin
目录,而不会自动创建 src/main/java
目录。可以在 src/main/
目录下,右键点击 kotlin
目录,选择 New
-> Directory输入java,之后点击Java就可以create package/class了。
并且在gradle.properties中加上:
platformBundledPlugins = com.intellij.java,com.intellij.gradle