Sử dụng các giá trị Lựa chọn ưu tiên đã lưu Một phần của Android Jetpack.

Tài liệu này mô tả cách lưu trữ và sử dụng các giá trị Preference do Thư viện lựa chọn ưu tiên lưu.

Lưu trữ dữ liệu ưu tiên

Phần này mô tả cách Preference có thể lưu giữ lại dữ liệu.

SharedPreferences

Theo mặc định, Preference sử dụng SharedPreferences để lưu giá trị. API SharedPreferences hỗ trợ đọc và ghi các cặp khoá-giá trị đơn giản từ một tệp được lưu trong các phiên hoạt động của ứng dụng. Thư viện lựa chọn ưu tiên sử dụng một thực thể SharedPreferences riêng tư để chỉ ứng dụng của bạn mới có thể truy cập vào thực thể đó.

Ví dụ: giả sử SwitchPreferenceCompat như sau:

<SwitchPreferenceCompat
        app:key="notifications"
        app:title="Enable message notifications"/>

Khi người dùng chuyển nút này sang trạng thái "bật", tệp SharedPreferences sẽ cập nhật bằng một cặp khoá-giá trị của "notifications" : "true". Khoá được sử dụng giống với khoá được đặt cho Preference.

Để biết thêm thông tin về API SharedPreferences, hãy xem bài viết Lưu dữ liệu khoá-giá trị.

Để biết thông tin về những cách lưu trữ dữ liệu trên Android, hãy xem bài viết Tổng quan về lưu trữ dữ liệu và tệp.

PreferencesDataStore

Mặc dù Thư viện lựa chọn ưu tiên vẫn duy trì dữ liệu bằng SharedPreferences theo mặc định, nhưng SharedPreferences không phải lúc nào cũng là giải pháp lý tưởng. Ví dụ: nếu ứng dụng yêu cầu người dùng đăng nhập, thì bạn nên duy trì chế độ cài đặt ứng dụng trên đám mây để chế độ cài đặt được phản ánh trên các thiết bị và nền tảng khác. Tương tự, nếu ứng dụng có các lựa chọn cấu hình dành riêng cho thiết bị, thì mỗi người dùng trên thiết bị có các chế độ cài đặt riêng, thì SharedPreferences sẽ trở thành một giải pháp không lý tưởng.

PreferenceDataStore cho phép bạn sử dụng phần phụ trợ lưu trữ tuỳ chỉnh để lưu trữ các giá trị Preference. Để biết thêm thông tin, hãy xem bài viết Sử dụng kho dữ liệu tuỳ chỉnh.

Đọc giá trị ưu tiên

Để truy xuất đối tượng SharedPreferences đang được sử dụng, hãy gọi PreferenceManager.getDefaultSharedPreferences(). Mặc dù phương thức này hoạt động từ mọi nơi trong ứng dụng, nhưng bạn nên chia ứng dụng thành các lớp. Để biết thêm thông tin, hãy xem bài viết Lớp dữ liệu.

Ví dụ: đã cung cấp EditTextPreference có khoá là "signature" như sau:

<EditTextPreference
        app:key="signature"
        app:title="Your signature"/>

Bạn có thể truy xuất toàn bộ giá trị đã lưu cho Preference này như sau:

Kotlin

val sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this /* Activity context */)
val name = sharedPreferences.getString("signature", "")

Java

SharedPreferences sharedPreferences =
        PreferenceManager.getDefaultSharedPreferences(this /* Activity context */);
String name = sharedPreferences.getString("signature", "");

Lắng nghe các thay đổi giá trị Ưu tiên

Để lắng nghe các thay đổi đối với giá trị Preference, bạn có thể chọn giữa hai giao diện:

• Preference.OnPreferenceChangeListener
• SharedPreferences.OnSharedPreferenceChangeListener

Bảng sau đây trình bày sự khác biệt giữa hai giao diện:

