插件-存储全局应用级别的用户数据 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. ‌替代方案 ‌

    如需持久化数据,应使用 PersistentStateComponent 或 PropertiesComponent‌。


‌验证效果‌

  1. 运行插件后,通过菜单 ‌Tools > Show User Data‌ 触发 Action。
  2. 弹窗将显示存储的值 "Hello Plugin!",证明数据已成功读写‌。
相关推荐
QCoding7 分钟前
企业级Agent Evaluation实战:Agent能跑就能上线?AI Agent到底怎么测?
后端·spring
苍何29 分钟前
让 WorkBuddy 操控浏览器,干活有点猛啊1
后端
IT_陈寒1 小时前
当Java的hashCode遇上Lombok,我的缓存被全清了
前端·人工智能·后端
XW1 小时前
常用提示词(Prompt)框架总结
后端
ServBay1 小时前
DeepSeek 再次崩了,DeepSeek V5正在路上?
后端·deepseek
IT规划师2 小时前
编程术语中的同步与异步:从"等不等"到工程取舍
后端·面试
孟陬3 小时前
Foobar 技术周刊#159:当看不懂代码时,如何高效排障调试。脏页陷阱:一条只读查询,写入数 TB 数据。推测解码:大模型加速利器
前端·人工智能·后端
GoGeekBaird3 小时前
别再给每个 AI 做自我介绍了:我做了一个「个人上下文」管理系统
后端·github·agent
码事漫谈3 小时前
腾讯混元 Hy4 正式版发布了
后端
Mikko73 小时前
Redis 连接数满了服务端有错误信息吗?连接数不增加却命令超时?6.2 实测连接池、超时与大 key 怎么判定
java·spring boot·redis·后端