Posted 2021-11-15Updated 2024-04-24Android / Framework39 minutes read (About 5825 words)

sharePreference

SharedPreferences是系统提供的一种简易数据持久化的手段，适合单进程、小批量的数据存储与访问。以键值对的形式存储在xml文件中。
文件存储路径为data/data/package_name/shared_prefs/目录。

源码解析

获取SharedPerferences对象

获取方法从getSharedPreferences(name,mode)开始，此时就需要去加载对应name的xml文件

class MainActivity : AppCompatActivity() {
    lateinit var sharedPreferences: SharedPreferences
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        sharedPreferences = getSharedPreferences("test", MODE_PRIVATE);
    }
}
Copy
test`表示生成的xml文件名为`test.xml

mode对应的是xml文件的访问权限以及数据的写入方式

权限控制格式	作用	备注
Context.MODE_PRIVATE	代表该文件是私有数据，只能被当前应用访问。写入的内容会覆盖源文件的内容。	默认操作模式
Context.MODE_WORLD_READABLE	表示当前文件可以被其他应用读取
Context.MODE_WORLE_WRITEABLE	表示当前文件可以被其他应用写入
Context.MODE_APPEND	会检查当前是否有文件存在？在在后面追加内容不存在则去创建新文件
~~Context.MODE_MULTI_PROCESS~~	部分支持跨进程使用	原理就是重新读取xml文件内容

//ContextImpl.java

