135-1821-9792

一时兴起，自己动手开发了个IDEA插件！

前言

最近工作比较闲，自己琢磨点东西，一时兴起想自己做个IDEA插件玩玩，说不定还能卖钱，哈哈。

成都创新互联公司主要从事成都网站建设、成都网站设计、网页设计、企业做网站、公司建网站等业务。立足成都服务五寨,十年网站建设经验,价格优惠、服务专业,欢迎来电咨询建站服务:18980820575

版本工具

  • 说明JDK1.8
  • IDEA2020.1
  • 插件项目基于gradle构建。
  • 知识背景：swing

达到什么目标?

本实例实现一个Idea的插件，弹出一个表单Dialog，然后点击按钮，获取表单里输入的内容，然后将内容打印在表单的上方。

成品图展示：

项目初始化

新建一个gradle项目，修改其build.gradle文件：

 
 
 
 
    
  
  
  
  
  1. plugins { 
    2.   
  
  
  
  2.     id 'java' 
    3.   
  
  
  
  3.     id 'org.jetbrains.intellij' version '0.4.14' //引入intellij的gradle插件 
    4.   
  
  
  
  4. } 
    5.   
  
  
  
  5.   
    6.   
  
  
  
  6. group 'org.example' 
    7.   
  
  
  
  7. version '1.0' //定义jar包/zip包的版本号 
    8.   
  
  
  
  8.   
    9.   
  
  
  
  9. sourceCompatibility = 1.8 //限制jdk的使用版本号，这里限制到8，表示生成的idea插件只能运行在jdk8以上的环境中 
    10.   
  
  
  
  10.   
    11.   
  
  
  
  11. repositories { 
    12.   
  
  
  
  12.     mavenCentral() //远程仓库 
    13.   
  
  
  
  13. } 
    14.   
  
  
  
  14.   
    15.   
  
  
  
  15. dependencies { 
    16.   
  
  
  
  16.     //这里引别的依赖包 
    17.   
  
  
  
  17.     testCompile group: 'junit', name: 'junit', version: '4.12' 
    18.   
  
  
  
  18. } 
    19.   
  
  
  
  19.   
    20.   
  
  
  
  20. // See https://github.com/JetBrains/gradle-intellij-plugin/ 
    21.   
  
  
  
  21. intellij { 
    22.   
  
  
  
  22.     // 这里是指打插件包的时候用idea什么版本的依赖包打 
    23.   
  
  
  
  23.     // 比如这里用2019.3打包，如果你的插件实现源码里用了2019.3不存在的依赖包或类，就会报错 
    24.   
  
  
  
  24.     // 一般就填当前IDEA的版本号即可 
    25.   
  
  
  
  25.     version "2019.3" 
    26.   
  
  
  
  26. } 
    27.   
  
  
  
  27.   
    28.   
  
  
  
  28. patchPluginXml { 
    29.   
  
  
  
  29.   
    30.   
  
  
  
  30.     //changeNotes里的内容展示位置参考图14 
    31.   
  
  
  
  31.     changeNotes """ 
    32.   
  
  
  
  32.       1.0版本. 
    33.   
  
  
  
  33.  
    34.   
  
  
  
  34.       第1.0版本：初始化这个测试插件项目""" 
    35.   
  
  
  
  35.   
    36.   
  
  
  
  36.     // 这个意思是说当前定义的这个插件最早支持到什么版本的IDEA 
    37.   
  
  
  
  37.     // 这里配置sinceBuild=191，表示插件只能被版本号大于等于2019.1版本的IDEA安装，低于这个版本的将抛无法兼容的错误 
    38.   
  
  
  
  38.     // ↑上方参考这篇问答：https://intellij-support.jetbrains.com/hc/en-us/community/posts/360003338799-Build-compatible-plugin 
    39.   
  
  
  
  39.     sinceBuild "191" 
    40.   
  
  
  
  40. } 
    41.

然后Idea的右边栏gradle将会多出intellij选项：

“这里说下runIde，它用来调试插件，运行它会再次启动一个Idea，这个Idea会自动安装上你当前定义的插件包，让你用来调试。

新增plugin.xml

这个文件非常重要，它可以指定你定义的插件出现在IDEA的哪个位置，可以指定具体的处理逻辑，还可以定义插件名称、子名称等等。

这个文件位于MATE-INF下：

