IDEA 插件开发教程(一)

·  阅读 15037

我正在参加「掘金·启航计划」

背景

IDEA/Android Studio 插件开发系列教程,文章链接如下:

IDEA 插件开发教程(一)

IDEA 插件开发教程(二)

作为使用 IDEA/Android Studio 的开发者,大家或多或少都使用过插件,随着开发工具的版本升级,很多插件会出现兼容性问题,而作者可能几年前就已经停止维护了。

如果我们能掌握一些插件开发知识,遇到停止维护的插件,就可以自动动手维护了,如果自己有一些想法,甚至可以自己开发插件。

目前网上关于 IDEA 插件的教程非常少,并且有些教程时间比较久远,很多配置都已经发生改变,所以接下来我计划写几篇关于开发 IDEA 插件的教程,希望能够帮助到大家。

本文是教程的第一篇,通过本文你可以新建一个简单的 HelloWorld 插件项目,熟悉 IDEA 插件开发的环境搭建,了解 IDEA 插件的项目结构。

开发工具

开发 IDEA 插件,需要下载 IDEA, 下载地址: www.jetbrains.com/zh-cn/idea/… 选择免费的 Community 版本即可。

创建项目

打开 IDEA,点击 New Project , 然后选择 IDE Plugin,如下图所示

idea_plugin_guide_1.png

输入插件项目相关信息,然后点击 Create 按钮创建项目,项目结构如下:

DxyJsonToDart
├── .idea
│   └── .gitignore
│   └── gradle.xml
│   └── misc.xml
│   └── vcs.xml
├── .run
│   └── Run IDE with Plugin.run.xml
├── gradle
│   └── wrapper
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── src
│   ├── main
│   │   ├── java
│   │   └── resources
│   │       └── META-INF
│   │           └── plugin.xml
│   │           └── pluginIcon.svg
├── .gitignore
├── build.gradle.kts
├── gradlew
├── gradlew.bat
└── settings.gradle.kts
复制代码

开发过 Android 项目的,对这个项目结构应该会熟悉一些,和 Android 项目基本差不多,我们的代码会写到 src/main/java/包名 中,build.gradle.kts 是 Gradle 的配置文件 plugin.xml 是插件的配置文件,在插件开发中,我们会经常和这两个配置文件打交道。

下面我们大概看一下 build.gradle.kts 文件:

plugins {
    id("java")
    id("org.jetbrains.intellij") version "1.6.0"
}

group = "cn.dxy.app"
version = "1.0-SNAPSHOT"

repositories {
    mavenCentral()
}

intellij {
    version.set("2021.3")
    type.set("IC") 
    plugins.set(listOf(/* Plugin Dependencies */))
}

tasks {
    withType<JavaCompile> {
        sourceCompatibility = "11"
        targetCompatibility = "11"
    }

    patchPluginXml {
        sinceBuild.set("212")
        untilBuild.set("223.*")
    }

    signPlugin {
        certificateChain.set(System.getenv("CERTIFICATE_CHAIN"))
        privateKey.set(System.getenv("PRIVATE_KEY"))
        password.set(System.getenv("PRIVATE_KEY_PASSWORD"))
    }

    publishPlugin {
        token.set(System.getenv("PUBLISH_TOKEN"))
    }
}

复制代码

这个文件中的配置信息具体是什么意思,后续会讲到,暂时先不管。这时我们什么代码没有写,直接运行项目,因为在上面配置了 version.set("2021.3"),运行时会下载一个 2021.3 版本的 IDEA。这个 IDEA 大概有 1~2G 大小,下载成功后,这个 IDEA 会运行起来,运行结果如下图所示。

idea_plugin_guide_2.png

如果你切换到 Plugins 选项,你会发现我们开发的插件被自动安装到这个 IDEA 中了。

我第一次解除插件开发时有点蒙:一个 IDEA 运行启动了另外一个 IDEA。后来我才想通,因为我们的插件是要运行在 IDEA/Android Studio 中的,我们的插件适配不同的版本,还要进行代码调试,所以只能一个 IDEA 运行启动了另外一个 IDEA。

建议大家动手实践一下,会有更加直观的感受。

新建 Action

想一下我们平时是如何使用插件的,我们可能是右键点击了文件夹,或者是点击了某个菜单,这时会弹出一些选项,这些选项一般就是某个插件的入口,这些入口在 IDEA 插件中叫做 Action

下面我们写点代码,看看如何创建一个 Action,在项目的代码包中,点击右键,New => Plugin DevKit => Action,可以创建一个 Action

idea_plugin_guide_3.png

添加 Action 相关信息

idea_plugin_guide_4.png

在上图中,Add to Group 选择的是 Groups: NewGroup(New) Action: NewFile(File) Anchor: First,那么我们新建的这个 Action 就会出现在 New 这个选项中的第一个位置

点击确定按钮后,会新增一个继承 AnAction 的类 DxyJsonToDartAction

package cn.dxy.app.dxyjsontodart;

import com.intellij.openapi.actionSystem.AnAction;
import com.intellij.openapi.actionSystem.AnActionEvent;

public class DxyJsonToDartAction extends AnAction {

    @Override
    public void actionPerformed(AnActionEvent e) {
        // TODO: insert action logic here
    }
}
复制代码

并且会在 plugin.xml 中新增这个 action

<actions>
    <action id="DxyJsonToDart" class="cn.dxy.app.dxyjsontodart.DxyJsonToDartAction" 
        text="我是 name" description="我是 description">
        <add-to-group group-id="NewGroup" anchor="first"/>
    </action>
</actions>
复制代码

这时我们再运行插件,看看我们刚刚编写的代码有什么效果:

IDEA 启动后,我们随便打开一个项目,在文件夹上,点击右键,可以看到 New 菜单中出现了我们刚开发的插件选项 我是 name

idea_plugin_guide_5.png

引用其它插件

我们写的插件,可以依赖其它插件,依赖其它插件之后,可以使用它们的类

官方文档:plugins.jetbrains.com/docs/intell…

打开项目 build.gradle.kts 文件,把 plugins.set() 中的代码修改如下:

intellij {
    version.set("2021.3")
    type.set("IC") // Target IDE Platform

    plugins.set(
        listOf(
            "Dart:213.5744.122", //https://plugins.jetbrains.com/plugin/6351-dart/versions
            "io.flutter:63.2.4",//https://plugins.jetbrains.com/plugin/9212-flutter/versions/stable
            "GsonFormatPlus:1.6.1",//https://plugins.jetbrains.com/plugin/14949-gsonformatplus/versions
            "com.jack.plugin.autojson:1.5", //https://plugins.jetbrains.com/plugin/11600-autojson/versions
            "com.crzsc.FlutterAssetsGenerator:2.0.0",//https://plugins.jetbrains.com/plugin/15427-flutterassetsgenerator/versions
            "com.ruiyu.ruiyu:4.4.2", //https://plugins.jetbrains.com/plugin/11415-flutterjsonbeanfactory-only-null-safety-/versions
        )
    )
}
复制代码

再次运行项目,运行成功后,切换到 Plugin 选项,如下图所示:

idea_plugin_guide_6.png

我们可以看到,这次运行的 IDEA 会把上面引入的插件那些插件全部打包安装了。

最后

本篇教程就写到这了,如果大家动手进行了实践,相信会对 IDEA 插件开发会有一个大概的了解了。

更多内容,会在后续的教程中介绍。

另外,大家对那些方面感兴趣,也可以留言评论,如果我知道的话,也会进行分享。

收藏成功!
已添加到「」, 点击更改