Android SharedPreferences Best Practices

Question

In an application I have been building we rely on SharedPreferences quite a bit, this got me thinking about what is best practice when it comes to accessing SharedPreference

Answer 1

If you have a large application that is relying on SharedPreferences you could have key duplication, especially in the case of using some third party library that relies on SharedPreferences as well.

Libraries should not use that particular SharedPreferences. The default SharedPreferences should only be used by the application.

This way if you have a class that heavily relies on SharedPreferences you can create a preference file that is used only by your class.

You are certainly welcome to do this. I wouldn't, at the application level, as the primary reason for SharedPreferences is to have them be shared among the components in the application. A development team should have no problem managing this namespace, just as they should have no problem managing names of classes, packages, resources, or other project-level stuff. Moreover, the default SharedPreferences are what your PreferenceActivity will use.

However, going back to your libraries point, reusable libraries should use a separate SharedPreferences for their library only. I would not base it on a class name, because then you are one refactoring away from breaking your app. Instead, pick a name that is unique (e.g., based on the library name, such as "com.commonsware.cwac.wakeful.WakefulIntentService") but stable.

it seems that accesses SharedPreferences should be done off the UI thread which makes sense.

Ideally, yes. I recently released a SharedPreferencesLoader that helps with this.

Are there any other best practices Android developers should be aware of when using SharedPreferences in their applications?

Don't over-rely upon them. They are stored in XML files and are not transactional. A database should be your primary data store, particularly for data you really don't want to lose.