【插件开发】—— 8 IPreferenceStore,插件的键/值存储!

时间:2022-04-22
本文章向大家介绍【插件开发】—— 8 IPreferenceStore,插件的键/值存储!,主要内容包括先描述下我遇到的问题吧:、IPregerenceStore、基本概念、基础应用、原理机制和需要注意的事项等,并结合实例形式分析了其使用技巧,希望通过本文能帮助到大家理解应用这部分内容。

前文回顾: 1 插件学习篇简单的建立插件工程以及模型文件分析利用扩展点,开发透视图SWT编程须知SWT简单控件的使用与布局搭配SWT复杂空间与布局搭配 7 SWT布局详解

  前几篇讲解了SWT的基本知识。这篇作为穿插,讲述一下工作终于到的一个问题,并且借着这个机会,好好的学习了一下!

  先描述下我遇到的问题吧:

  由于对插件的了解也并不全面,很多知识点都不知道。学习其他人的开源源码时,我遇到了下面的报错:

1  org.eclipse.jface.resource.DataFormatException
2  at org.eclipse.jface.resource.StringConverter.asRGB(StringConverter.java:567)
3  at com.xxxxxx.rcp.dbeditor.util.EditorColorProvider.getToken(EditorColorProvider.java:32)

  根据报错提示的位置,以及调试发现,是有colorName为空,从而无法进行转换

 1 public IToken getToken(String prefKey) {
 2   System.out.println(store.getString(prefKey));
 3   Token token = (Token) tokenTable.get(prefKey);
 4   if (token == null) {
 5    String colorName = store.getString(prefKey);
 6    RGB rgb = StringConverter.asRGB(colorName);
 7    token = new Token(new TextAttribute(getColor(rgb)));
 8    tokenTable.put(prefKey, token);
 9   }
10   return token;
11  }

  追踪堆栈,发现这个store根本没有任何getString的方法以及map类型的存储集合。

  很费解这个对象时怎么回事,于是再重新学习源码,各种比对,发现都是相同的。

  并且这个对象时在插件初次加载的start函数通过getPreferenceStore()进行初始化的。

那么就奇怪了,一样的代码过程,为什么源码可以查找到值,而我的却不行呢?

  于是查看IPreferenceStore接口的源码,查找它的实现类,并没有任何收获!

  无奈之下,只能百度了!

  于是,万能的百度再次立功了,原来是首选项中配置的内容。也就是说与手写的代码其实是分离的,它是在扩展点org.eclipse.core.runtime.preferences中扩展的一个初始化函数。

  知道了原因,那么就好好研究下吧!

  IPregerenceStore

  它是eclipse基于字符串的一个键值存储结构,也就是说,以String类型为主键,存储其他类型。它在插件加载的时候进行执行,并且存储在本地。可以同过getPregerenceStore()获取这个对象,通过setDefault方法进行赋值。

  接下来看一下这个对象的使用方法吧!

1 在扩展点中扩展org.eclipse.core.runtime.preferences

2 新建一个 initializer ,并且指定实现一个初始化的类

3 创建IPreferenceStore对象,并设定初始化值

 1 import org.eclipse.core.runtime.preferences.AbstractPreferenceInitializer;
 2 import org.eclipse.jface.preference.IPreferenceStore;
 3 
 4 import testpreference.Activator;
 5 
 6 public class AbstractPreferenceInitializer1 extends
 7         AbstractPreferenceInitializer {
 8 
 9     public AbstractPreferenceInitializer1() {
10         // TODO Auto-generated constructor stub
11     }
12 
13     @Override
14     public void initializeDefaultPreferences() {
15         IPreferenceStore store = Activator.getDefault().getPreferenceStore();
16 
17         store.setDefault(Activator.PREF_PARAM_1, "hello");
18         store.setDefault(Activator.PREF_PARAM_2, "xingoo");
19     }
20 }

4 在Activator中进行初始化【并实现调用】

public class Activator extends AbstractUIPlugin {   
    ...
    public static final String PREF_PARAM_1 = "param_1";
    public static final String PREF_PARAM_2 = "param_2";
    
    private IPreferenceStore store;
    
    public void start(BundleContext context) throws Exception            {
        super.start(context);
        plugin = this;
        store =getPreferenceStore();
        
        System.out.println("param1"+store.getString(PREF_PARAM_1));
        System.out.println("param2"+store.getString(PREF_PARAM_2));
    }

    ...
}

  IPreferenceStore的使用过程大致就是如此了!

  总结起来这次调试过程,归结原因,只能算是自己无知了,学无止境!