Android 性能优化篇之SharedPreferences使用优化

移动开发 2022-06-19 14:01:24 阅读次数: 0

SP的使用及存在的问题

SharedPreferences(以下简称SP)是Android本地存储的一种方式，是以key-value的形式存储在/data/data/项目包名/shared_prefs/sp_name.xml里，SP的使用示例及源码解析参见：Android本地存储之SharedPreferences源码解析。以下是SP的一些结论：

  • SharedPreferences读取xml文件时，会以DOM方式解析（把整个xml文件直接加载到内存中解析），在调用getXXX()方法时取到的是内存中的数据，方法执行时会有个锁来阻塞，目的是等待文件加载完毕，没加载完成之前会wait()。
  • SP第一次初始化到读取到数据存在一定延迟，因为需要到文件中读取数据，因此可能会对UI线程流畅度造成一定影响，严重情况下会产生ANR。
  • SharedPreferences写文件时，如果调用的commit(),会将数据同步写入内存中，内存数据更新，再同步写入磁盘中;如果调用的apply(),会将数据同步写入内存中，内存数据更新，然后异步写人磁盘，也就是说可能写磁盘操作还没有完成就直接返回了。在UI线程中建议使用apply()，因为同步写磁盘，当文件较大时，commit()会等到写磁盘完成再返回，可能会有ANR问题。
  • 写文件时即使用的是apply()方法，依然有可能会造成ANR问题，

apply()流程分析

8.0以上

写文件流程

apply()为什么还会出现ANR呢？我们来看下apply()的逻辑（这里源码是看的API30的）：

//SharedPreferencesImpl.EditorImpl.java
@Override
public void apply() {
    final long startTime = System.currentTimeMillis();
    //写入内存
    final MemoryCommitResult mcr = commitToMemory();
    //这里的操作时为了CountDownLatch实现等待效果
    final Runnable awaitCommit = new Runnable() {
            @Override
            public void run() {
                try {
                    //writtenToDiskLatch类型是CountDownLatch(1)
                    mcr.writtenToDiskLatch.await();
                } catch (InterruptedException ignored) {
                }
               }
            }
        };
    //将awaitCommit加入队列中，后续Activity的onStop()中会执行这个Runnable等待
    QueuedWork.addFinisher(awaitCommit);

    Runnable postWriteRunnable = new Runnable() {
            @Override
            public void run() {
                awaitCommit.run();
                QueuedWork.removeFinisher(awaitCommit);
            }
        };
    //文件写入操作
    SharedPreferencesImpl.this.enqueueDiskWrite(mcr, postWriteRunnable);
}
复制代码

QueuedWork.addFinisher(awaitCommit)将awaitCommit加入到队列中，awaitCommit在执行时利用CountDownLatch机制可以实现对当前线程的阻塞效果，后续Activity的onStop()中会将这里的awaitCommit取出来执行，即UI线程会阻塞等待sp文件写入磁盘，写入操作是通过SharedPreferencesImpl#enqueueDiskWrite()完成的，写入成功后会通过writtenToDiskLatch.countDown()释放awaitCommit中的锁，如果写入操作比较耗时，就会造成ANR问题。

