从零开始开发JetBrains插件（一）——准备工作

引言

        在当今的软件开发领域，JetBrains系列的集成开发环境（IDE）无疑是程序员中使用最广泛的工具之一。具备个性化功能的插件能显著提升开发效率，成为这些环境的重要补充。那么，我们如何开发出一款适合自己的JetBrains插件呢？本文将从基础开始，带领大家一步步走进JetBrains插件的开发世界，共同打造一款属于我们自己的插件。

开发环境和技术栈

我的操作系统：MacOS 14.2.1

集成开发环境：以IntelliJ IDEA为主

开发语言：Java、Kotlin 等

需要用到的开源工具：Gradle 等

官方插件市场和文档

JetBrains Marketplacehttps://plugins.jetbrains.com

IntelliJ Platform SDK | IntelliJ Platform Plugin SDKhttps://plugins.jetbrains.com/docs/intellij/welcome.html

        在深入研究JetBrains的官方插件市场和相关文档后，我们可以明确地了解到，JetBrains插件开发主要集中在IntelliJ IDEA环境中。目前，官方支持使用Java和Kotlin作为编写插件的主要语言。未来，我们计划引入大型模型的能力，这将使得调用Python脚本成为可能，进一步拓展我们的开发范围。在插件的项目构建过程中，我们将采用Gradle，这是一个基于Apache Ant和Apache Maven理念的强大的项目自动化构建工具。它不仅有助于简化构建流程，而且能够有效地协助我们管理和整合插件项目，确保开发的高效性和项目的稳定性。

 Gradle的安装及配置

        在我们正式开始创建插件之前，首先需要确保Gradle的正确安装和配置。对于MacOS用户来说，使用Homebrew进行安装是一个简单而高效的选择。首先，打开终端，并执行以下命令来安装Gradle。如果安装过程中出现了“success”的提示，那么Gradle已成功安装到你的系统中。这一步骤是整个开发过程中的基础，确保了后续工作的顺利进行。

brew install gradle

        成功安装到本地后，我们打开IntelliJ IDEA中的设置，将项目构建里的构建工具Gradle进行配置，在这里，你需要将构建工具的配置从默认设置调整为“本地安装”。具体操作是修改“分发”选项，将其指向你的本地Gradle安装路径，通常这个路径指向Gradle压缩包解压后的libexec文件夹。如下图所示，这一步骤将确保你的IDEA能够正确地识别并使用本地安装的Gradle，为接下来的插件开发提供必要的支持。

 项目创建

        接下来，我们将进入实际的项目创建阶段。在这一步骤中，需要特别注意IntelliJ IDEA的版本。如果您使用的是2023.2或更早的版本，可以直接在新建项目的界面中找到“IDE 插件”选项（因为在此版本之前，插件Devkit与IntelliJ IDEA是捆绑在一起的），如果在这之后，需要在插件市场中安装Plugin Devkit并重启。选择“IDE 插件”选项后，在右侧的类型中选择“插件”，然后选择合适的JDK版本即可顺利创建新的插件项目。如下图所示，这一流程简洁明了，允许您迅速进入插件开发的下一阶段。

进入项目自带demo

进入后点击右侧的运行配置，完成gradle的构建过程

        如果遇到报错，大概率就是在配置gradle的过程中出了问题，一定要设置分发的本地路径时，要一直精确到libexec目录下。成功的完成运行配置构建的结果如下

my_plugin
├── .run
│   └── Run IDE with Plugin.run.xml
├── gradle
│   └── wrapper
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── src
│   └── main
│       ├── kotlin
│       └── resources
│           └── META-INF
│               ├── plugin.xml
│               └── pluginIcon.svg
├── .gitignore
├── build.gradle.kts
├── gradle.properties
├── gradlew
├── gradlew.bat
└── settings.gradle.kts

准备工作完成

        本期的JetBrains插件开发的准备工作环节就已经全部完成了，下期我们将对项目自带demo中项目架构进行分析以及解释其中各文件的作用