IDEA插件开发-开发一个IntelliJIDEA插件-《Java笔记》

admin 2025-10-19 01:19:19 编程 来源:ZONE.CI 全球网 0 阅读模式

IDEA Plugins

开发环境

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

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

本地可能已经安装了Ultimate版本,但是还是需要安装IDEA的社区版本。因为商业版是闭源的,所以在调试时无法调试核心代码。社区版的安装包里是不包含源码的,所以需要手动从github上clone一份:

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

关于从源码运行IDEA的方法参考:Check Out And Build Community Edition

添加 IDEA jdk

虽然不知道原因,但是根据Check Out And Build Community Edition,需要建立一个IDEA jdk 来运行插件:除非在Mac上使用官方JDK,否则需要手动添加%20/lib/tools.jar%20到classpath中。

配置%20IntelliJ%20Platform%20SDK

打开%20File%20|%20Project%20Structure%20新建一个%20IntelliJ%20Platform%20SDK:Java%20SDK%20选择刚刚建立的%20IDEA%20jdk:然后可以把下载的%20IDEA%20社区版源码添加到源码路径中,这样在调试时,就可以调试%20IDEA%20自身的代码了:

第一个插件

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

新建工程

选择IntellJ%20Platform%20Plugin,然后Project%20SDK指定刚刚新建的plugin%20sdk:新建的插件项目:插件根目录下有两个目录src和resources。src是插件代码目录,resource是插件资源目录,其中META-INF/plugin.xml是插件的描述文件,就像Java%20web项目的web.xml一样。plugin.xml%20默认的内容如下:

<idea-plugin>%20%20<id>com.your.company.unique.plugin.id</id>%20%20<name>Plugin%20display%20name%20here</name>%20%20<version>1.0</version>%20%20<vendor%20email="[email protected]"%20url="http://www.yourcompany.com">YourCompany</vendor>%20%20<description><![CDATA[%20%20%20%20%20%20Enter%20short%20description%20for%20your%20plugin%20here.<br>%20%20%20%20%20%20<em>most%20HTML%20tags%20may%20be%20used</em>%20%20%20%20]]></description>%20%20<change-notes><![CDATA[%20%20%20%20%20%20Add%20change%20notes%20here.<br>%20%20%20%20%20%20<em>most%20HTML%20tags%20may%20be%20used</em>%20%20%20%20]]>%20%20</change-notes>%20%20<!--%20please%20see%20http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/build_number_ranges.html%20for%20description%20-->%20%20<idea-version%20since-build="145.0"/>%20%20<!--%20please%20see%20http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/plugin_compatibility.html%20%20%20%20%20%20%20on%20how%20to%20target%20different%20products%20-->%20%20<!--%20uncomment%20to%20enable%20plugin%20in%20all%20products%20%20<depends>com.intellij.modules.lang</depends>%20%20-->%20%20<extensions%20defaultExtensionNs="com.intellij">%20%20%20%20<!--%20Add%20your%20extensions%20here%20-->%20%20</extensions>%20%20<actions>%20%20%20%20<!--%20Add%20your%20actions%20here%20-->%20%20</actions></idea-plugin>

新建一个%20Action

插件扩展%20IDEA%20最常见的方式就是在菜单栏或者工具栏中添加菜单项,用户通过点击菜单项来触发插件功能。IDEA%20提供了%20AnAction%20类,这个类有一个虚方法%20actionPerformed,这个方法会在每次菜单被点击时调用。新建一个自定义的%20Action%20有两个步骤:

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

先写一个简单的Action类:

public%20class%20TextBoxes%20extends%20AnAction%20{%20%20%20%20//%20如果通过Java代码来注册,这个构造函数会被调用,传给父类的字符串会被作为菜单项的名称%20%20%20%20//%20如果你通过plugin.xml来注册,可以忽略这个构造函数%20%20%20%20public%20TextBoxes()%20{%20%20%20%20%20%20%20%20//%20设置菜单项名称%20%20%20%20%20%20%20%20super("Text%20_Boxes");%20%20%20%20%20%20%20%20//%20还可以设置菜单项名称,描述,图标%20%20%20%20%20%20%20%20//%20super("Text%20_Boxes","Item%20description",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:

    1. <actions>
    2. <group id="MyPlugin.SampleMenu" text="_Sample Menu" description="Sample menu">
    3. <add-to-group group-id="MainMenu" anchor="last" />
    4. <action id="Myplugin.Textboxes" class="Mypackage.TextBoxes" text="Text _Boxes" description="A test menu item" />
    5. </group>
    6. </actions>

    这里新建了一个菜单组,其中 text 字符串的下划线表示这个字母作为快捷键。这个菜单显示的效果如下:开发一个 IntelliJ IDEA 插件 - 图8除了手动新建Action,IDEA还提供了快速新建的方法,在代码目录上点击新建,可以看到Action:开发一个 IntelliJ IDEA 插件 - 图9可以在这个面板中填写要新建的Action信息,IDEA会新建类,还有在plugin.xml中注册:开发一个 IntelliJ IDEA 插件 - 图10

    运行插件

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

    以太坊cppgolang区别 编程

    以太坊cppgolang区别

    以太坊是一种去中心化的开源平台,它采用智能合约技术,旨在构建和运行不受干扰的分布式应用程序。作为目前最受欢迎的区块链平台之一,以太坊提供了多种编程语言的支持,其
    progolang 编程

    progolang

    Go语言(Golang)是由Google开发的一门静态类型编程语言。作为一名专业的Golang开发者,我深知这门语言的优势和特点。在本文中,我将介绍Golang
    golangn个发送者 编程

    golangn个发送者

    Golang是一种开源的编程语言,由Google团队开发,旨在提高程序的并发性和简化软件开发过程。在Go语言中,有时需要向多个接收者发送信息。本文将介绍如何在G
    golang技能图谱 编程

    golang技能图谱

    从互联网行业的快速发展到人工智能技术的日益成熟,各种编程语言也应运而生。而在这众多的编程语言中,Golang(即Go)作为一门强大且高效的开发语言备受关注。Go
    评论:0   参与:  13