idea plugin插件开发1——idea底部窗口(带按钮)

已于 2022-02-23 20:09:02 修改
阅读量2.5k 收藏 4
点赞数 2
分类专栏： # idea插件开发 文章标签： intellij-idea java intellij idea idea plugin
于 2022-02-23 16:56:00 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/q258523454/article/details/123093013
版权

目录

第一步：新建一个Executor

第二步：自定义按钮

第三步：定义runner

第四步：定义插件Action

第五步：plugin.xml 配置

 相关文章推荐

idea插件开发资料实在太少，官方demo的例子也很少。

 官方demo：GitHub - JetBrains/intellij-sdk-code-samples: Mirror of the IntelliJ SDK Docs Code Sampleshttps://github.com/JetBrains/intellij-sdk-code-samples

这里笔者介绍一下官方demo中没有的例子——底部窗口。

这只是一个demo，用于实际开发，还要结合官方手册来。

先看下效果图： 

给大家看下我的目录结构：

第一步：新建一个Executor

package com.example.action.t3_tool_windows.console_view.bottom_console;

import com.example.utils.MyIconUtil;
import com.intellij.execution.Executor;
import org.jetbrains.annotations.NotNull;

import javax.swing.Icon;

public class ConsoleTool_Executor extends Executor {

    public static final String PLUGIN_ID = "SQL Plugin ID";

    public static final String TOOL_WINDOW_ID = "SQL Scanner";

    public static final String CONTEXT_ACTION_ID = "custom context action id";

    @NotNull
    @Override
    public String getId() {
        return PLUGIN_ID;
    }

    @Override
    public String getToolWindowId() {
        return TOOL_WINDOW_ID;
    }

    @Override
    public Icon getToolWindowIcon() {
        return MyIconUtil.ICON;
    }

    @NotNull
    @Override
    public Icon getIcon() {
        return MyIconUtil.ICON;
    }

    @Override
    public Icon getDisabledIcon() {
        return MyIconUtil.ICON;
    }

    @Override
    public String getDescription() {
        return TOOL_WINDOW_ID;
    }

    @NotNull
    @Override
    public String getActionName() {
        return TOOL_WINDOW_ID;
    }

    @NotNull
    @Override
    public String getStartActionText() {
        return TOOL_WINDOW_ID;
    }

    @Override
    public String getContextActionId() {
        return CONTEXT_ACTION_ID;
    }

    @Override
    public String getHelpId() {
        return TOOL_WINDOW_ID;
    }

}

在 plugin.xml 中添加， 注意路径换成你自己的。

<!-- 插件扩展 -->
<extensions defaultExtensionNs="com.intellij">
      <!-- 自定义 底部view -->
    <executor id="CustomRunExecutor" order="last" implementation="com.example.action.t3_tool_windows.console_view.bottom_console.ConsoleTool_Executor"/>
</extensions>

我的build.gradle配置如下：


plugins {
    id 'org.jetbrains.intellij' version '0.4.10'
    id "org.jetbrains.kotlin.jvm" version "1.3.41"
    id 'java'
}
repositories {
    mavenCentral()
}

dependencies {
    testCompile group: 'junit', name: 'junit', version: '4.12'
}

apply {
    "java"
    "terminal"
    "ant"
}
group 'org.example'
version '1.0-SNAPSHOT'

// See https://github.com/JetBrains/gradle-intellij-plugin/
intellij {
    version '2019.3.3'
    // 必须,否则无法找到 PsiClass 等
    plugins = ['java', 'gradle']
    intellij.updateSinceUntilBuild false
}

sourceCompatibility = 1.8
targetCompatibility = 1.8

apply {
    "java"
    "terminal"
    "ant"
}

test {
    useJUnitPlatform()
}

tasks.withType(JavaCompile) {
    options.encoding = "UTF-8"
}

buildPlugin {
    buildSearchableOptions.enabled = false
}

第二步：自定义按钮

先添加后面需要用到的工具类

这个类是为了获取当前窗口的运行状态，以便后续扩充操作。

public enum MyProjectUtil {
    ;

    public static void setRunning(Project project, String key, boolean value) {
        PropertiesComponent.getInstance(project).setValue(key, value);
    }

    public static boolean getRunning(Project project, String key) {
        return PropertiesComponent.getInstance(project).getBoolean(key);
    }
}

下面这个类是获取正在运行的Executor


