android SharedPreference的实现（2）

从SharedPreference中获取值以及从Editor中设置值已经在SharedPreferences的具体实现(1)中具体说明，这节的主要目的就是理解SharedPreference的commit过程。

代码1：
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;
}  

以上就是commit的代码，最终返回执行成功或者失败，具体细节我们先分析下一个对象–MemoryCommitResult

代码2：
private static class MemoryCommitResult {
    public long memoryStateGeneration;
    public List<String> keysModified;  // may be null
    public Set<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();
    }
}  

解释下这个类的具体作用，这个类记录着内存中key-value的变化并将这种变化告诉listener。memoryStateGeneration实际上是一种xml配置版本记录，系统中存在着mCurrentMemoryStateGeneration和mDiskStateGeneration，他们的类型均为long，分别记录了一个数值，这个数值表示key-value是否已经发生变化，在commit的时候是否需要写入xml文件。mDiskStateGeneration表示上一次执行commit后xml配置文件版本，mCurrentMemoryStateGeneration和memoryStateGeneration表示当前xml配置文件的版本，在将key-value写入xml配置文件时，只有memoryStateGeneration大于mDiskStateGeneration时，系统才会将key-value写入xml配置文件；keysModified表示发生变化的key，发生变化可能是新添加也可能是修改了key对应的value。listeners表示监听SharedPreference上key变化的监听器；mapToWriteToDisk是需要写入xml配置文件的key-value集合；writeToDiskResult表示写入xml配置文件的结果；writtenToDiskLatch，在commit将key-value写入xml配置文件时，系统使用writtenToDiskLatch让程序阻塞，直到commit写入完成。

介绍完MemoryCommitResult，commitToMemory()方法，commitToMemory()方法代码其实很好分析，主要功能就是记录当前需要写入配置文件的key-value，并将需要写入xml配置文件的key-value全部存储在mapToWriteToDisk，同时收集value发生变化的key。mapToWriteToDisk初始值为mMap(mMap可见SharedPreferences的具体实现1中的介绍)。系统会遍历mModified（mModified可见SharedPreferences的具体实现1中的介绍），并通过一定的机制将需要写入xml配置文件的key-value值添加到mapToWriteToDisk中，同时添加到keysModified中；同时修改memoryStateGeneration。

enqueueDiskWrite中执行的核心代码是writeToFile(mcr, isFromSyncCommit)方法，接下来我们主要分析下这部分的代码。
在分析这段代码之前，我们需要了解系统在写入配置文件时，有一个保护机制，为原来的配置文件生成一份备份文件，写入成功后删除备份文件，写入失败后从备份文件中恢复。看下写入文件的代码：

try {
        FileOutputStream str = createFileOutputStream(mFile);
        ....
        XmlUtils.writeMapXml(mcr.mapToWriteToDisk, str);
        ....
    }  

我注释了其他代码，只保留了最核心的代码，可以发现最核心的部分就是将需要写入配置文件的xml写入对应的文件输出流。