IDEA 插件开发教程

最新推荐文章于 2026-04-28 11:55:47 发布

原创

最新推荐文章于 2026-04-28 11:55:47 发布 · 1.3k 阅读

标签

#intellij-idea #java #ide

如果文章对您有用，请关注点赞加收藏，博主会持续更新相关的专栏笔记🫡

安装 Plugin DevKit 插件

Idea 2023.3 以下版本可以不用安装当前插件。IDEA 自带。2023.3 版本及之后的版本没有当前插件，需要自己安装。

安装完成之后，建议重启一下 IDEA，不然可能开发工具出不来：

开启 IDEA 内部模式

输入如下内容：

idea.is.internal=true

重启之后生效。

新建插件项目

同时注意 JDK 版本需要和 IDEA 对应。

参考文章

修改 Gradle 相关配置

取消 Gradle 构建

先取消默认的 Gradle 构建。先修改一些配置再重新构建。

修改依赖远程仓库地址

修改 build.gradle.kts 中的 repositories，注释中央仓库，配置阿里云地址：

repositories {
   
   
    // mavenCentral()
    maven {
   
   
        url = uri("https://maven.aliyun.com/repository/public")
    }
}

如果文件名不是 kts 结尾，而是 gradle 结尾，配置可能有些区别。

修改使用本地 IDEA 调试

注释 intellij 中的 version 和 type，如果指定，需要下载，这里我们使用本地安装的 IDEA 进行调试。

使用 localPath 设置本地 IDEA 的安装路径，参考文章。

intellij {
   
   
    localPath.set("D:\\install\\JetBrains\\IntelliJ IDEA Community Edition 2024.2.0.1")
    // version.set("2023.2.6")
    // type.set("IC") // Target IDE Platform
    plugins.set(listOf(/* Plugin Dependencies */))
}

重新加载 Gradle 变更

点击 Gradle 图标重新加载变更，等待构建完成，初次可能比较慢，需要下载依赖等。构建完成之后，文件也就有高亮显示了。

plugin.xml 解读

plugin.xml 文件可以理解是当前插件的相关配置。是插件开发中非常重要的一个文件。

参考文章

构建完成之后，它会报错，是因为不能使用默认的模版字符。我们改掉就可以了。

<!-- Plugin Configuration File. Read more: https://plugins.jetbrains.com/docs/intellij/plugin-configuration-file.html -->
<idea-plugin>
    <!-- 插件的唯一 ID -->
    <id>com.hzhiping.text-beautifier</id>

    <!-- 插件名称 -->
    <name>text-beautifier</name>

    <!-- A displayed Vendor name or Organization ID displayed on the Plugins Page. -->
    <vendor email="23955637@qq.com" url="https://www.baidu.com">hzhiping</vendor>

    <description>
        <![CDATA[
            插件描述。A displayed Vendor name or Organization ID displayed on the Plugins Page.
         ]]>
    </description>