//SharedPreferencesImpl.java
private void enqueueDiskWrite(final MemoryCommitResult mcr,
                              final Runnable postWriteRunnable) {
    final boolean isFromSyncCommit = (postWriteRunnable == null);

    final Runnable writeToDiskRunnable = new Runnable() {
            @Override
            public void run() {
                synchronized (mWritingToDiskLock) {
                    //写入磁盘操作
                    writeToFile(mcr, isFromSyncCommit);
                }
                synchronized (mLock) {
                    mDiskWritesInFlight--;
                }
                if (postWriteRunnable != null) {
                    postWriteRunnable.run();
                }
            }
        };

    //commit()会在当前线程进行写入操作
    if (isFromSyncCommit) {
        boolean wasEmpty = false;
        synchronized (mLock) {
            wasEmpty = mDiskWritesInFlight == 1;
        }
        if (wasEmpty) {
            writeToDiskRunnable.run();
            return;
        }
    }

    QueuedWork.queue(writeToDiskRunnable, !isFromSyncCommit);
}
复制代码
//QueuedWork.java
public static void queue(Runnable work, boolean shouldDelay) {
    Handler handler = getHandler();

    synchronized (sLock) {
        sWork.add(work);

        if (shouldDelay && sCanDelay) {
            handler.sendEmptyMessageDelayed(QueuedWorkHandler.MSG_RUN, DELAY);
        } else {
            handler.sendEmptyMessage(QueuedWorkHandler.MSG_RUN);
        }
    }
}

//构造一个Handler并传入HandlerThread的Looper，即Handler会在子线程中处理消息
private static Handler getHandler() {
    synchronized (sLock) {
        if (sHandler == null) {
            HandlerThread handlerThread = new HandlerThread("queued-work-looper",
                    Process.THREAD_PRIORITY_FOREGROUND);
            handlerThread.start();

            sHandler = new QueuedWorkHandler(handlerThread.getLooper());
        }
        return sHandler;
    }
}

private static class QueuedWorkHandler extends Handler {
    static final int MSG_RUN = 1;

    QueuedWorkHandler(Looper looper) {
        super(looper);
    }

    public void handleMessage(Message msg) {
        if (msg.what == MSG_RUN) {
            processPendingWork();
        }
    }
}

private static void processPendingWork() {
    synchronized (sProcessingWork) {
        LinkedList<Runnable> work;

        synchronized (sLock) {
            work = (LinkedList<Runnable>) sWork.clone();
            sWork.clear();

            // Remove all msg-s as all work will be processed now
            getHandler().removeMessages(QueuedWorkHandler.MSG_RUN);
        }

        if (work.size() > 0) {
            //取出Runnable并执行
            for (Runnable w : work) {
                w.run();
            }
        }
    }
}
复制代码
QueuedWork.waitToFinish()

Activity的onStop()、Service的onDestroy()执行时，都会调用到QueuedWork.waitToFinish()方法**：

//ActivityThread.java
private void handleStopService(IBinder token) {
    Service s = mServices.remove(token);
    if (s != null) {
        try {
            if (localLOGV) Slog.v(TAG, "Destroying service " + s);
            s.onDestroy();
            s.detachAndCleanUp();
            //看这里 看这里！！！
            QueuedWork.waitToFinish();
            //...其他代码...
        } catch (Exception e) {
        }
    }
}

@Override
public void handleStopActivity(IBinder token, int configChanges,
        PendingTransactionActions pendingActions, boolean finalStateRequest, String reason) {
    final ActivityClientRecord r = mActivities.get(token);
    r.activity.mConfigChangeFlags |= configChanges;

    final StopInfo stopInfo = new StopInfo();
    performStopActivityInner(r, stopInfo, true /* saveState */, finalStateRequest,
            reason);
    //大于API11的时候执行
    if (!r.isPreHoneycomb()) {
        //看这里 看这里！！！
        QueuedWork.waitToFinish();
    }
   //......
}
复制代码

Activity的onStop()、Service中的onDestroy()都是间接在ActivityThread中的handleStopService()、handleStopActivity()执行的，这两个方法里都会执行到QueuedWork.waitToFinish()：

