1 简介
SharedPreferences是Android日常开发中熟悉得不能再熟悉的轻量数据存储框架。通过它我们可以方便的实现int, long, float, char, String类型的存储和获取。具体怎么使用这里不展开了。本文准备从源码角度来解答下面几个问题：
- commit和apply两种提交方式的区别？
- 多次频繁使用getXXX方法会不会降低性能？
- 多进程中能否使用？
- 缓存机制的实现？
2 源码解析-ContextImpl#getSharedPreferences
2.1 getSharedPreferences方法
不管是在activity，还是在application中调用getSharedPreferences方法，最后都是通过ContextImpl类的getSharedPreferences获取SharedPreferences实例的。
@Override
public SharedPreferences getSharedPreferences(File file, int mode) {
checkMode(mode);
//SharedPreferences的具体实现类SharedPreferencesImpl
SharedPreferencesImpl sp;
//每个SharedPreferences实例都是有缓存的
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;
}
}
//如果是MODE_MULTI_PROCESS模式(或者低于3.0系统)，那么它会在首次初始化的时候重新加载数据
if ((mode & Context.MODE_MULTI_PROCESS) != 0 || getApplicationInfo().targetSdkVersion < android.os.Build.VERSION_CODES.HONEYCOMB) {
sp.startReloadIfChangedUnexpectedly();
}
return sp;
}
上面方法就是先判断缓存中有没有对应的SharedPreferences实例，如果有，那么如果是MODE_MULTI_PROCESS模式，就重新加载，如果没有就初始化一个，这时候是不需要重新加载的。
3 源码解析-SharedPreferencesImpl
3.1 SharedPreferences
SharedPreferences实际上是个接口，具体实现类是SharedPreferencesImpl。
public interface SharedPreferences {
//数据改变监听接口,能实现key级别的改变监听
public interface OnSharedPreferenceChangeListener {
void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key);
}
//SharedPreferences编辑器的接口
public interface Editor {
//基本数据key-value的接口方法
Editor putString(String key, String value);
Editor putStringSet(String key, Set<String> values);
Editor putInt(String key, int value);
Editor putLong(String key, long value);
Editor putFloat(String key, float value);
Editor putBoolean(String key, boolean value);
//删除指定key的键值对
Editor remove(String key);
//清空所有键值对
Editor clear();
//同步提交
boolean commit();
//异步提交
void apply();
}
//数据获取接口
Map<String, ?> getAll();
String getString(String key, String defValue);
Set<String> getStringSet(String key, Set<String> defValues);
int getInt(String key, int defValue);
long getLong(String key, long defValue);
float getFloat(String key, float defValue);
boolean getBoolean(String key, boolean defValue);
boolean contains(String key);
//针对preferences创建一个新的Editor对象，通过它你可以修改preferences里的数据，并且原子化的将这些数据提交回SharedPreferences对象
Editor edit();
//注册回调函数
void registerOnSharedPreferenceChangeListener(OnSharedPreferenceChangeListener listener);
//注销的回调函数
void unregisterOnSharedPreferenceChangeListener(OnSharedPreferenceChangeListener listener);
}
3.2 SharedPreferencesImpl构造函数
SharedPreferencesImpl(File file, int mode) {
//该file是在ContextImpl里面定义的，在应用的data目录下的shared_prefs目录下，文件名和模式都是创建时传入的
mFile = file;
//与mFile同名的.bak文件，当mFile出现crash时恢复数据
mBackupFile = makeBackupFile(file);
//模式,常用的是MODE_PRIVATE，还有MODE_MULTI_PROCESS、MODE_WORLD_READABLE、MODE_WORLD_WRITEABLE，后面两个在android N以上已经不支持了
mMode = mode;
mLoaded = false;
//缓存map
mMap = null;
//从磁盘中加载数据
startLoadFromDisk();
}
3.3 SharedPreferencesImpl#startLoadFromDisk
private void startLoadFromDisk() {
//加了个对象同步锁，表明只有持有该锁的线程才能将mLoaded置为false
synchronized (this) {
mLoaded = false;
}
//新启动一个线程去执行loadFromDisk
new Thread("SharedPreferencesImpl-load") {
public void run() {
loadFromDisk();
}
}.start();
}
3.4 SharedPreferencesImpl#loadFromDisk
private void loadFromDisk() {
synchronized (SharedPreferencesImpl.this) {
//已经加载，直接返回
if (mLoaded) {
return;
}
//如果有备份文件，则删除原文件，并将备份文件改名为原文件
if (mBackupFile.exists()) {
mFile.delete();
mBackupFile.renameTo(mFile);
}
}
Map map = null;
StructStat stat = null;
try {
//读取文件的属性
stat = Os.stat(mFile.getPath());
if (mFile.canRead()) {
BufferedInputStream str = null;
try {
str = new BufferedInputStream(new FileInputStream(mFile), 16 * 1024);
//通过系统的XmlUtils类中的readMapXml方法实现xml文件的读取
map = XmlUtils.readMapXml(str);
} catch (XmlPullParserException | IOException e) {
Log.w(TAG, "getSharedPreferences", e);
} finally {
IoUtils.closeQuietly(str);
}
}
} catch (ErrnoException e) {
/* ignore */
}
//更新内存中的一些记录
synchronized (SharedPreferencesImpl.this) {
//已经加载置为true
mLoaded = true;
if (map != null) {
//数据map赋值
mMap = map;
//时间戳
mStatTimestamp = stat.st_mtime;
//文件大小
mStatSize = stat.st_size;
} else {
mMap = new HashMap<>();
}
// //唤醒其他等待线程,主要是getXXX(),因为在这些方法中都加了synchronized (this)的线程锁
notifyAll();
}
}
上面完成了将磁盘xml文件解析到内存map在的操作。在加载操作完成前，getXXX系列方法都是阻塞等待的，一旦拿到SharePreference对象后，getXXX操作都不再是文件读操作了，所有并不存在多次调用getXXX方法会导致性能降低的说法。
3.5 SharedPreferencesImpl#getString
public String getString(String key, @Nullable String defValue) {
synchronized (this) {
//阻塞等待异步加载线程加载完成
awaitLoadedLocked();
//获取map中key对应的string
String v = (String) mMap.get(key);
return v != null ? v : defValue;
}
}
private void awaitLoadedLocked() {
//如果未加载完成，则一直wait，直到加载线程notify
while (!mLoaded) {
try {
wait();
} catch (InterruptedException unused) {
}
}
}
如果数据未加载完成的时候，get方法是阻塞等待的，所以在应用中一般在应用初始化的时候就把SharedPreferences对象创建完成，后面使用的时候就是直接内存操作了。
下面开始分析put的代码。
3.6 SharedPreferencesImpl#edit
public Editor edit() {
synchronized (this) {
//等待异步加载线程完成加载
awaitLoadedLocked();
}
//Editor接口的具体实现
return new EditorImpl();
}
数据的设置，还有将内存数据持久化到磁盘文件都是通过Editor实现的。
3.7 SharedPreferencesImpl$EditorImpl
//创建一个map，用来存放内存数据
private final Map<String, Object> mModified = Maps.newHashMap();
//是否全部清除的标记
private boolean mClear = false;
//设置String值，就是放到map缓存中，其他的类型也是同样
public Editor putString(String key, @Nullable String value) {
//加了一个EditorImpl对象的同步锁，主要用来控制mModified的单线程操作
synchronized (this) {
mModified.put(key, value);
return this;
}
}
//remove的时候value是this，这是一个“魔法值”
public Editor remove(String key) {
synchronized (this) {
mModified.put(key, this);
return this;
}
}
public Editor clear() {
synchronized (this) {
mClear = true;
return this;
}
}
通过Editor对象的put方法来设置数据，然后通过commit或者apply同步数据到SharedPreferences中的map，在同步或者异步提交数据到磁盘文件。
3.8 SharedPreferencesImpl$EditorImpl#apply、commit
apply方法与commit方法的不同之处是，前者写文件的时候是异步的，而后者是同步的。
public void apply() {
//将Editor的数据同步到SharedPreferences的缓存map中，它返回的是MemoryCommitResult类型的结果
final MemoryCommitResult mcr = commitToMemory();
final Runnable awaitCommit = new Runnable() {
public void run() {
try {
//等待写文件结束
mcr.writtenToDiskLatch.await();
} catch (InterruptedException ignored) {
}
}
};
QueuedWork.add(awaitCommit);
//处理扫尾工作的Runnable
Runnable postWriteRunnable = new Runnable() {
public void run() {
awaitCommit.run();
QueuedWork.remove(awaitCommit);
}
};
//写文件
SharedPreferencesImpl.this.enqueueDiskWrite(mcr, postWriteRunnable);
notifyListeners(mcr);
}
private void enqueueDiskWrite(final MemoryCommitResult mcr, final Runnable postWriteRunnable) {
//写文件的Runnable
final Runnable writeToDiskRunnable = new Runnable() {
public void run() {
synchronized (mWritingToDiskLock) {
//最核心的写文件方法
writeToFile(mcr);
}
synchronized (SharedPreferencesImpl.this) {
//写文件计数器-1
mDiskWritesInFlight--;
}
//执行收尾的Runnabel
if (postWriteRunnable != null) {
postWriteRunnable.run();
}
}
};
//commit（后面会分析）时postWriteRunnable为null，isFromSyncCommit为true
final boolean isFromSyncCommit = (postWriteRunnable == null);
if (isFromSyncCommit) {
boolean wasEmpty = false;
synchronized (SharedPreferencesImpl.this) {
//当前只有一个写操作
wasEmpty = mDiskWritesInFlight == 1;
}
if (wasEmpty) {
//只有一个写操作，直接在当前线程执行写文件，然后返回
writeToDiskRunnable.run();
return;
}
}
//在单独线程执行写文件
QueuedWork.singleThreadExecutor().execute(writeToDiskRunnable);
}
下面看下commit方法。
public boolean commit() {
//与apply方法一样也是先提交内存
MemoryCommitResult mcr = commitToMemory();
//postWriteRunnable参数为空
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和writeToFile。那么我们首先看下MemoryCommitResult。
MemoryCommitResult正如它的命名一样，是表示内存提交结果的数据结构，用于标注是否有数据改变、改变的key列表、监听器、需要写入文件的数据、写文件结果等。
private static class MemoryCommitResult {
public boolean changesMade; // any keys different?
public List<String> keysModified; // may be null
public Set<android.content.SharedPreferences.OnSharedPreferenceChangeListener> listeners; // may be null
public Map<?, ?> mapToWriteToDisk;
public final CountDownLatch writtenToDiskLatch = new CountDownLatch(1);
public volatile boolean writeToDiskResult = false;
public void setDiskWriteResult(boolean result) {
writeToDiskResult = result;
writtenToDiskLatch.countDown();
}
}
下面是commitToMemory方法。
private MemoryCommitResult commitToMemory() {
//实例化MemoryCommitResult对象
MemoryCommitResult mcr = new MemoryCommitResult();
//和SharedPreferencesImpl共用一把锁
synchronized (SharedPreferencesImpl.this) {
if (mDiskWritesInFlight > 0) {
//拷贝一份内存数据
mMap = new HashMap<String, Object>(mMap);
}
//将内存中的mMap赋值给要写到disk的Map
mcr.mapToWriteToDisk = mMap;
//写文件计数器+1
mDiskWritesInFlight++;
//判断有没有监听器
boolean hasListeners = mListeners.size() > 0;
if (hasListeners) {
//创建监听队列
mcr.keysModified = new ArrayList<String>();
mcr.listeners =
new HashSet<android.content.SharedPreferences.OnSharedPreferenceChangeListener>(mListeners.keySet());
}
//加一个EditorImpl的锁
synchronized (this) {
//清除数据
if (mClear) {
if (!mMap.isEmpty()) {
mcr.changesMade = true;
mMap.clear();
}
mClear = false;
}
//遍历mModified，将remove的数据移除，将新数据放进去
for (Map.Entry<String, Object> e : mModified.entrySet()) {
String k = e.getKey();
Object v = e.getValue();
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;
}
}
//把变化和新加的数据更新到SharePreferenceImpl的mMap中
mMap.put(k, v);
}
//设置数据结构变化标记
mcr.changesMade = true;
if (hasListeners) {
mcr.keysModified.add(k);
}
}
//清空Editor中临时数据
mModified.clear();
}
}
//返回值，里面最重要的数据是更新后的map数据，用于后面的写文件
return mcr;
}
最核心的写文件操作，它的参数就是提交内存方法返回的MemoryCommitResult数据，里面封装了所有需要写入文件的数据。
private void writeToFile(MemoryCommitResult mcr) {
if (mFile.exists()) {
if (!mcr.changesMade) {
//如果文件存在且没有改变的数据则直接返回
mcr.setDiskWriteResult(true);
return;
}
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();
}
}
try {
//创建mFile文件
FileOutputStream str = createFileOutputStream(mFile);
if (str == null) {
//标记写失败
mcr.setDiskWriteResult(false);
return;
}
//把数据写入mFile文件
XmlUtils.writeMapXml(mcr.mapToWriteToDisk, str);
//同步到磁盘文件中
FileUtils.sync(str);
str.close();
//设置文件权限
ContextImpl.setFilePermissionsFromMode(mFile.getPath(), mMode, 0);
//更新文件时间戳和大小
try {
final StructStat stat = Os.stat(mFile.getPath());
synchronized (this) {
mStatTimestamp = stat.st_mtime;
mStatSize = stat.st_size;
}
} catch (ErrnoException e) {
// Do nothing
}
//写成功了mFile那就把备份文件直接删掉
mBackupFile.delete();
//标记写成功，然后返回
mcr.setDiskWriteResult(true);
return;
} catch (XmlPullParserException e) {
Log.w(TAG, "writeToFile: Got exception:", e);
} catch (IOException e) {
Log.w(TAG, "writeToFile: Got exception:", e);
}
// Clean up an unsuccessfully written file
if (mFile.exists()) {
//标记写失败，删除文件。
if (!mFile.delete()) {
Log.e(TAG, "Couldn't clean up partially-written file " + mFile);
}
}
//标记写失败
mcr.setDiskWriteResult(false);
}
比较难以理解的是源文件和备份文件的处理逻辑，按照代码逻辑应该是，只要文件写入成功，那么就删除备份文件，保证只有源文件存在，如果写入不成功，那么就把不完整的源文件删掉，保证只存在备份文件，但是备份文件保存的是上一次的完整数据，用于初始化的时候加载数据。这跟数据库的事务处理比较像。
4 问题总结
- commit和apply两种提交方式的区别？
看前面源码分析就知道了，前者是同步数据提交，后者是异步数据提交。 - 多次频繁使用getXXX方法会不会降低性能？
不会，原因看前面分析。 - 多进程中能否使用？
如果是MODE_MULTI_PROCESS模式的，那么也只是在初始化的时候同步其他进程最新的数据，后面改变的数据，不会同步过来。推荐使用ContentProvider这种方式。 - 缓存机制的实现？
看前面源码分析就知道了。