public enum MyExecutorUtil {
    ;

    /**
     * 返回正在运行的 Executor
     * @param id Executor id
     */
    public static Executor getRunExecutorInstance(String id) {
        return ExecutorRegistry.getInstance().getExecutorById(id);
    }
}

重启按钮Action：

package com.example.action.t3_tool_windows.console_view.bottom_console.toolbar;

import com.intellij.icons.AllIcons;
import com.intellij.openapi.actionSystem.AnAction;
import com.intellij.openapi.actionSystem.AnActionEvent;
import com.intellij.openapi.project.DumbAware;

/**
 * 重启 ConsoleTool
 */
public class ConsoleTool_Rerun_Action extends AnAction implements DumbAware {

    /**
     * 重启 ToolWindow
     */
    private Runnable rerun;

    public ConsoleTool_Rerun_Action(Runnable rerun) {
        super("Rerun", "Rerun", AllIcons.Actions.Restart);
        this.rerun = rerun;
    }

    /**
     * 执行动作
     */
    @Override
    public void actionPerformed(AnActionEvent e) {
        rerun.run();
    }

    /**
     * 监听该Action, 每次焦点更换、窗口切换都会触发 update
     */
    @Override
    public void update(AnActionEvent e) {
        e.getPresentation().setVisible(rerun != null);
    }
}

关闭按钮Action

package com.example.action.t3_tool_windows.console_view.bottom_console.toolbar;

import com.example.utils.MyProjectUtil;
import com.intellij.icons.AllIcons;
import com.intellij.openapi.actionSystem.AnAction;
import com.intellij.openapi.actionSystem.AnActionEvent;
import com.intellij.openapi.project.DumbAware;

public class ConsoleTool_Stop_Action extends AnAction implements DumbAware {

    /**
     * 停止 ToolWindow
     */
    private Runnable stop;


    public ConsoleTool_Stop_Action(Runnable stop) {
        super("Stop", "Stop", AllIcons.Actions.Suspend);
        this.stop = stop;
    }

    /**
     * 执行动作
     */
    @Override
    public void actionPerformed(AnActionEvent e) {
        stop.run();
    }

    /**
     * 监听该Action, 每次焦点更换、窗口切换都会触发 update
     */
    @Override
    public void update(AnActionEvent e) {
        if (null != e && null != e.getProject()) {
            e.getPresentation().setEnabled(MyProjectUtil.getRunning(e.getProject(), "running"));
        }
    }
}

 一个自定义的执行按钮

package com.example.action.t3_tool_windows.console_view.bottom_console.toolbar;

import com.intellij.execution.ui.ConsoleView;
import com.intellij.execution.ui.ConsoleViewContentType;
import com.intellij.icons.AllIcons;
import com.intellij.openapi.actionSystem.AnAction;
import com.intellij.openapi.actionSystem.AnActionEvent;
import org.jetbrains.annotations.NotNull;

public class Scanner_Action extends AnAction {

    private ConsoleView consoleView;

    public Scanner_Action(ConsoleView consoleView) {
        super("Scanner Sql", "Scanner sql", AllIcons.Actions.Upload);
        this.consoleView = consoleView;
    }

    @Override
    public void actionPerformed(@NotNull AnActionEvent e) {
        // Messages.showMessageDialog("SQL Scan Action", "Scanner", Messages.getInformationIcon());
        if (null != consoleView) {
            consoleView.print("新输出一条日志.", ConsoleViewContentType.NORMAL_OUTPUT);
        }
    }
}

第三步：定义runner

package com.example.action.t3_tool_windows.console_view.bottom_console;

import com.example.action.t3_tool_windows.console_view.bottom_console.toolbar.ConsoleTool_Rerun_Action;
import com.example.action.t3_tool_windows.console_view.bottom_console.toolbar.ConsoleTool_Stop_Action;
import com.example.action.t3_tool_windows.console_view.bottom_console.toolbar.Scanner_Action;
import com.example.utils.MyExecutorUtil;
import com.intellij.execution.DefaultExecutionResult;
import com.intellij.execution.ExecutionException;
import com.intellij.execution.ExecutionManager;
import com.intellij.execution.Executor;
import com.intellij.execution.configurations.RunProfile;
import com.intellij.execution.configurations.RunProfileState;
import com.intellij.execution.filters.TextConsoleBuilder;
import com.intellij.execution.filters.TextConsoleBuilderFactory;
import com.intellij.execution.runners.ExecutionEnvironment;
import com.intellij.execution.ui.ConsoleView;
import com.intellij.execution.ui.ConsoleViewContentType;
import com.intellij.execution.ui.RunContentDescriptor;
import com.intellij.execution.ui.RunnerLayoutUi;
import com.intellij.icons.AllIcons;
import com.intellij.openapi.actionSystem.ActionGroup;
import com.intellij.openapi.actionSystem.DefaultActionGroup;
import com.intellij.openapi.project.Project;
import com.intellij.ui.content.Content;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import javax.swing.*;
import java.awt.*;

