Android SharedPreferences 實現原理解析

序言

Android 中的 SharedPreference 是輕量級的數據存儲方式，可以保存簡單的數據類型，好比 String、int、boolean 值等。其內部是以 XML 結構保存在 /data/data/包名/shared_prefs 文件夾下，數據以鍵值對的形式保存。下面有個例子：

<?xml version='1.0' encoding='utf-8' standalone='yes' ?>
<map>
    <float name="isFloat" value="1.5" />
    <string name="isString">Android</string>
    <int name="isInt" value="1" />
    <long name="isLong" value="1000" />
    <boolean name="isBoolean" value="true" />
    <set name="isStringSet">
        <string>element 1</string>
        <string>element 2</string>
        <string>element 3</string>
    </set>
</map>
複製代碼

這裏不討論 API 的使用方法，主要是從源碼角度分析 SharedPreferences （如下簡稱 SP） 的實現方式。

1. 初始化

首先咱們使用 context 的 getSharedPreferences 方法獲取 SP 實例，它是一個接口對象。 SharedPreferences testSp = getSharedPreferences("test_sp", Context.MODE_PRIVATE); Context 是一個抽象類，其核心實現類是 ContextImpl ，找到裏面的 getSharedPreferences 方法。

@Override
    public SharedPreferences getSharedPreferences(String name, int mode) {
        SharedPreferencesImpl sp;
        synchronized (ContextImpl.class) {
            if (sSharedPrefs == null) {
                // sSharedPrefs 是 ContextImpl 的靜態成員變量，經過 Map 維護着當前包名下的 SP Map 集合
                sSharedPrefs = new ArrayMap<String, ArrayMap<String, SharedPreferencesImpl>>();
            }

            final String packageName = getPackageName();
            ArrayMap<String, SharedPreferencesImpl> packagePrefs = sSharedPrefs.get(packageName);
            if (packagePrefs == null) {
                packagePrefs = new ArrayMap<String, SharedPreferencesImpl>();
                sSharedPrefs.put(packageName, packagePrefs);
            }

            // At least one application in the world actually passes in a null
            // name.  This happened to work because when we generated the file name
            // we would stringify it to "null.xml".  Nice.
            if (mPackageInfo.getApplicationInfo().targetSdkVersion <
                    Build.VERSION_CODES.KITKAT) {
                // name 參數爲 null 時，文件名使用 null.xml
                if (name == null) {
                    name = "null";
                }
            }

            sp = packagePrefs.get(name);
            if (sp == null) {
                // SP 集合是一個以 SP 的名字爲 key , SP 爲值的 Map
                File prefsFile = getSharedPrefsFile(name);
                // SP 的實現類是 SharedPreferencesImpl
                sp = new SharedPreferencesImpl(prefsFile, mode);
                packagePrefs.put(name, sp);
                return sp;
            }
        }
        // Android 3.0 如下或者支持 MODE_MULTI_PROCESS 模式時，若是文件被改動，就從新從文件讀取，實現多進程數據同步，可是實際使用中效果不佳，可能會有不少坑。
        if ((mode & Context.MODE_MULTI_PROCESS) != 0 ||
            getApplicationInfo().targetSdkVersion < android.os.Build.VERSION_CODES.HONEYCOMB) {
            // If somebody else (some other process) changed the prefs
            // file behind our back, we reload it.  This has been the
            // historical (if undocumented) behavior.
            sp.startReloadIfChangedUnexpectedly();
        }
        return sp;
    }
複製代碼

首次使用 getSharedPreferences 時，內存中不存在 SP 以及 SP Map 緩存，須要建立 SP 並添加到 ContextImpl 的靜態成員變量（sSharedPrefs）中。 下面來看 SharedPreferencesImpl 的構造方法，

SharedPreferencesImpl(File file, int mode) {
        mFile = file;
        mBackupFile = makeBackupFile(file);
        mMode = mode;
        mLoaded = false;
        mMap = null;
        startLoadFromDisk();
    }
複製代碼

makeBackupFile 用來定義備份文件，該文件在寫入磁盤時會用到，繼續看 startLoadFromDisk 方法。

private void startLoadFromDisk() {
        synchronized (this) {
            mLoaded = false;
        }
        // 開啓異步線程從磁盤讀取文件，加鎖防止多線程併發操做
        new Thread("SharedPreferencesImpl-load") {
            public void run() {
                synchronized (SharedPreferencesImpl.this) {
                    loadFromDiskLocked();
                }
            }
        }.start();
    }

 private void loadFromDiskLocked() {
        if (mLoaded) {
            return;
        }
        // 備份文件存在，說明上次的寫入操做失敗，直接讀取備份文件
        if (mBackupFile.exists()) {
            mFile.delete();
            mBackupFile.renameTo(mFile);
        }

        // Debugging
        if (mFile.exists() && !mFile.canRead()) {
            Log.w(TAG, "Attempt to read preferences file " + mFile + " without permission");
        }

        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);
                    // 從 XML 裏面讀取數據返回一個 Map，內部使用了 XmlPullParser
                    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) {
        }
        mLoaded = true;
        if (map != null) {
            mMap = map;
            mStatTimestamp = stat.st_mtime;
            mStatSize = stat.st_size;
        } else {
            mMap = new HashMap<String, Object>();
        }
         // 喚醒等待的線程，到這文件讀取完畢
        notifyAll();
}
複製代碼

