SharedPreferences源码浅析
0、6.0网盘地址https://yunpan.cn/cBV9PmkBEPdcd (提取码:61a8)我已经将Android 6.0 的源代码压缩上传到了360网盘,有需要的同学请自取。1、 前言一般来说,我们有两种方法获取SharedPreferences对象(下文称为sp)。Activit#getSharedPreferencesContext#getSharedPreferences
0、6.0网盘地址
https://yunpan.cn/cBV9PmkBEPdcd (提取码:61a8)
我已经将Android 6.0 的源代码压缩上传到了360网盘,有需要的同学请自取。
1、 前言
一般来说,我们有两种方法获取SharedPreferences对象(下文称为sp)。
- Activit#getSharedPreferences
- Context#getSharedPreferences
不管是上面那个方法,最终都会调用Context#getSharedPreferences方法,而我们知道Context的实现类为ContextImpl。所以,我们需要在ContextImpl类中查看。
2、 ContextImpl#getSharedPreferences
源码部分较多,就不贴代码了。这里只把关键性的贴一下。
SharedPreferencesImpl sp;
可以看的出,sp的实现类为SharedPreferencesImpl。
final String packageName = getPackageName();
ArrayMap<String, SharedPreferencesImpl> packagePrefs = sSharedPrefs.get(packageName);
if (packagePrefs == null) {
packagePrefs = new ArrayMap<String, SharedPreferencesImpl>();
sSharedPrefs.put(packageName, packagePrefs);
}
看的出,SharedPreferencesImpl存在了ArrayMap当中,方便下次读取。
File prefsFile = getSharedPrefsFile(name);
sp = new SharedPreferencesImpl(prefsFile, mode);
packagePrefs.put(name, sp);
return sp;
- getSharedPrefsFile创建.xml文件。
@Override
public File getSharedPrefsFile(String name) {
return makeFilename(getPreferencesDir(), name + ".xml");
}
3、SharedPreferencesImpl的初始化过程
SharedPreferencesImpl(File file, int mode) {
mFile = file;
mBackupFile = makeBackupFile(file);
mMode = mode;
mLoaded = false;
mMap = null;
startLoadFromDisk();
}
- mBackupFile是备份文件
重点是startLoadFromDisk()方法。
startLoadFromDisk-》loadFromDiskLocked(子线程)去将数据加载到内存中。我们看下loadFromDiskLocked方法的关键代码。
try {
stat = Os.stat(mFile.getPath());
if (mFile.canRead()) {
BufferedInputStream str = null;
try {
str = new BufferedInputStream(
new FileInputStream(mFile), 16*1024);
map = XmlUtils.readMapXml(str);
} catch (XmlPullParserException e) {
Log.w(TAG, "getSharedPreferences", e);
} catch (FileNotFoundException e) {
Log.w(TAG, "getSharedPreferences", e);
} catch (IOException e) {
Log.w(TAG, "getSharedPreferences", e);
} finally {
IoUtils.closeQuietly(str);
}
}
} catch (ErrnoException e) {
}
从上面可以看到,将name对应的.xml文件加载到内存中,并通过XmlUtils.readMapXml(str)方法,读取到map中,注意。在ContextImpl的有这么一段代码。
private static ArrayMap<String, ArrayMap<String, SharedPreferencesImpl>> sSharedPrefs;
可以看到,这里是个static,表明,这万一是在整个程序运行过程中都存在的,所以,有以下点需要注意。
- 理论上在存储数据是没有限制的。(存储控件的大小限制)
- 但是数据不能太大,因为在程序的运行过程中,缓存在了内存。
4、 更新数据/添加数据的过程
我们通过edit方法去获取Editor对象。
return new EditorImpl();
看的出Editor的实现类为EditorImpl。当我们修改完数据之后,会通过commit或者apply方法刷新数据。
public boolean commit() {
MemoryCommitResult mcr = commitToMemory();
SharedPreferencesImpl.this.enqueueDiskWrite(
mcr, null /* sync write on this thread okay */);
try {
mcr.writtenToDiskLatch.await();
} catch (InterruptedException e) {
return false;
}
notifyListeners(mcr);
return mcr.writeToDiskResult;
}
我们先看commitToMemory(),从方法名可以看出,这是将内存中的数据更新,也就是我们最先读取到map中的数据。该方法代码比较长,只给出修改数据部分的吧。
for (Map.Entry<String, Object> e : mModified.entrySet()) {
String k = e.getKey();
Object v = e.getValue();
// "this" is the magic value for a removal mutation. In addition,
// setting a value to "null" for a given key is specified to be
// equivalent to calling remove on that key.
if (v == this || v == null) {
if (!mMap.containsKey(k)) {
continue;
}
mMap.remove(k);
} else {
if (mMap.containsKey(k)) {
Object existingValue = mMap.get(k);
if (existingValue != null && existingValue.equals(v)) {
continue;
}
}
mMap.put(k, v);
}
mcr.changesMade = true;
if (hasListeners) {
mcr.keysModified.add(k);
}
}
mModified.clear();
}
这样,我们读取到内存map中的数据就更新了。接下来就会执行磁盘写入了。
SharedPreferencesImpl.this.enqueueDiskWrite(
mcr, null /* sync write on this thread okay */);
enqueueDiskWrite->writeToFile方法进行数据写入。
if (!mBackupFile.exists()) {
if (!mFile.renameTo(mBackupFile)) {
Log.e(TAG, "Couldn't rename file " + mFile
+ " to backup file " + mBackupFile);
mcr.setDiskWriteResult(false);
return;
}
} else {
mFile.delete();
}
在写入之前,先将当前的文件重命名为我们的备份文件,然后在写入,写入的代码如下。
FileOutputStream str = createFileOutputStream(mFile);
if (str == null) {
mcr.setDiskWriteResult(false);
return;
}
XmlUtils.writeMapXml(mcr.mapToWriteToDisk, str);
FileUtils.sync(str);
str.close();
这样就将最新的数据写入到了文件中了。
5、 总结
- 高效的原因,数据缓存在了一个map当中
- 注意,虽然说没有大小限制,但是尽量轻量吧,毕竟数据一股脑的加载到了内存中。
- 源码中还有许多细节,没有介绍,还得继续看。
开放原子开发者工作坊旨在鼓励更多人参与开源活动,与志同道合的开发者们相互交流开发经验、分享开发心得、获取前沿技术趋势。工作坊有多种形式的开发者活动,如meetup、训练营等,主打技术交流,干货满满,真诚地邀请各位开发者共同参与!
更多推荐
所有评论(0)