配置内容为：

 
 
 
 
    
  
  
  
  
  1.  
    2.   
  
  
  
  2.      
    3.   
  
  
  
  3.     plugin.test 
    4.   
  
  
  
  4.      
    5.   
  
  
  
  5.     PluginTest 
    6.   
  
  
  
  6.     你公司的名字 
    7.   
  
  
  
  7.  
    8.   
  
  
  
  8.      
    9.   
  
  
  
  9.       
  
  
  
  10.     Plugin Test
     
    11.   
  
  
  
  11.     第一行：单纯只是个测试
     
    12.   
  
  
  
  12.     第二行：都说了只是个测试(●￣(ｴ)￣●)
     
    13.   
  
  
  
  13.     你猜猜这是哪个网站？ 
    14.   
  
  
  
  14.     v1.0 
    15.   
  
  
  
  15.     ]]> 
    16.   
  
  
  
  16.      
    17.   
  
  
  
  17.      
    18.   
  
  
  
  18.          
    19.   
  
  
  
  19.      
    20.   
  
  
  
  20.  
    21.   
  
  
  
  21.      
    22.   
  
  
  
  22.      
    23.   
  
  
  
  23.  
    24.   
  
  
  
  24.      
    25.   
  
  
  
  25.          
    26.   
  
  
  
  26.          
    27.   
  
  
  
  27.              
    28.   
  
  
  
  28.              
    29.   
  
  
  
  29.              
    30.   
  
  
  
  30.               
  
  
  
  31.                     class="plugin.test.FromAction" 
    32.   
  
  
  
  32.                     text="表单测试" description="表单测试描述"/> 
    33.   
  
  
  
  33.          
    34.   
  
  
  
  34.      
    35.   
  
  
  
  35.  
    36.

然后定义一个Action类，记为FormAction，继承AnAction，实现其抽象方法actionPerformed即可：

 
 
 
 
    
  
  
  
  
  1. public class FromAction extends AnAction { 
    2.   
  
  
  
  2.     @Override 
    3.   
  
  
  
  3.     public void actionPerformed(@NotNull AnActionEvent e) { 
    4.   
  
  
  
  4.         //TODO 这里放插件逻辑 
    5.   
  
  
  
  5.     } 
    6.   
  
  
  
  6. } 
    7.

启动

现在双击runIde即可调出另外一个安装了这个插件的IDEA界面，然后可以看运行结果进行调试。runIde还支持debug模式，不过运行时要右击选择：

来看下调试IDEA的界面运行效果：

定义Action

1. 定义会话框类

经过上面三步的配置，插件的基本样式已经展示出来，但是点击下方“表单测试”的action，并没有什么用，因为其绑定的FormAction类里没有任何有意义的实现。现在来实现开始的目标，点击“表单测试”后，弹出一个自定义的表单会话框，然后点击按钮，获取表单内容后打印在会话框内。

会话框(Dialog)需要定义一个继承了IDEA的DialogWrapper抽象类的子类，这个子类就是自定义的会话框实现，所有的样式定义、功能触发都是放到这个子类里的，现定于如下子类：

 
 
 
 
    
  
  
  
  
  1. public class FormTestDialog extends DialogWrapper { 
    2.   
  
  
  
  2.   
    3.   
  
  
  
  3.     private String projectName; //假如需要获取到项目名，作为该类的属性放进来 
    4.   
  
  
  
  4.   
    5.   
  
  
  
  5.     // DialogWrapper没有默认的无参构造方法，所以需要重写构造方法，它提供了很多重载构造方法， 
    6.   
  
  
  
  6.     // 这里使用传project类型参数的那个，通过Project对象可以获取当前IDEA内打开的项目的一些属性， 
    7.   
  
  
  
  7.     // 比如项目名，项目路径等 
    8.   
  
  
  
  8.     public FormTestDialog(@Nullable Project project) { 
    9.   
  
  
  
  9.         super(project); 
    10.   
  
  
  
  10.         setTitle("表单测试~~"); // 设置会话框标题 
    11.   
  
  
  
  11.         this.projectName = project.getName(); 
    12.   
  
  
  
  12.     } 
    13.   
  
  
  
  13.   
    14.   
  
  
  
  14.     // 重写下面的方法，返回一个自定义的swing样式，该样式会展示在会话框的最上方的位置 
    15.   
  
  
  
  15.     @Override 
    16.   
  
  
  
  16.     protected JComponent createNorthPanel() { 
    17.   
  
  
  
  17.         return null; 
    18.   
  
  
  
  18.     } 
    19.   
  
  
  
  19.   
    20.   
  
  
  
  20.     // 重写下面的方法，返回一个自定义的swing样式，该样式会展示在会话框的最下方的位置 
    21.   
  
  
  
  21.     @Override 
    22.   
  
  
  
  22.     protected JComponent createSouthPanel() { 
    23.   
  
  
  
  23.         return null; 
    24.   
  
  
  
  24.     } 
    25.   
  
  
  
  25.   
    26.   
  
  
  
  26.     // 重写下面的方法，返回一个自定义的swing样式，该样式会展示在会话框的中央位置 
    27.   
  
  
  
  27.     @Override 
    28.   
  
  
  
  28.     protected JComponent createCenterPanel() { 
    29.   
  
  
  
  29.         return null; 
    30.   
  
  
  
  30.     } 
    31.   
  
  
  
  31. } 
    32.

