IDEA-插件开发入门篇

r囧r小猫 2022-12-17 10:59 129阅读 0赞

## IDEA-插件开发 入门篇 ##

### 文章目录 ###

*   *  IDEA-插件开发 入门篇
 *  前言
 *  一、插件入门 项目创建
 *  二、实战案例 - mysql 列转换
 *   *  1. 配置插件信息
     *  2. 创建action
     *  3. 运行结果
 *  总结

--------------------

# 前言 #

由于网上的idea 插件教程很少,无奈只能自己研究,文章记录的内容不能保证准确性,有问题希望可以评论指出!。

--------------------

# 一、插件入门 项目创建 #

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0MjY2_size_16_color_FFFFFF_t_70_pic_center]

# 二、实战案例 - mysql 列转换 #

插件作用 - 通常写sql的时候,sql 需要把列名写出来,比如 select s.u\_id as uId,… from xxx, 对于我这种懒人党说简直巨麻烦,毕竟自动生成的列是没有前缀的… 像这样 u\_id,u\_name

## 1. 配置插件信息 ##

配置 resources 下的 plugin.xml  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0MjY2_size_16_color_FFFFFF_t_70_pic_center 1]

配置如下

<idea-plugin>
        <id>org.example.myPlugins</id>
        <name>MyPlugin</name>
        <vendor email="1585946147@qq.com" url="http://www.baidu.com">lieying</vendor>
    
        <description>first test plugin</description>
    
    
        <extensions defaultExtensionNs="com.intellij">
            
        </extensions>
    
        <actions>
            
            <group id="MyPlugin.SampleMenu" text="_Sample Menu" description="Sample menu">
                <add-to-group group-id="MainMenu" anchor="last" />
                <action id="Myplugin.Textboxes" class="com.hunt.plugin.TextBoxes" text="Text _Boxes" description="A test menu item">
                    <keyboard-shortcut keymap="$default" first-keystroke="ctrl alt Z" />
                </action>
            </group>
    
    
        </actions>
    </idea-plugin>

## 2. 创建action ##

需要去继承AnAction,当idea 的按钮被触发时会被调用actionPerformed 方法：

package com.hunt.plugin;
    
    import com.intellij.openapi.actionSystem.AnAction;
    import com.intellij.openapi.actionSystem.AnActionEvent;
    import com.intellij.openapi.actionSystem.PlatformDataKeys;
    import com.intellij.openapi.project.Project;
    import com.intellij.openapi.ui.Messages;
    
    import javax.swing.*;
    
    public class TextBoxes extends AnAction { 
    
        // 定义按钮的名称
        public TextBoxes() { 
            super("MYSQL_COLUMN_ADD_PRO");
        }
    
        public void actionPerformed(AnActionEvent event) { 
            Project project = event.getData(PlatformDataKeys.PROJECT);
    
            // userInput
            String strMysqlColumns = Messages.showMultilineInputDialog(project, "Enter the column you need to add salt",
                    "xyang", "example:\n" +
                            "\t user_id,\n " +
                            "\t user_name", Messages.getInformationIcon(), null);
            // 如果任意一个值是null, 那么就不做
            if (strMysqlColumns == null || strMysqlColumns.trim().equals("")){ 
                return;
            }
    
            String prefix = Messages.showInputDialog(project, "Enter the prefix you need to add",
                    "xyang", Messages.getInformationIcon());
            // 如果任意一个值是null, 那么就不做
            if (prefix == null || prefix.trim().equals("")){ 
                return;
            }
    
            // 结果存放
            StringBuffer sb = new StringBuffer();
    
            // 处理列,加上前缀
            String[] columns = strMysqlColumns.split(",");
            for (int i = 0; i < columns.length; i++) { 
                // 单个column 加上前缀
                sb.append(prefix);
                sb.append(".");
                sb.append(columns[i]);
    
    
                // 最后一次循环不执行
                if (columns.length - 1 > i){ 
                    sb.append(",");
                    sb.append("\n");
                }
            }
    
            // 返回出结果
            Messages.showMessageDialog(project, sb.toString() + "\n ", "Thank you for your use.", Messages.getInformationIcon());
        }
    
    }

## 3. 运行结果 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0MjY2_size_16_color_FFFFFF_t_70_pic_center 2]

--------------------

# 总结 #

例如：以上就是今天要讲的内容，本文仅仅简单介绍了定义简单插件，而idea提供了大量接口支持我们自定义插件,后续更新自定义工具栏的章节

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0MjY2_size_16_color_FFFFFF_t_70_pic_center]: /images/20221122/795e14f8536b44369752d11e31da104a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0MjY2_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221122/469eda33973d474a9b42c9c5bad37ce1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0MjY2_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221122/4898eb4716de4cf1b11b3102015cab99.png