插件-存储全局应用级别的用户数据 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!",证明数据已成功读写‌。
相关推荐
Piper蛋窝6 小时前
深入 Go 语言垃圾回收:从原理到内建类型 Slice、Map 的陷阱以及为何需要 strings.Builder
后端·go
六毛的毛9 小时前
Springboot开发常见注解一览
java·spring boot·后端
AntBlack9 小时前
拖了五个月 ,不当韭菜体验版算是正式发布了
前端·后端·python
31535669139 小时前
一个简单的脚本,让pdf开启夜间模式
前端·后端
uzong9 小时前
curl案例讲解
后端
一只叫煤球的猫10 小时前
真实事故复盘:Redis分布式锁居然失效了?公司十年老程序员踩的坑
java·redis·后端
大鸡腿同学11 小时前
身弱武修法:玄之又玄,奇妙之门
后端
轻语呢喃13 小时前
JavaScript :字符串模板——优雅编程的基石
前端·javascript·后端
MikeWe13 小时前
Paddle张量操作全解析:从基础创建到高级应用
后端
岫珩13 小时前
Ubuntu系统关闭防火墙的正确方式
后端