天天看点

idea 2020.2 如何设置classpath_开发属于自己的第一款 IDEA 插件!一、开发环境二、第一个插件三、参考资料

往期热门文章:

1、《往期精选优秀博文都在这里了!》2、又一个程序员跑路删库跑路被抓了,导致服务器瘫痪 36 个小时!3、恕我直言,有了这款 IDEA 插件,你可能只需要写 30% 的代码。。。4、Java8 的 Stream API 的确牛X,但性能究竟如何呢?5、关于MySQL索引面试题的6连炮!招架的住吗?6、真香!IDEA 最新版本,支持免打扰和轻量模式!

作者:木杉 来源:http://dwz.date/BxH 写Java代码的时候,经常会涉及到重复性的操作,这个时候就会想要是有这样一个插件就好了,如果是大家都会遇到的场景,IDE或许已经提供了,再不然也有可能有人编写了相关的插件。要是这个操作是你们的编码环境特有的,那就只能自己写工具了。所以这里来学学如何编写IDEA插件,让自己的编程环境更加强大,更好的进行装逼。

一、开发环境

开发IDEA插件有以下这些依赖:

  • IntelliJ IDEA Community Edition
  • IntelliJ IDEA Community Edition 源码
  • Plugin DevKit 插件
  • IntelliJ Platform SDK

1.1、安装IntelliJ IDEA Community Edition

你可能已经安装了Ultimate版本,但是你还是需要安装IDEA的社区版本。 因为商业版是闭源的,所以在调试时无法调试核心代码。

1.2、下载IntelliJ IDEA Community Edition源码

社区版的安装包里是不包含源码的,所以我们需要手动从github上clone一份:

git clone --depth 1 git://git.jetbrains.org/idea/community.git idea
           

关于从源码运行IDEA的方法参考 Check Out And Build Community Edition: http://www.jetbrains.org/intellij/sdk/docs/basics/checkout_and_build_community.html

1.3、添加IDEA jdk

虽然不知道原因,但是根据Check Out And Build Community Edition: http://www.jetbrains.org/intellij/sdk/docs/basics/checkout_and_build_community.html 我们需要建立一个

IDEA jdk

来运行插件:

idea 2020.2 如何设置classpath_开发属于自己的第一款 IDEA 插件!一、开发环境二、第一个插件三、参考资料

除非你在Mac上使用官方JDK,否则你需要手动添加

/lib/tools.jar

到classpath中。

1.4、配置IntelliJ Platform SDK

打开

File | Project Structure

新建一个

IntelliJ Platform SDK

idea 2020.2 如何设置classpath_开发属于自己的第一款 IDEA 插件!一、开发环境二、第一个插件三、参考资料

 Java SDK选择我们刚刚建立的

IDEA jdk

idea 2020.2 如何设置classpath_开发属于自己的第一款 IDEA 插件!一、开发环境二、第一个插件三、参考资料

 然后我们可以把下载的IDEA社区版源码添加到源码路径中,这样在调试时,就可以调试IDEA自身的代码了:

idea 2020.2 如何设置classpath_开发属于自己的第一款 IDEA 插件!一、开发环境二、第一个插件三、参考资料

idea 2020.2 如何设置classpath_开发属于自己的第一款 IDEA 插件!一、开发环境二、第一个插件三、参考资料

二、第一个插件

我们来编写一个最简单的插件来学习编写一个插件的完整步骤。

2.1、新建工程

选择

IntellJ Platform Plugin

,然后Project SDK指定刚刚新建的plugin sdk:

idea 2020.2 如何设置classpath_开发属于自己的第一款 IDEA 插件!一、开发环境二、第一个插件三、参考资料

新建的插件项目:

idea 2020.2 如何设置classpath_开发属于自己的第一款 IDEA 插件!一、开发环境二、第一个插件三、参考资料

 插件根目录下有两个目录

src

resources

src

是插件代码目录,

resource

是插件资源目录,其中

META-INF/plugin.xml

是插件的描述文件,就像Java web项目的

web.xml

一样。 plugin.xml默认的内容如下:

com.your.company.unique.plugin.id  Plugin display name here  1.0  "[email protected]" url="http://www.yourcompany.com">YourCompany[   //mp.weixin.qq.com/s/PiAxqEhkR8g1AOYGGS5Yqw)      Enter short description for your plugin here.      most HTML tags may be used    ]]>[   //mp.weixin.qq.com/s/PiAxqEhkR8g1AOYGGS5Yqw)      Add change notes here.      most HTML tags may be used    ]]>      "145.0"/>      "com.intellij">              
           

2.2、新建一个Action

插件扩展IDEA最常见的方式就是在菜单栏或者工具栏中添加菜单项,用户通过点击菜单项来触发插件功能。 IDEA提供了

AnAction

类,这个类有一个虚方法

actionPerformed

,这个方法会在每次菜单被点击时调用。 新建一个自定义的Action有两个步骤:

  1. 继承

    AnAction

    类,在

    actionPerformed

    方法中实现插件逻辑
  2. 注册action,有两种方式,通过代码注册和通过

    plugin.xml

    注册

我们先写一个简单的Action类:

publicclass TextBoxes extends AnAction {// 如果通过Java代码来注册,这个构造函数会被调用,传给父类的字符串会被作为菜单项的名称// 如果你通过plugin.xml来注册,可以忽略这个构造函数public TextBoxes() {// 设置菜单项名称super("Text _Boxes");// 还可以设置菜单项名称,描述,图标// super("Text _Boxes","Item description",IconLoader.getIcon("/Mypackage/icon.png"));    }public void actionPerformed(AnActionEvent event) {        Project project = event.getData(PlatformDataKeys.PROJECT);        String txt= Messages.showInputDialog(project, "What is your name?", "Input your name", Messages.getQuestionIcon());        Messages.showMessageDialog(project, "Hello, " + txt + "!\n I am glad to see you.", "Information", Messages.getInformationIcon());    }}
           

然后我们在

plugin.xml

中注册这个Action:

"MyPlugin.SampleMenu" text="_Sample Menu" description="Sample menu">    "MainMenu" anchor="last"  />       "Myplugin.Textboxes"class="Mypackage.TextBoxes" text="Text _Boxes" description="A test menu item" />  
           

这里我们新建了一个菜单组,其中text字符串的下划线表示这个字母作为快捷键。这个菜单显示的效果如下:

idea 2020.2 如何设置classpath_开发属于自己的第一款 IDEA 插件!一、开发环境二、第一个插件三、参考资料

 除了手动新建Action,IDEA还提供了快速新建的方法,在代码目录上点击新建,可以看到Action:

idea 2020.2 如何设置classpath_开发属于自己的第一款 IDEA 插件!一、开发环境二、第一个插件三、参考资料

 可以在这个面板中填写你要新建的Action信息,IDEA会帮你新建类,还有在plugin.xml中帮你注册:

idea 2020.2 如何设置classpath_开发属于自己的第一款 IDEA 插件!一、开发环境二、第一个插件三、参考资料

2.3、运行插件

运行插件特别简单,和运行普通Java代码一样,点击运行或者调试的按钮,就会启动一个新的IDEA实例,这个实例中插件是生效的。 点击Text Boxes就可以看到插件的效果了。

三、参考资料

  • Setting Up a Development Environment
  • How to make an IntelliJ IDEA plugin in less than 30 minutes

往期热门文章:

1、《历史文章分类导读列表!精选优秀博文都在这里了!》2、关于MySQL索引面试题的6连炮!招架的住吗?3、MyBatis她不香吗?为啥老外却喜欢Hibernate/Jpa?4、代码对比工具,我就用这7个!5、Mybatis 中经典的 9 种设计模式!面试可以吹牛了!6、海量交易订单查询没做“重试”,一哥们“喜提”P3故障!7、2020年Java框架排行榜,谁居榜首?8、格式化时间用了YYYY-MM-dd,元旦当天老板喊我回去改Bug!9、除了 P 站,程序员在摸鱼时还喜欢上这些网站...10、39 个奇葩代码注释,看完笑哭了。。。

idea 2020.2 如何设置classpath_开发属于自己的第一款 IDEA 插件!一、开发环境二、第一个插件三、参考资料

继续阅读