public class ConsoleTool_Runner {

    /**
     * Project
     */
    private Project project = null;

    /**
     * 视图面板
     */
    private ConsoleView consoleView = null;


    /**
     * 重启/运行 ToolWindow
     */
    private Runnable rerun;

    /**
     * 停止 ToolWindow
     */
    private Runnable stop;


    public ConsoleTool_Runner(@NotNull Project project, Runnable rerun, Runnable stop) {
        this.project = project;
        this.consoleView = createConsoleView(project);
        this.rerun = rerun;
        this.stop = stop;
    }

    private ConsoleView createConsoleView(Project project) {
        TextConsoleBuilder consoleBuilder = TextConsoleBuilderFactory.getInstance().createBuilder(project);
        ConsoleView console = consoleBuilder.getConsole();
        console.print("第一行日志输出", ConsoleViewContentType.LOG_DEBUG_OUTPUT);
        return console;
    }

    public void run() {
        // 返回定义的 Executor
        Executor executor = MyExecutorUtil.getRunExecutorInstance(ConsoleTool_Executor.PLUGIN_ID);
        if (executor == null) {
            return;
        }

        // 创建 RunnerLayoutUi
        final RunnerLayoutUi.Factory factory = RunnerLayoutUi.Factory.getInstance(project);
        RunnerLayoutUi layoutUi = factory.create("id", "title", "session name", project);

        // 创建 panel
        final JPanel panel = new JPanel();
        panel.add(consoleView.getComponent(), BorderLayout.CENTER);

        // 创建描述信息
        RunContentDescriptor descriptor = new RunContentDescriptor(new RunProfile() {
            @Nullable
            @Override
            public RunProfileState getState(@NotNull Executor executor, @NotNull ExecutionEnvironment environment) throws ExecutionException {
                return null;
            }

            @NotNull
            @Override
            public String getName() {
                return "name";
            }

            @Nullable
            @Override
            public Icon getIcon() {
                return null;
            }
        }, new DefaultExecutionResult(), layoutUi);
        descriptor.setExecutionId(System.nanoTime());

        final Content content = layoutUi.createContent("contentId", panel, "displayName", AllIcons.Debugger.Console, panel);
        content.setCloseable(true);
        layoutUi.addContent(content);

        // 新增左边工具条
        layoutUi.getOptions().setLeftToolbar(createActionToolbar(consoleView), "RunnerToolbar");

        ExecutionManager.getInstance(project).getContentManager().showRunContent(executor, descriptor);
    }

    private ActionGroup createActionToolbar(ConsoleView consoleView) {
        final DefaultActionGroup actionGroup = new DefaultActionGroup();
        // ConsoleView 按钮: warp
        actionGroup.add(consoleView.createConsoleActions()[2]);
        // ConsoleView 按钮: scroll to end
        actionGroup.add(consoleView.createConsoleActions()[3]);
        // ConsoleView 按钮: clear
        actionGroup.add(consoleView.createConsoleActions()[5]);
        // 自定义按钮
        actionGroup.add(new Scanner_Action(consoleView));
        actionGroup.add(new ConsoleTool_Rerun_Action(rerun));
        actionGroup.add(new ConsoleTool_Stop_Action(stop));
        return actionGroup;
    }
}

第四步：定义插件Action

package com.example.action.t3_tool_windows.console_view.bottom_console.action;

import com.example.action.t3_tool_windows.console_view.bottom_console.ConsoleTool_Runner;
import com.example.utils.MyProjectUtil;
import com.intellij.openapi.actionSystem.AnAction;
import com.intellij.openapi.actionSystem.AnActionEvent;
import com.intellij.openapi.project.Project;
import org.jetbrains.annotations.NotNull;