看到這，基本明白了 getSharedPreferences 的原理，應用首次使用 SP 的時候會從磁盤讀取，以後緩存在內存中。

2. 讀數據

下面分析 SP 讀取數據的方法，就以 getString 爲例。

@Nullable
public String getString(String key, @Nullable String defValue) {
      synchronized (this) {
          awaitLoadedLocked();
          String v = (String)mMap.get(key);
          return v != null ? v : defValue;
      }
}

private void awaitLoadedLocked() {
      if (!mLoaded) {
          // Raise an explicit StrictMode onReadFromDisk for this
          // thread, since the real read will be in a different
          // thread and otherwise ignored by StrictMode.
          BlockGuard.getThreadPolicy().onReadFromDisk();
      }
      while (!mLoaded) {
          try {
              wait();
          } catch (InterruptedException unused) {
          }
      }
}
複製代碼

首先取得 SharedPreferencesImpl 對象鎖，而後同步等待從磁盤加載數據完成，最後返回數據。這裏有個問題，若是單個 SP 存儲的內容過多，致使咱們使用 getXXX 方法的時候阻塞，特別是在主線程調用的時候，因此建議在單個 SP 中儘可能少地保存數據，雖然操做時間是毫秒級別的，用戶基本上感受不到。

3. 寫數據

SP 寫入數據的操做是經過 Editor 完成的，它也是一個接口，實現類是 EditorImpl，是 SharedPreferencesImpl 的內部類。 經過 SP 的 edit 方法獲取 Editor 實例，等到加載完畢直接返回一個 EditorImpl 對象。

public Editor edit() {
      // TODO: remove the need to call awaitLoadedLocked() when
      // requesting an editor.  will require some work on the
      // Editor, but then we should be able to do:
      //
      //      context.getSharedPreferences(..).edit().putString(..).apply()
      //
      // ... all without blocking.
      synchronized (this) {
          awaitLoadedLocked();
      }
      return new EditorImpl();
}
複製代碼

好比咱們要保存某個 String 的值，調用 putString 方法。

public Editor putString(String key, @Nullable String value) {
      synchronized (this) {
          mModified.put(key, value);
          return this;
      }
}
複製代碼

