插件-存储全局应用级别的用户数据 ApplicationManager.getApplication().putUserData

IntelliJ IDEA 插件中的 ApplicationManager.getApplication().putUserData 方法用于存储全局应用级别的用户数据。该数据在整个 IDE 生命周期内有效(不持久化到磁盘),适用于跨插件功能共享临时数据。以下是详细说明及 Demo:


方法说明

  1. 方法签名

    java 复制代码
    void putUserData(@NotNull Key<T> key, T value)
    • Key<T>:需继承自 Key 类的自定义键对象,用于唯一标识存储的数据。
    • value:存储的值,类型需与 Key<T> 泛型匹配。
  2. 特点

    • 应用级别共享:数据对所有项目窗口和插件实例可见‌。
    • 临时存储:IDE 重启后数据丢失,需配合持久化组件(如 PersistentStateComponent)实现长期存储‌。
    • 线程安全:可在多线程环境下直接调用‌。

Demo 实现

步骤 1:定义 Key 对象

java 复制代码
import com.intellij.openapi.util.Key;

public class MyKeys {
    public static final Key<String> DEMO_KEY = new Key<>("myPlugin.demoData");
}

步骤 2:在 Action 中读写数据

java 复制代码
import com.intellij.openapi.application.ApplicationManager;
import com.intellij.openapi.ui.Messages;

public class MyAction extends AnAction {
    @Override
    public void actionPerformed(AnActionEvent e) {
        // 写入数据
        ApplicationManager.getApplication().putUserData(MyKeys.DEMO_KEY, "Hello Plugin!");

        // 读取数据
        String value = ApplicationManager.getApplication().getUserData(MyKeys.DEMO_KEY);
        Messages.showInfoMessage("Stored Value: " + value, "Demo");
    }
}

步骤 3:注册 Action 到 plugin.xml

java 复制代码
<actions>
    <action 
        id="MyPlugin.Action" 
        class="MyAction" 
        text="Show User Data" 
        description="Demo for putUserData">
        <add-to-group group-id="ToolsMenu" anchor="first"/>
    </action>
</actions>

关键注意点

  1. 数据生命周期

    数据仅在 IDE 运行期间有效,重启后需重新初始化‌。

  2. 适用场景

    • 跨 Action 或组件传递临时状态(如用户会话令牌)。
    • 缓存频繁访问的非持久化数据(如动态配置参数)‌。
  3. 替代方案

    如需持久化数据,应使用 PersistentStateComponentPropertiesComponent‌。


验证效果

  1. 运行插件后,通过菜单 ‌Tools > Show User Data‌ 触发 Action。
  2. 弹窗将显示存储的值 "Hello Plugin!",证明数据已成功读写‌。
相关推荐
创码小奇客5 分钟前
保姆级 Talos 超参数优化实战指南:从入门到封神
java·后端·架构
程序媛李李李李李蕾11 分钟前
你不能直接用现成的吗?整个前端做笔记管理工具真是折腾人
javascript·vue.js·后端
易元21 分钟前
设计模式-访问者模式
前端·后端·设计模式
liangdabiao32 分钟前
一篇文章尽快介绍入门级智能体Agent是什么回事, Starter AI Agents 项目 来自 awesome-llm-apps
前端·后端
JohnYan1 小时前
工作笔记 - 一种业务信息汇报机制的设计和实现
数据库·后端·postgresql
EdenX1 小时前
MySQL详解:从基础到应用,附电商订单系统实战
后端
error_cn1 小时前
匿名ftp服务器搭建指南
后端
就是帅我不改1 小时前
深入实战责任链模式:在企业级审批流程中的优雅应用
后端·面试
武子康1 小时前
大数据-54 Kafka 安装配置 从 ZooKeeper 到 KRaft 的演进之路
大数据·后端·kafka
星辰大海的精灵1 小时前
深入解析 CopyOnWriteArrayList
java·后端·算法