NSMutableArrayに格納した独自クラスごと、シリアライズしたい

Question

独自クラスを作成して、それをNSMutableArrayに格納しているのですが、このNSMutableArray型の変数をシリアライズして、UserDefaultsに保存したいです。(Swift3でコーディングしています)

独自クラスは以下の様に定義しました。

class DisplayNutritionData :NSObject, NSCoding{
    
    // 栄養素名
    var name :String = ""
    
    // 表示するかどうか
    var display :Bool = true
    
    //  表示内容
    var value :String = ""
    
    init(name :String){
        self.name = name
    }
    
    func encode(with aCoder: NSCoder) {
        aCoder.encode(name, forKey: "name")
        aCoder.encode(display, forKey: "display")
        aCoder.encode(value, forKey: "value")
    }
    
    required init?(coder aDecoder: NSCoder) {
        name = aDecoder.decodeObject(forKey: "name") as! String
        display = aDecoder.decodeBool(forKey: "display")
        value = aDecoder.decodeObject(forKey: "value") as! String
    }
}

保存処理は次の様に書きました。

// itemsがNSMutableArray型の変数で、DisplayNutritionDataのインスタンスをいくつか追加してあります。
let userDefault = UserDefaults.standard
        let data :Data = NSKeyedArchiver.archivedData(withRootObject: items) as Data
        userDefault.set(data, forKey: "displayNutrition")
        userDefault.synchronize()

このコードだと、NSKeyedArchiver.archivedDataを呼んだ時点で落ちてしまいます。

Terminating app due to uncaught exception 'NSInvalidArgumentException', reason: '-[_SwiftValue encodeWithCoder:]: unrecognized selector sent to instance 0x600000052840'

Arrayに格納してある独自クラスにNSCodingのプロトコルを実装しておけばそれが呼ばれるのだと思ったのですがうまくいきませんでした。

Swift3でコーディングしているのですが、まだネットを探してもあまり情報がなく、困っています。
※Swift３というよりももっと根本的な問題かも知れませんが。。。

以上、よろしくお願い致します。

Comments

[退会済みユーザー]

このコードで問題なく`UserDefaults`に保存、復元できましたよ。まっさらなプロジェクトで確かめてみたらどうですか？

[bizkit.kit]

実際に試していただけたのですね。ありがとうございます。新しいプロジェクトで試してみましたが、結果は同じでした。。。

Answer 1

func encode 内にブレークポイントは設定してみましたでしょうか。
何をエンコードしようとした時に落ちるのかが分かれば手がかりになるかもしれません。

Objective-Cだと items に格納されているモノが想定と違っていた・・・なんてことがすごくありがちですが
Swiftでもあり得なくはないですね。あと、SwiftだとOptional値が紛れ込んだりするとおかしくなることがありますね。

Comments

[bizkit.kit]

デバッグログにインスタンスのアドレスの様なものは表示されているのですが、実際にどのインスタンスをエンコードしようとして例外が発生しているのかがわかりませんでした。確かにその方法なら何かわかりそうですね。

itemsに入っているものが違うというのは、ジェネリクスとかそんな(すいません、Javaだとジェネリクスというのですが、Swiftでなんというのかわかりません)話でしょうか。

アドバイスありがとうございました。

[YokemuraTakeshi]

配列の型が [Any] とか [AnyObject] だと、何でも入れられちゃうので必ずしも DisplayNutritionData のインスタンスが入っているかどうかわからない、ということですね。

Swiftで怪しいのは、Optional型が入っている可能性ですね。
Optional型はNSKeyedArchiverでシリアライズできない仕様なんですよ。
つまり、DisplayNutritionData でなく、DisplayNutritionData? (=Optional<DisplayNutritionData>)が入ってるとシリアライズできないです。

NSKeyedArchiver.archivedData の前にブレークポイントを置いて、デバッガコマンドで po items とやると、何が出てきますかね。
もし、Optional<...> みたいなモノが配列の中に入ってるような雰囲気でしたらそれが怪しいです。