public static void waitToFinish() {
    long startTime = System.currentTimeMillis();
    boolean hadMessages = false;

    Handler handler = getHandler();

    synchronized (sLock) {
        if (handler.hasMessages(QueuedWorkHandler.MSG_RUN)) {
            // Delayed work will be processed at processPendingWork() below
            handler.removeMessages(QueuedWorkHandler.MSG_RUN);
        }

        // We should not delay any work as this might delay the finishers
        sCanDelay = false;
    }

    StrictMode.ThreadPolicy oldPolicy = StrictMode.allowThreadDiskWrites();
    try {
        //把任务取出来，直接在当前线程处理 8.0之后才有的逻辑
        processPendingWork();
    } finally {
        StrictMode.setThreadPolicy(oldPolicy);
    }

    try {
        while (true) {
            Runnable finisher;

            synchronized (sLock) {
                //重点 看这里 看这里！！！
                finisher = sFinishers.poll();
            }

            if (finisher == null) {
                break;
            }
            finisher.run();
        }
    } finally {
        sCanDelay = true;
    }
   }
}
复制代码

这里的sFinishers中取的Runnable就是在写文件之前通过QueuedWork.addFinisher(awaitCommit)添加的，当取出awaitCommit执行时即会阻塞当前线程，如果apply()中写入磁盘时间过长导致awaitCommit的锁没有及时释放，UI线程就会因为长时间被阻塞得不到执行而出现ANR了。

用一张图来总结： SP隐患

图片来自：今日头条 ANR 优化实践系列 - 告别 SharedPreference 等待，所以结论是：使用apply()依然有可能会造成ANR问题。

8.0以下

写文件流程
public void apply() {
            final MemoryCommitResult mcr = commitToMemory();
            //这里的操作时为了CountDownLatch实现等待效果
            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);
        }
复制代码
QueuedWork.waitToFinish()
    public static void waitToFinish() {
        Runnable toFinish;
        while ((toFinish = sPendingWorkFinishers.poll()) != null) {
            toFinish.run();
        }
    }
复制代码

8.0以下的流程相对更简单一些，但核心流程是一样的，当在UI线程中调用到QueuedWork.waitToFinish()时，如果写入磁盘的操作还未完成且耗时比较长，都会引起UI线程的ANR。

如何优化

Jetpack DataStore替代

Jetpack DataStore 是一种改进的新数据存储解决方案，允许使用协议缓冲区存储键值对或类型化对象。DataStore 以异步、一致的事务方式存储数据，克服了 SharedPreferences（以下统称为SP）的一些缺点。DataStore基于Kotlin协程和Flow实现，并且可以对SP数据进行迁移，旨在取代SP。

DataStore提供了两种不同的实现：Preferences DataStore与Proto DataStore，其中Preferences DataStore用于存储键值对；Proto DataStore用于存储类型化对象，DataStore更详细的介绍参见：Android Jetpack系列之DataStore

MMKV替代

MMKV 是基于 mmap 内存映射的 key-value 组件，底层序列化/反序列化使用 protobuf 实现，性能高，稳定性强。从 2015 年中至今在微信上使用，其性能和稳定性经过了时间的验证。近期也已移植到 Android / macOS / Win32 / POSIX 平台，一并开源。

注：mmap 内存映射，可以提供一段可供随时写入的内存块，App 只管往里面写数据，由操作系统负责将内存回写到文件，不必担心 crash 导致数据丢失。

MMKV地址：https://github.com/tencent/mmkv

apply()使用优化

主要是优化UI线程中执行QueuedWork.waitToFinish()，当队列执行poll()时，通过反射修改poll()的返回值，将其设为null，这样UI线程会继续往下执行而不会原地阻塞等待了。示例如下（注意8.0以上与8.0以下处理不一样）：

object SPHook {

    fun optimizeSpTask() {
        if (Build.VERSION.SDK_INT < 26) {
            reflectSPendingWorkFinishers()
        } else {
            reflectSFinishers()
        }
    }

    /**
     * 8.0以上 Reflect finishers
     *
     */
    private fun reflectSFinishers() {
        try {
            val clz = Class.forName("android.app.QueuedWork")
            val field = clz.getDeclaredField("sFinishers")
            field.isAccessible = true
            val queue = field.get(clz) as? LinkedList<Runnable>
            if (queue != null) {
                val linkedListProxy = LinkedListProxy(queue)
                field.set(queue, linkedListProxy)
                log("hook success")
            }
        } catch (ex: Exception) {
            log("hook error:${ex}")
        }
    }