private static ArrayMap<String, ArrayMap<File, SharedPreferencesImpl>> sSharedPrefsCache;
private ArrayMap<String, File> mSharedPrefsPaths;

    public SharedPreferences getSharedPreferences(String name, int mode) {
      
        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);
    }

    @Override
    public File getSharedPreferencesPath(String name) {
        return makeFilename(getPreferencesDir(), name + ".xml");
    }

    public SharedPreferences getSharedPreferences(File file, int mode) {
        SharedPreferencesImpl sp;
      //保证创建过程线程安全
        synchronized (ContextImpl.class) {
            final ArrayMap<File, SharedPreferencesImpl> cache = getSharedPreferencesCacheLocked();
          //获取缓存sp
            sp = cache.get(file);
            if (sp == null) {
                checkMode(mode);
              ...
                //新建SP对象
                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) {
          //重新加载XML文件
            sp.startReloadIfChangedUnexpectedly();
        }
        return sp;
    }
Copy

主要执行了三步：

根据传入的name在对应路径下生成对应的xml文件，并存入mSharedPrefsPaths进行缓存。
创建文件完毕后，再去创建对应的SharedPreferencesImpl对象，创建完成后缓存到cache中。每一个xml文件都会对应一个SP对象
若设置了mode为Context.MODE_MULTI_PROCESS，就需要重新去加载一次xml文件。

初始化

SP对象最后都是由SharedPreferencesImpl进行构建

SharedPreferencesImpl(File file, int mode) {
    mFile = file;
  //构建备份文件
    mBackupFile = makeBackupFile(file);
    mMode = mode;
    mLoaded = false;
  //缓存当前SP存储的键值对
    mMap = null;
    mThrowable = null;
  //开始加载磁盘的xml文件
    startLoadFromDisk();
}
Copy

加载文件

开启一个异步线程去加载xml文件，防止阻塞主线程

private void startLoadFromDisk() {
  //上锁保证线程安全
    synchronized (mLock) {
        mLoaded = false;
    }
    new Thread("SharedPreferencesImpl-load") {
        public void run() {
            loadFromDisk();
        }
    }.start();
}
Copy

loadFromDisk()时，需要判断当前是否存在备份文件，若存在备份文件就意味着上一次写入文件的过程出现了异常，导致写入失败。

private void loadFromDisk() {
    synchronized (mLock) {
        if (mLoaded) {
            return;
        }
        if (mBackupFile.exists()) {
          //删除源文件
            mFile.delete();
          //备份文件重命名为 源文件
            mBackupFile.renameTo(mFile);
        }
    }
  ...
    synchronized (mLock) {
        mLoaded = true;
        mThrowable = thrown;
                try {
            if (thrown == null) {
                if (map != null) {
                  //解析成功 赋值到mMap进行缓存
                    mMap = map;
                    mStatTimestamp = stat.st_mtim;
                    mStatSize = stat.st_size;
                } else {
                    mMap = new HashMap<>();
                }
            }
        } catch (Throwable t) {
            mThrowable = t;
        } finally {
            //释放锁 通知其他线程可以开始使用SP对象
            mLock.notifyAll();
        }
  }
}
Copy

这里就表现了SP的文件损坏时的备份机制，当文件写入异常时，启用备份文件保证之前的数据不会出现异常。

获取数据

1
2
3

... 初始化完成 sp对象
sp.getString("a","b"); //从sp获取a的值
Copy

获取数据支持部分数据类型，例如int、long、String等

//SharedPreferencesImpl.java
public String getString(key){}
public Set<String> getStringSet(key){}
public int getInt(key){}
public long getLong(key){}
public float getFloat(key){}
public boolean getBoolean(key){}

//以下拿 getString() 举例分析获取数据流程
    public String getString(String key, @Nullable String defValue) {
        synchronized (mLock) {
            awaitLoadedLocked();
            String v = (String)mMap.get(key);
            return v != null ? v : defValue;
        }
    }

    private void awaitLoadedLocked() {
        while (!mLoaded) {
            try {
              //等待mLock释放
                mLock.wait();
            } catch (InterruptedException unused) {
            }
        }
        if (mThrowable != null) {
            throw new IllegalStateException(mThrowable);
        }
    }
Copy

getXX()都是运行在主线程的，并且想要获取数据就必须等待加载文件这一步完成。等待mLock.notifyAll()才可以继续向下执行。

如果需要读取一个很大的文件，在调用getXX()之后，就需要一直进行等待，而导致主线程发生阻塞。

xml文件加载完毕后，getXX()从mMap获取数据，就不需要重新读取文件。

获取数据异常

SP中进行存储时，可能会导致同一个key存储不同类型的值，导致获取数据的时候抛出ClassCastException异常。

写入数据

... 初始化完成 sp对象
SharedPreferences.Editor mEditor = sharedPreferences.edit();
//写入数据
mEditor.putString("a","c");
Copy

写入数据同样支持部分数据类型。但是不是通过SP对象，而是通过Editor对象进行数据的写入

Editor对象

写入数据的相关操作都要通过Editor，本体是一个接口

//SharedPreferences.java
public interface Editor {
  //放入对应类型的对象
  Editor putString(String key, @Nullable String value);
  Editor putStringSet(String key, @Nullable Set<String> values);
  Editor putInt(String key, int value);
  Editor putLong(String key, long value);
  Editor putFloat(String key, float value);
  Editor putBoolean(String key, boolean value);
  //删除数据
  Editor remove(String key);
  Editor clear();
  //提交数据
  boolean commit();
  void apply();
}
Copy

Editor只是一个接口，EditorImpl才是具体的实现类。

//SharedPreferencesImpl.java
    public final class EditorImpl implements Editor {
        private final Object mEditorLock = new Object();

        @GuardedBy("mEditorLock")
        private final Map<String, Object> mModified = new HashMap<>();
      
              @Override
        public Editor putString(String key, @Nullable String value) {
          //通过synchronized修饰保证线程安全。
            synchronized (mEditorLock) {
              //存入临时map中，后续有用
                mModified.put(key, value);
                return this;
            }
        }
    }
Copy

mModified保存的是用户通过putXX()新增的数据，数据有效期位于第一次putXX 到 commit()/apply().

提交数据

上面写入数据完毕后，最后要调用一次commit()/apply()准备把数据写入到对应xml文件中。

“半同步”提交数据——commit

commit

... 初始化完成 sp对象
SharedPreferences.Editor mEditor = sharedPreferences.edit();
//写入数据
mEditor.putString("a","c");
//提交数据
mEditor.commit();
Copy
//SharedPreferencesImpl.java
        @Override
        public boolean commit() {
            long startTime = 0;

            if (DEBUG) {
                startTime = System.currentTimeMillis();
            }

            MemoryCommitResult mcr = commitToMemory();//写入内存

            SharedPreferencesImpl.this.enqueueDiskWrite(
                mcr, null /* sync write on this thread okay */);//写入磁盘
            try {
              //等待写入磁盘任务执行完毕 此处可能导致主线程阻塞
                mcr.writtenToDiskLatch.await();
            } catch (InterruptedException e) {
                return false;
            } finally {
            }
            notifyListeners(mcr);//通知监听
            return mcr.writeToDiskResult;
        }
Copy

commit()先后调用了commitToMemory()/*写入数据到mMap中，等待写入磁盘*/、enqueueDiskWrite()/*将数据写入到磁盘中*/，通过writeToFile()写入到磁盘中并会返回对应写入结果。

commit()如果当前没有线程在写入文件时，就会直接在当前线程开启写入磁盘任务，导致主线程阻塞(可能发生ANR)，等待线程执行完毕。如果在写入文件，就会通过QueuedWork开启异步执行。(这就是半同步的原因)

commit()执行都是同步的，而且每次都是写入全量的数据，会导致主线程阻塞。

SharedPreferences-commit

异步提交数据——apply

apply

... 初始化完成 sp对象
SharedPreferences.Editor mEditor = sharedPreferences.edit();
//写入数据
mEditor.putString("a","c");
//提交数据
mEditor.apply();
Copy
@Override
public void apply() {
    final long startTime = System.currentTimeMillis();

    final MemoryCommitResult mcr = commitToMemory();//写入内存
    final Runnable awaitCommit = new Runnable() {
            @Override
            public void run() {
                try {
                    mcr.writtenToDiskLatch.await();//等待磁盘写入任务完成
                } catch (InterruptedException ignored) {
                }
            }
        };

  //添加 QueuedWork执行完毕的回调监听
    QueuedWork.addFinisher(awaitCommit);

    Runnable postWriteRunnable = new Runnable() {
            @Override
            public void run() {
                awaitCommit.run();
                QueuedWork.removeFinisher(awaitCommit);
            }
        };
  //开启异步线程执行写入任务
    SharedPreferencesImpl.this.enqueueDiskWrite(mcr, postWriteRunnable);

    notifyListeners(mcr);
}
Copy

apply()也先调用commitToMemory()将更改提交到内存，之后调用enqueueDiskWriter()开启写入磁盘任务。

apply()是提交任务到线程池后，就直接通知写入成功，不需要等待线程执行完成。

虽然apply()是异步执行的，但是存在某些场景下也会发生ANR。后文会分析

缓存写入内存

写入内存

将缓存文件写入内存

// Returns true if any changes were made
private MemoryCommitResult commitToMemory() {
    long memoryStateGeneration;
    List<String> keysModified = null;
    Set<OnSharedPreferenceChangeListener> listeners = null;
    Map<String, Object> mapToWriteToDisk;

    synchronized (SharedPreferencesImpl.this.mLock) {
        if (mDiskWritesInFlight > 0) {
            mMap = new HashMap<String, Object>(mMap);
        }
      //软拷贝
        mapToWriteToDisk = mMap;
        mDiskWritesInFlight++;

        synchronized (mEditorLock) {
            boolean changesMade = false;
           //调用了 clear() 清理的是所有数据
            if (mClear) {
                if (!mapToWriteToDisk.isEmpty()) {
                    changesMade = true;
                    mapToWriteToDisk.clear();
                }
                mClear = false;
            }

          //mModified的值写入到 mapToWriteToDisk中，准备写入到文件中
            for (Map.Entry<String, Object> e : mModified.entrySet()) {
                String k = e.getKey();
                Object v = e.getValue();
                // "this" is the magic value for a removal mutation. In addition,
                // setting a value to "null" for a given key is specified to be
                // equivalent to calling remove on that key.
                if (v == this || v == null) {
                    if (!mapToWriteToDisk.containsKey(k)) {
                        continue;
                    }
                    mapToWriteToDisk.remove(k);
                } else {
                    if (mapToWriteToDisk.containsKey(k)) {
                        Object existingValue = mapToWriteToDisk.get(k);
                        if (existingValue != null && existingValue.equals(v)) {
                            continue;
                        }
                    }
                    mapToWriteToDisk.put(k, v);
                }
              //发生了变化
              changesMade = true;
            }
          //执行完毕后 mMap和 mapToWriteToDisk内容一致

          //写入内存后，清除原先未写入的数据
            mModified.clear();
          
            if (changesMade) {
              //差异计数 +1 
                mCurrentMemoryStateGeneration++;
            }                  
        }
    }
    return new MemoryCommitResult(memoryStateGeneration, keysModified, listeners,
            mapToWriteToDisk);
}
Copy

将mModified的值写入到mapToWriteToDisk，其实mMap中也是一样的内容，然后清空mModified的数据，拼接得到一个MemoryCommitResult对象，里面持有的就是要写入xml文件的内容。

内存写入磁盘

写入磁盘

把存入内存的数据mapToWriteToDisk写入到对应的xml文件。

private void enqueueDiskWrite(final MemoryCommitResult mcr,
                               //commit() 传入为null apply() 传入不为null 
                                  final Runnable postWriteRunnable) {
        final boolean isFromSyncCommit = (postWriteRunnable == null);//commit 为 true apply为false

        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 执行写入任务
        QueuedWork.queue(writeToDiskRunnable, !isFromSyncCommit);
    }
Copy
/*
 *  写入数据到磁盘中
 *  把已存在的文件进行重命名 添加.bak后缀，作为备份文件存在。删除源文件
 *  新建 源文件，重新写入所有数据，同时记录写入时间
 *  如果写入文件失败，删除新建的文件，并返回失败
 *  如果写入文件成功，删除备份文件，返回成功
 */
private void writeToFile(MemoryCommitResult mcr, boolean isFromSyncCommit) {
  //把当前文件做一份备份文件
       if (!backupFileExists) {
            if (!mFile.renameTo(mBackupFile)) {
                Log.e(TAG, "Couldn't rename file " + mFile
                      + " to backup file " + mBackupFile);
                mcr.setDiskWriteResult(false, false);
                return;
            }
        } else {
            mFile.delete();
        }    
  ...
    
}

    void setDiskWriteResult(boolean wasWritten, boolean result) {
        this.wasWritten = wasWritten;
        writeToDiskResult = result;
      //比较两次请求的版本号，版本号不一致表示发生了改变
        if (mDiskStateGeneration < mcr.memoryStateGeneration) {
            if (isFromSyncCommit) {
                needsWrite = true;
            } else {
                synchronized (mLock) {
                    // No need to persist intermediate states. Just wait for the latest state to
                    // be persisted.
                    if (mCurrentMemoryStateGeneration == mcr.memoryStateGeneration) {
                        needsWrite = true;
                    }
                }
            }
        }
       //版本号一致，就不重复执行写入磁盘任务
        if (!needsWrite) {
            mcr.setDiskWriteResult(false, true);
            return;
        }          
      
      //执行完毕一次任务 自动-1
        writtenToDiskLatch.countDown();
    }
Copy

写入到xml文件之前，会把原有的数据保存在.bak文件进行备份，用于写入磁盘过程中发生任何异常都可以恢复原有数据。

根据上述流程commit()/apply()提交数据 -> 写入内存 -> 写入硬盘，每次调用都会走一遍完整流程，导致频繁的IO使用。

官方更建议将数据的更新合并到一次写操作中，即多次写入一次提交。

commit与apply的比较

apply()没有返回值，commit()有返回值可以知道文件是否写入成功
apply()将修改提交内存，再异步写入文件；commit()同步写入文件。
并发commit()时，需要等待正在执行的数据写入到文件后才会继续往下执行；apply()先更新到内存，后面再次调用会覆盖原有的内存数据，接下来再异步写入文件即可。

删除数据

SharedPreferences sp = getSharedPreferences("a",MODE_PRIVATE);
SharedPreferences.Editor editor =  sp.edit();
//写入数据
editor.putString("a","b");
//通过remove 清除单个数据
editor.remove("a");
//提交数据
editor.commit();

//清除所有数据
editor.clear();
editor.commit();
Copy
        private MemoryCommitResult commitToMemory() {
          Map<String, Object> mapToWriteToDisk;
          ...
          synchronized (SharedPreferencesImpl.this.mLock) {
            //赋值原有数据
            mapToWriteToDisk = mMap;
            ...
              synchronized (mEditorLock) {
                        boolean changesMade = false;
                        if (!mapToWriteToDisk.isEmpty()) {
                            changesMade = true;
                          //清除原有数据
                            mapToWriteToDisk.clear();
                        }
                        mClear = false;              
            }
          }
          
        }
//最后写入的就是一个空map，导致所有存储的数据都被清空
Copy

数据改变监听

SP支持监听数据的改变，返回的是修改的内容

SharedPreferences sp = getSharedPreferences("a",MODE_PRIVATE);
SharedPreferences.Editor editor =  sp.edit();

SharedPreferences.OnSharedPreferenceChangeListener listener =  new SharedPreferences.OnSharedPreferenceChangeListener() {
            @Override
            public void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key) {
                //打印发生了改变的值
            }
        };

