SharedPreference引发ANR原理详解

// 初始化一个sp
SharedPreferences sharedPreferences = context.getSharedPreferences("name_sp", MODE_PRIVATE);
// 修改key的值，有两种方法：commit和apply
sharedPreferences.edit().putBoolean("key_test", true).commit();
sharedPreferences.edit().putBoolean("key_test", true).apply();
// 读取一个key
sharedPreferences.getBoolean("key_test", false);

    @Override
    public SharedPreferences getSharedPreferences(String name, int mode) {
        File file;
        //  与sp相关的操作，都使用ContextImpl的类锁
        synchronized (ContextImpl.class) {
            if (mSharedPrefsPaths == null) {
                mSharedPrefsPaths = new ArrayMap<>();
            }
            // mSharedPrefsPaths是内存缓存的文件路径
            file = mSharedPrefsPaths.get(name);
            if (file == null) {
                // 此处获取SharedPreferences的文件路径，可能存在耗时
                file = getSharedPreferencesPath(name);
                mSharedPrefsPaths.put(name, file);
            }
        }
        return getSharedPreferences(file, mode);
    }

    public File getSharedPreferencesPath(String name) {
        // 创建一个sp的存储文件
        return makeFilename(getPreferencesDir(), name + ".xml");
    }

    private File getPreferencesDir() {
        // 所有和文件有关的操作，都会使用mSync锁，可能出现与其他线程抢锁的耗时
        synchronized (mSync) {
            if (mPreferencesDir == null) {
                mPreferencesDir = new File(getDataDir(), "shared_prefs");
            }
            // 这个方法，如果目录不存在，会创建目录，可能存在耗时
            return ensurePrivateDirExists(mPreferencesDir);
        }
    }

    private static File ensurePrivateDirExists(File file, int mode, int gid, String xattr) {
        if (!file.exists()) {
            final String path = file.getAbsolutePath();
            try {
                // 创建文件夹，会耗时
                Os.mkdir(path, mode);
                Os.chmod(path, mode);
            } catch (ErrnoException e) {
            }
        return file;
    }

    public SharedPreferences getSharedPreferences(File file, int mode) {
        SharedPreferencesImpl sp;
        synchronized (ContextImpl.class) {
            // 获取cache，先从cache中获取SharedPreferenceImpl
            final ArrayMap<File, SharedPreferencesImpl> cache = getSharedPreferencesCacheLocked();
            sp = cache.get(file);
            if (sp == null) {
                // 如果没有cache，则创建一个SharedPreferencesImpl，此处可能存在耗时
                sp = new SharedPreferencesImpl(file, mode);
                cache.put(file, sp);
                return sp;
            }
        }
        return sp;
    }

    private ArrayMap<File, SharedPreferencesImpl> getSharedPreferencesCacheLocked() {
        // ssharedPrefsCache是一个静态变量，全局有效
        if (sSharedPrefsCache == null) {
            sSharedPrefsCache = new ArrayMap<>();
        }
        // key:包名，value: ArrayMap<File, SharedPreferencesImpl> 
        final String packageName = getPackageName();
        ArrayMap<File, SharedPreferencesImpl> packagePrefs = sSharedPrefsCache.get(packageName);
        if (packagePrefs == null) {
            packagePrefs = new ArrayMap<>();
            sSharedPrefsCache.put(packageName, packagePrefs);
        }
        return packagePrefs;
    }

    SharedPreferencesImpl(File file, int mode) {
        mFile = file;
        mBackupFile = makeBackupFile(file);
        // 设置是否load到内存的标志位为false
        mLoaded = false;
        startLoadFromDisk();
    }

    private void startLoadFromDisk() {
        // 改mLoaded标志位时，需要获取mLock锁
        synchronized (mLock) {
           // load之前先设置mLoaded标志位为false
            mLoaded = false;
        }
        // 开启一个线程，从文件中将sp中的内容读取到内存中
        new Thread("SharedPreferencesImpl-load") {
            public void run() {
                // 在子线程load
                loadFromDisk();
            }
        }.start();
    }

   private void loadFromDisk() {
        synchronized (mLock) {
            // 如果已经load过了，直接return，不需要再重新load
            if (mLoaded) {
                return;
            }
            stat = Os.stat(mFile.getPath());
            if (mFile.canRead()) {
                BufferedInputStream str = null;
                try {
                    str = new BufferedInputStream(
                            new FileInputStream(mFile), 16 * 1024);
                    // 读取xml的内容到map中
                    map = (Map<String, Object>) XmlUtils.readMapXml(str);
                } catch (Exception e) {
                    Log.w(TAG, "Cannot read " + mFile.getAbsolutePath(), e);
                } finally {
                    IoUtils.closeQuietly(str);
                }
            }
        synchronized (mLock) {
            // 设置mLoaded标志位为true，表示已经load完，通知所有在等待的线程
            mLoaded = true;
            mLock.notifyAll();
        }
    }

    public boolean getBoolean(String key, boolean defValue) {
        synchronized (mLock) {
            // 需要等待，直到load成功
            awaitLoadedLocked();
            // 从缓存中取value
            Boolean v = (Boolean)mMap.get(key);
            return v != null ? v : defValue;
        }
    }

    private void awaitLoadedLocked() {
       // 只有当mLoaded为true时，才能跳出死循环
        while (!mLoaded) {
            try {
                // 调用wait后，会释放mLock锁，并且进入等待池，等待load完之后的唤醒
                mLock.wait();
            } catch (InterruptedException unused) {
            }
        }
    }

        public boolean commit() {
            // 开始排队写
            SharedPreferencesImpl.this.enqueueDiskWrite(
                mcr, null );
            try {
                // 等待同步写的结果
                mcr.writtenToDiskLatch.await();
            } catch (InterruptedException e) {
                return false;
            } finally {
            }
            notifyListeners(mcr);
            return mcr.writeToDiskResult;
        }

        public void apply() {
            // 先将更新写入内存缓存
            final MemoryCommitResult mcr = commitToMemory();
            // 创建一个awaitCommit的runnable，加入到QueuedWork中
            final Runnable awaitCommit = new Runnable() {
                    @Override
                    public void run() {
                        try {
                            // 等待写入完成
                            mcr.writtenToDiskLatch.await();
                        } catch (InterruptedException ignored) {
                        }
                    }
                };
            // 将awaitCommit加入到QueuedWork中
            QueuedWork.addFinisher(awaitCommit);
            Runnable postWriteRunnable = new Runnable() {
                    @Override
                    public void run() {
                        awaitCommit.run();
                        QueuedWork.removeFinisher(awaitCommit);
                    }
                };
            // 真正执行sp持久化操作，异步执行
            SharedPreferencesImpl.this.enqueueDiskWrite(mcr, postWriteRunnable);
            // 虽然还没写入文件，但是内存缓存已经更新了，而listener通常都持有相同的sharedPreference对象，所以可以使用内存缓存中的数据
            notifyListeners(mcr);
        }

public static void waitToFinish() {
       Runnable toFinish;
       //等待所有的任务执行完成
       while ((toFinish = sPendingWorkFinishers.poll()) != null) {
           toFinish.run();
       }
   }