    /**
     * 8.0以下 Reflect pending work finishers
     */
    private fun reflectSPendingWorkFinishers() {
        try {
            val clz = Class.forName("android.app.QueuedWork")
            val field = clz.getDeclaredField("sPendingWorkFinishers")
            field.isAccessible = true
            val queue = field.get(clz) as? ConcurrentLinkedQueue<Runnable>
            if (queue != null) {
                val proxy = ConcurrentLinkedQueueProxy(queue)
                field.set(queue, proxy)
                log("hook success")
            }
        } catch (ex: Exception) {
            log("hook error:${ex}")
        }
    }

    /**
     * 在8.0以上apply()中QueuedWork.addFinisher(awaitCommit), 需要代理的是LinkedList，如下：
     * # private static final LinkedList<Runnable> sFinishers = new LinkedList<>()
     */
    private class LinkedListProxy(private val sFinishers: LinkedList<Runnable>) :
        LinkedList<Runnable>() {

        override fun add(element: Runnable): Boolean {
            return sFinishers.add(element)
        }

        override fun remove(element: Runnable): Boolean {
            return sFinishers.remove(element)
        }

        override fun isEmpty(): Boolean = true

        /**
         * 代理的poll()方法，永远返回空，这样UI线程就可以避免被阻塞，继续执行了
         */
        override fun poll(): Runnable? {
            return null
        }
    }

    /**
     * 在8.0以下代理
     * // The set of Runnables that will finish or wait on any async activities started by the application.
     * private static final ConcurrentLinkedQueue<Runnable> sPendingWorkFinishers = new ConcurrentLinkedQueue<Runnable>();
     */

    private class ConcurrentLinkedQueueProxy(private val sPendingWorkFinishers: ConcurrentLinkedQueue<Runnable>) :
        ConcurrentLinkedQueue<Runnable>() {

        override fun add(element: Runnable?): Boolean {
            return sPendingWorkFinishers.add(element)
        }

        override fun remove(element: Runnable?): Boolean {
            return sPendingWorkFinishers.remove(element)
        }

        override fun isEmpty(): Boolean = true

        /**
         * 代理的poll()方法，永远返回空，这样UI线程就可以避免被阻塞，继续执行了
         */
        override fun poll(): Runnable? {
            return null
        }
    }
}
复制代码

猜你喜欢

转载自juejin.im/post/7110618131000721416
今日推荐
TIOBE 5 月榜单：Fortran “复活”进入 Top 10
GCC 14.1 发布
面壁智能发布 Eurux-8x22B 开源大模型 —— 堪称「理科状元」
开源日报 | 谷歌扶持鸿蒙上位；开源Rabbit R1；Docker加持的安卓手机；微软的焦虑和野心；海尔电器把开放平台关了
中国码农的“35岁魔咒”
蘭雅 CorelDRAW 插件 2024.5.1 国际劳动节版，免费下载
Arc Browser for Windows 1.0 正式 GA
90后程序员开发视频搬运软件、不到一年获利超 700 万，结局很刑！
周排行
Java自定义时间格式
同步整形电路
在开发中最最最常用的字符串的属性大集合
Linux 查看端口占用并杀掉
Java基础四：ArrayList
多线程之死锁就是这么简单
mysql 基础命令集
awk 命令详解
Centos6.3编译安装nginx+php步骤
OCR （Optical Character Recognition，光学字符识别）
每日归档
更多
2024-05-08(42)
2024-05-07(14)
2024-05-06(40)
2024-05-05(0)
2024-05-04(7)
2024-05-03(19)
2024-05-02(0)
2024-05-01(4)
2024-04-30(1)
2024-04-29(40)

代码天地 © 2018 codetd.com

境外服务器   最新电视剧2022