SharedPreferences を使ったデータアクセス部分を Kotlin のカスタムアクセサ で実装する

ユーザーの血液型を保存したいとします。

SharedPreferences に保存するとして、保存・読み出しでキーを間違えたり、対象の SharedPreferences を間違えたりしないためには、SharedPreferences への保存と読み出しを行うためのクラスを用意するとよいです。

例えば次のような Utils クラスを用意したとしましょう。

view plainprint?

1. public class ProfileSettingUtils {  
2.   
3.     private static final String PREF_KEY_BLOOD_TYPE = "blood_type";  
4.   
5.     private static SharedPreferences getPref(@NonNull Context context) {  
6.         return PreferenceManager.getDefaultSharedPreferences(context.getApplicationContext());  
7.     }  
8.   
9.     @Nullable  
10.     public static String getBloodType(@NonNull Context context) {  
11.         return getPref(context).getString(PREF_KEY_BLOOD_TYPE, null);  
12.     }  
13.   
14.     public static void setBloodType(@NonNull Context context, @Nullable String bloodType) {  
15.         getPref(context)  
16.             .edit()  
17.             .putString(PREF_KEY_BLOOD_TYPE, bloodType)  
18.             .apply();  
19.     }  
20. }  

public class ProfileSettingUtils { private static final String PREF_KEY_BLOOD_TYPE = "blood_type"; private static SharedPreferences getPref(@NonNull Context context) { return PreferenceManager.getDefaultSharedPreferences(context.getApplicationContext()); } @Nullable public static String getBloodType(@NonNull Context context) { return getPref(context).getString(PREF_KEY_BLOOD_TYPE, null); } public static void setBloodType(@NonNull Context context, @Nullable String bloodType) { getPref(context) .edit() .putString(PREF_KEY_BLOOD_TYPE, bloodType) .apply(); } } この Utils クラスで保存・読み出しを行えば、キーを間違えたり対象の SharedPreferences を間違えたりはしません。
しかし、"a" がA型を意味するなど、利用側が返される文字列の意味を知っている必要がありますし、"-" など意図しない文字列も保存できてしまいます。

血液型のような取り得る値が決まっているものは enum で定義して、保存・読み出し部分も enum でやりとりするべきです。

view plainprint?

1. public enum BloodType {  
2.     A("a"),  
3.     B("b"),  
4.     O("o"),  
5.     AB("ab");  
6.   
7.     @NonNull  
8.     public final String value;  
9.   
10.     BloodType(@NonNull String value) {  
11.         this.value = value;  
12.     }  
13.   
14.     @Nullable  
15.     public static BloodType from(@Nullable String value) {  
16.         if (value != null) {  
17.             for (BloodType bloodType : values()) {  
18.                 if (bloodType.value.equals(value)) {  
19.                     return bloodType;  
20.                 }  
21.             }  
22.         }  
23.         return null;  
24.     }  
25. }  

public enum BloodType { A("a"), B("b"), O("o"), AB("ab"); @NonNull public final String value; BloodType(@NonNull String value) { this.value = value; } @Nullable public static BloodType from(@Nullable String value) { if (value != null) { for (BloodType bloodType : values()) { if (bloodType.value.equals(value)) { return bloodType; } } } return null; } }

view plainprint?

1. public class ProfileSettingUtils {  
2.   
3.     private static final String PREF_KEY_BLOOD_TYPE = "blood_type";  
4.   
5.     private static SharedPreferences getPref(@NonNull Context context) {  
6.         return PreferenceManager.getDefaultSharedPreferences(context.getApplicationContext());  
7.     }  
8.   
9.     @Nullable  
10.     public static BloodType getBloodType(@NonNull Context context) {  
11.         return BloodType.from(getPref(context).getString(PREF_KEY_BLOOD_TYPE, null));  
12.     }  
13.   
14.     public static void setBloodType(@NonNull Context context, @Nullable BloodType bloodType) {  
15.         getPref(context)  
16.             .edit()  
17.             .putString(PREF_KEY_BLOOD_TYPE, bloodType != null ? bloodType.value : null)  
18.             .apply();  
19.     }  
20. }  

public class ProfileSettingUtils { private static final String PREF_KEY_BLOOD_TYPE = "blood_type"; private static SharedPreferences getPref(@NonNull Context context) { return PreferenceManager.getDefaultSharedPreferences(context.getApplicationContext()); } @Nullable public static BloodType getBloodType(@NonNull Context context) { return BloodType.from(getPref(context).getString(PREF_KEY_BLOOD_TYPE, null)); } public static void setBloodType(@NonNull Context context, @Nullable BloodType bloodType) { getPref(context) .edit() .putString(PREF_KEY_BLOOD_TYPE, bloodType != null ? bloodType.value : null) .apply(); } } Robolectric を使えばテスト時に SharedPreferences の動きをモック化できますが、テストのセットアップとして SharedPreferences に値をセットするよりは、BloodType を返す部分をモック化できたほうが柔軟性があります。

では Utils クラスをやめてみましょう。

view plainprint?