2. 会话框模块&类元素对照

找个实际的会话框为例，针对上述中几个方法所控制的会话框里的元素如下：

3. 会话框方法重定义

按照本文的实现目标，自定义的表单主体部分可以位于createCenterPanel里，然后表单的大标题可以放到createNorthPanel里，提交按钮可以放到createSouthPanel里，现在改写如下：

 
 
 
 
    
  
  
  
  
  1. public class FormTestDialog extends DialogWrapper { 
    2.   
  
  
  
  2.   
    3.   
  
  
  
  3.     private String projectName; 
    4.   
  
  
  
  4.       
    5.   
  
  
  
  5.     //swing样式类，定义在4.3.2 
    6.   
  
  
  
  6.     private FormTestSwing formTestSwing = new FormTestSwing(); 
    7.   
  
  
  
  7.   
    8.   
  
  
  
  8.     public FormTestDialog(@Nullable Project project) { 
    9.   
  
  
  
  9.         super(true); 
    10.   
  
  
  
  10.         setTitle("表单测试~~"); //设置会话框标题 
    11.   
  
  
  
  11.         this.projectName = project.getName(); //获取到当前项目的名称 
    12.   
  
  
  
  12.         init(); //触发一下init方法，否则swing样式将无法展示在会话框 
    13.   
  
  
  
  13.     } 
    14.   
  
  
  
  14.   
    15.   
  
  
  
  15.     @Override 
    16.   
  
  
  
  16.     protected JComponent createNorthPanel() { 
    17.   
  
  
  
  17.         return formTestSwing.initNorth(); //返回位于会话框north位置的swing样式 
    18.   
  
  
  
  18.     } 
    19.   
  
  
  
  19.   
    20.   
  
  
  
  20.     // 特别说明：不需要展示SouthPanel要重写返回null，否则IDEA将展示默认的"Cancel"和"OK"按钮 
    21.   
  
  
  
  21.     @Override 
    22.   
  
  
  
  22.     protected JComponent createSouthPanel() { 
    23.   
  
  
  
  23.         return formTestSwing.initSouth(); 
    24.   
  
  
  
  24.     } 
    25.   
  
  
  
  25.   
    26.   
  
  
  
  26.     @Override 
    27.   
  
  
  
  27.     protected JComponent createCenterPanel() { 
    28.   
  
  
  
  28.         //定义表单的主题，放置到IDEA会话框的中央位置 
    29.   
  
  
  
  29.         return formTestSwing.initCenter(); 
    30.   
  
  
  
  30.     } 
    31.   
  
  
  
  31. } 
    32.

4. 自定义swing样式

