开发idea插件教程

效果

自己也编写了一个代码生成器插件并发布到了仓库中，可以直接搜索“Neo Coder”，开发的这个插件是位于Tool Windows里面的，如下

要功能，就是根据建表语句，直接生成DO和DAO层的代码，不过其中的Orm框架采用的是框架Neo：
https://github.com/SimonAlong/Neo
下面讲述下，如果创建自己的idea插件
插件源码在这里：
https://github.com/simonalong/NeoCoderPlugin

1.建项目

创建idea插件项目很简单，idea对应的项目就有，如下


其中plugin.xml就是idea给我们的配置文件，后续要将我们的插件在哪些位置限制，都在该文件中配置即可

2.写代码

项目创建完毕就可以开发我们自己的插件了，插件的开发可以根据idea的插件包，进行快速的开发

编写基本代码

我们这里创建Action，该Action就是一个动作

创建Action

添加之后，在plugin.xml中就有如下的配置

<actions>
  <!-- Add your actions here -->
  <action id="test" class="com.simonalong.test.test" text="test" description="test">
    <add-to-group group-id="ViewMenu" anchor="first"/>
  </action>
</actions>

对应的test类

public class test extends AnAction {

    @Override
    public void actionPerformed(AnActionEvent e) {
		Project project = e.getData(PlatformDataKeys.PROJECT);
        Messages.showMessageDialog(project, "helloword", "test", Messages.getInformationIcon());
    }
}

3.调试

在配置中，如下，直接运行即可，运行会重新启动一个新的idea，记得新的idea也是需要激活才行，所以用一些激活码激活即可（怎么获取你懂得）

在这里就有我们添加的，其中文案对应的就是我们上面的text


注意：
如果重新打开，有些时候 Use classpath of module显示为[none]，如果是这种情况请看后面的问题

4.试用

当我们开发完我们的，我们就可以将我们的程序发布出去，但是在发布之前，我们可以给其他小伙伴或者自己的其他程序先安装试用下，这个时候只需要build出来我们自己的jar包，然后安装到我们的插件库就可以了

编写插件对外文案

如果不编辑则采用的就是默认的

打包

打包出来如下

本地安装

打包之后，只需要将如上的jar包安装即可，如下

从本地安装即可

5.发布

当也试用完毕后，没什么问题，就可以将自己的插件发布到idea的市场上面
https://plugins.jetbrains.com/plugin/add#teamcity

如果发布成功，比如如下，而且会有一封邮件，表示插件会进行审核，在1~2个工作日之后才会对外公开

6.问题

1.idea插件项目再次打开时候无法运行

原因是idea会将打开的项目默认为java项目，只需要手动将根目录下面的.idea文件下的*.iml中的Model从"JAVA_MODULE"修改为"PLUGIN_MODULE"即可，就可以运行了

2.编译启动上报错误

Plugin Error
Problems found loading plugins:
Duplicate plugin id:com.your.company.unique.plugin.id

我这里其实是修改了自己的plugin id的，但是不知道为什么还有上面这个错误，后来重新创建了一个项目，将代码都拷贝过去，然后就好了

3.发布时候报如下问题

Invalid plugin descriptor 'plugin.xml': value of <description> must not have default 'Enter short description for your plugin here.' or 'most HTML tags may be used'

发现自己的描述中有如下这么一句话，这句话是之前旧的描述，我只是在上面添加了一行，删除就可以了

<em>most HTML tags may be used</em>

4.发布时候上报问题

Plugin has no dependencies. Please check the documentation.

只需要将plugin.xml下面的注释取消即可

  <!-- 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>
  -->

或者将下面的添加即可

  <depends>com.intellij.modules.lang</depends>

补充：

1.编写界面

对于需要编写界面的部分，可以采用Swing的手写方式，也可以采用idea提供的这个界面拖拽公共。
前面调用部分写完之后，就可以在idea点击了，但是没有界面的话，还是不好交互，我们直接用idea中的拖拽方式进行开发界面即可

创建完就如下，然后就可以在上面通过拖拽的方式，开发自己的界面了

提示：
开发后界面的查看可以直接点击右键预览，不用启动也可以看界面效果，只能看界面效果不能看功能

官方文档

https://jetbrains.org/intellij/sdk/docs/intro/welcome.html