[Swift] Header - Items形式のデータの読み書きを行う

-
ヘッダデータ[1]と明細データ[0...n]を１つのデータの塊として、
ファイルに保存したり、読み込んだりしたくて、試行錯誤しました。

DBにした方が楽なんじゃない？　とか思ったけど、DBにするほどデータも無かったので 、意地でもファイルで実現してやる！
ってことで、なんとか動きました。

扱うデータのイメージ



＜ヘッダデータ＞ [1]
　伝票番号　　　orderNo
　仕入先コード　vendorCode
　仕入先名　　　vendorName

＜明細データ＞ [0...1]
　明細番号　　　itemNo
　明細テキスト　itemText
　数量　　　　　quantity

ヘッダは必ず存在し、明細は0以上の可変を想定。

データ受け渡し用の構造


struct DataEntity {
    // Header
    var orderNo: Int!
    var vendorCode: String!
    var vendorName: String!

    // Items
    var items: [Item]!
    
    init(){
        orderNo = 0
        vendorCode = ""
        vendorName = ""
        items = []
    }
}

struct Item {
    var itemNo: Int!
    var itemText: String!
    var quantity: Int!
    
    init(){
        itemNo = 0;
        itemText = ""
        quantity = 0
    }
}


コード

データをファイルに保存する


    func writeData(dataEntity: DataEntity){
        
        var data:Dictionary = [String:AnyObject]()
        // Header
        data["orderNo"] = dataEntity.orderNo as AnyObject
        data["vendorCode"] = dataEntity.vendorCode as AnyObject
        data["vendorName"] = dataEntity.vendorName as AnyObject

        // Items
        var dataItem  :Dictionary = [String:Any]()
        var dataItems:Array = []
        for item in dataEntity.items {
            dataItem.removeAll()
            dataItem["itemNo"]   = item.itemNo
            dataItem["itemText"] = item.itemText
            dataItem["quantity"] = item.quantity
            dataItems.append(dataItem as AnyObject)
        }
        data["items"] = dataItems as AnyObject

        // ファイルへ書き込み
        let manager = FileManager.default
        let documentDir = manager.urls(for: .documentDirectory, in: .userDomainMask)[0]
        let url = documentDir.appendingPathComponent("Test.plist")
        let dic = NSDictionary(dictionary: data)
        dic.write(to: url, atomically: true)
        
    }

説明

Dictionary型を使うと便利そうだったでので、こちらを使ってます。
キーはStringで良いと思いますが、値は、String、Int、Item構造型など、様々な型があるので、AnyObjectとしました。
        var data:Dictionary = [String:AnyObject]()

ヘッダデータは、キーと値を単純にセットしてます。
        // Header
        data["orderNo"] = dataEntity.orderNo as AnyObject
        data["vendorCode"] = dataEntity.vendorCode as AnyObject
        data["vendorName"] = dataEntity.vendorName as AnyObject
明細については、明細データをDictionary型で格納し、Dictionary型をArray配列に格納てます。
これにより明細数を動的にしてます。
        // Items
        var dataItem  :Dictionary = [String:Any]()
        var dataItems:Array = []
        for item in dataEntity.items {
            dataItem.removeAll()
            dataItem["itemNo"]   = item.itemNo
            dataItem["itemText"] = item.itemText
            dataItem["quantity"] = item.quantity
            dataItems.append(dataItem as AnyObject)
        }


Array配列の明細データを作り上げてから、ヘッダデータを格納した　Dictionary型の変数に格納してます。

       data["items"] = dataItems as AnyObject

データは、アプリのDocuments内に、Test.plistで保存してます。


ファイルからデータを読み込む


    func readData() -> DataEntity {
        // ファイル読み込み
        let manager = FileManager.default
        let documentDir = manager.urls(for: .documentDirectory, in: .userDomainMask)[0]
        let url = documentDir.appendingPathComponent("Test.plist")
        let plist = NSMutableDictionary(contentsOf: url)
        
        var dataEntity = DataEntity()
        if plist == nil {
            return dataEntity
        }
        
        // Header
        if let _orderNo = plist?["orderNo"] as? Int {
           dataEntity.orderNo = _orderNo
        }
        if let _vendorCode = plist?["vendorCode"] as? String {
            dataEntity.vendorCode = _vendorCode
        }
        if let _vendorName = plist?["vendorName"] as? String {
            dataEntity.vendorName = _vendorName
        }
        
        // Items
        if let _items = plist?["items"] as? Array {
            let dataItems = _items
            for dataItem in dataItems {
                var item = Item()
                if let _itemNo = dataItem["itemNo"] as? Int {
                    item.itemNo = _itemNo
                }
                if let _itemText = dataItem["itemText"] as? String {
                    item.itemText = _itemText
                }
                if let _quantity = dataItem["quantity"] as? Int {
                    item.quantity = _quantity
                }
                dataEntity.items.append(item)
            }
        }
        
        return dataEntity

    }

