说起SharedPreferences,我相信每个Android开发人员都用过,用法也很简单。但是很多人往往只关注了如何去使用,而对于其实现原理和使用过程中的注意点并没有去深入了解过。本篇文章就来说说SharedPreferences在使用过程中你所需要注意和了解的东西,后续将会说到SharedPreferences具体的实现原理以及替换方案。为了方便,后文中将用sp代替SharedPreferences。
-
SharedPreferences的获取:
context.getSharedPreferences("your file name",Context.MODE_PRIVATE);
我们在获取sp的时候往往都是通过一个上下文对象调用getSharedPreferences()去直接获取,而getSharedPreferences()具体实现是在ContextImpl中。先总结sp获取流程:
1.根据传入的fileName作为key在ContextImpl中的成员变量ArrayMap<String, File> mSharedPrefsPaths中获取fileName所对应的文件,如果mSharedPrefsPaths中没有对应的文件,则直接创建一个新的File并放入其中。
2.根据包名来获取该包下所有file-sp的Map集合ArrayMap<File, SharedPreferencesImpl>。
3.通过1中获取的file作为key在2中的Map中获取file所对应的sp。
我们来看看具体实现代码(相关注释我已标明在代码中):
public SharedPreferences getSharedPreferences(String name, int mode) {
......省略无关紧要代码
File file;
synchronized (ContextImpl.class) {
/*
ArrayMap<String, File> mSharedPrefsPaths;是该类的一个成员变量,
主要保存文件名对应的文件。也就是说每一个ContextImpl实例中都会有
一个mSharedPrefsPaths
*/
if (mSharedPrefsPaths == null) {
mSharedPrefsPaths = new ArrayMap<>();
}
file = mSharedPrefsPaths.get(name);
if (file == null) {
file = getSharedPreferencesPath(name);
mSharedPrefsPaths.put(name, file);
}
}
return getSharedPreferences(file, mode);
}
这个方法很简单首先根据传入的fileName去获取对应的文件,如果获取的 file=null,再去调用getSharedPreferencesPath(name)这个方法去获取文件,并把获取到的文件放入mSharedPrefsPaths中保存,该方法的具体代码如下:
@Override
public File getSharedPreferencesPath(String name) {
return makeFilename(getPreferencesDir(), name + ".xml");
}
很显然直接创建一个文件返回。最后调用getSharedPreferences(file, mode)返回我们所需要的sp。接下来直接看看getSharedPreferences(file, mode)方法的具体实现:
@Override
public SharedPreferences getSharedPreferences(File file, int mode) {
.......省略无关紧要代码
SharedPreferencesImpl sp;
synchronized (ContextImpl.class) {
final ArrayMap<File, SharedPreferencesImpl> cache = getSharedPreferencesCacheLocked();
sp = cache.get(file);
if (sp == null) {
sp = new SharedPreferencesImpl(file, mode);
cache.put(file, sp);
return sp;
}
}
.......省略无关紧要代码
return sp;
}
该方法也很简单通过getSharedPreferencesCacheLocked()方法返回一个ArrayMap<File, SharedPreferencesImpl> cache对象里面存储的是file-sp的键值对,通过之前获取的file来获取对应的sp对象。getSharedPreferencesCacheLocked()的具体实现如下:
private ArrayMap<File, SharedPreferencesImpl> getSharedPreferencesCacheLocked() {
// private static ArrayMap<String, ArrayMap<File, SharedPreferencesImpl>> sSharedPrefsCache;
// sSharedPrefsCache是ContextImpl的一个静态变量,key是包名,value是file-sp的map集合
if (sSharedPrefsCache == null) {
sSharedPrefsCache = new ArrayMap<>();
}
final String packageName = getPackageName();
ArrayMap<File, SharedPreferencesImpl> packagePrefs = sSharedPrefsCache.get(packageName);
if (packagePrefs == null) {
packagePrefs = new ArrayMap<>();
sSharedPrefsCache.put(packageName, packagePrefs);
}
return packagePrefs;
}
-
得出结论:
1.我们在使用context获取上下文时候最好用同一个上下文,这里建议用Application作为上下文去调用getSharedPreferences()。原因是每一个ContextImpl实例都有ArrayMap类型的mSharedPrefsPaths成员变量,而每一个Activity和Application都有自己的ContextImpl实例,为了不创建多余的mSharedPrefsPaths,故而建议使用同一个context去调用getSharedPreferences()。
2.通过思考得出虽然不同的context上下文去调用getSharedPreferences()时候,最初都会由于mSharedPrefsPaths中不存在fileName对应的file而会去创建一个新的file,但是还是可以在ArrayMap<File, SharedPreferencesImpl> packagePrefs中通过创建的新file找到对应的sp,这就说明File这个类肯定重写了equals()和hashCode()方法,就像String类一样虽然字符串相同,但是作为不同的对象equals()方法也会返回true。而后查看了一下File类果然重写了equals()和hashCode()方法。最终File的这两个方法如下(其中fs是UnixFileSystem这个类的实例):
public boolean equals(Object obj) {
if ((obj != null) && (obj instanceof File)) {
return compareTo((File)obj) == 0;
}
return false;
}
public int compareTo(File pathname) {
return fs.compare(this, pathname);
}
public int compare(File f1, File f2) {
return f1.getPath().compareTo(f2.getPath());
}
public int hashCode() {
return fs.hashCode(this);
}
public int hashCode(File f) {
return f.getPath().hashCode() ^ 1234321;
}
结合以下代码运行:
ArrayMap<File,String> stringArrayMap = new ArrayMap<>();
File file1 = new File("a.txt");
File file2 = new File("a.txt");
stringArrayMap.put(file1,"lili");
stringArrayMap.put(file2,"haha");
Log.d("llll",stringArrayMap.size()+"");
Log.d("llll",stringArrayMap.get(file1));
Log.d("llll",stringArrayMap.get(file2));
结果:
D/llll: 1
haha
haha