public class ConsoleTool_Action extends AnAction {
    @Override
    public void actionPerformed(@NotNull AnActionEvent e) {
        runExecutor(e.getProject());
    }

    public void runExecutor(Project project) {
        if (project == null) {
            return;
        }

        // 设置restart (再次执行这个action)
        Runnable rerun = () -> runExecutor(project);

        // 设置stop
        Runnable stop = () -> MyProjectUtil.setRunning(project, "running", false);

        MyProjectUtil.setRunning(project, "running", true);
        ConsoleTool_Runner executor = new ConsoleTool_Runner(project, rerun, stop);

        executor.run();
    }
}

至此代码写完！

第五步：plugin.xml 配置

注意，下面的路径需要更换成你自己的路径。

	<!-- 插件扩展 -->
	<extensions defaultExtensionNs="com.intellij">
	      <!-- 自定义 底部view -->
	    <executor id="CustomRunExecutor" order="last" implementation="com.example.action.t3_tool_windows.console_view.bottom_console.ConsoleTool_Executor"/>
	</extensions>
    <actions>
        <!-- 自定义分组 -->
        <group id="zhang.group1.id" text="Zhang-菜单汇总" description="Group1 description">
            <add-to-group group-id="MainMenu" anchor="last"/>

            <action id="zhang.bottom_tool.id"
                    class="com.example.action.t3_tool_windows.console_view.bottom_console.action.ConsoleTool_Action"
                    text="底部-ToolWindow" description="Description">
            </action>
        </group>
    </actions>

 相关文章推荐

笔者的开源插件：Java Mybatis SQL Scannerhttps://zhangxiaofan.blog.csdn.net/article/details/123094358

idea plugin插件开发2——预览代码(多窗口)https://zhangxiaofan.blog.csdn.net/article/details/123097015idea plugin插件开发3——可编辑表单https://zhangxiaofan.blog.csdn.net/article/details/123097368