[bizkit.kit]

ありがとうございます。

(lldb) po items
▿ Optional<NSMutableArray>
▿ some : 47 elements
▿ 0 : <SerializeTest.DisplayNutritionData: 0x600000094730>
▿ 1 : <SerializeTest.DisplayNutritionData: 0x600000094000>
▿ 2 : <SerializeTest.DisplayNutritionData: 0x6000000945a0>
(つづく)

こんな感じでした。自作クラスが問題なのか、そもそもシリアライズ処理の書き方が問題なのか、、、その辺切り分けないと本質はわからなさそうですね。まだ全然初心者(始めて一ヶ月くらい)なので、勉強しないといけないですね。

[YokemuraTakeshi]

解決なさったようですが、そもそも items 自体が Optinal でラップされてるので、これ自身がエンコードできてなかったかもですね。if-let 文で囲ってアンラップしてからエンコード、で良かったかもしれません。

Answer 2

以下のようにすると配列の形で保存できます。
※ Swift3

class DisplayNutritionData :NSObject, NSCoding {
    
    // 栄養素名
    var name :String = ""
    
    // 表示するかどうか
    var display :Bool = true
    
    //  表示内容
    var value :String = ""
    
    init(name :String, display: Bool = true, value: String = "") {
        self.name = name
        self.display = display
        self.value = value
    }
    
    func encode(with aCoder: NSCoder) {
        aCoder.encode(name, forKey: "name")
        aCoder.encode(display, forKey: "display")
        aCoder.encode(value, forKey: "value")
    }
    
    required init?(coder aDecoder: NSCoder) {
        name = aDecoder.decodeObject(forKey: "name") as! String
        display = aDecoder.decodeBool(forKey: "display")
        value = aDecoder.decodeObject(forKey: "value") as! String
    }
}


extension UserDefaults {
    var nutritionDataArray: [DisplayNutritionData] {
        get{
            let rowData: NSData = self.object(forKey: "nutritionData") as? NSData ?? NSData()
            let datas = NSKeyedUnarchiver.unarchiveObject(with: rowData as Data) as? [DisplayNutritionData] ?? []
            return datas
        }
        set(newDatas) {
            let archive = NSKeyedArchiver.archivedData(withRootObject: newDatas)
            self.set(archive, forKey: "nutritionData")
        }
    }
}


// 使い方

let userDefault = UserDefaults.standard
let nutritionData = DisplayNutritionData(name: "test", display: false, value: "value1")
userDefault.nutritionDataArray = [nutritionData]
userDefault.synchronize()


let nutritionData1 = userDefault.nutritionDataArray
print(nutritionData1[0].name, nutritionData1[0].display, nutritionData1[0].value)
//=> test false value1

Comments

[bizkit.kit]

ありがとうございます。教えていただいた方法で実装できました。

ただ、イマイチ何をやっているのかよくわかっていません(コピペしたので(^_^;)
extensionを使ってUserDefaultsを拡張している・・・ということくらいはわかるのですが。。。

実際、配列に格納されている独自クラスをシリアライズすることは割とよくありそうなのですが、その場合は普通はどういう風にするものなのでしょうか？
＃ご教示いただいた内容は結構テクニカルな感じの印象を受けました。

お手すきでしたら、少しその辺を教えていただけると幸いです。

[_Kentarou]

> 配列に格納されている独自クラスをシリアライズすることは割とよくありそうなのですが、その場合は普通はどういう風にするものなのでしょうか

データ量が多くなければ簡単に扱えてよいと思いますが、一般的にはDatabaseを使うと思います。
UserDefaultsは全て読みだして、全て書き込むので一部更新や検索して取得などができませんので自分はあまり使用しませんね。

[bizkit.kit]

なるほど。

実は扱っているデータが幾つかあって、量が多くて検索が必要なモノはRealmを使ってみています。

中途半端な量(50項目くらい)のものはUserDefaultsでもいいかな、と思って試していた次第です。

回答ありがとうございました！助かりました！