你已經用 SharedPrefrence 的 apply() 替換 commit() 了嗎?

nanchen2251發表於2017-11-21

這是 面試系列 的第六期。本期我們將來探討一個有趣的東西 —— SharePrefrence 的兩種提交方式 apply()commit()

往期內容傳遞:
Android 面試(一):說說 Android 的四種啟動模式
Android 面試(二):如何理解 Activity 的生命週期
Android 面試(三):用廣播 BroadcastReceiver 更新 UI 介面真的好嗎?
Android 面試(四):Android Service 你真的能應答自如了嗎?
Android 面試(五):探索 Android 的 Handler

開始

其實非常有趣,我們經常在開發中使用 SharePrefrence 儲存一些輕量級資料,比如判斷是否是首次啟動,首次啟動進入引導頁,否則直接到主頁面,或者是其它的一些應用場景。

而我們也耳熟能詳這樣的寫法。

  • 根據 Context 獲取 SharedPreferences 物件
  • 利用 edit() 方法獲取 Editor 物件。
  • 通過 Editor 物件儲存 key-value 鍵值對資料。
  • 通過 commit() 方法提交資料。
public class SplashActivity extends AppCompatActivity {
    public static final String SP_KEY = "com.zxedu.myapplication.SplashActivity_SP_KEY";
    public static final String IS_FIRST_IN = "com.zxedu.myapplication.SplashActivity_IS_FIRST_IN";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        // 一些業務程式碼
        ......    

        SharedPreferences preferences = getSharedPreferences("name",MODE_PRIVATE);
        if (preferences.getBoolean(IS_FIRST_IN,true)){
            // 跳轉引導頁面
            startActivity(new Intent(this,GuideActivity.class));
            finish();
        }else{
            // 跳轉主頁面
            startActivity(new Intent(this,MainActivity.class));
        }

    }
}


public class GuideActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_splash);
        getSharedPreferences(SplashActivity.SP_KEY,MODE_PRIVATE).edit().putBoolean(SplashActivity.IS_FIRST_IN,false).apply();
    }
}複製程式碼

從程式碼中可以看到,一陣混亂操作,沒啥特別的地方,但早期開發的人員應該知道,之前我們都是比較青睞 commit() 進行提交的。而現在 Android Studio 在我們使用 commit() 直接提交的時候會直接報黃色警告。

nanchen
nanchen

commit() 和 apply() 到底有什麼異同?

先說說相同點:

  • 二者都是提交 Prefrence 修改資料;
  • 二者都是原子過程。

不同點直接上原始碼吧,先看看 commit() 方法的定義:

/**
         * Commit your preferences changes back from this Editor to the
         * {@link SharedPreferences} object it is editing.  This atomically
         * performs the requested modifications, replacing whatever is currently
         * in the SharedPreferences.
         *
         * <p>Note that when two editors are modifying preferences at the same
         * time, the last one to call commit wins.
         *
         * <p>If you don't care about the return value and you're
         * using this from your application's main thread, consider
         * using {@link #apply} instead.
         *
         * @return Returns true if the new values were successfully written
         * to persistent storage.
         */
        boolean commit();複製程式碼

綜合一下 commit() 方法的註釋也就是兩點:

  • 會返回執行結果。
  • 如果不考慮結果並且是在主執行緒執行可以考慮 apply()

再看看 apply() 方法的定義:

/**
         * Commit your preferences changes back from this Editor to the
         * {@link SharedPreferences} object it is editing.  This atomically
         * performs the requested modifications, replacing whatever is currently
         * in the SharedPreferences.
         *
         * <p>Note that when two editors are modifying preferences at the same
         * time, the last one to call apply wins.
         *
         * <p>Unlike {@link #commit}, which writes its preferences out
         * to persistent storage synchronously, {@link #apply}
         * commits its changes to the in-memory
         * {@link SharedPreferences} immediately but starts an
         * asynchronous commit to disk and you won't be notified of
         * any failures.  If another editor on this
         * {@link SharedPreferences} does a regular {@link #commit}
         * while a {@link #apply} is still outstanding, the
         * {@link #commit} will block until all async commits are
         * completed as well as the commit itself.
         *
         * <p>As {@link SharedPreferences} instances are singletons within
         * a process, it's safe to replace any instance of {@link #commit} with
         * {@link #apply} if you were already ignoring the return value.
         *
         * <p>You don't need to worry about Android component
         * lifecycles and their interaction with <code>apply()</code>
         * writing to disk.  The framework makes sure in-flight disk
         * writes from <code>apply()</code> complete before switching
         * states.
         *
         * <p class='note'>The SharedPreferences.Editor interface
         * isn't expected to be implemented directly.  However, if you
         * previously did implement it and are now getting errors
         * about missing <code>apply()</code>, you can simply call
         * {@link #commit} from <code>apply()</code>.
         */
        void apply();複製程式碼

略微有點長,大概意思就是 apply()commit() 不一樣的地方是,它使用的是非同步而不是同步,它會立即將更改提交到記憶體,然後非同步提交到硬碟,並且如果失敗將沒有任何提示。

總結一下不同點:

  • commit() 是直接同步地提交到硬體磁碟,因此,多個併發的採用 commit() 做提交的時候,它們會等待正在處理的 commit() 儲存到磁碟後再進行操作,從而降低了效率。而 apply() 只是原子的提交到內容,後面再呼叫 apply() 的函式進行非同步操作。
  • 翻原始碼可以發現 apply() 返回值為 void,而 commit() 返回一個 boolean 值代表是否提交成功。
  • apply() 方法不會有任何失敗的提示。

那到底使用 commit() 還是 apply()?

大多數情況下,我們都是在同一個程式中,這時候的 SharedPrefrence 都是單例項,一般不會出現併發衝突,如果對提交的結果不關心的話,我們非常建議用 apply() ,當然需要確保操作成功且有後續操作的話,還是需要用 commit() 的。

做不完的開源,寫不完的矯情。歡迎掃描下方二維碼或者公眾號搜尋「nanchen」關注我的微信公眾號,目前多運營 Android ,儘自己所能為你提升。如果你喜歡,為我點贊分享吧~
nanchen
nanchen

相關文章