SharedPreferencesCompat的由来与简单解析

最近在读项目源码的时候，发现一个SharedPreferencesCompat类，这个类做了一些简单的工作，后来google之后理解了这种写法的缘由，在这里跟大家分享一下。

首先我们直接来看这个类的源码，很简短

[java] view plain copy

1. /** 
2.  * Reflection utils to call SharedPreferences$Editor.apply when possible, 
3.  * falling back to commit when apply isn't available. 
4.  */  
5. public class SharedPreferencesCompat {  
6.     private static final Method sApplyMethod = findApplyMethod();  
7.   
8.     private static Method findApplyMethod() {  
9.         try {  
10.             Class cls = SharedPreferences.Editor.class;  
11.             return cls.getMethod("apply");  
12.         } catch (NoSuchMethodException unused) {  
13.             // fall through  
14.         }  
15.         return null;  
16.     }  
17.   
18.     public static void apply(SharedPreferences.Editor editor) {  
19.         if (sApplyMethod != null) {  
20.             try {  
21.                 sApplyMethod.invoke(editor);  
22.                 return;  
23.             } catch (InvocationTargetException unused) {  
24.                 // fall through  
25.             } catch (IllegalAccessException unused) {  
26.                 // fall through  
27.             }  
28.         }  
29.         editor.commit();  
30.     }  
31. }  

从上面的代码我们可以看出，首先在

[java] view plain copy

1. findApplyMethod()  

方法里面，我们通过反射获得Editor的apply()对象，这个对象是一个final static,并且findApplyMethod()方法是静态调用的，也就是我们一旦使用了这个类，就首先获得了一个apply()方法对象。

接着，我们看public方法apply()，传入的是一个Editor对象，sApplyMethod不为空，则通过反射调用Editor的apply()方法，否则呢，调用Editor的commit()方法

在这里我们的疑惑是，什么时候sApplyMethod可能为空呢。这里涉及了一个api版本问题，Editor的apply()是在API 9以后新增的，所以为了兼容API 9以下的版本，当我们没有aplly()方法的时候，才调用commit()方法。

OK,说到这里，这个类的作用解决了，但是可能又有一个疑惑，apply()和commit()方法有什么区别呢？

apply()是新增的，目的是为了提高commit()方法的效率问题。

相同点：

1.二者都是提交preference修改数据

2.二者都是原子过程。

区别：

1.apply没有返回值而commit返回boolean表明修改是否提交成功

2.apply是将修改数据原子提交到内存，而后异步真正提交到硬件磁盘；而commit是同步的提交到硬件磁盘，因此，在多个并发的提交commit的时候，他们会等待正在处理的commit保存到磁盘后在操作，从而降低了效率。而apply只是原子的提交到内容，后面有调用apply的函数的将会直接覆盖前面的内存数据，这样从一定程度上提高了很多效率。

3.apply方法不会提示任何失败的提示。

综合上述，由于在一个进程中，sharedPreference是单实例，一般不会出现并发冲突，如果对提交的结果不关心的话，建议使用apply，当然需要确保提交成功且有后续操作的话，还是需要用commit的。

commit介绍：public abstract boolean commit ()

修改你的preferences，从Editor到SharePreferences。它执行所请求的修改，替代SharedPreferences中的任何数据

当2个editor同时修改preferences ，最后一个commit成功。

如果不关注返回值或在程序的main线程使用时，推荐使用apply().

apply介绍：public abstract void apply ()

区别：

commit将同步的将数据写到preferences；apply立即更改内存中的SharedPreferences，但是开始异步提交到磁盘中。保存失败你也不会得到任何提示信息，

如果在这个sharedPreferences有另外一个editor执行一个定期的commit，此时一个apply依旧未完成。commit将被阻塞，直到所有异步操作完成，以及自己的commit。

由于SharedPreferences在进程中是单实例的。在忽略返回值的前提下，取代任何实例的commit或apply都是安全的。