下面是放置swing样式的类：

 
 
 
 
    
  
  
  
  
  1. public class FormTestSwing { 
    2.   
  
  
  
  2.   
    3.   
  
  
  
  3.     private JPanel north = new JPanel(); 
    4.   
  
  
  
  4.   
    5.   
  
  
  
  5.     private JPanel center = new JPanel(); 
    6.   
  
  
  
  6.   
    7.   
  
  
  
  7.     private JPanel south = new JPanel(); 
    8.   
  
  
  
  8.   
    9.   
  
  
  
  9.     //为了让位于底部的按钮可以拿到组件内容，这里把表单组件做成类属性 
    10.   
  
  
  
  10.     private JLabel r1 = new JLabel("输出："); 
    11.   
  
  
  
  11.     private JLabel r2 = new JLabel("NULL"); 
    12.   
  
  
  
  12.   
    13.   
  
  
  
  13.     private JLabel name = new JLabel("姓名："); 
    14.   
  
  
  
  14.     private JTextField nameContent = new JTextField(); 
    15.   
  
  
  
  15.   
    16.   
  
  
  
  16.     private JLabel age = new JLabel("年龄："); 
    17.   
  
  
  
  17.     private JTextField ageContent = new JTextField(); 
    18.   
  
  
  
  18.   
    19.   
  
  
  
  19.     public JPanel initNorth() { 
    20.   
  
  
  
  20.   
    21.   
  
  
  
  21.         //定义表单的标题部分，放置到IDEA会话框的顶部位置 
    22.   
  
  
  
  22.   
    23.   
  
  
  
  23.         JLabel title = new JLabel("表单标题"); 
    24.   
  
  
  
  24.         title.setFont(new Font("微软雅黑", Font.PLAIN, 26)); //字体样式 
    25.   
  
  
  
  25.         title.setHorizontalAlignment(SwingConstants.CENTER); //水平居中 
    26.   
  
  
  
  26.         title.setVerticalAlignment(SwingConstants.CENTER); //垂直居中 
    27.   
  
  
  
  27.         north.add(title); 
    28.   
  
  
  
  28.   
    29.   
  
  
  
  29.         return north; 
    30.   
  
  
  
  30.     } 
    31.   
  
  
  
  31.   
    32.   
  
  
  
  32.     public JPanel initCenter() { 
    33.   
  
  
  
  33.   
    34.   
  
  
  
  34.         //定义表单的主体部分，放置到IDEA会话框的中央位置 
    35.   
  
  
  
  35.   
    36.   
  
  
  
  36.         //一个简单的3行2列的表格布局 
    37.   
  
  
  
  37.         center.setLayout(new GridLayout(3, 2)); 
    38.   
  
  
  
  38.   
    39.   
  
  
  
  39.         //row1：按钮事件触发后将结果打印在这里 
    40.   
  
  
  
  40.         r1.setForeground(new Color(255, 47, 93)); //设置字体颜色 
    41.   
  
  
  
  41.         center.add(r1); 
    42.   
  
  
  
  42.         r2.setForeground(new Color(139, 181, 20)); //设置字体颜色 
    43.   
  
  
  
  43.         center.add(r2); 
    44.   
  
  
  
  44.   
    45.   
  
  
  
  45.         //row2：姓名+文本框 
    46.   
  
  
  
  46.         center.add(name); 
    47.   
  
  
  
  47.         center.add(nameContent); 
    48.   
  
  
  
  48.   
    49.   
  
  
  
  49.         //row3：年龄+文本框 
    50.   
  
  
  
  50.         center.add(age); 
    51.   
  
  
  
  51.         center.add(ageContent); 
    52.   
  
  
  
  52.   
    53.   
  
  
  
  53.         return center; 
    54.   
  
  
  
  54.     } 
    55.   
  
  
  
  55.   
    56.   
  
  
  
  56.     public JPanel initSouth() { 
    57.   
  
  
  
  57.   
    58.   
  
  
  
  58.         //定义表单的提交按钮，放置到IDEA会话框的底部位置 
    59.   
  
  
  
  59.   
    60.   
  
  
  
  60.         JButton submit = new JButton("提交"); 
    61.   
  
  
  
  61.         submit.setHorizontalAlignment(SwingConstants.CENTER); //水平居中 
    62.   
  
  
  
  62.         submit.setVerticalAlignment(SwingConstants.CENTER); //垂直居中 
    63.   
  
  
  
  63.         south.add(submit); 
    64.   
  
  
  
  64.   
    65.   
  
  
  
  65.         return south; 
    66.   
  
  
  
  66.     } 
    67.   
  
  
  
  67. } 
    68.

现在点击下runIde按钮，同样的，在调试IDE里点击“表单测试”，然后就会弹出如下表单框：

“除非有特殊情况需要自定义swing样式，否则建议不加任何swing样式，这样自定义的swing界面是会随着IDEA的主题改变而去自适应的，比如将图7中的调试IDE的主题设置成Darcula，自定义的表单也会自适应的变成黑色背景：

