IDEA Plugin 开发探索

pexels-photo-1116613

最近,在优化 APK 体积,压缩图片一般会使用 TinyPNG ,想着一张一张处理太麻烦,就搜索了一些批量处理的工具,有 gradle 脚本的,也有 IDEA 插件的,结果都不大理想,因此,想自己开发一个 TinyPNG 的插件。

IDEA 全称IntelliJ IDEA,是用于 java 语言开发的集成环境(也可用于其他语言),IntelliJ 在业界被公认为最好的java开发工具。

IDEA 的创造者,大名鼎鼎的 JetBreain 公司,同时还创造出许多 IT 界耳熟能详的开发工具,

例如:PyCharmWebStormPhpStorm ,还有谷歌维护的 Android Studio

这些工具有些需要收费,当然,网上也有很多免费的注册码,在线生成intellij idea注册码 (话题跑偏了~)

我们在使用这些集成环境时,通常会安装许多 Plugin,而这些插件也是可以自行开发的。

这里就以 TinyPNGGithub 地址)这个插件为例,记录下开发插件的过程。


搭建环境

插件开发,要用到IntelliJ Platform SDK 环境,所有一般使用到 IntelliJ IDEA点此下载

这里有两个版本,Community 是免费版,Ultimate 30 天免费使用,过后可以使用注册码。

两个版本都可以,下载安装完成后,打开

IntelliJ IDEA

选择新建项目 Create New Project

IntelliJ Platform Plugin

左边选择插件项目 IntelliJ Platform Plugin ,然后右边选择正确的插件环境,点击 Next ,填写项目名称以及存放位置。

项目创建完成后,目录很简单,这里放出 TinyPNG 的目录

plugin.xml

lib 目录是手动创建的目录,里面存放一些依赖库
src 目录存放项目代码
resources 目录中, plugin.xml 是整个插件的配置文件,很重要,下面给出 TinyPNG 中的 plugin.xml 文件部分代码

<idea-plugin>
  <id>cn.deemons.tinypng.plugin</id><!--插件id,不能和其他插件项目重复,推荐com.xxx.xxx的格式 -->
  <name>TinyPNG</name><!--插件名称 -->
  <version>1.3</version><!--插件版本号 -->
  <vendor email="deemonsch@gmail.com" url="https://deemons.cn">Deemons</vendor>
    <!--插件发布者信息,可以添加邮箱链接 -->
    
    <!--插件描述信息,在这里可以介绍你的插件内容,支持HTML标签 -->
  <description><![CDATA[
      <h1>TinyPNG</h1>
      <br/>
      <p><b>A plugin for compression picture by TinyPNG API.</b></p>
      <br/>
      <p><b>利用 TinyPNG 的 API ,开发的图片压缩工具,其中提供了一些 Key。</b></p>
      <p><b>欢迎大家留言,提供更多 API Key。</b></p>

    ]]>
  </description>

    <!--插件版本变更日志,支持HTML标签 -->
  <change-notes><![CDATA[
      <ul>
        <li>v1.3 fix some bug</li>
        <li>v1.2 add info</li>
        <li>v1.1 fix bug</li>
        <li>v1.0 init</li>
      </ul>
    ]]>
  </change-notes>

  <!-- 对IntelliJ IDEA软件支持本插件版本号 -->
  <idea-version since-build="145"/>

  <!-- please see http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/plugin_compatibility.html on how to target different products -->
  <!-- uncomment to enable plugin in all products
  -->
  <depends>com.intellij.modules.lang</depends>

  <!--自定义扩展,暂时用不到 -->
  <extensions defaultExtensionNs="com.intellij">
    <!-- Add your extensions here -->
  </extensions>

    <!--具体的插件动作,后面会介绍 -->
  <actions>
    <!-- Add your actions here -->
  </actions>

</idea-plugin>

这里填写的信息,会在别人搜索你插件的时候展现介绍

browse repositories


创建Action

在 src 下新建 Action

new action

然后,填写相关信息

Action

点击 ok 后,会在 src 目录下,自动生成对应的文件

public class Action extends AnAction {

    @Override
    public void actionPerformed(AnActionEvent e) {
        // TODO: insert action logic here
        // 每次点选此 Action,都会调用到这里
    }
}

同时,在插件的配置文件中 plugin.xml ,自动生成对应的 action

  <actions>
    <!-- Add your actions here -->
    <action id="Action" class="Action" text="Action" description="Action">
      <add-to-group group-id="CodeMenu" anchor="last"/>
    </action>
  </actions>

到此,插件的基本创建就结束了。

之后的编程,很大程度需要依赖 对 Java GUI Swing 的熟悉程度了,反正我是不熟悉的。

如果需要了解,创建弹窗、存储数据等知识,请参考

Android Studio Plugin 插件开发教程(一) —— 开发你的第一个插件

Android Studio插件开发1--环境搭建

这两个系列教程。

打包发布

在插件编写的工程中,需要查看效果,可以直接点击 run 按钮,它会重启一个新的 IDEA,然后随便进入一个项目,查看此插件的效果。

如果插件编写完成,这时候,可以直接打包插件,点击 Build -> Prepare Plugin Module...

prepare plugin

之后,会在项目目录下,生成一个 zip 文件,这个文件就是打包的插件。

这个插件,可以发布到插件市场,供其它人下载使用。

地址:https://plugins.jetbrains.com/
登录之后,就可以上传你的插件了

add new plugin

其中,LICENSE 需要填写协议证书地址,一般直接填写 http://www.apache.org/licenses/LICENSE-2.0

提交,上传成功后,需要一两天的审核时间,如果审核通过,就可以搜索到此插件了。


TinyPNG 这个插件以及上传,Github 地址

欢迎 start ,欢迎留言更多 API Key


参考

IntelliJ Platform SDK

AndroidStudio插件开发(Hello World篇)

【Intellij Idea 插件从入门到深坑】系列目录

学会编写Android Studio插件 别停留在用的程度了

手把手教你 Android Studio 插件从开发到发布官方

Android Studio Plugin 插件开发教程(一) —— 开发你的第一个插件

Android Studio插件开发1--环境搭建


©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 195,980评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,422评论 2 373
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 143,130评论 0 325
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,553评论 1 267
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,408评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,326评论 1 273
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,720评论 3 386
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,373评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,678评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,722评论 2 312
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,486评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,335评论 3 313
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,738评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,009评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,283评论 1 251
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,692评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,893评论 2 335

推荐阅读更多精彩内容