android SharedPreference的实现(1)
一直在用SharedPreferences进行数据缓存,也知道
SharedPreferences使用xml文件保存缓存信息,但背后究竟是如何实现的?跟着源码一看究竟。
通常,我们在
context.getSharedPreferences获得
SharedPreferences,然后使用
get方法根据键值获得值,使用
SharedPreferences.edit获得Editor,向
SharedPreferences中更键值。
追踪到最后,context.getSharedPreferences方法时在
ContextImpl类中具体实现的。
代码1 public SharedPreferences getSharedPreferences(String name, int mode) { // 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) { if (name == null) { name = "null"; } } File file; synchronized (ContextImpl.class) { if (mSharedPrefsPaths == null) { mSharedPrefsPaths = new ArrayMap<>(); } file = mSharedPrefsPaths.get(name); if (file == null) { file = getSharedPreferencesPath(name); mSharedPrefsPaths.put(name, file); } } return getSharedPreferences(file, mode); }
可以看到,首先进行判断,如果targetSdkVersion小于19,如果传入的name为空,则创建null.xml文件,这会在后面讲解。接着会从mSharedPrefsPaths中根据传入的name去获取一个文件,这个文件其实就是xml的配置文件。看下mSharedPrefsPaths的申明:
ArrayMap mSharedPrefsPaths;
从mSharedPrefsPaths的申明可以看出,mSharedPrefsPaths存储的是name和xml文件的映射,在getSharedPreferences会首先判断mSharedPrefsPaths是否会为空。mSharedPrefsPaths为空只会在应用启动后第一次调用getSharedPreferences才会发生,接着会从mSharedPrefsPaths中根据name获取一个xml配置文件,如果没有获取到xml配置文件,则调用getSharedPreferencesPath(name)创建一个xml配置文件。进入getSharedPreferencesPath看下里面发生了什么:
public File getSharedPreferencesPath(String name) { return makeFilename(getPreferencesDir(), name + ".xml"); }
好吧,终于看到这个配置文件是如何产生的了……,我就不解释这个位置了
再进入
getSharedPreferences(file, mode)这个方法看下。
代码2 public SharedPreferences getSharedPreferences(File file, int mode) { checkMode(mode); SharedPreferencesImpl sp; synchronized (ContextImpl.class) { final ArrayMap cache = getSharedPreferencesCacheLocked(); sp = cache.get(file); if (sp == null) { 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) { // 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; }
这里我们看到了SharedPreferencesImpl这样一个类。SharedPreferences实际上是一个接口,系统提供了SharedPreferencesImpl这样一个实现简化对SharedPreferences的操作。进入方法后,首先执行了
ArrayMap cache = getSharedPreferencesCacheLocked()
可以猜测每个配置文件对应于一个SharedPreferencesImpl,后面我们会做具体的验证。再进入getSharedPreferencesCacheLocked() 方法体看下。
代码3 private ArrayMap getSharedPreferencesCacheLocked() { if (sSharedPrefsCache == null) { sSharedPrefsCache = new ArrayMap<>(); } final String packageName = getPackageName(); ArrayMap packagePrefs = sSharedPrefsCache.get(packageName); if (packagePrefs == null) { packagePrefs = new ArrayMap<>(); sSharedPrefsCache.put(packageName, packagePrefs); } return packagePrefs; }
进入方法体后,出现了sSharedPrefsCache这样一个变量,看下它的申明:
private static ArrayMap> sSharedPrefsCache; 根据代码可知道,sSharedPrefsCache根据包名,存储了xml文件到SharedPreferencesImpl的映射。回到代码3,系统返回ArrayMap,并根据条件判断向sSharedPrefsCache添加ArrayMap。再回到代码2,获得到对应的缓存后,执行```sp = cache.get(file)```,如果对应的xml文件没有找到SharedPreferences,则为对应的xml文件新建SharedPreferencesImpl,并将新生成的SharedPreferencesImpl放入缓存中。我们进入SharedPreferencesImpl中看看是如何创建的。 代码4 SharedPreferencesImpl(File file, int mode) { mFile = file; mBackupFile = makeBackupFile(file); mMode = mode; mLoaded = false; mMap = null; startLoadFromDisk(); }
代码4为SharedPreferencesImpl的构造函数,file为xml配置文件,mode为我们在调用getSharedPreferences方法时传入的mode的字段。可以看到,在构造对象时,系统首先执行makeBackupFile(file)创建了备份文件,并调用startLoadFromDisk()方法,startLoadFromDisk()方法实际上是读取file指向的xml配置文件,并将所有的配置对象读取到mMap中。好的,进入源码看下是不是这样:
代码5 private void startLoadFromDisk() { synchronized (this) { mLoaded = false; } new Thread("SharedPreferencesImpl-load") { public void run() { loadFromDisk(); } }.start(); } 代码6 private void loadFromDisk() { synchronized (SharedPreferencesImpl.this) { 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); map = XmlUtils.readMapXml(str); } catch (XmlPullParserException | IOException e) { Log.w(TAG, "getSharedPreferences", e); } finally { IoUtils.closeQuietly(str); } } } catch (ErrnoException e) { /* ignore */ } synchronized (SharedPreferencesImpl.this) { mLoaded = true; if (map != null) { mMap = map; mStatTimestamp = stat.st_mtime; mStatSize = stat.st_size; } else { mMap = new HashMap<>(); } notifyAll(); }
好的,这部分源码就是比较简单了,可以发现系统考虑了缓存文件较大的情况,在读取文件时捕获了解析和IO异常,防止在调用getSharedPreferences时由于xml配置文件的原因产生应用崩溃。经过代码代码5和代码6,xml配置文件中已有的键值已经放入了内存中,这样也就避免了对频繁对文件的读写。这次,getSharedPreferences这个过程已经分析完毕了,接下来我们看下SharedPreferences中的get方法时如何执行的。由于get方法较多,故只选取getInt进行分析,其他部分也是类似实现。
代码7 public int getInt(String key, int defValue) { synchronized (this) { awaitLoadedLocked(); Integer v = (Integer)mMap.get(key); return v != null ? v : defValue; } }
代码6中已经将xml配置文件中的键值对全部读取到mMap中,在获取int类型的缓存值时,直接从mMap中get,然后进行类型转换即可,如果未找到值,则返回用户定义的defValue。
上一篇: iOS开发系列----C语言(函数)