5. 事件绑定

定义好了样式，现在给“提交”按钮绑定一个事件，现在改写下FormTestSwing.initSouth方法：

 
 
 
 
    
  
  
  
  
  1. public JPanel initSouth() { 
    2.   
  
  
  
  2.   
    3.   
  
  
  
  3.     //定义表单的提交按钮，放置到IDEA会话框的底部位置 
    4.   
  
  
  
  4.   
    5.   
  
  
  
  5.     JButton submit = new JButton("提交"); 
    6.   
  
  
  
  6.     submit.setHorizontalAlignment(SwingConstants.CENTER); //水平居中 
    7.   
  
  
  
  7.     submit.setVerticalAlignment(SwingConstants.CENTER); //垂直居中 
    8.   
  
  
  
  8.     south.add(submit); 
    9.   
  
  
  
  9.   
    10.   
  
  
  
  10.     //按钮事件绑定 
    11.   
  
  
  
  11.     submit.addActionListener(e -> { 
    12.   
  
  
  
  12.         //获取到name和age 
    13.   
  
  
  
  13.         String name = nameContent.getText(); 
    14.   
  
  
  
  14.         String age = ageContent.getText(); 
    15.   
  
  
  
  15.         //刷新r2标签里的内容，替换为name和age 
    16.   
  
  
  
  16.         r2.setText(String.format("name:%s, age:%s", name, age)); 
    17.   
  
  
  
  17.     }); 
    18.   
  
  
  
  18.   
    19.   
  
  
  
  19.     return south; 
    20.   
  
  
  
  20. } 
    21.

现在再来点击下“提交”按钮，就可以输出表单内容了：

6. 插件绑定类：FormAction

之前讲过，这个类是插件的入口，结合上面定义好的表单Dialog，来看下它是怎么写的：

 
 
 
 
    
  
  
  
  
  1. public class FromAction extends AnAction { 
    2.   
  
  
  
  2.     @Override 
    3.   
  
  
  
  3.     public void actionPerformed(@NotNull AnActionEvent e) { 
    4.   
  
  
  
  4.         FormTestDialog formTestDialog = new FormTestDialog(e.getProject()); 
    5.   
  
  
  
  5.         formTestDialog.setResizable(true); //是否允许用户通过拖拽的方式扩大或缩小你的表单框，我这里定义为true，表示允许 
    6.   
  
  
  
  6.         formTestDialog.show(); 
    7.   
  
  
  
  7.     } 
    8.   
  
  
  
  8. } 
    9.

7. 插件的打包&安装

截止到第四步，都只是在调试IDE里查看效果，如果一个插件开发完成后，需要被实际的IDEA安装，这个时候就需要借助打包选项来打包你的插件，点击下面的选项构建插件：

构建完成后，查看build包下的distributions目录，里面的zip包就可以直接安装进你的IDEA：

然后选择IDEA的Preferences下的plugins选项，弹出如下框，按照图里的指示选择zip包安装即可：

然后安装完成，重启IDEA即可：

各个展示模块对应插件项目里配置的来源参考下图：

重启后出现了跟调试IDEA里一样的菜单栏，选中后运行成功：

总结

截止到这里，一个插件的开发、调试、安装就完成了，理论上通过这个简单的例子就可以实现一些实际的功能了，因为其完整展示了数据输入到数据获取整个过程。

因为工作当中需要写一个代码生成器，想要以一个IDEA插件的方式提供服务，所以在这里做个记录，防止以后再次用到时从零开始。

要有一定的swing基础，我在开发代码生成器的时候，就是因为swing基础太差，布局花了非常多的时间。


当前题目：一时兴起，自己动手开发了个IDEA插件！
URL分享：http://wtcwzsj.com/article/cdpcgig.html

其他资讯


关于我们
我们的服务
网站建设案例
新闻动态
联系我们

135-1821-9792

公司服务热线
友情链接： 蜀锦在线   myfdjzy.com   都江堰发电机   网站推广   企业网站建设   南充网站制作   成都棕树机房   成都发电机维保   乐山主机托管   名片印刷   

Copyright © 2009-2022 www.wtcwzsj.com 青羊区广皓图文设计工作室（个体工商户） 版权所有　蜀ICP备19037934号