Android---SharedPreferences解析

SharedPreferences真正实现的类是:SharedPreferencesImpl

构造函数中:
会创建出该XML的文件,以及一个bak的备份文件。并且调用startLoadFromDisk开启一个线程从本地文件中读取配置文件。

其中每个SharedPreferencesImpl中都会有一个mLoaded变量,它标志着是否已经从本地文件中读取过了。而对它进行同步的时候,都是通过SharedPreferencesImpl.this来上锁进行的。

在loadFromDiskLocked函数中:

  1. 检测.bak备份文件是否存在,如果存在的话,那么则将原来的文件删除,然后将.bak文件renameto正常文件,也就意味着,如果在写的时候,出问题了,导致中断了,就使用原来没问题的备份文件。
  2. 接着会通过Native检查文件是否存在,并且进行权限检查,看该文件是否可读
  3. 通过XmlUtils.readMapXml读取对应的XML文件,然后将数据放到Map中保存
  4. 读取完后,将mLoaded变量设置成true,标识已经读取完毕,并且调用notifyAll,让其他线程被唤醒

而在getStringgetInt等函数中,都会调用:

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

首先调用awaitLoadedLocked方法,该函数体是一个while循环,一直等待mLoaded被设置成true,否则无论当前线程是否抛出了InterruptedException,都会一直处于wait状态。所以,如果SharedPreferences太大的话,读取的时间会越来越长,如果在主线程调用了getString等方法的话,会等待子线程把数据读取完之后才会返回值,建议不要让一个XML太大,可以分多个XML存储,这样不会有ANR的风险。

读取的过程比较简单,而写入的过程会非常复杂,因为需要考虑多线程,多进程,什么时候写入,同时写入等等非常规情况的处理。

等待读取完成后,创建出一个EditorImpl对象,该对象中只有一个HashMap用来保存变更的Key-Value,并且可以调用clear方法将mClear设置成true

调用apply方法

  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);
    }

从apply函数中可以看到:

  1. 调用commitToMemory方法
    a) 创建一个MemoryCommitResult对象
    b) 判断mDiskWritesInFlight是否大于0,如果大于0的话,说明之前已经有正在往磁盘里写的任务了,那么则将改变的值copy到一个新的Map中
    c) 将map放入MemoryCommitResult,并且将mDiskWritesInFlight加1
    d) 判断当前SharedPreferences是否已经注册过Listener,如果注册过的话,那么将Listener放到MemoryCommitResult中,以便后续的回调使用
    e) 判断mClear是否被设置,如果被设置的话,那么就会将当前SharedPreferencesImpl中的Map清空,并将结果的changesMade设置成true,标识在内存中值已经发生改变
    f) 遍历改变的Map对象,判断要改变的值与当前值是否相同,不同的话,则改变当前值。并将结果的changesMade设置成true,标识在内存中值已经发生改变
    g) 判断是否有Listener,如果有,则将有改变的Key添加到MemoryCommitResult中的keysModified这个Set中,最后将EditorImpl中的Map给清空

  2. 获取到了内存改变的值之后,会创建awaitCommit以及postWriteRunnable两个Runnable:
    awaitCommit:该Runnable中执行CountDownlaunch的await方法进行等待,并且会被添加到QueueWork中
    postWriteRunnable:该Runnable执行awaitCommit的run方法,并且将awaitCommit从QueueWork中移除

  3. 调用enqueueDiskWrite方法,开始往写磁盘队列中插入。
    a) 创建一个writeToDiskRunnable对象,该Runnable中完成将MemoryCommitResult写入文件的操作
    b) 判断postWriteRunnable是否为空,该判断主要是用来判断当前的操作是commit还是apply,因为commit的话,是一个同步操作,需要等待写完磁盘之后,才能继续往下运行,而apply是个异步操作,当异步写完磁盘之后,会调用postWriteRunnable.run方法。
    c) 如果是调用commit的话,则判断mDiskWritesInFlight是否为1,如果为1的话,那么就说明当前没有写磁盘任务,那么就直接调用writeToDiskRunnable.run方法,执行完之后返回,否则将写入文件的操作放到一个单线程池中慢慢执行。

writeToFile中,会将每一个MemoryCommitResult都写到文件中

  1. 判断XML文件是否存在,如果存在的话,那么判断当前内存值是否有改变,如果没有改变的话,就调用setDiskWriteResult方法,将之前的CountDownLaunch减一,让原来等待的线程处于就绪状态,并且将写入成功的标志位设置成true,标识写入成功
  2. 判断.bak文件是否存在,如果不存在的话,那么则将xml文件renameTo备份文件,如果备份失败的话,那么则标记写入失败,返回。如果bak文件存在的话,那么则将原来的XML文件删除
  3. 得到XML对应的FileOutputStream,如果获取失败的话(如无权限,创建文件失败等等),则标记写入失败并且返回
  4. 将完整的Map对象写入XML中,并且调用FileUtils.sync进行文件同步,同步完之后,关闭输出流,并且设置文件权限
  5. 写入成功后,删除.bak文件,并且标记写入文件成功,并且返回,如果写文件过程中遇到异常,则直接将XML文件删除,并且标记写入失败。

在写完文件之后,将mDiskWritesInFlight减一,并且判断postWriteRunnable是否存在,如果有的话,则执行postWriteRunnable。

最后没有搞明白为什么要有个CountDownLaunch,因为CountDownLaunch.await是在最后被执行的,而那时候早就已经调用了CountDownLaunch.countdown了,所以貌似没什么用。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,718评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,683评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,207评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,755评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,862评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,050评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,136评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,882评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,330评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,651评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,789评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,477评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,135评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,864评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,099评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,598评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,697评论 2 351

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,858评论 25 707
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,602评论 18 399
  • 从三月份找实习到现在,面了一些公司,挂了不少,但最终还是拿到小米、百度、阿里、京东、新浪、CVTE、乐视家的研发岗...
    时芥蓝阅读 42,218评论 11 349
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,637评论 18 139
  • 想要对比一下《肖申克的救赎》(斯蒂芬·金中篇小说改编而成)里的主人公安迪与《面纱》(毛姆同名小说改编而成)里的主人...
    童九莉阅读 833评论 1 3