OnPreferenceChangeListener	OnSharedPreferenceChangeListener
Được đặt trên một Preference.	Áp dụng cho mọi đối tượng Preference.
Được gọi khi Preference sắp thay đổi giá trị đã lưu, ngay cả khi giá trị đang chờ xử lý giống với giá trị đã lưu.	Chỉ được gọi khi giá trị được lưu cho Preference thay đổi.
Chỉ được gọi thông qua thư viện Preference. Một phần riêng của ứng dụng có thể thay đổi giá trị đã lưu.	Được gọi mỗi khi giá trị đã lưu thay đổi, ngay cả khi giá trị đó đến từ một phần riêng biệt của ứng dụng.
Được gọi trước khi giá trị đang chờ xử lý được lưu.	Được gọi sau khi giá trị được lưu.
Được gọi khi sử dụng SharedPreferences hoặc PreferenceDataStore.	Chỉ được gọi khi sử dụng SharedPreferences.

Triển khai OnPreferenceChangeListener

Việc triển khai OnPreferenceChangeListener cho phép bạn theo dõi thay đổi đang chờ xử lý đối với giá trị của Preference. Sau đó, bạn có thể xác thực xem thay đổi đó có xảy ra hay không. Ví dụ: Mã sau đây cho biết cách theo dõi thay đổi đối với giá trị của EditTextPreference bằng khoá "name":

Kotlin

override fun onPreferenceChange(preference: Preference, newValue: Any): Boolean {
    Log.e("preference", "Pending Preference value is: $newValue")
    return true
}

Java

@Override
public boolean onPreferenceChange(Preference preference, Object newValue) {
    Log.e("preference", "Pending Preference value is: " + newValue);
    return true;
}

Tiếp theo, bạn cần thiết lập trực tiếp trình nghe này với setOnPreferenceChangeListener() như sau:

Kotlin

preference.onPreferenceChangeListener = ...

Java

preference.setOnPreferenceChangeListener(...);

Triển khai OnSharedPreferencesChangeListener

Khi lưu giữ lại giá trị Preference bằng SharedPreferences, bạn cũng có thể sử dụng SharedPreferences.OnSharedPreferenceChangeListener để lắng nghe các thay đổi. Điều này cho phép bạn theo dõi thời điểm các giá trị do Preference lưu bị thay đổi, chẳng hạn như khi đồng bộ hoá các chế độ cài đặt với máy chủ. Ví dụ sau cho biết cách theo dõi thay đổi đối với giá trị của EditTextPreference bằng khoá "name":

Kotlin

override fun onSharedPreferenceChanged(sharedPreferences: SharedPreferences, key: String) {
    if (key == "signature") {
        Log.i(TAG, "Preference value was updated to: " + sharedPreferences.getString(key, ""))
    }
}

Java

@Override
public void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key) {
    if (key.equals("signature")) {
        Log.i(TAG, "Preference value was updated to: " + sharedPreferences.getString(key, ""));
    }
}

Đăng ký trình nghe bằng cách sử dụng registerOnSharedPreferenceChangedListener() như sau:

Kotlin

preferenceManager.sharedPreferences.registerOnSharedPreferenceChangeListener(...)

Java

getPreferenceManager().getSharedPreferences().registerOnSharedPreferenceChangeListener(...);

Cảnh báo: Để ngăn việc thu thập rác ngoài ý muốn, hãy lưu trữ một tham chiếu rõ ràng đến trình nghe. Khi gọi registerOnSharedPreferenceChangeListener(), SharedPreferenceManager không lưu trữ một tham chiếu rõ ràng đến trình nghe. Để giải quyết vấn đề này, bạn có thể triển khai onSharedPreferenceChanged() trực tiếp trong PreferenceFragmentCompat. Bạn cũng có thể tạo một biến bản sao, như trong ví dụ sau:

Kotlin

    val listener: SharedPreferences.OnSharedPreferenceChangeListener =
            SharedPreferences.OnSharedPreferenceChangeListener {...}
    

Java

    SharedPreferences.OnSharedPreferenceChangeListener listener =
            new SharedPreferences.OnSharedPreferenceChangeListener() {...}
    

Để quản lý vòng đời thích hợp trong Activity hoặc Fragment, hãy đăng ký và huỷ đăng ký trình nghe này trong các lệnh gọi lại onResume() và onPause(), như minh hoạ trong ví dụ sau:

Kotlin

