【SwiftUI, Swift】UserDefaultsで独自に定義した型の配列が保存できません。

Question

##【SwiftUI, Swift】UserDefaultsで独自に定義した型の配列が保存できません。

###SceneDelegate.swift

import UIKit
import SwiftUI
class SceneDelegate: UIResponder, UIWindowSceneDelegate {

    var window: UIWindow?


    func scene(_ scene: UIScene, willConnectTo session: UISceneSession, options connectionOptions: UIScene.ConnectionOptions) {
        let context = (UIApplication.shared.delegate as! AppDelegate).persistentContainer.viewContext

       
        
        let contentView = ContentView()
            .environment(.managedObjectContext, context)
            .environmentObject(GlobalData())

        
        if let windowScene = scene as? UIWindowScene {
            let window = UIWindow(windowScene: windowScene)
            window.rootViewController = UIHostingController(rootView: contentView)
            self.window = window
            window.makeKeyAndVisible()
        }
    }

    func sceneDidDisconnect(_ scene: UIScene) {
    }

    func sceneDidBecomeActive(_ scene: UIScene) {
    }

    func sceneWillResignActive(_ scene: UIScene) {
    }

    func sceneWillEnterForeground(_ scene: UIScene) {
    }

    func sceneDidEnterBackground(_ scene: UIScene) {
        (UIApplication.shared.delegate as? AppDelegate)?.saveContext()
    }


}

###ContentView.swift

struct ContentView: View {
    @EnvironmentObject var globalData: GlobalData
    var body: some View {
        Button(action: {
            self.globalData.data.append(hogeStruct(text: "テキスト", weather: .sunny))
            self.globalData.saveData()
        }) {
            Text("Add Data")
        }
    }
}

class GlobalData: ObservableObject {
    @Published var data: [hogeStruct] = []
    
    func saveData() {
        let u = UserDefaults.standard
        u.set(self.data, forKey: "data")//ここでエラーが出る。
    }
}

struct hogeStruct {
    var id = UUID()
    var text: String
    var weather: Weather
    
    enum Weather: CaseIterable {
        case sunny
        case cloudy
    }
}

↑問題の再現に必要なコードです。

###エラーが出る箇所

let u = UserDefaults.standard
u.set(self.data, forKey: "data")//ここ！

独自にhogeStruct型を宣言し、その配列をUserDefaultsに保存しようとしてエラーが出ます。
hogeStruct型の配列をスマホ内に保存する方法は他にありますか？

###試したこと
Core Dataを使う
しかし独自の型は保存できない仕様のようです。(HashValueが関係している???)

hogeStruct型をHashableに準拠させるのでしょうか。

ご教授よろしくお願いいたします。

Answer 1

一番簡単なのは保存したいstruct/enumをCodableにしてしまう方法です

struct hogeStruct: Codable {
    var id = UUID()
    var text: String
    var weather: Weather
    
    // 用途がよくわからないのでとりあえずStringで
    enum Weather: String, CaseIterable, Codable {
        case sunny
        case cloudy
    }
}

これでさらにUserDefaultsを以下のように拡張すれば簡単に利用できるようになります。

extension UserDefaults {
  func setEncoded<T: Encodable>(_ value: T, forKey key: String) {
    guard let data = try? JSONEncoder().encode(value) else {
       print("Can not Encode to JSON.")
       return
    }
    
    set(data, forKey: key)
  }
  
  func decodedObject<T: Decodable>(_ type: T.Type, forKey key: String) -> T? {
    guard let data = data(forKey: key) else {
      return nil
    }
    
    return try? JSONDecoder().decode(type, from: data)
  }
}

---

追記

このUserDefaultsの使い方は

保存

let values: [hogeStruct] = ... //ここに保存対象が入っているとします

UserDefaults.standard.setEncoded(values, forKey: "KEY")

取り出し

// Optional<[hogeStruct]>型になります。
let optionalValues = UserDefaults.standard.decodedObject([hogeStruct].self, forKey: "KEY")

// nilなら空の配列とする時
let values = UserDefaults.standard.decodedObject([hogeStruct].self, forKey: "KEY") ?? []

最初の引数に取り出す値の型に.selfを付けたものを与えます。
これによってキャストなしに目的の型（のOptional型）で取得できます。

Comments

[taichi_dm_]

回答ありがとうございます！
使う時はUserdefaults.standard.set(data, forKey: "data")ですか？
このまま使ったらエラーになりました。

[MasakiHori]

エラーの内容が分からないと何もわかりません
上のCodableにしたhogeStructを利用していますか？

[taichi_dm_]

申し訳ありません。hogeStructを使用しています。
UserDefaults.standard.setを使用した際、
Thread 1: Exception: "Attempt to insert non-property list object (\n \"Experience_Project.hogeStruct(id: F196BC40-530C-46E0-9764-7A1A98293DEA, text: \\"\U30c6\U30b9\U30c8\\", weather: Experience_Project.hogeStruct.Weather.sunny)\"\n) for key array"
こんなエラーが出ました。
そこで、先ほどextension内で定義されていたUserDefaults.standard.setEncodedを使ったらUserDefaultsに書き込むことはおそらく成功しました。

しかし、読み取りはどうすれば良いでしょうか。
self.globalData = UserDefaults.standard.array(forKey: "array") as! [hogeStruct]
これを実行したら、Thread 1: Fatal error: Unexpectedly found nil while unwrapping an Optional valueというエラーが出ました。

[MasakiHori]

すみません。使い方難しいですね。説明追加します。

[taichi_dm_]

ありがとうございます
無事、期待通りの動作が確認できました
丁寧に使い方まで説明していただきありがとうございます！

Answer 2

UserDefaultではカスタムクラス（というか、プロパティリスト以外のインスタンス）は保存できません。

https://developer.apple.com/documentation/foundation/userdefaults

A default object must be a property list—that is, an instance of (or for collections, a combination of instances of) NSData, NSString, NSNumber, NSDate, NSArray, or NSDictionary. If you want to store any other type of object, you should typically archive it to create an instance of NSData.

カスタムクラスの保存例は別の回答の後半にも書いていますので、こちらの方法でためしてもらえますでしょうか。

• [swift 5]textViewで変えた色を違う画面のlabelに反映させたい