idea 好用的lua插件写idea插件

转载

liutao988 2024-05-25 15:55:27

文章标签 idea 好用的lua插件 idea添加插件 xml ide Java 文章分类 游戏开发

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

开发环境

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

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

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

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

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

添加 IDEA jdk

我们需要建立一个IDEA jdk来运行插件：

idea 好用的lua插件写idea插件_idea添加插件

除非你在 Mac 上使用官方 JDK，否则你需要手动添加/lib/tools.jar到 classpath 中。

配置 IntelliJ Platform SDK

打开File | Project Structure新建一个IntelliJ Platform SDK：

idea 好用的lua插件写idea插件_ide_02

Java SDK 选择我们刚刚建立的IDEA jdk：

idea 好用的lua插件写idea插件_xml_03

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

idea 好用的lua插件写idea插件_ide_04

idea 好用的lua插件写idea插件_xml_05

第一个插件

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

新建工程

选择IntellJ Platform Plugin，然后 Project SDK 指定刚刚新建的 plugin sdk：

idea 好用的lua插件写idea插件_ide_06

新建的插件项目：

idea 好用的lua插件写idea插件_xml_07

插件根目录下有两个目录src和resources。src是插件代码目录，resource是插件资源目录，其中META-INF/plugin.xml是插件的描述文件，就像 Java web 项目的web.xml一样。

plugin.xml 默认的内容如下：

<idea-plugin>
  <id>com.your.company.unique.plugin.idid>
  <name>Plugin display name herename>
  <version>1.0version>
  <vendor email="support@yourcompany.com" url="http://www.yourcompany.com">YourCompanyvendor>
  <description>      Enter short description for your plugin here.

      most HTML tags may be used
    ]]>description>
  <change-notes>      Add change notes here.

      most HTML tags may be used
    ]]>
  change-notes>
  <idea-version since-build="145.0"/>
  <extensions defaultExtensionNs="com.intellij"> 
  extensions>
  <actions>   
  actions>
idea-plugin>

新建一个 Action

插件扩展 IDEA 最常见的方式就是在菜单栏或者工具栏中添加菜单项，用户通过点击菜单项来触发插件功能。IDEA 提供了AnAction类，这个类有一个虚方法actionPerformed，这个方法会在每次菜单被点击时调用。

新建一个自定义的 Action 有两个步骤：

继承AnAction类，在actionPerformed方法中实现插件逻辑
注册 action，有两种方式，通过代码注册和通过plugin.xml注册

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

public class TextBoxes extends AnAction {    
    public TextBoxes() {      
        super("Text _Boxes");   
    }
    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：

<actions>
  <group text="_Sample Menu" description="Sample menu">
    <add-to-group group-id="MainMenu" anchor="last"  />
       <action text="Text _Boxes" description="A test menu item" />
  group>
actions>

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

idea 好用的lua插件写idea插件_xml_08