Mr.Java.
关注
  • 2
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
IDEA插件开发-创建项目
qq_24680093的博客
05-03 447
等待项目构建，第一次会比较慢，要下载一个idea等相关的资源。
idea插件开发-自定义语言
05-29
1. **IntelliJ IDEA 插件开发环境搭建** 在开始开发之前，首先需要安装IntelliJ IDEA并设置好插件开发环境。这通常包括安装IDEA的Ultimate版，因为它包含了用于插件开发的功能。然后创建一个新的"IntelliJ Platform...
idea插件开发入门
qiushily2030的博客
03-06 3236
另外使用IDEA提供的Swing Designer设计器还是挺方便的，自动生成的样式和布局代码为了避免被修改，也不会被我们看到（与NetBeans不同），所以最终代码很简洁。其实很简单，实现方法就是先创建一个Dialog，然后在Swing设计器中设计好Dialog中的控件布局，最后在Action中显示出对话框。运行起来就会发现，原来会启动一个新的Intellij IDEA实例，可以选择新建项目，也可以选择导入项目，我们选择导入一个项目。最终效果就是这样的了，我们在设计器里设计的面板嵌入到了右边。
idea插件开发之hello idea plugin
最新发布
wang0907的博客
06-07 587
最近一直想研究下自定义idea插件的内容，这样如果是想要什么插件，但又一时找不到合适的，就可以自己来搞啦！这不终于有时间来研究下，但过程可谓是一波三折，再一次切身体验了下万事开头难。那么，为了能让有这方面需求的小伙伴，少走弯路，直通罗马，就考虑写一篇入门的文章，我们共同学习，共同进步！！！
Intellij IDEA plugin 开发最常用插件
zhaoyang10的专栏
02-14 4105
lombok plugin p3c 阿里巴巴代码检查工具 GsonFormat json和java对象转换工具 GenerateAllSetter new 对象 赋值时 自动生成对象的所有set FindBugs-IDEA 自动扫描项目中的bug VisualVM Launcher 启动java项目时 自动启动jvisualvm 监控内存占用 Mybatisx mybatis自动生成工具 .........
idea插件开发-Icon and Image
编程是一门实践技术
05-29 2253
通过注册com.intellij.iconDescriptionBundle扩展点，可自动为所有工具栏配置默认图标，然后在资源文件中就可以按如下格式定义icon..tooltip，比如。如果插件要支持新UI，则需要经过以下操作，比如原默认UI图标的存放路径为/src/main/resources/icons。图标一般放在src/main/resources文件夹下的特定文件夹中，比如icons，然后可以通过IconLoader工具类来获取；. 每一帧代表一个图标，以及到下一帧的延迟。
实践idea插件开发
cj_eryue的博客
09-26 3806
idea插件开发，demo
Intelij开发idea插件从开发到发布的完整详细教程附带源码demo
任聪聪的博客
01-21 8201
说明：此处的代码是直接写上即可，无需通过devkit进行创建，如果你通过devkit进行创建，记得什么都不要选择，之后再回到这个配置文件配置你想设置的快捷键，如图中的first-key…=“你的快捷键多个用空格隔开”
Intellij Idea插件开发分享
10-12
### Intellij IDEA插件开发知识点概述 #### 一、Intellij IDEA插件开发基础 - **IntelliJ Platform SDK**：IntelliJ IDEA基于自家的IntelliJ Platform SDK开发，这意味着开发者可以利用这个平台提供的API来创建...
idea插件plugin.rar
06-21
标题中的"idea插件plugin.rar"表明这是一个与IntelliJ IDEA相关的插件压缩包，而描述中的"idea eval resetter"则暗示这可能是用于重置IDEA试用期的插件，通常这样的插件用于开发者在试用期内延长IDE的免费使用时间。...
Statistic Tool 3.8.1 IntelliJ IDEA开发工具插件
03-04
Statistic对idea的版本有要求，如果你正在使用idea版本是2019.1及以前版本，你在安装Statistic代码统计插件时，你会发现找不到安装后应该出现在左下角的图标，在View -> Tool Windows里也没有，查看插件的话，显示...
IDEA插件开发之环境搭建过程图文详解
08-19
IDEA插件开发环境搭建过程是指基于IntelliJ Platform Plugin搭建环境的步骤，在本文中我们将通过图文并茂实例代码相结合给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值。 一、基于IntelliJ ...
IDEA全系软件-插件开发
啥都靠学
07-20 3298
找不到想用的插件？那就自己敲一个！
IDEA插件开发
这里的分享，都是干货
11-10 6066
idea这些插件都是怎么开发的？本文手把手带你开发。
【IDEA插件开发】快速入门系列01 开发一个简单的Idea插件
Vaxue的博客
05-29 2635
英文好的建议阅读官方文档IDEA插件开发官方文档：https://plugins.jetbrains.com/docs/intellij/welcome.html。
【idea插件开发】从0入门idea插件开发，idea插件开发教程，如何开发idea插件
热门推荐
Rubik Blog
06-26 2万+
作为一枚程序员，平时最常用的ide就是IntelliJ IDEA。平时会用到各种各样的插件，通过插件的使用，提高自己的开发效率。idea具有全局性，安装好插件后，对idea生效，所有的工程均能找到。idea使用的便捷性，在固定的菜单中，或者右键即可看到该插件的使用入口专注度高，展示出来的内容均是自己需要关注的，不需要关注的就不会展示。可以专注思考自己要怎么用。和系统解耦，插件可以给给开发提效，却不会去占用项目的空间位置。…目前已有插件并不能真的完全满足自己的需求。举个简单的栗子，比如，最近在用mybatis
从零开始使用 IDEA 开发插件 （一）
assember的博客
06-24 4014
从零开始写 IDEA 插件 记录我从零基础开始写到插件全过程
第一章：idea插件开发环境搭建
寒风的博客
03-07 2646
IntelliJ IDEA 简称 IDEA，是 Jetbrains 公司旗下的一款 JAVA 开发工具，支持 Java、Scala、Groovy 等语言的开发，同时具备支持目前主流的技术和框架，擅长于企业应用、移动应用和 Web 应用的开发，提供了丰富的功能，智能代码助手、代码自动提示、重构、J2EE支持、各类版本工具(git、svn等)、JUnit、CVS整合、代码分析、 创新的GUI设计等。 idea插件开发学习
idea plugin 插件开发
诸葛子房的博客
11-10 3517
1.需要安装gradle 参考：Gradle的安装与配置_wenchang-的博客-CSDN博客_gradle安装 2.插件开发 3.项目目录 4.plugin.xml <idea-plugin> <!--插件id--> <id>com.xiaokai.test.demo</id> <!--插件名称--> <name>Demo</name> <!--开发者..
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值