前言
Linus Benedict Torvalds : RTFSC – Read The Fucking Source Code
概括
分析SharedPreferences的獲取生成原理和它的修改原理。并且會看到為什么對于多進程是不安全的。
創(chuàng)建原理
SharedPreferences的獲取原理從getSharedPreferences函數(shù)開始燎潮。所以我們從getSharedPreferences函數(shù)為起點開始分析馏颂。
ContextImpl
我們知道Context的主要實現(xiàn)從ContextImpl開始,如何傳進來的過程忽略瘾晃。
getSharedPreferences函數(shù)返回的是一個SharedPreferences的對象并且是以單例實現(xiàn)的爆安。因為此函數(shù)比較重要我們一步步來看。
Step 1.getSharedPreferences()
Part 1.初始化映射對象
ContextImpl 包含了一個比較復(fù)雜的內(nèi)部全局私有變量sSharedPrefs烦却,它的類型是ArrayMap<String, ArrayMap<String, SharedPreferencesImpl>>
,比較難讀先巴,簡單點就是從包名映射到preference名字到緩存preferences其爵。
一開始我們先新建一個映射對象,然后獲取包名賦予它初值伸蚯。
Part 2.創(chuàng)建SharedPrefs文件
接下來我們通過一開始傳進來的文件名去創(chuàng)建一個SharedPrefs文件摩渺,通過getSharedPrefsFile()函數(shù)返回一個".xml"的文件對象。然后就會調(diào)用new SharedPreferencesImpl(prefsFile, mode)
來創(chuàng)建一個SharedPreferencesImpl對象剂邮。
SharedPreferencesImpl
SharedPreferences的其中一個重點在于它的創(chuàng)建摇幻,構(gòu)造函數(shù)就是獲取它對象的地方。
Step 2.SharedPreferencesImpl()
mFile = file;
mBackupFile = makeBackupFile(file);
...
startLoadFromDisk();
構(gòu)造函數(shù)功能是初始化一些變量和調(diào)用一些初始函數(shù)挥萌。
這里有兩個變量值得注意绰姻,一個是mFile,保存preference的文件對象引瀑,另一個是mBackupFile狂芋,保存preference的備份文件對象。
首先來看makeBackupFile()函數(shù)
Step 3.makeBackupFile()
return new File(prefsFile.getPath() + ".bak");
makeBackupFile從字面意思也很好理解憨栽,就是生成一個備份的文件帜矾,主要是生成一個prefsFile的備份文件翼虫。
初始化的最后是調(diào)用startLoadFromDisk()函數(shù)進行操作。
Step 4.startLoadFromDisk()
loadFromDiskLocked()
startLoadFromDisk() 的函數(shù)功能也很簡單屡萤,開啟一個線程單步調(diào)用loadFromDiskLocked()
Step 5.loadFromDiskLocked()
Part 1.查看PrefsFile
loadFromDiskLocked()函數(shù)的第一步是查看備份文件是否已經(jīng)存在珍剑,存在則講原文件刪除用備份文件替換。
Part 2.加載PrefsFile
在確認(rèn)PrefsFile文件可以被讀取后會將PrefsFile文件內(nèi)容加載到一個map里面死陆,確認(rèn)map不為空后會將它存到全局的mMap里次慢,然后通過notifyAll發(fā)出一個通知,通知所有等待初始化完成的線程可以開始運作翔曲。
ContextImpl
Step 6.getSharedPreferences()
當(dāng)創(chuàng)建完一個SharedPreferencesImpl后會將SharedPrefs對象保存到最初的數(shù)組里面迫像。最后,如果這不是第一次加載瞳遍,那么SharedPrefs對象不需要創(chuàng)建闻妓,但是會重新調(diào)用一次startLoadFromDisk(),讓文件保持最新狀態(tài)掠械。
總結(jié)
SharedPreference的創(chuàng)建原理就到此為止了由缆,到此用戶就得到了SharedPreference的對象,方便未來的操作猾蒂。
獲取原理
獲取的操作都是要在創(chuàng)建SharedPreference之后才可以操作的均唉。
獲取的過程我們以獲取String為例。
SharedPreferencesImpl
getString()
首先通過SharedPreference對象調(diào)用getString方法肚菠。此方法有兩個參數(shù)舔箭,一個是key值,也就是我們windows ini配置文件的key值一樣蚊逢,另一個就是默認(rèn)參數(shù)层扶。
首先進來會調(diào)用awaitLoadedLocked()來查看加載配置文件是否初始化完成。接著就很簡單了烙荷,調(diào)用全局變量mMap來查找想要的信息镜会。
修改原理
修改的操作都是要在創(chuàng)建SharedPreference之后才可以操作的。
修改的過程我們以修改一個String值為例终抽。
Activity
在我們調(diào)用的地方戳表,我們首先通過preference.edit()函數(shù)獲取SharedPreference的Editor類的對象。
SharedPreferencesImpl
Step 1.edit()
edit()函數(shù)返回的是一個新建EditorImpl類的對象昼伴。
SharedPreferencesImpl.EditorImpl類里面有一個關(guān)鍵的變量mModified匾旭,這是一個Map,它會將以后要修改的值都放到里面去
Activity
Step 2.editor.putString()
這一步很簡單亩码,將我們要保存的值存入EditorImpl類里的變量mModified里季率。
Step 3.editor.commit()
這一步就是調(diào)用editor的提交方法了。比較關(guān)鍵描沟。
SharedPreferencesImpl
Step 4.commit()
首先會調(diào)用commitToMemory函數(shù)返回一個MemoryCommitResult對象飒泻。所以我們首先來看下commitToMemory鞭光。
Step 5.commitToMemory()
MemoryCommitResult類是一個封裝了commitmemory結(jié)果的一個類,里面有許多信息泞遗。
commitToMemory首先創(chuàng)建一個MemoryCommitResult對象惰许。接著會克隆一個mMap對象。如果有設(shè)置監(jiān)聽消息會在這里設(shè)置一個值到MemoryCommitResult史辙。接下來我們就會對mMap里面的值進行修改汹买,在修改完成后會把之前我們所進行修改臨時保存的全局變量mModified進行清空處理。然后返回出去MemoryCommitResult對象聊倔。
在commitToMemory返回一個結(jié)果類后會將它當(dāng)作參數(shù)傳入enqueueDiskWrite()函數(shù)里晦毙。
Step 6.enqueueDiskWrite()
enqueueDiskWrite()函數(shù)里面執(zhí)行的是一個異步操作,在外部commit()函數(shù)會做一個await操作等待異步的完成耙蔑。
在這個函數(shù)里會開啟一個writeToDiskRunnable的線程见妒,該線程做的事情是將傳進來的MemoryCommitResult 里的數(shù)據(jù)寫入到文件里。
Step 7.writeToFile()
此函數(shù)首先會判斷mFile文件是否存在甸陌,如果存在就再判斷備份文件是否存在须揣,備份文件不在的話就創(chuàng)建一個備份文件,然后刪除原文件钱豁。
接著創(chuàng)建一個mFile的文件耻卡,將數(shù)據(jù)寫入,再添加權(quán)限牲尺,做完后將備份文件刪除卵酪。
做完后commit函數(shù)的職責(zé)就算完了,然后再廣播監(jiān)聽者修改完成的消息秸谢。
總結(jié)
對于修改的原理凛澎,在多進程情況下如果兩個修改的時機接近那么就很容易導(dǎo)致一方寫不進去的問題,是因為會被另一個進程將寫入的數(shù)據(jù)覆蓋估蹄。這個問題目前的解決方案是不同的進程盡量使用不同的SharedPreference進行存儲。