mModified 是一個 editor 中的一個 Map，保存着要修改的數據，在將改動保存到 SP 的 Map（變量 mMap，裏面保存着使用中的鍵值對 ） 後被清空。put 完成後就要調用 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;
        }

        public void apply() {
            final MemoryCommitResult mcr = commitToMemory();
            final Runnable awaitCommit = new Runnable() {
                    public void run() {
                        try {
                            mcr.writtenToDiskLatch.await();
                        } catch (InterruptedException ignored) {
                        }
                    }
                };

            QueuedWork.add(awaitCommit);

            Runnable postWriteRunnable = new Runnable() {
                    public void run() {
                        awaitCommit.run();
                        QueuedWork.remove(awaitCommit);
                    }
                };

            SharedPreferencesImpl.this.enqueueDiskWrite(mcr, postWriteRunnable);

            // Okay to notify the listeners before it's hit disk // because the listeners should always get the same // SharedPreferences instance back, which has the // changes reflected in memory. notifyListeners(mcr); } 複製代碼

能夠看到，commit 和 apply 操做首先執行了 commitToMemory，顧名思義就是提交到內存，返回值是 MemoryCommitResult 類型，裏面保存着本次提交的狀態。而後 commit 調用 enqueueDiskWrite 會阻塞當前線程，而 apply 經過封裝 Runnable 把寫磁盤以後的操做傳遞給 enqueueDiskWrite 方法。

private MemoryCommitResult commitToMemory() {
            MemoryCommitResult mcr = new MemoryCommitResult();
            synchronized (SharedPreferencesImpl.this) {
                // We optimistically don't make a deep copy until // a memory commit comes in when we're already
                // writing to disk.
                // mDiskWritesInFlight  表示準備操做磁盤的進程數
                if (mDiskWritesInFlight > 0) {
                    // We can't modify our mMap as a currently // in-flight write owns it. Clone it before // modifying it. // noinspection unchecked mMap = new HashMap<String, Object>(mMap); } mcr.mapToWriteToDisk = mMap; mDiskWritesInFlight++; // 把註冊的 listeners 放到 mcr 中去，以便在數據寫入的時候被回調 boolean hasListeners = mListeners.size() > 0; if (hasListeners) { mcr.keysModified = new ArrayList<String>(); mcr.listeners = new HashSet<OnSharedPreferenceChangeListener>(mListeners.keySet()); } synchronized (this) { if (mClear) { if (!mMap.isEmpty()) { mcr.changesMade = true; mMap.clear(); } mClear = false; } 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. // 當值是 null 時，表示移除該鍵值對，在 editor 的 remove 實現中，並非真正地移除， // 而是把 value 賦值爲當前 editor 對象 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); } } // 添加完成後把 editor 裏的 map 清空 mModified.clear(); } } return mcr; } 複製代碼

這是 MemoryCommitResult 類，主要用於提交到內存後返回結果，而後在寫入磁盤時做爲參數傳遞。

private static class MemoryCommitResult {
        public boolean changesMade;  // any keys different?
        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();
        }
    }
複製代碼

下面看保存到磁盤的操做，enqueueDiskWrite 方法，參數有 MemoryCommitResult 和 Runnable，mcr 剛纔說過，就看這個 Runnable 是幹嗎的。在 commit 方法中調用 enqueueDiskWrite 方法是傳入的 Runnable 是null，它會在當前線程直接執行寫文件的操做，而後返回寫入結果。而若是 Runnable 不是 null，那就使用 QueueWork 中的單線程執行。這就是 apply 和 commit 的根本區別：一個同步執行，有返回值；一個異步執行，沒有返回值。大多數狀況下，咱們使用 apply 就夠了，這也是官方推薦的作法。

private void enqueueDiskWrite(final MemoryCommitResult mcr,
                                  final Runnable postWriteRunnable) {
        final Runnable writeToDiskRunnable = new Runnable() {
                public void run() {
                    synchronized (mWritingToDiskLock) {
                        // 真正寫入文件
                        writeToFile(mcr);
                    }
                    synchronized (SharedPreferencesImpl.this) {
                        mDiskWritesInFlight--;
                    }
                    if (postWriteRunnable != null) {
                        postWriteRunnable.run();
                    }
                }
            };

        final boolean isFromSyncCommit = (postWriteRunnable == null);

        // Typical #commit() path with fewer allocations, doing a write on
        // the current thread.
        if (isFromSyncCommit) {
            boolean wasEmpty = false;
            synchronized (SharedPreferencesImpl.this) {
                wasEmpty = mDiskWritesInFlight == 1;
            }
            if (wasEmpty) {
                writeToDiskRunnable.run();
                return;
            }
        }
        // 把寫文件的操做放到線程池中執行
        QueuedWork.singleThreadExecutor().execute(writeToDiskRunnable);
    }
複製代碼

再看一下具體寫文件的代碼 writeToFile 方法，關鍵點在代碼中文註釋部分。簡單說就是備份 → 寫入 → 檢查 → 善後，這樣保證了數據的安全性和穩定性。

private void writeToFile(MemoryCommitResult mcr) {
        // Rename the current file so it may be used as a backup during the next read
        if (mFile.exists()) {
            if (!mcr.changesMade) {
                // If the file already exists, but no changes were
                // made to the underlying map, it's wasteful to // re-write the file. Return as if we wrote it // out. 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(); } } // Attempt to write the file, delete the backup and return true as atomically as // possible. If any exception occurs, delete the new file; next time we will restore // from the backup. try { FileOutputStream str = createFileOutputStream(mFile); if (str == null) { mcr.setDiskWriteResult(false); return; } // 而後把新數據寫入文件 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 } // Writing was successful, delete the backup file if there is one. // 寫入成功刪除備份文件 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. 總結

經過 getSharedPreferences 能夠獲取 SP 實例，從首次初始化到讀到數據會存在延遲，由於讀文件的操做阻塞調用的線程直到文件讀取完畢，若是在主線程調用，可能會對 UI 流暢度形成影響。 commit 會在調用者線程同步執行寫文件，返回寫入結果；apply 將寫文件的操做異步執行，沒有返回值。能夠根據具體狀況選擇性使用，推薦使用 apply。 雖然支持設置 MODE_MULTI_PROCESS 標誌位，可是跨進程共享 SP 存在不少問題，因此不建議使用該模式。

最後

在這裏我總結出了互聯網公司Android程序員面試簡歷模板，面試涉及到的絕大部分面試題及答案作成了文檔和架構視頻資料免費分享給你們【包括高級UI、性能優化、架構師課程、NDK、Kotlin、混合式開發（ReactNative+Weex）、Flutter等架構技術資料】，但願能幫助到您面試前的複習且找到一個好的工做，也節省你們在網上搜索資料的時間來學習。

資料獲取方式：加入Android架構交流QQ羣聊：513088520 ，進羣即領取資料！！！

點擊連接加入羣聊【Android移動架構總羣】：加入羣聊