override fun onResume() {
    super.onResume()
    preferenceManager.sharedPreferences.registerOnSharedPreferenceChangeListener(this)
}

override fun onPause() {
    super.onPause()
    preferenceManager.sharedPreferences.unregisterOnSharedPreferenceChangeListener(this)
}

Java

@Override
public void onResume() {
    super.onResume();
    getPreferenceManager().getSharedPreferences().registerOnSharedPreferenceChangeListener(this);
}

@Override
public void onPause() {
    super.onPause();
    getPreferenceManager().getSharedPreferences().unregisterOnSharedPreferenceChangeListener(this);
}

Sử dụng kho dữ liệu tuỳ chỉnh

Mặc dù bạn nên lưu trữ các đối tượng Preference bằng SharedPreferences, nhưng bạn cũng có thể sử dụng kho dữ liệu tuỳ chỉnh. Kho dữ liệu tuỳ chỉnh có thể hữu ích nếu ứng dụng của bạn duy trì các giá trị cho một cơ sở dữ liệu hoặc nếu các giá trị là dành riêng cho thiết bị, như minh hoạ trong các ví dụ sau.

Triển khai kho dữ liệu

Để triển khai kho dữ liệu tuỳ chỉnh, hãy tạo một lớp mở rộng PreferenceDataStore. Ví dụ sau đây sẽ tạo một kho dữ liệu xử lý các giá trị String:

Kotlin

class DataStore : PreferenceDataStore() {
    override fun putString(key: String, value: String?) {
        // Save the value somewhere.
    }

    override fun getString(key: String, defValue: String?): String? {
        // Retrieve the value.
    }
}

Java

public class DataStore extends PreferenceDataStore {
    @Override
    public void putString(String key, @Nullable String value) {
        // Save the value somewhere.
    }
    @Override
    @Nullable
    public String getString(String key, @Nullable String defValue) {
        // Retrieve the value.
    }
}

Lưu ý: Chỉ ghi đè các phương thức mà đối tượng Preference sử dụng. Gọi một phương thức mà bạn không triển khai sẽ dẫn đến UnsupportedOperationException.

Chạy mọi thao tác tốn thời gian ngoài luồng chính để tránh chặn giao diện người dùng. Vì Fragment hoặc Activity chứa kho dữ liệu có thể bị huỷ trong khi giữ lại giá trị, hãy chuyển đổi tuần tự dữ liệu để bạn không bị mất bất kỳ giá trị nào do người dùng thay đổi.

Bật kho dữ liệu

Sau khi triển khai kho dữ liệu, hãy thiết lập kho dữ liệu mới trong onCreatePreferences() để các đối tượng Preference lưu giữ giá trị với kho dữ liệu thay vì sử dụng SharedPreferences mặc định. Bạn có thể bật một kho dữ liệu cho mỗi Preference hoặc cho toàn bộ hệ phân cấp.

Để bật kho dữ liệu tuỳ chỉnh cho một Preference cụ thể, hãy gọi setPreferenceDataStore() trên Preference, như trong ví dụ sau:

Kotlin

val preference: Preference? = findPreference("key")
preference?.preferenceDataStore = dataStore

Java

Preference preference = findPreference("key");
if (preference != null) {
    preference.setPreferenceDataStore(dataStore);
}

Để bật kho dữ liệu tuỳ chỉnh cho toàn bộ hệ phân cấp, hãy gọi setPreferenceDataStore() trên PreferenceManager:

Kotlin

val preferenceManager = preferenceManager
preferenceManager.preferenceDataStore = dataStore

Java

PreferenceManager preferenceManager = getPreferenceManager();
preferenceManager.setPreferenceDataStore(dataStore);

Một kho dữ liệu được đặt cho một Preference cụ thể sẽ ghi đè mọi kho dữ liệu được đặt cho hệ phân cấp tương ứng. Trong hầu hết các trường hợp, bạn sẽ thiết lập kho dữ liệu cho toàn bộ hệ phân cấp.

Lưu ý: Nếu bạn thiết lập kho dữ liệu cho Preference sau khi Preference được đính kèm vào hệ phân cấp, thì giá trị ban đầu của Preference sẽ không được truyền lại.