【Swift】UserDefaultsに、自分で定義した構造体の配列の値を格納し、取得したい

Question

【やりたいこと】複数画面に渡って共通の配列の値を参照・更新をかけることができるように、UserDefaultsへ、配列の値を格納し、取得するコードを組みたいです。また、配列は自分で定義した構造体の型で定義しています。

下記の方法で実現を試してみましたが、（３）がうまく行きません。（下記詳細）

【処理概要】
（１）構造体：foodの定義

（２）food型の配列に値を入れ、UserDefaultsへ格納する

（３）UserDefaultsから、(2)で登録した値を取得する

※本来、こういったリストのデータを格納するには、UserDefaultsよりもCoreDataを使う方が良いという理解をしていますが、今回は練習でUserDefaultsを使っています。

【コード】
（１）構造体foodの定義

struct food :Codable{
    var nameJP : String
    var buyDate : String
    var volume : Int
    var imageName : String
}

（２）food型の配列に値を入れ、UserDefaultsへ格納する

import UIKit

class Cabin:UIViewController, UITableViewDelegate, UITableViewDataSource{
    
    //UseDefaultsに入れたい配列
    var InputFoodlist:[food]=[
        food(nameJP: "牛乳", buyDate:"20200101", volume: 1, imageName: "milk"),
        food(nameJP: "卵", buyDate: "20200106", volume: 5, imageName: "egg"),
        food(nameJP: "豚肉", buyDate: "20210301", volume: 2, imageName: "meat(pig)")
    ]
    //UserDefaultsから取得した値を格納するFoodList
    var Foodlist:[food] = []

    let userDefaults = UserDefaults.standard

    override func viewDidLoad() {

        super.viewDidLoad()
        //UserDefaultに、値を入れる
        Inputlist()
        //UserDefaultから値を取得数
        getFoodlist()
     }

　　//UserDefaultsへ値を格納するメソッド
    func Inputlist(){
        let encoder = JSONEncoder()
        if let encodedValue = try? encoder.encode(InputFoodlist){
            UserDefaults.standard.set(encodedValue, forKey: "default")
        }
    }

（３）UserDefaultsから、(2)で登録した値を取得する

    func getFoodlist(){
        /// 読み込み
        if let savedValue = UserDefaults.standard.data(forKey: "default") {
            let decoder = JSONDecoder()
            if let value = try? decoder.decode(food.self, from: savedValue) {
                //ぶち込んだFoodlistの値が取れて欲しい
                print("UserDefaultsを取得")
                print(value)
            }
            else {
                print("値取れてない")
            }
        }
    }

発生している問題・エラーメッセージ

上記処理を実行するとgetFoodlistメソッドのelseの方の処理が実行され、、"値取れていない"と出力される（＝正しくUserDefaultsから値が取れていない）状態となってしまします。

初心者なりの見当違いかもしれないのですが、恐らくUserDefaultsからdecodeして取得する値と、
それを受け取る箱の型が一致していないことが原因なのかと考えているのですが、
仮にそうであった場合、どのように修正したら良いかがネットの記事等を見てもわからなかったです。

原因と、対処案をご教示いただけますと大変助かります。
また、【やりたいこと】に対して、より良い実現方法等あればオプションとして教えていただけると大変大変助かります。
よろしくお願いします。

Answer 1

恐らくUserDefaultsからdecodeして取得する値と、
それを受け取る箱の型が一致していないことが原因なのかと考えているのですが、

encoder.encode(InputFoodlist) の引数 InputFoodlist の型は food の配列 (つまり [food]) なのに対して、decoder.decode(food.self, from: savedValue) で変換する型は food.self つまり配列ではない単なる food 型を指定しているためですね。これを [food].self に変更すれば取得できると思います。

また、【やりたいこと】に対して、より良い実現方法等あればオプションとして教えていただけると大変大変助かります。

勉強中ということでとりあえず UserDefaults で構わないと思いますが、いずれは Core Data なども使えるようになると良いと思います。Core Data 以外の選択肢は、自分でファイルや SQLite に保存する、Core Data の代わりに Realm を使う、Firebase などのクラウドストレージを利用する、などの方法があります。

また、余計なお世話かとは思いますが、型や変数やメソッドの名前の付け方が気になりました。Swift の命名規則では、型やクラスの名前は大文字、変数やメソッドの名前は原則として小文字で始めることになっていますので、次のように修正することをお勧めします。

• struct food → struct Food
• var InputFoodlist → var inputFoodlist
• var Foodlist → var foodlist
• func Inputlist → func inputlist

また、Cabin というクラス名も CabinViewController とするのが一般的かと思います。(Cabin という名前は純粋なデータ型のために取っておきたいので。)

参考: 【Swift】命名規則や書き方など まとめ | Swift Note
参考: Swiftの命名規則を理解する（Swift API Design Guidelines - Naming 日本語まとめ） - Qiita

Comments

[sta_sato]

ありがとうございます。ご指摘の通り、変換先の型を変更したら無事実装できました。
データを入れた時の型と、取り出して値を入れる型が合っていないので、取得できていなかったのだと理解しました。

Core Dataや、外部DBを使った値の受け渡しについても、チャレンジしていきたいと思っています。

また、変数名についても、アドバイスありがとうございます。命名規則はなんとなくでしか分かっていなかったですので、参考のリンクは大変助かります。

ありがとうございました。