一.sp是什么?能做什么?
SharedPreferences(簡稱SP)是Android中很常用的數據存儲方式，SP采用key-value（鍵值對）形式, 主要用于輕量級的數據存儲, 尤其適合保存應用的配置參數, 但不建議使用SP 來存儲大規模的數據, 可能會降低性能.
SP采用xml文件格式來保存數據, 該文件所在目錄位于/data/data//shared_prefs/
二.該怎么使用?
SharedPreferences sharedPreferences = getSharedPreferences("hello", Context.MODE_PRIVATE);
Editor editor = sharedPreferences.edit();
editor.putString("hello", "lemon");
editor.putInt("old", 3);
editor.commit();
生成的hello.xml文件內容如下：
<?xml version='1.0' encoding='utf-8' standalone='yes' ?>
<map>
<string name="hello">"lemon"</string>
<int name="years" value="3" />
</map>
三.優缺點
四.源碼解析
-
SharedPreferences與Editor只是兩個接口. SharedPreferencesImpl和EditorImpl分別實現了對應接口. 另外, ContextImpl記錄著SharedPreferences的重要數據, 如下:
- sSharedPrefsCache:以包名為key, 二級key是以SP文件, 以SharedPreferencesImpl為value的嵌套map結構. 這里需要sSharedPrefsCache是靜態類成員變量, 每個進程是保存唯一一份, 且由ContextImpl.class鎖保護.
- mSharedPrefsPaths:記錄所有的SP文件, 以文件名為key, 具體文件為value的map結構;
- mPreferencesDir:是指SP所在目錄, 是指/data/data//shared_prefs/
-
SP獲取方式
-
getPreferences{Activity.getPreferences(mode): 以當前Activity的類名作為SP的文件名. 即xxxActivity.xml.}
public SharedPreferences getPreferences(int mode) { //[見下文] return getSharedPreferences(getLocalClassName(), mode); } -
getDefaultSharedPreferences{PreferenceManager.getDefaultSharedPreferences(Context): 以包名加上_preferences作為文件名, 以MODE_PRIVATE模式創建SP文件. 即packgeName_preferences.xml.}
public static SharedPreferences getDefaultSharedPreferences(Context context) { //[見下文] return context.getSharedPreferences(getDefaultSharedPreferencesName(context), getDefaultSharedPreferencesMode()); } -
getSharedPreferences{當然也可以直接調用Context.getSharedPreferences(name, mode), 以上所有的方法最終都是調用到如下方法:}
-
此方法是contxtimpl的具體實現:
class ContextImpl extends Context { private ArrayMap<String, File> mSharedPrefsPaths; public SharedPreferences getSharedPreferences(String name, int mode) { File file; synchronized (ContextImpl.class) { if (mSharedPrefsPaths == null) { mSharedPrefsPaths = new ArrayMap<>(); } //先從mSharedPrefsPaths查詢是否存在相應文件 file = mSharedPrefsPaths.get(name); if (file == null) { //如果文件不存在, 則創建新的文件 [見小節2.1.4] file = getSharedPreferencesPath(name); mSharedPrefsPaths.put(name, file); } } //[見小節2.2] return getSharedPreferences(file, mode); } } -
getSharedPreferencesPath{先從mSharedPrefsPaths查詢是否存在相應文件;如果文件不存在, 則創建新的xml文件; 如果目錄也不存在, 則先創建目錄創建目錄/data/data/package name/shared_prefs/;其中mSharedPrefsPaths用于記錄所有的SP文件, 是以文件名為key的Map數據結構.}
public File getSharedPreferencesPath(String name) { return makeFilename(getPreferencesDir(), name + ".xml"); } private File getPreferencesDir() { synchronized (mSync) { if (mPreferencesDir == null) { //創建目錄/data/data/package name/shared_prefs/ mPreferencesDir = new File(getDataDir(), "shared_prefs"); } return ensurePrivateDirExists(mPreferencesDir); } } -
getSharedPreferences
public SharedPreferences getSharedPreferences(File file, int mode) { checkMode(mode); //[見小節2.2.1] SharedPreferencesImpl sp; synchronized (ContextImpl.class) { //[見小節2.2.2] final ArrayMap<File, SharedPreferencesImpl> cache = getSharedPreferencesCacheLocked(); sp = cache.get(file); if (sp == null) { //創建SharedPreferencesImpl[見小節2.3] sp = new SharedPreferencesImpl(file, mode); cache.put(file, sp); return sp; } } //指定多進程模式, 則當文件被其他進程改變時,則會重新加載 if ((mode & Context.MODE_MULTI_PROCESS) != 0 || getApplicationInfo().targetSdkVersion < android.os.Build.VERSION_CODES.HONEYCOMB) { sp.startReloadIfChangedUnexpectedly(); } return sp; } checkMode{從Android N開始, 創建的SP文件模式, 不允許MODE_WORLD_READABLE和MODE_WORLD_WRITEABLE模塊, 否則會直接拋出異常SecurityException. 另外, 順帶說一下MODE_MULTI_PROCESS這種多進程的方式也是Google不推薦的方式, 后續同樣會不再支持, 強烈建議App不用使用該方式來實現多個進程實現 同一個SP文件.
當設置MODE_MULTI_PROCESS模式, 則每次getSharedPreferences過程, 會檢查SP文件上次修改時間和文件大小, 一旦所有修改則會重新從磁盤加載文件.}
-
-
private void checkMode(int mode) {
if (getApplicationInfo().targetSdkVersion >= Build.VERSION_CODES.N) {
if ((mode & MODE_WORLD_READABLE) != 0) {
throw new SecurityException("MODE_WORLD_READABLE no longer supported");
}
if ((mode & MODE_WORLD_WRITEABLE) != 0) {
throw new SecurityException("MODE_WORLD_WRITEABLE no longer supported");
}
}
}
-
Editor
1.Editor 該過程同樣要等待awaitLoadedLocked完成, 然后創建EditorImpl對象. 而EditorImpl作為SharedPreferencesImpl的內部類,其繼承于Editor類.public Editor edit() { synchronized (this) { awaitLoadedLocked(); } return new EditorImpl(); //創建EditorImpl }-
EditorImpl{從這里可以看出, 這些數據修改操作僅僅是修改mModified和mClear. 直到數據提交commit或許apply過程, 才會真正的把數據更新到SharedPreferencesImpl(簡稱SPI). 比如設置mClear=true則會情況SPI的mMap數據.}
public final class EditorImpl implements Editor { private final Map<String, Object> mModified = Maps.newHashMap(); private boolean mClear = false; //插入數據 public Editor putString(String key, @Nullable String value) { synchronized (this) { //插入數據, 先暫存到mModified對象 mModified.put(key, value); return this; } } //移除數據 public Editor remove(String key) { synchronized (this) { mModified.put(key, this); return this; } } //清空全部數據 public Editor clear() { synchronized (this) { mClear = true; return this; } } }
-
-
數據提交{這里重點來說說數據提交的兩個重要方法commit()和apply().}
-
commit
public boolean commit() { //將數據更新到內存[見小節4.2] MemoryCommitResult mcr = commitToMemory(); //將內存數據同步到文件[見小節4.3] SharedPreferencesImpl.this.enqueueDiskWrite(mcr, null); try { //進入等待狀態, 直到寫入文件的操作完成 mcr.writtenToDiskLatch.await(); } catch (InterruptedException e) { return false; } //通知監聽則, 并在主線程回調onSharedPreferenceChanged()方法 notifyListeners(mcr); // 返回文件操作的結果數據 return mcr.writeToDiskResult; }-
commitToMemory
private MemoryCommitResult commitToMemory() { MemoryCommitResult mcr = new MemoryCommitResult(); synchronized (SharedPreferencesImpl.this) { if (mDiskWritesInFlight > 0) { mMap = new HashMap<String, Object>(mMap); } mcr.mapToWriteToDisk = mMap; mDiskWritesInFlight++; //是否有監聽key改變的監聽者 boolean hasListeners = mListeners.size() > 0; if (hasListeners) { mcr.keysModified = new ArrayList<String>(); mcr.listeners = new HashSet<OnSharedPreferenceChangeListener>(mListeners.keySet()); } synchronized (this) { //當mClear為true, 則直接清空mMap 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是個特殊值, 用于移除相應的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; // changesMade代表數據是否有改變 if (hasListeners) { mcr.keysModified.add(k); //記錄發生改變的key } } mModified.clear(); //清空EditorImpl中的mModified數據 } } return mcr; } apply
-
-
public void apply() {
//把數據更新到內存[見小節4.2]
final MemoryCommitResult mcr = commitToMemory();
final Runnable awaitCommit = new Runnable() {
public void run() {
try {
//進入等待狀態
mcr.writtenToDiskLatch.await();
} catch (InterruptedException ignored) {
}
}
};
//將awaitCommit添加到QueuedWork
QueuedWork.add(awaitCommit);
Runnable postWriteRunnable = new Runnable() {
public void run() {
awaitCommit.run();
//從QueuedWork移除
QueuedWork.remove(awaitCommit);
}
};
//[見小節4.4.1]
SharedPreferencesImpl.this.enqueueDiskWrite(mcr, postWriteRunnable);
notifyListeners(mcr);
}
可見, apply跟commit的最大區別 在于apply的寫入文件操作是在單線程的線程池來完成.
五.優化
- 強烈建議不要在sp里面存儲特別大的key/value, 有助于減少卡頓/anr
- 請不要高頻地使用apply, 盡可能地批量提交;commit直接在主線程操作, 更要注意了
- 不要使用MODE_MULTI_PROCESS;
- 高頻寫操作的key與高頻讀操作的key可以適當地拆分文件, 由于減少同步鎖競爭;
- 不要一上來就執行getSharedPreferences().edit(), 應該分成兩大步驟來做, 中間可以執行其他代碼,由于edit的時候包括put,set等都是阻塞方法,等加載完成之后才能執行下一個,所以當第一次執行的時候需要創建xml文件,創建完成之后需要讀入內存之后才能執行edit,所以這個時候就等待了,此時可以做點其他的工作;
- 不要連續多次edit(), 應該獲取一次獲取edit(),然后多次執行putxxx(), 減少內存波動; 經常看到大家喜歡封裝方法, 結果就導致這種情況的出現.
- 每次commit時會把全部的數據更新的文件, 所以整個文件是不應該過大的, 影響整體性能;
總結:
- 獲取sp的常用的方式:
- Activity.getPreference(mode)此方式獲取到的是以當前activity為名的sp
- preferenceManger.getDefaultSharedPreferences(context),此方式調用的是第三種,創建的是包名加上_preferences作為文件名,
- Context.getSharedPreferences(name, mode)
- commit()和apply().
- apply跟commit的最大區別 在于apply的寫入文件操作是在單線程的線程池來完成.
- apply方法開始的時候, 會把awaitCommit放入QueuedWork;文件寫入操作完成, 則會把相應的awaitCommit從QueuedWork中移除.
- apply沒有返回值, commit有返回值能知道修改是否提交成功
- apply是將修改提交到內存，再異步提交到磁盤文件; commit是同步的提交到磁盤文件;
- 多并發的提交commit時，需等待正在處理的commit數據更新到磁盤文件后才會繼續往下執行，從而降低效率; 而apply只是原子更新到內存，后調用apply函數會直接覆蓋前面內存數據，從一定程度上提高很多效率。