//对应的需要在 页面销毁时，及时取消监听
sp.unregisterOnSharedPreferenceChangeListener(listener);
Copy
//SharedPreferencesImpl.java
    public void registerOnSharedPreferenceChangeListener(OnSharedPreferenceChangeListener listener) {
        synchronized(mLock) {
            mListeners.put(listener, CONTENT);
        }
    }

        private MemoryCommitResult commitToMemory() {
          ...
                boolean hasListeners = mListeners.size() > 0;
                if (hasListeners) {
                    keysModified = new ArrayList<String>();
                  //转化 去重
                    listeners = new HashSet<OnSharedPreferenceChangeListener>(mListeners.keySet());
                }            
          ...
            //作为参数 传入 MCR
            return new MemoryCommitResult(memoryStateGeneration, keysModified, listeners,
                    mapToWriteToDisk);            
        }

//发生变化后通知回调
        private void notifyListeners(final MemoryCommitResult mcr) {
            if (mcr.listeners == null || mcr.keysModified == null ||
                mcr.keysModified.size() == 0) {
                return;
            }
            if (Looper.myLooper() == Looper.getMainLooper()) {
              //在主线程直接回调
                for (int i = mcr.keysModified.size() - 1; i >= 0; i--) {
                    final String key = mcr.keysModified.get(i);
                    for (OnSharedPreferenceChangeListener listener : mcr.listeners) {
                        if (listener != null) {
                            listener.onSharedPreferenceChanged(SharedPreferencesImpl.this, key);
                        }
                    }
                }
            } else {
                // 不在主线程切换到主线程回调
                ActivityThread.sMainThreadHandler.post(() -> notifyListeners(mcr));
            }
        }