説明

アプリ内のDocumentsフォルダ内のTest.plistファイルを読み込みます。

ヘッダデータは、キー指定で値を取り出してます。
nilの場合（キー値が存在しない場合）は、何もせず初期値のままとするため、nilの判定を入れてます。
        if let _orderNo = plist?["orderNo"] as? Int {
           dataEntity.orderNo = _orderNo
        }


明細データは、Array配列として一旦取り込んでから、１件毎に明細データの取り出しを行ってます。
配列は、0件の場合もあるため、nil判定を行ってます。 
if let _items = plist?["items"] as? Array {

forループで明細データを１件毎 取り出してます。 
for dataItem in dataItems {

サンプルコード（全体）


import UIKit

class ViewController: UIViewController {

    let txtView = UITextView()
    override func viewDidLoad() {
        super.viewDidLoad()
        // Do any additional setup after loading the view, typically from a nib.
        self.view.backgroundColor = UIColor.lightGray
        txtView.frame = self.view.frame
        view.addSubview(txtView)

        // -----------------------------
        var data = DataEntity()
        // Test Data
        data.orderNo = 100
        data.vendorCode = "VEN-123"
        data.vendorName = "Test Vendor Name"

        var item = Item()
        // item 1
        item.itemNo = 10
        item.itemText = "Item Text 1"
        item.quantity = 2
        data.items.append(item)
        // item 2
        item.itemNo = 20
        item.itemText = "Item Text 2"
        item.quantity = 7
        data.items.append(item)

        // Write to File
        writeData(dataEntity: data)
        
        // -----------------------------
        // Initialize
        data = DataEntity()
        // Read from File
        data = readData()
        
        txtView.text.append("Order = " + String(data.orderNo) + "\n")
        txtView.text.append("Vendor Code = " + data.vendorCode + "\n")
        txtView.text.append("Vendor Name = " + data.vendorName + "\n")
        
        for item in data.items {
            txtView.text.append("----------\n")
            txtView.text.append("ItemNo: " + String(item.itemNo) + "\n")
            txtView.text.append("Item Text: " + item.itemText + "\n")
            txtView.text.append("Quantity: " + String(item.quantity) + "\n")
        }

    }

    func writeData(dataEntity: DataEntity){
        
        var data:Dictionary = [String:AnyObject]()
        // Header
        data["orderNo"] = dataEntity.orderNo as AnyObject
        data["vendorCode"] = dataEntity.vendorCode as AnyObject
        data["vendorName"] = dataEntity.vendorName as AnyObject

        // Items
        var dataItem  :Dictionary = [String:Any]()
        var dataItems:Array = []
        for item in dataEntity.items {
            dataItem.removeAll()
            dataItem["itemNo"]   = item.itemNo
            dataItem["itemText"] = item.itemText
            dataItem["quantity"] = item.quantity
            dataItems.append(dataItem as AnyObject)
        }
        data["items"] = dataItems as AnyObject

        // ファイルへ書き込み
        let manager = FileManager.default
        let documentDir = manager.urls(for: .documentDirectory, in: .userDomainMask)[0]
        let url = documentDir.appendingPathComponent("Test.plist")
        let dic = NSDictionary(dictionary: data)
        dic.write(to: url, atomically: true)
        
    }
    
    func readData() -> DataEntity {
        // ファイル読み込み
        let manager = FileManager.default
        let documentDir = manager.urls(for: .documentDirectory, in: .userDomainMask)[0]
        let url = documentDir.appendingPathComponent("Test.plist")
        let plist = NSMutableDictionary(contentsOf: url)
        
        var dataEntity = DataEntity()
        if plist == nil {
            return dataEntity
        }
        
        // Header
        if let _orderNo = plist?["orderNo"] as? Int {
           dataEntity.orderNo = _orderNo
        }
        if let _vendorCode = plist?["vendorCode"] as? String {
            dataEntity.vendorCode = _vendorCode
        }
        if let _vendorName = plist?["vendorName"] as? String {
            dataEntity.vendorName = _vendorName
        }
        
        // Items
        if let _items = plist?["items"] as? Array {
            let dataItems = _items
            for dataItem in dataItems {
                var item = Item()
                if let _itemNo = dataItem["itemNo"] as? Int {
                    item.itemNo = _itemNo
                }
                if let _itemText = dataItem["itemText"] as? String {
                    item.itemText = _itemText
                }
                if let _quantity = dataItem["quantity"] as? Int {
                    item.quantity = _quantity
                }
                dataEntity.items.append(item)
            }
        }
        
        return dataEntity

    }
}

実行結果




説明

パラメータをセットしてファイル書き込み用の関数（writeData）を呼び出してます。
ファイルからの読み込み値を検証するために、一旦、変数を初期化してます。
その後、データ内容をファイルから読み込む関数（readData）を呼び出してます。
取り込んだデータは、UITextViewに出力してます。

最後に

エラーハンドリングなど甘いところはあると思いますが、
実装の参考になれば幸いです。

場所: 日本、大阪府大阪市

コメント

コメントを投稿

このブログの人気の投稿

[Music] DTM初心者のためのドラム打ち込み その2

-
イメージ
目的 ドラム譜を見て打ち込みをする人を対象に、楽譜の奏法と打ち込みについてわかるようになる 自分で曲を書いてる人や耳コピで打ち込みをする人にとっては参考にならないかもです 楽譜と奏法 アクセント アクセントはバンド譜でも出てくるのでわかる方も多いかと思います。 音符の上に付いてる「＞」とか「＾」ですね。 「＞」も「＾」も他の音よりも大きく叩くことになります。 クラッシュは、ライドと区別するためにアクセント付きがクラッシュを意味してることもあります。 「＾」は、バンド譜では出てこないかもしれませんが、吹奏楽やマーチングではよく出てきます。「＞」よりも強いアクセントになり、メリハリをつけるためにオープンリムショット（打面の真ん中とフープを同時に叩く奏法）にすることが多いです。 GM音源だと、残念ながらオープンリムショットに該当する音がありません。 DAWなどに付いてる標準のドラム音源だと、それっぽい音も含まれてますが、明確に使い分けたものはないかもしれないです。 私が使っているドラム音源（BFD3.0）だと、リムショットの音は用意されています。 フラム（装飾音符） 上の楽譜で、2小節目の4拍目にある小さな音符です。 これは、４拍目の音の前に小さな音を足すことを意味してます。 演奏には２つの解釈があり、曲調によって使い分けることになります。 (1) メインとなる音を拍の頭に置いて、装飾音符を拍の前に叩く (2) 装飾音符を拍の頭に置いて、メインとなる音を拍の後で叩く 多くの場合は、(1)のケースになりますが、重い感じを出したい場合は、(2)にすると雰囲気が出ます。 装飾音符の位置は、64分音符で配置するといい感じに聞こえます。 フラムの音については、音源で用意されていることもありますが、私は使ってません。 理由は、フラムの種類によっては対応できないためです。 例えば、こんなのです。 装飾が２つ、３つある場合、用意された音では表現できなかったりします。 打ち込みだと、これらは表現はできます。 ２つ、３つ続く場合、64分音符で並べると、粒が出でないので、32分音符の３連譜で音を並べてます。 ロール ロールには、オープ...
続きを読む

[Swift] StoryBoardを使用しない - UITextFieldで編集不可にする方法

-
イメージ
コーディングでUITextFieldの入力可否を制御する Swiftのバージョンにより実装方法が異なるようで、悩みました・・・。 UILabelを使えば、表示専用にはなりますが、状況によって編集/表示を切り替えたい場合には、UITextFieldの属性を切り替えられる方が便利。 StoryBoardだとControlにあるEnabledにチェックを入れると実現できるので、絶対に何かあるはず！ ってことで探しました。 環境 Xcode10 Swift 4.2 編集可否の制御方法 let txtAmount = UITextField() //　編集不可 txtAmount.isEnabled = false isEnabledをtrueにすると、編集可能となります。 感覚的に isXXXX のメソッドって、Get専用と思い込んで見逃してました。。。 スッキリ（笑
続きを読む

[Swift] UISliderをカスタマイズしてみる

-
イメージ
iOSの標準コントロールに、UISliderというのがありますが、現在の値を表示したいと思ったことはないでしょうか。 プロパティを探してもそれらしいものが見つけられなかったので、UISliderを継承してオブジェクトを作ってみました。 UISlider 今回作成するオブジェクト 環境 MacOSX 10.14 Xcode 10.1 Swift 4 Target iOS 9.0 実現する内容 スライダーの値を表示する スライダーの上に見出し（タイトル）を表示する 増加量（ステップ量）を指定できるようにする 実装 SUISlider UISliderを継承して、SUISliderを作成します。 ソースの全体像は下記の通りです。 import UIKit public class SUISlider : UISlider { var labelTitle: UILabel var valueWidth: CGFloat = 60 var stepValue : Float = 0 private var labelValue: UILabel private let SPACING: CGFloat = 8 public override init(frame: CGRect) { labelTitle = UILabel() labelValue = UILabel() labelValue.textAlignment = NSTextAlignment.right super.init(frame: frame) self.addSubview(labelTitle) self.addSubview(labelValue) self.addTarget(self, action: #selector(self.onValueChanged(sender: )), ...
続きを読む