Intellij IDEA插件开发：如何实现Banner通知？

核心实现思路 #

Editor Banner功能依赖EditorNotificationProvider接口，通过实现该接口并注册为插件扩展点，即可在编辑器顶部展示自定义通知横幅。

具体代码实现 #

1. 实现EditorNotificationProvider类 #

创建自定义类实现EditorNotificationProvider，重写方法定义横幅内容与交互逻辑：

import com.intellij.openapi.editor.Editor;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.util.Key;
import com.intellij.ui.EditorNotificationProvider;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import javax.swing.*;
import java.util.function.Function;

public class CustomBannerProvider implements EditorNotificationProvider {
    // 用于标识通知的唯一Key
    private static final Key<String> CUSTOM_BANNER_KEY = Key.create("Plugin.CustomBanner");

    @Override
    public @Nullable Function<? super Editor, ? extends JComponent> collectNotificationData(@NotNull Project project, @NotNull Editor editor) {
        // 自定义判断逻辑：仅满足条件时显示横幅
        if (isEligibleForBanner(project, editor)) {
            return e -> {
                // 构建横幅面板，支持任意Swing组件
                JPanel bannerPanel = new JPanel();
                bannerPanel.add(new JLabel("🔔 这是自定义Editor Banner通知"));

                // 添加操作按钮
                JButton confirmBtn = new JButton("确认");
                confirmBtn.addActionListener(evt -> {
                    // 点击后的业务逻辑
                    executeBannerAction(project, editor);
                    // 手动关闭横幅
                    EditorNotificationProvider.clearNotification(editor, CUSTOM_BANNER_KEY);
                });
                bannerPanel.add(confirmBtn);

                return bannerPanel;
            };
        }
        return null;
    }

    // 判断是否显示横幅的自定义逻辑
    private boolean isEligibleForBanner(@NotNull Project project, @NotNull Editor editor) {
        // 示例：仅在项目未关闭且编辑器有内容时显示
        return !project.isDisposed() && editor.getDocument().getTextLength() > 0;
    }

    // 横幅按钮的业务处理逻辑
    private void executeBannerAction(@NotNull Project project, @NotNull Editor editor) {
        // 这里添加你的插件业务代码，比如执行代码检查、弹出详情窗口等
        JOptionPane.showMessageDialog(null, "Banner操作已触发");
    }
}

2. 在plugin.xml中注册扩展点 #

将自定义Provider注册为IntelliJ的扩展点，让插件加载时识别该组件：

<extensions defaultExtensionNs="com.intellij">
    <editorNotificationProvider implementation="com.your.plugin.package.CustomBannerProvider"/>
</extensions>

关键注意事项 #

• 可通过isEligibleForBanner方法灵活控制横幅显示场景，比如根据文件类型、用户配置、项目状态过滤
• 使用EditorNotificationProvider.clearNotification可主动关闭横幅，也可让用户通过横幅自带的关闭按钮（若添加）关闭
• 横幅面板支持完全自定义，可添加图标、文本框、下拉菜单等任意Swing组件
• 若需要持久化用户关闭状态，可结合PersistentStateComponent存储用户偏好，避免重复显示同一通知

内容的提问来源于stack exchange，提问作者Quentin M