Copy

commit()需要在数据写入文件后，才可以回调到notifyListeners()通知数据发生变化。

apply()只要数据在写入内存后，就会直接回调。

QueuedWork

SP-QueuedWork

系统提供的异步工具类，内部通过HandlerThread作为工作线程，用于跟踪那些未完成或尚未结束的全局任务。

初始化

private static Handler getHandler() {
    synchronized (sLock) {
        if (sHandler == null) {
          //新建HandlerThread执行任务
            HandlerThread handlerThread = new HandlerThread("queued-work-looper",
                    Process.THREAD_PRIORITY_FOREGROUND);
            handlerThread.start();

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

queue()

向QueuedWork中添加任务

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

commit()时，shouldDelay为false，直接发送消息

apply()时，shouldDelay为true，需要延迟100ms再发送消息，避免频繁的磁盘写入操作

addFinisher()

添加完成任务完成回调

@GuardedBy("sLock")
private static final LinkedList<Runnable> sFinishers = new LinkedList<>();

public static void addFinisher(Runnable finisher) {
    synchronized (sLock) {
      //将完成任务后的Runnable添加进去，等待任务完成后执行
        sFinishers.add(finisher);
    }
}
Copy

processPendingWork()

执行写入磁盘任务

private static void processPendingWork() {
    long startTime = 0;

    synchronized (sProcessingWork) {
        LinkedList<Runnable> work;

        synchronized (sLock) {
            work = (LinkedList<Runnable>) sWork.clone();
            sWork.clear();
            getHandler().removeMessages(QueuedWorkHandler.MSG_RUN);
        }

        if (work.size() > 0) {
            for (Runnable w : work) {
              //执行任务
                w.run();
            }
        }
    }
}
Copy

QueuedWork执行流程

* waitToFinish()

等待任务完成。这里也就是ANR发生的根本原因

//主线程调用 
public static void waitToFinish() {
        long startTime = System.currentTimeMillis();
        boolean hadMessages = false;

        Handler handler = getHandler();

        try {
          //执行未完成的任务
            processPendingWork();
        } finally {
            StrictMode.setThreadPolicy(oldPolicy);
        }

        try {
            while (true) {
                Runnable finisher;

                synchronized (sLock) {
                    finisher = sFinishers.poll();//取出 任务完成后的回调
                }

                if (finisher == null) {
                    break;
                }
              //此处会导致阻塞的发生
                finisher.run();//执行 任务完成后的回调  对应执行的就是 writtenToDiskLatch.await()
            }
        } finally {
            sCanDelay = true;
        }

    }


//SharedPreferencesImpl.java
apply(){
              final Runnable awaitCommit = new Runnable() {
                    @Override
                    public void run() {
                        try {
                          //需要等待主线程写入任务完毕
                            mcr.writtenToDiskLatch.await();//等待磁盘写入任务完成
                        } catch (InterruptedException ignored) {
                        }
                    }
                };

          //添加 QueuedWork执行完毕的回调监听
            QueuedWork.addFinisher(awaitCommit);
}
Copy

调用waitToFinish()时，会主动调用processPendingWork()去执行任务，在HandlerThread执行写入磁盘任务。

waitToFinish()会一直等待写入任务执行完毕，其他什么都不做，当存在很多写入任务时，会依次执行，文件很大时效率很低，就有可能导致ANR。

线程安全

SP的线程安全分为两部分分析

读线程安全

  @GuardedBy("mLock")
  private Map<String, Object> mMap;//通过注解的形式 告知该对象由哪把锁控制


public String getString(String key, @Nullable String defValue) {
    synchronized (mLock) {
        String v = (String)mMap.get(key);
        return v != null ? v : defValue;
    }
}
Copy

读操作主要是从mMap读取缓存的值，避免其他线程执行写操作导致线程不安全，通过mLock保证线程安全。

写线程安全

写操作，主要分为三步，每一步都有不同的锁进行控制。

写入对象

@GuardedBy("mEditorLock")
private final Map<String, Object> mModified = new HashMap<>();

@Override
public Editor putString(String key, @Nullable String value) {
    synchronized (mEditorLock) {
        mModified.put(key, value);
        return this;
    }
}
Copy

第一把锁mEditorLock保证写入到mModified线程安全

写入内存

synchronized (SharedPreferencesImpl.this.mLock) {
  //控制mMap赋值
  if (mDiskWritesInFlight > 0) {
    mMap = new HashMap<String, Object>(mMap);
  }
  mapToWriteToDisk = mMap;
  synchronized (mEditorLock) {
    boolean changesMade = false;
    //保证mModified 与 mapToWriteToDisk的合并安全
    for (Map.Entry<String, Object> e : mModified.entrySet()) {
      mapToWriteToDisk.put(k, v);
    }
    
  }
Copy

写入内存时，需要把mModify待添加的数据合并到mapToWriteToDisk中，这时需要通过两把锁保证线程安全。

保证mapToWriteToDisk赋值时数据正确
保证mModified合并到mapToWriteToDisk时线程安全

写入硬盘

//将mapToWriteToDisk的内容写入到 xml文件中
synchronized (mWritingToDiskLock) {
   writeToFile(mcr, isFromSyncCommit);
}
Copy

写入硬盘时，保证写入时内容不会发生改变。

进程安全

SharedPreferences不是进程安全的。

MODE_MULTI_PROCESS

if ((mode & Context.MODE_MULTI_PROCESS) != 0 ||
    getApplicationInfo().targetSdkVersion < android.os.Build.VERSION_CODES.HONEYCOMB) {
  //重新加载XML文件
    sp.startReloadIfChangedUnexpectedly();
}
Copy

唯一的作用就是切换进程时重新加载XML文件内容。

当在频繁跨进程读写时就会有数据丢失的可能。

ContentProvider(官方推荐)

ContentProvider是Android提供的跨进程组件，可以替换其底层实现为SP，来保证SP的进程安全。

//TODO 实现待添加

文件锁

SharedPreferences 本质是对xml文件的读写，可以通过对xml文件添加文件锁，就能保证进程安全。

FileLock(文件锁)用来表示文件区域锁定标记，可以通过对一个可写文件加锁，保证同时只有一个进程可以拿到文件的锁，这个进程就可以对文件进行访问；其他拿不到锁的进程要么选择被挂起等待，要么去做一些其他的事情。

可以保证众进程可以顺序访问文件，并且可以通过FileLock进行并发控制，保证进程的顺序执行。

获取锁

FileChannel.lock()：阻塞直至获得文件锁。默认锁定整个文件
FileChannel.lock(position,size,shared)：阻塞直至获取文件的部分数据的文件锁
FileChannel.tryLock()：立即返回，要么返回锁，要么返回null(获取锁失败)

释放锁

FileLock.release()：释放当前文件锁

检测锁

FileLock.isValid()：检测文件锁的有效性

//TODO 实现待添加

ANR分析

在上面有提到QueuedWork.waitToFinish()是要在写入文件的操作完成后才会结束，且这个方法会运行在当前线程，极有可能导致阻塞/ANR。

`waitToFinish()`调用场景

通过全局搜索QueuedWork.waitToFinish()找到在ActivityThread使用的较多

//ActivityThread.java
    public void handleStopActivity(IBinder token, boolean show, int configChanges,
            PendingTransactionActions pendingActions, boolean finalStateRequest, String reason) {
      ...
        if (!r.isPreHoneycomb()) {
            QueuedWork.waitToFinish();
        }
    }

    private void handleSleeping(IBinder token, boolean sleeping) {
      ...
           if (sleeping) {
            if (!r.stopped && !r.isPreHoneycomb()) {
                callActivityOnStop(r, true /* saveState */, "sleeping");
            }

            // Make sure any pending writes are now committed.
            if (!r.isPreHoneycomb()) {
                QueuedWork.waitToFinish();
            }
    }
Copy

会在onStop()时调用QueuedWork.waitToFinish()等待当前未执行完毕的写入任务结束，才可以释放锁。此时就会阻塞主线程，可能导致ANR。

解决方案

反射在ActivityThread中的H变量添加一个callback，可以拦截Handler的事件分发。在几个关键的节点例如stop、pause及时通过反射清理QueuedWork中的sFinishers请求等待队列。
开启一个异步线程在其内部调用commit()去写入数据

使用注意事项

建议不要在SP里存储特别大的key/value,因为内容都是一次性加载到内存中，过大会导致卡顿/ANR。
不要频繁调用commit()/apply()，SP的数据每次都是全量写入文件，尤其是commit()直接同步操作，更容易卡顿。建议批量写一次提交
MODE_MULTI_PROCESS是在每次getSharedPreferences时检查磁盘上配置文件上次修改时间和文件大小，一旦所有修改则会重新从磁盘加载文件，所以并不能保证多进程数据的实时同步。
高频写操作的key与高频读操作的key可以适当的拆分文件，减少同步锁的竞争。
最好写入轻量级的数据，不要存储大量的数据。

替换方案

MMKV

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

写入的数据格式为 Protobuf

Github-MMKV

MMKV原理

MMKV for Android 多进程设计与实现

参考链接

全面解析SharedPReferences

SharedPreferences的设计与实现

Jetpack DataStore 分析

剖析 SharedPreference apply 引起的 ANR 问题

Android 源码仓库

sharePreference

http://example.com/2021/11/15/SharePreference/

Author

white crow

Posted on

2021-11-15

Updated on

2024-04-24

sharePreference

源码解析

获取SharedPerferences对象

初始化

加载文件

获取数据

获取数据异常

写入数据

Editor对象

提交数据

“半同步”提交数据——commit

异步提交数据——apply

缓存写入内存

内存写入磁盘

commit与apply的比较

删除数据

数据改变监听

QueuedWork

初始化

queue()

addFinisher()

processPendingWork()

* waitToFinish()

线程安全

读线程安全

写线程安全

写入对象

写入内存

写入硬盘

进程安全

MODE_MULTI_PROCESS

ContentProvider(官方推荐)

文件锁

获取锁

释放锁

检测锁

ANR分析

waitToFinish()调用场景

解决方案

使用注意事项

替换方案

MMKV

参考链接

Author

Posted on

Updated on

Licensed under

Catalogue

`waitToFinish()`调用场景