1. public class ProfileSetting {  
2.   
3.     private static final String PREF_KEY_BLOOD_TYPE = "blood_type";  
4.   
5.     @NonNull  
6.     private final SharedPreferences pref;  
7.   
8.     public ProfileSetting(@NonNull Context context) {  
9.         pref = PreferenceManager.getDefaultSharedPreferences(context.getApplicationContext());  
10.     }  
11.   
12.     @Nullable  
13.     public BloodType getBloodType() {  
14.         return BloodType.from(pref.getString(PREF_KEY_BLOOD_TYPE, null));  
15.     }  
16.   
17.     public void setBloodType(@Nullable BloodType bloodType) {  
18.         pref  
19.             .edit()  
20.             .putString(PREF_KEY_BLOOD_TYPE, bloodType != null ? bloodType.value : null)  
21.             .apply();  
22.     }  
23. }  

public class ProfileSetting { private static final String PREF_KEY_BLOOD_TYPE = "blood_type"; @NonNull private final SharedPreferences pref; public ProfileSetting(@NonNull Context context) { pref = PreferenceManager.getDefaultSharedPreferences(context.getApplicationContext()); } @Nullable public BloodType getBloodType() { return BloodType.from(pref.getString(PREF_KEY_BLOOD_TYPE, null)); } public void setBloodType(@Nullable BloodType bloodType) { pref .edit() .putString(PREF_KEY_BLOOD_TYPE, bloodType != null ? bloodType.value : null) .apply(); } } このクラスを使って、読み出した BloodType を判断・加工するロジック部分があるとします。
このままだとロジック部分がデータアクセス部分に依存しています。
そこで、依存関係逆転の原則（DIP）を適用してロジックが抽象に依存できるように interface を用意します。

view plainprint?

1. public interface Profile {  
2.   
3.     @Nullable  
4.     BloodType getBloodType();  
5.   
6.     void setBloodType(@Nullable BloodType bloodType);  
7. }  

public interface Profile { @Nullable BloodType getBloodType(); void setBloodType(@Nullable BloodType bloodType); }

view plainprint?

1. public class ProfileSetting implements Profile {  
2.   
3.     private static final String PREF_KEY_BLOOD_TYPE = "blood_type";  
4.   
5.     @NonNull  
6.     private final SharedPreferences pref;  
7.   
8.     public ProfileSetting(@NonNull Context context) {  
9.         pref = PreferenceManager.getDefaultSharedPreferences(context.getApplicationContext());  
10.     }  
11.   
12.     @Override  
13.     @Nullable  
14.     public BloodType getBloodType() {  
15.         return BloodType.from(pref.getString(PREF_KEY_BLOOD_TYPE, null));  
16.     }  
17.   
18.     @Override  
19.     public void setBloodType(@Nullable BloodType bloodType) {  
20.         pref  
21.             .edit()  
22.             .putString(PREF_KEY_BLOOD_TYPE, bloodType != null ? bloodType.value : null)  
23.             .apply();  
24.     }  
25. }  

public class ProfileSetting implements Profile { private static final String PREF_KEY_BLOOD_TYPE = "blood_type"; @NonNull private final SharedPreferences pref; public ProfileSetting(@NonNull Context context) { pref = PreferenceManager.getDefaultSharedPreferences(context.getApplicationContext()); } @Override @Nullable public BloodType getBloodType() { return BloodType.from(pref.getString(PREF_KEY_BLOOD_TYPE, null)); } @Override public void setBloodType(@Nullable BloodType bloodType) { pref .edit() .putString(PREF_KEY_BLOOD_TYPE, bloodType != null ? bloodType.value : null) .apply(); } } ロジック部分は ProfileSetting ではなく interface の Profile を外部から渡してもらうようにします。

さて、これを Kotlin 化してみましょう。

view plainprint?

1. enum class BloodType(val value: String) {  
2.     A("a"),  
3.     B("b"),  
4.     O("o"),  
5.     AB("ab");  
6.   
7.     companion object {  
8.         fun from(value: String?): BloodType? =  
9.                 value?.let { values().firstOrNull { it.value == value } }  
10.     }  
11. }  

enum class BloodType(val value: String) { A("a"), B("b"), O("o"), AB("ab"); companion object { fun from(value: String?): BloodType? = value?.let { values().firstOrNull { it.value == value } } } }

view plainprint?

1. interface Profile {  
2.     var bloodType: BloodType?  
3. }  

interface Profile { var bloodType: BloodType? }

view plainprint?

1. class ProfileSetting(context: Context) : Profile {  
2.   
3.     companion object {  
4.         private const val PREF_KEY_BLOOD_TYPE = "blood_type"  
5.     }  
6.   
7.     private val pref: SharedPreferences =   
8.         PreferenceManager.getDefaultSharedPreferences(context.applicationContext)  
9.   
10.     override var bloodType: BloodType?  
11.         get() = BloodType.from(pref.getString(PREF_KEY_BLOOD_TYPE, null))  
12.         set(bloodType) = pref.edit().putString(PREF_KEY_BLOOD_TYPE, bloodType?.value).apply()  
13. }  

class ProfileSetting(context: Context) : Profile { companion object { private const val PREF_KEY_BLOOD_TYPE = "blood_type" } private val pref: SharedPreferences = PreferenceManager.getDefaultSharedPreferences(context.applicationContext) override var bloodType: BloodType? get() = BloodType.from(pref.getString(PREF_KEY_BLOOD_TYPE, null)) set(bloodType) = pref.edit().putString(PREF_KEY_BLOOD_TYPE, bloodType?.value).apply() } Kotlin ではプロパティの定義にカスタムアクセサを書けるので、同じキーに対する保存と読み込みを一箇所に書けて対応がわかりやすくなりますね。