用gradle开发IDEA插件_idea plugin gradel

之前维护过IDEA插件GenerateO2O （GenerateO2O - IntelliJ IDEs Plugin | Marketplace），主要用来解决在分层架构中，每一层的对象装换的问题，比如DTO转换成DO，或者反过来。这个其实在字段数量很多，而且大部分长得一样的时候非常消耗人肉时间，而且容易错漏部分字段。当然可以使用类似Dozer这类动态BeanMapper工具。 但是这类工具的转换工作是黑盒的，实际使用中还是存在挺多问题，后面就在规范中规定不允许使用这类工具。这个插件的初衷就是尽量减少维护机械代码的时间，提升编码效率。插件上线之后一直运行的不错，但是最近发现在新版idea（IDEA2020）上会报错 explicitly marked as incompatible ，并且被直接失效。

环境搭建：

      整个项目已经过去好多年了，之前开发方式是用的DevKit，jetbrain家自己的一套工具，整体还算方便，但是带来的问题是缺少依赖管理，如果你需要使用其他jar包就要一个个手动加入到插件工程里面，比较原始。现在jetbrain 已经推荐使用gradle 的方式来组织项目了，所以整体结构跨度比较大，加上原来的代码比较简单就一个文件，直接开了一个新的项目来管理。首先是要确保IDEA 已经装好了DevKit 和Gradle 插件。参考 Building Plugins with Gradle | IntelliJ Platform Plugin SDK ，新建一个Gradle工程。记得选中Platform Plugin，接着Next，输入项目名称点击Finish就完事了。

建完之后的工程差不多长这样：

核心配置：

首先要关注的是build.gradle，这里的配置很重要，因为很多关键的信息和运行环境都依赖这个配置。

plugins {
    id 'java'
    id 'org.jetbrains.intellij' version '0.7.3'
}

根据上面的文档配置gradle-intellij-plugin插件，最新版本可以查询 Releases · JetBrains/gradle-intellij-plugin · GitHub。  

intellij {
    plugins = ['com.intellij.java']
    version '2020.1.1'
    sandboxDirectory = "$project.buildDir/myCustom-sandbox"
}

因为IDEA2019版本之后将com.intellij.java 从默认基础底层剥离了（大概就是这么个意思吧），导致很多依赖java结构的psi接口都会找不到。所以这里很重要的是在intellij里添加上这块的依赖。同时注意这里的version指定了插件依赖的IDEA版本，这块也是后续运行沙箱环境使用的IDEA版本。配置完成后刷新一下依赖，这个时候会花较长时间去下载相应的依赖以及idea 虚拟环境，网上很多文章反馈网络差一点的会超时，然后就失败了。如果出现这种情况需要自己下载对应的文件并放到本地gradle的对应目录下。我下载的时候还行，稍微等了一会，最终还是下载好了。

    接下来就是开发了，在src main java 下新建一个action，然后开发自己的逻辑就行了。这里把原来的代码搬过来之后发现部分api调整了，好在psi的部分整体基本没有变动。

psi相关关的开发技巧：·

1.IDEA自带的PSI 查看器

在idea.properties 里面配置

idea.is.internal=true

 就可以在Tools菜单中看到

拿当前文件举例

你就能直观的看到都有哪些元素，这些元素分别负责什么，这对于你后面对这些结构进行组织有很大帮助。

2.psiViewer插件

这个是第三方开发的插件，能够跟上面那个插件很好的互补。他是能够方便的看到代码对应psi元素。上面的插件能够方面看到元素对应的代码范围。

运行调试：

利用gradle 直接debug runIde选项就可以debug，但是gradle 任务会先去下载一个JBR ，用于idea运行环境，可以参考 IDEA插件开发笔记001环境搭建（使用Gradle插件方式） - 一杯半盏 - 博客园

这个时候通常在当前的gradle 中是下载不成功的，可以通过浏览器执行下载。将下载的tar.gz文件放入本地的gradle的cache中 ，在本机上是

~/.gradle/caches/modules-2/files-2.1/com.jetbrains/jbre

然后重新启动，就不会需要再去下载了。

打包发布：

这里没有使用gradle 插件直接发布，因为需要配置账号密码，开源的一般不建议这么做。关于打包还有一个比较重要的配置是版本问题，我第一次打包的时候就出现了，打出来的包没办法用，提示版本不匹配。在build.gradle 中配置最低支持版本，和最高支持版本

patchPluginXml {
    //最低支持的版本
    //版本参考：https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html?from=jetbrains.org#intellij-platform-based-products-of-recent-ide-versions
    sinceBuild '201'
    //最高支持的版本，不能不设置，不设置是默认为 project.version
    untilBuild ''
    changeNotes """
      2.0版本.<br>
      针对2020版本的更新，主要修复了2020版本及更高版本报explicitly marked as incompatible的问题.<br>
      使用了新的gradle来创建插件.<br>
      """
}

这里要注意的是untilBuild 必须设置，不然就会使用project.version ，这样达不到我们希望最高支持版本不限制的目的。

总结：开发一个简单的插件还是挺容易的，网上也有比较多的入门文章，但是具体到一个比较可用的插件，这些入门文章还是远远不够的。这个时候就需要多参考官方的文档，这里不得不吐槽下官方文档的使用体验比较糟糕，一些问题还是从社区答疑里得到解决。

参考链接：

AS 自定义插件 总结 ：AS 自定义插件 总结 [MD] - 白乾涛 - 博客园

IDEA插件开发：一个简单的表单demo ：IDEA插件开发（一）一个简单的表单demo - 胖虎1993 - 博客园

IDEA插件开发教程： IntelliJ IDEA插件开发教程_纵横wan的博客-CSDN博客_idea插件开发教程

IDEA插件开发视频教程： 42. IntelliJ IDEA 插件开发视频教程 - IntelliJ-IDEA-Tutorial

IDEA插件开发指南： https://www.yuque.com/xjt2016/xd2ir5

IntelliJ Platform SDK : IntelliJ Platform SDK | IntelliJ Platform Plugin SDK

IntelliJ Platform SDK 中文：IntelliJ Platform SDK / IntelliJ Platform SDK DevGuide  （有点机翻的味道）

IDEA 插件开发入门教程：IDEA 插件开发入门教程 - 掘金 （讲了一点进阶内容）

编写一个IDEA插件之：自动生成Java代码： 编写一个IDEA插件之：自动生成Java代码 - 知乎