插件-存储全局应用级别的用户数据 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!",证明数据已成功读写‌。
相关推荐
豌豆花下猫13 分钟前
Python 3.14 新特性盘点,更新了些什么?
后端·python·ai
caihuayuan51 小时前
Vue生命周期&脚手架工程&Element-UI
java·大数据·spring boot·后端·课程设计
明月与玄武3 小时前
Spring Boot中的拦截器!
java·spring boot·后端
菲兹园长4 小时前
SpringBoot统一功能处理
java·spring boot·后端
muxue1784 小时前
go语言封装、继承与多态:
开发语言·后端·golang
开心码农1号4 小时前
Go语言中 源文件开头的 // +build 注释的用法
开发语言·后端·golang
北极象4 小时前
Go主要里程碑版本及其新增特性
开发语言·后端·golang
lyrhhhhhhhh5 小时前
Spring框架(1)
java·后端·spring
喝养乐多长不高6 小时前
Spring Web MVC基础理论和使用
java·前端·后端·spring·mvc·springmvc
莫轻言舞6 小时前
SpringBoot整合PDF导出功能
spring boot·后端·pdf