2015年6月14日日曜日

ファイルの読み書きも間接参照で(本編+使用例編)

ファイルの読み書きを間接参照で作る話の続きです。前回は作成理由を書いたので、いよいよSwiftコードを紹介します。

 

その前に、ファイルを読み書きするライブラリの話を少しだけ。

今回のリンククラスを作る前に、ファイルの読み書きライブラリを更新しました。今まではクラスとして作っていたのですが、よく考えると、値を保持する必要はありません。ということは、UI部品の生成関数と同じく、グローバル関数で作ったほうが適しています。グローバル関数なら、インスタンス化が不要となり、何の準備もせずに使い始められますから。また、アプリの初期処理で、インスタンスを生成する順番を気にせずに済みます。

あとエラー処理に関する話も少しだけ。ファイルの読み書きでは、NSErrorを指定できるメソッドの場合、必ず指定しています。処理後にNSErrorがnilでなければ、内部的にエラーメッセージを出して、そのまま処理を終わらせます。読んだ結果を返すメソッドでは、nilが返ることになります。

このような形で作ってあるため、この読み書きライブラリを使う側は、基本的に内部向けのエラーメッセージを出しません。ユーザーに何かを伝える必要があるときだけ、画面上にメッセージを出します。

具体的なSwiftコードも1つだけ。アプリ内のリソースから、テキストファイルを読み込む関数です。

// アプリ内リソースから、テキストファイルを読み込む
func zFReadFileTextResF(rFName:String, rFNameSuf:String) -> String? {
    let iPathFile: String? = NSBundle.mainBundle().pathForResource(rFName, ofType:rFNameSuf)
    if iPathFile == nil { zSendErrMsgF("ERROR:BPF_RFR:パスの生成に失敗:ファイル名を確認"); return nil }
    var iErr: NSError? = nil
    var iNSStr: NSString? = NSString(contentsOfFile:iPathFile!, encoding:NSUTF8StringEncoding, error:&iErr)
    if iErr != nil { zSendErrMsgF("ERROR:BPF_RFR:NSError=\(iErr)") }
    return iNSStr as String?
}

見てのとおり、NSErrorに何かが入っていると、内部的なエラーメッセージを出します。NSErrorの内容もテキスト化して出力されるので、エラーの原因究明に役立つはずです。

この関数では、ファイルを含んだパスを生成する箇所でも、エラーチェックを入れています。これは普通のファイルでは不要ですが、アプリ内のリソースから読む場合には必須となります。もし存在しないファイル名を指定すると、パスの値がnilになり、続きの読み込み処理でクラッシュするからです。クラッシュを避け、原因を知らせるために入れています。

他の読み書き関数も、似たような作り方を採用しました。また、ディレクトリとファイル名を指定してパスを生成する処理などは、共通の関数として別に用意し、いくつもの読み書き関数で使っています。

このライブラリの関数を使ったとき、処理が成功したかどうかは、戻り値を見て判定します。読み込み関数では、読み込んだ結果がnilなら処理の失敗です。書き出し関数では、戻り値のBool値がfalseなら処理の失敗です。

 

ようやく本題に入ります。まずは、テキストを扱うリンククラスから。次のようなSwiftコードになりました。

// ============================== 文字列をファイルへ読み書き
class ZSLText2File {
    var cDir: ZFDir = .Docs              // 仮の値
    var cFileName: String = "dummy.txt"
    //初期化
    init(_ rDir:ZFDir, _ rFileName:String) {
        cDir = rDir
        cFileName = rFileName
    }
    // アプリ内のリソースから
    func loadDefaultF() -> String? {
        let iFileNameN: String = cFileName.stringByDeletingPathExtension
        let iFileNameS: String = cFileName.pathExtension
        let iStr: String? = zFReadFileTextResF(iFileNameN, iFileNameS)
        return iStr
    }
    // 指定されたディレクトリから読み込む
    func loadF() -> String? {
        let iStr: String? = zFReadFileTextF(cDir, cFileName)
        return iStr
    }
    // 指定されたディレクトリへ書き出す
    func saveF(rStrData:String) -> Bool {
        let iBool: Bool = zFWriteFileTextF(cDir, cFileName, rStrData)
        return iBool
    }
}

いつものように、要点だけ簡単に説明します。

初期化の処理で、ディレクトリとファイル名を指定します。これで保存先が決まりますから、このインスタンスを使う限り、保存先を意識する必要がなくなります。

メソッドは3つだけです。デフォルト値のファイルは、アプリ内のリソースに入れますから、そこから読むグローバル関数を呼び出します。残りの読み書きでは、初期化で設定したディレクトリとファイル名を指定します。

どのメソッドでも、ファイル読み書き関数の戻り値を、そのまま返しています。そのため、ファイル読み書き関数と同じ方法で、処理の失敗を呼び出し側で判定できます。

ディレクトリの指定は、好きな値を使えるわけではありません。ファイルの読み書きライブラリで用意した、列挙型の値を使っています。「.Docs」はDocumentsフォルダを意味しています。このクラスを初期化する際にも、同じ列挙型の値を使います。

 

続いて、NSDictionaryのデータを扱うリンククラスです。次のようなSwiftコードになりました。

// ============================== NSDictionaryをファイルへ読み書き
class ZSLDic2File {
    var cDir: ZFDir = .Docs                    // 仮の値
    var cFileName: String = "dummy.plist"
    //初期化
    init(_ rDir:ZFDir, _ rFileName:String) {
        cDir = rDir
        cFileName = rFileName
    }
    // アプリ内のリソースから
    func loadDefaultF() -> NSDictionary? {
        let iFileNameN: String = cFileName.stringByDeletingPathExtension
        let iFileNameS: String = cFileName.pathExtension
        let iNSDic: NSDictionary? = zFReadFileDicResF(iFileNameN, iFileNameS)
        return iNSDic
    }
    // 指定されたディレクトリから読み込む
    func loadF() -> NSDictionary? {
        let iNSDic: NSDictionary? = zFReadFileDicF(cDir, cFileName)
        return iNSDic
    }
    // 指定されたディレクトリへ書き出す
    func saveF(rNSDic:NSDictionary) -> Bool {
        let iBool: Bool = zFWriteFileDicF(cDir, cFileName, rNSDic)
        return iBool
    }
}

見てのとおり、文字列のリンククラスとほぼ同じです。扱っているデータがNSDictionaryに変わっている点と、ファイルを読み書きする関数がNSDictionary用に入れ替わっている点だけが違います。

つまり、もっとも異なるファイルへの読み書き部分が、ファイル関係のライブラリに入っているので、それを呼び出す側は関数名が違うだけになります。結果としてリンククラスは、保存場所やファイル名を保持し、間接参照を担当するだけになっています。まさに目的どおりの機能です。

 

本題とは関係ないですが、このソースコードを見て、return文の書き方に無駄が多いと感じた人もいるのではないかと思います。iNSDicやiBoolという途中の変数を使わず、return文に関数を直接書いたほうが、ソースコードが短くなると。

この途中の変数は、あえて入れています。関数の戻り値のデータ型を、ソースコード上で明示的に記述したいからです。データ型の種類だけでなく、Optional型の有無まで含めて、何のデータ型で返されるのかを示しています。そのため、関数から返されるデータ型で書くのが決まりです。

背景となる考え方としては、データ型を強く意識したプログラミングをしたいのと、忘れたころに見ても思い出しやすく作りたいからです。関数の戻り値のデータ型が何かは、使う前に調べてますから、書いている段階では覚えています。でも少しでも時間が経つと、簡単に忘れてしまいます。この例のように、関数を使う際に一時的な変数を用意して、関数の戻り値と同じデータ型にすると、戻り値のデータ型を明示する効果があります。必ずletの変数にして、戻り値と同じデータ型にするのが必須条件です。

戻り値のデータ型が明確に分かると、データ型を強く意識したプログラミングが容易になります。Optrional型かどうか、キャスト可能かどうか、自動変換してくれるかどうかなど、きちんと作るための基礎情報が揃うからです。

自分自身が数年後にソースコードを見たときも、データ型が分かることで、処理の細かな点まで理解しやすくなります。当然、私以外の人がメンテするときも、同様に理解しやすいでしょう。

この辺のことは、あくまで私の考え方ですから、他人に勧める気はありません。

 

話を本題に戻しましょう。残りのリンククラスは、NSArrayとバイナリー(NSData)です。これらも、紹介した2つのリンククラスと非常に似ていますから、掲載は省略します。

どのリンククラスも、非常に単純なクラスに仕上がっています。もともと間接参照を実現するためのクラスですから、当然ですね。

 

では続いて、使用例を紹介しましょう。とても簡単です。iOS実験専用アプリでテストしたコードから一部を抜き出し、組み合わせて貼り付けます。

// アプリの初期処理内でインスタンス生成
let zData2Storage = ZSLText2File(.Docs, "test_data.txt")
let zPref2Storage = ZSLDic2File(.Docs, "test_pref.plist")

// アプリの中心処理内で使う(読み込み)
var iStrData: String = ...
if let iStr: String = zData2Storage.loadF() {
    // 正常に読み込めたときの処理
    iStrData = iStr
} else {
    // 読み込みが失敗したときの処理
    setMsgF("エラー:保存データの読み込みに失敗しました。")
    ...
}

// アプリの中心処理内で使う(書き出し)
let iResult: Bool = zPref2Storage.saveF(iNSDic)
if iResult {
    // 正常に書き出せたときの処理
    ...
} else {
    // 書き出しが失敗したときの処理
    setMsgF("エラー:データの保存に失敗しました。")
    ...
}

まず最初に、アプリの初期処理内でリンククラスのインスタンスを生成します。このとき、保存場所のディレクトリとファイル名を設定します。あとは必要に応じて、これらのインスタンスにロードまたはセーブのメソッドを実行します。

ロードの際には、正常に読み込めたかを確認します。nilが返ると失敗ですから、if let文を使えば切り分けが簡単です。

セーブの際にも、戻り値で成功と失敗を判定します。falseが返ると失敗なので、ユーザーにメッセージを出してから、失敗時の処理を続けます。

 

以上の使用例は、単純に使う場合です。もっと凝った作り方をする際の、拡張方法も簡単にですが取り上げてみます。

まずは、別な保存先へ切り替える場合です。今回のリンククラスと同じメソッドを持ったクラスを用意して、リンククラスを新しいクラスに置き換えるだけです。変数名が同じままなら、変数のデータ型を新しいリンククラス名に置き換えて、インスタンス生成の箇所を直すだけです。

このような変更を事前に予想し、リンククラスの変数名は、ファイルに関係ないものにしたいものです。「...2File」よりも「...2Storage」のほうが適しています。

次に、複数の保存先へ保存する場合も考えてみましょう。単純に切り替えるなら、同じメソッドの別なリンククラスを用意するでしょう。同じように、複数へ保存するリンククラスを作るのですが、すでにファイルへ保存するリンククラスがあります。同じコードを重複して書くのは好ましくないので、ファイルへのリンククラスのサブクラスを作って、2番目の保存先へ保存する処理だけ加えます。そのサブクラスへ切り替えるというわけです。

2つの保存先といっても、保存する先が2箇所だけで、ロードするときは片方だけでしょう。だとすると、上書きするのはセーブのメソッドだけになります。もしロードも2つから選ぶ場合は、既存のロードはメインの保存先としてそのまま残し、サブとなる保存先からロードするメッソドを追加する形が良いと思います。

 

一応の使い方を紹介しましたが、実際のアプリで使う際には、別な考慮点があります。それは、ファイルへ保存する情報を扱っているクラスとの関係です。

一般的な作り方として、情報をファイルへ保存するのであれば、その情報を扱っているクラスが存在します。MVCの考え方で言うと、Mのモデルに相当するクラスのはずです。保存するファイルごとに、関係するモデルのクラスがあるので、それぞれのファイルはどこかのモデルクラスと関連付けられます。

今回のリンククラスでは、インスタンスを生成する部分のコードに、ディレクトリとファイル名が含まれています。それをモデルクラスに入れてしまうと、モデルクラスは保存先情報を持ってしまいます。別な保存先に切り替えるとき、モデルクラス内のインスタンス生成コード部分で、ディレクトリとファイル名に相当する情報を書き換える必要が生じます。良い使い方とは言えません。

モデルクラスの役割は、ファイルへ保存するデータを生成する部分です。どこへ保存するかは含まず、保存する処理へ保存データを渡すだけなのが基本でしょう。

だとしたら、保存データを生成して渡すgetメソッドを作る方法が、真っ先に考えられます。アプリ全体をコントロールしている処理(中央処理と呼びましょうかね)が、モデルクラスから保存データを受け取り、リンククラスへ渡して保存します。リンククラスのインスタンス生成も、当然ながら、中央処理が担当します。

ロードも同様で、中央処理がリンククラス経由でロードし、モデルクラスに渡します。つまり、モデルクラス側では、ロードした出たを受け取るsetメソッドも必要になります。

モデルクラスが扱っている情報が複雑な場合は、保存ファイルが複数になることもあるでしょう。しかも、保存ファイルのデータ形式が同じとは限りません。今回用意した4種類の中で、複数のデータ形式を使うとかです。そうなると、モデルクラスで用意する保存データ用メソッドは、データ形式の種類分だけ増えることになります。美しくない方向へ、どんどん向かっているような気がします。

 

いろいろと悩みましたが、私が考えたベストは、次のような方法です。

まず、リンククラスのインスタンス生成は、中央処理が担当します。これによりモデルクラスは、保存先の情報を持たなくて済みます。

続いて大事な点ですが、モデルクラスと中央処理は、保存データの受け渡しをしません。保存する処理を実行するのは、モデルクラスです。中央処理は、モデルクラスが用意した保存メソッドを呼び出すだけで、呼び出されたモデルクラスが、リンククラスを呼び出して保存します。

では、モデルクラスとリンククラスの関係はどうなるのでしょうか。モデルクラスでは、中央処理が生成したリンククラスのインスタンスを、受け取るためのメソッドを用意します。つまり、setメソッドです。モデルクラスは、受け取ったリンククラスのインスタンスに対して、生成した保存データを渡して保存させたり、ロードしたデータを受け取って、自分自身の内部データを一括更新したりします。

このような構造だと、モデルクラスはリンククラスに依存します。もしリンククラスの仕様が変更になれば、モデルクラスも変更しなければなりません。ただし、リンククラスは非常に単純なので、仕様変更が発生する可能性はほぼゼロでしょう。つまり、実用上は、依存している点が問題にならないということです。

この方法には、別な良い点もあります。モデルクラスは、保存先のリンククラスを設定するメソッドを持っています。そのおかげで、保存先となるリンククラスを簡単に切り替える機能を持つことになるのです。それによって、複数の保存先へ保存する処理も作りやすくなります。

たとえば、次のような方法で。中央処理が最初に、保存先となるリンククラスのインスタンスを複数用意します。複数へ保存したいときは、最初のリンククラスをモデルに設定してから、保存メソッドを呼び出します。続いて、2番目のリンククラスを、同じモデルクラスに設定し、その後に保存メソッドを再び呼び出します。このように実行すれば、現状のリンククラスのままで(リンククラスを複数保存へ対応させずに)、複数の保存先へ保存する処理が簡単に作れます。

1つのモデルクラスで、複数のファイルを保存する場合も、少し考えてみましょう。複数のファイルですから、リンククラスのインスタンスも複数生成し、それぞれをモデルクラスに設定します。ただし、保存やロードはまとめて行って構わないケースがほとんどでしょうから、保存やロードのメソッドは1つだけにまとめることになります。この形だと、メソッド数が増えすぎて困ることもありません。

 

以上のような形で作るとすると、すぐに思い付くのは、リンククラスを扱う機能だけプロトコルにできないかということでしょう。当然、考えました。でも、すぐに諦めました。

今回のリンククラスは、とりあえず作っただけでも4種類のデータ形式があります。それに加えて、1つのモデルクラスが複数のデータを保存することもあるでしょう。それらが同じデータ形式とは限りません。つまり、何個を保存するのか、それぞれどんな形式なのか、先に問い合わせて、その回答内容に合った保存命令を出す必要があります。

プロトコル作り以上に、そのプロトコルで保存命令を出す側の処理が、かなり複雑になりそうです。やっぱり、それぞれのモデルクラスごとに適したメソッドを用意して、それに合わせて呼び出すのが現実的と言えそうです。もちろん、メソッドの形式は統一しますが。

 

もう1点、リンククラスのインスタンスの管理も、アプリ側での作り方で考慮すべき点です。

リンククラスのインスタンスは、どれかのモデルクラスへ関連付けられます。モデルクラスもインスタンスを生成しますから、それと同じ場所で生成する方法もあるでしょう。

しかし私は、リンククラスのインスタンスだけ、まとめて生成する方法が好きです。アプリの初期化処理の中で、すべての保存ファイル用のインスタンスを生成し、そのコードを一箇所にまとめて書きます。まとめて書くことで、どんなファイルを使っているのか、一目瞭然になるからです。

また一箇所にまとめると、一括バックアップなどの処理が作りやすくなります。リンククラスのインスタンスを並べ、それぞれのロードメソッドで保存データを受け取り、別な場所へ一括保存するといったバックアップ処理です。ファイルだけをまとめて管理しやすいので、こうした方法が好きです。

 

以上で説明は終わりです。後半のほうは、説明だけになってしまいましたので、要点だけでも読み取ってください。

ファイルの読み書きを間接参照で作るという狙いで、今回のようなリンククラスを作りました。間接参照の実現方法は、人によってつくり方が違うと思います。もし今回の考え方に興味を持った場合は、自分なりの間接参照を設計してみたらいかがでしょう。

 

(使用開発ツール:Xcode 6.3.2, SDK iOS 8.3)

2015年6月11日木曜日

ファイルの読み書きも間接参照で(作成理由編)

アプリで作成したデータを保存する場合、ファイルとして書き出すことが多いでしょう。作成データだけでなく、アプリの設定内容なども、ファイルとして保存することが多いはずです。

こうしたファイルに関する読み書きは、独自ライブラリとして用意し、それを使うことで、似たようなコードを何度も書かなくて済みます。ここまでなら、ライブラリ化が好きな人だと普通に行っているでしょう。

では、さらに1歩進めて設計するとしたら、どのような構造になるでしょうか。その辺の検討結果と、実際に作ったクラスを紹介ます。

 

まずアプリの一般的な構造を考えましょう。アプリの中心部分では、そのアプリに固有の情報を扱っていて、画面に表示したり、入力を求めたりします。入力されたデータや、外部から取得したデータを保存するとき、ファイルへ書き出すのが一般的です。

保存先としては、ファイル以外でも可能です。たとえば、ネット上のサーバーとか。つまりファイルとは、情報の保存先の1つでしかありません。

いくつかの中の1つである以上、切り替え可能なように作るのが良い作り方でしょう。保存先を単純に切り替えるだけでなく、同じ情報を複数に保存するとか、その片方への保存は1日に1回だけとか。切り替え可能な形で作っておくことで、保存する機能の拡張が格段にやりやすくなります。

つまり、アプリの内部構造として、中心部分の処理から、保存する処理を分離したいわけです。中心部分の処理では、どこに保存するのか、どんな名前で保存するのか、まったく知らない形となります。保存データを作った際には、保存する処理にデータを渡すだけで、あとは知らないという感じです。

 

以上のように考えた結果、ファイルの読み書きを間接参照で作ることにしました。ファイルの読み書きの基本的な部分は、すでにライブラリ化してあります。現状のアプリでは、それを直接呼び出しているのですが、今後は間接参照に変更しようということです。

間接参照をどのように作るのかが、一番重要です。大事な機能としては、保存先を切り替え可能に作る点があります。つまり、アプリの中心的な処理では、どこへ保存するのか知らなくても動くように作り、保存する処理が複数あって、それらが交換可能になるという形です。

そこで、間接参照を実現するためのリンククラスを用意することにしました。アプリ側では、このリンククラスのインスタンスを生成し、そのインスタンスへアクセスすることで、ファイルへの読み書きを実現します。具体的には、このリンククラスが、ファイルの読み書きのライブラリを呼び出して処理します。今まではアプリが、ファイル関連のライブラリを直接呼び出していましたが、改良版では、アプリがリンククラスを呼び出し、そのリンククラスがファイル関連のライブラリを呼び出します。また、どこへ保存するか、どんな名前で保存するかはリンククラスが持ち、アプリの中心処理では持たない形となります。

アプリがリンククラスのインスタンスを生成する際に、保存場所(ディレクトリ)とファイル名を指定します。そのため、ファイルとして保存するデータの数だけ、インスタンスを生成することになります。1つのファイル用に1つのインスタンスを生成するというルールです。

リンククラスで重要なのは、交換可能に作ることです。ネット経由での保存など、ファイル以外の保存先も考えられます。どの保存先でも共通のメソッドを持たせ、保存先が変更されても、ソースコードの変更を最小限に抑えます。

その実現で大事なのは、メソッド名と引数のデータ型です。これらが同じであれば、別なクラスに切り替えたとしても、修正箇所はたった2箇所だけになります。たとえば、変数名prefStorageで今回のリンククラスをインスタンス生成した場合、インスタンスへのアクセスは変数名prefStorageとメソッド名だけしか使いません。もしメソッド名が全部同じで、ネット上へ保存するリンククラスを別に用意したとき、次の2箇所だけ変更すれば良くなります。インスタンス生成するコードのリンククラス名を変更し、インスタンス生成で指定するする初期化の値(ディレクトリ位置やファイル名)を変えるだけです。それ以外のコードである、変数prefStorageへアクセスする箇所のコードは、変更しなくて済みます。このような形であれば、交換可能の良い実現方法でしょう。

以上のように考えると、ファイルの読み書きを強く意識したメソッド名(readやwrite)は適しません。もっと一般的なloadやsaveが、より適していると言えます。そこでリンククラスでは、メソッド名にloadとsaveを使うことにしました。

 

過去に作ったアプリを見ると、単純なloadとsaveだけでは不足です。デフォルト値を入れたファイルがあり、それを呼び出す機能も必要です。そこで、loadを2つ用意します。単純なloadと、デフォルト値のloadです。

以上を整理すると、次のようになります。とりあえず、ファイル編だけです。

リンククラスの主な仕様(ファイル編)
・保存先の情報を持つ:ディレクトリとファイル名
・初期化:保存先ディレクトリとファイル名を設定する
・保存メソッド:値を受け取ってファイルに保存する
・ロード・メソッド:保存されている値をロードする
・デフォルト値のロード・メソッド:デフォルト値をロードする

機能が少ないので、かなり単純なクラスになるでしょう。

 

さて、ここまでの話では、保存するデータの中身について触れていませんでした。保存データのデータ型が違うと、同じ処理を使えません。たとえば、ファイルから読み込む処理は、文字列、バイナリー、NSDictionary、NSArrayで違います。ファイルへ書き出す処理も同様です。つまり、扱うデータ型ごとに、別々なクラスを用意しないといけないわけです。

リンククラスの種類(ファイル編)
・文字列(文字コードはUTF-8)
・NSDictionary
・NSArray
・バイナリー

構造が簡単なクラスで、しかもファイルの読み書きライブラリが既に作成済みなので、作るのは簡単です。

それぞれのクラスでは、扱うデータの型が決められています。そのおかげで、コンパイラの型チェック機能が有効に働き、ちょっとした間違いなどをコンパイル時点で発見できるようになります。

 

リンククラスの作成理由を簡単に紹介するつもりでしたが、書いてみたら予想より長くなってしまいました。いつもの全体設計編というレベルではないので、作成理由編とし、ここで一旦区切ります。具体的なSwiftコードは、次の投稿にて。

2015年6月3日水曜日

モーダルビューをライブラリ化(本編2+使用例編)

モーダルビューをライブラリとして作った話の続きです。前回では、Swiftコードの説明が途中まででした。残りのソースコードを挙げながら、要点を説明します。さらに、簡単な使用例も紹介します。

 

いよいよ、肝となるボタンとレイアウトを取り上げます。ボタンはキャンセルとOKの2つがあり、基本的には次のように使います。

キャンセルボタンがタップされると、何もせずに、モーダルビューを閉じるだけです。

OKボタンがタップされると、設定された関数を実行します。初期状態では、このクラスの関数が設定されていますが、通常の使い方では、アプリ側で用意した関数を設定し、タップされたときに実行させます。

何かの登録処理でモーダルビューを使う際には、まだ何も選択されていない状態のとき、選択を促すメッセージを表示して、モーダルビューは開いたままにします。このように、開いたまま使い続ける場合もあり得るので、OKボタンの処理には、自動的に閉じる処理は付けていません。

OKボタンでモーダルビューを閉じたい場合には、アプリ側が設定した関数内から、閉じるメソッドを実行します。つまり、アプリ側の関数から、このクラスの閉じるメソッドを呼び出す形となります。

ボタンの初期化と、ボタンに関するメソッドは、次のようなSwiftコードになりました。

// ======================================== ボタン
var btnCancel: UIButton!
var btnOKay: UIButton!
var funcOKay: () -> Void = { () -> Void in return }

// 初期化
private func setupBtnF() {
    // キャンセルボタン
    btnCancel = zCreateBtnF("キャンセル", 20, 400, 550, 120, 50)
    btnCancel.addTarget(self, action:Selector("runCancelF:"), forControlEvents: .TouchUpInside)
    self.addSubview(btnCancel)
    // OKボタン
    btnOKay = zCreateBtnF("OK", 20, 600, 550, 120, 50)
    btnOKay.addTarget(self, action:Selector("runOkayF:"), forControlEvents: .TouchUpInside)
    self.addSubview(btnOKay)
    funcOKay = funcDummyF    // ダミーの警告関数を設定
    // サイズとレイアウトの設定
    setBtnSizeF()
    setBtnPositionF()
}

// キャンセル処理:アニメーションで自分自身を隠す
func runCancelF(rSender:UIButton) {
    closeF()
}
// OK処理:変数に代入した関数を実行する(Viewのclose処理は、必要な場合にアプリ側で行う)
func runOkayF(rSender:UIButton) {
    funcOKay()
}
// OKボタンのダミー処理:未設定をメッセージで知らせる
private func funcDummyF() {
    setMsgF("内部エラー:OKボタンに処理が設定されていません。")
}

// OK処理で実行する関数を設定
func setFuncF(rFunc:() -> Void) {
    funcOKay = rFunc
}
// 2つのボタン名を設定
func setBtnNameF(rStrC:String, _ rStrO:String) {
    btnCancel.setTitle(rStrC, forState: .Normal)
    btnOKay.setTitle(rStrO, forState: .Normal)
}

初期化の処理では、まず2つのボタンを生成します。このときの大きさや表示位置は、仮の値です。初期化の最後に、レイアウトを設定する処理を実行するからです。

ボタンがタップされたときに実行する関数も、初期化の処理内で設定します。キャンセルボタンのほうは、このモーダルビューを閉じるだけの処理です。

OKボタンのほうは、関数を入れる変数funcOKayに入っている関数を実行します。この変数をOptional型にしたくなかったので、変数宣言の際に、何もしない処理(クロージャ)を入れました。

この変数のデータ型は、「() -> Void」にしてあります。これは「() -> ()」とも書けるのですが、Swiftに詳しくない人が少しでも分かりやすいようにと考え、あえてVoidを選んでいます。2種類以上の表記が可能な場合、初心者が少しでも理解しやすい方を選ぶのが、私の方針だからです。

この変数に入れる関数は、アプリ側で必ず入れるものです。入れ忘れを気付きやすいように、ダミーの関数を用意して、それを初期化の処理で入れています。このダミー関数を実行すると、メッセージ欄に「内部エラー:OKボタンに処理が設定されていません。」と表示されます。いつものエラーメッセージと少し違うのは、画面上に表示するメッセージなので、ユーザーが読む可能性があるからです。

当然ですが、OKボタンに関数を設定するメソッドも必要です。関数のデータ型を指定してあるため、とくにエラー検査はしていません。

ボタン名を自由に変えたい要望もあるでしょう。2つのボタンを一緒に変えるメソッドの形にしました。おそらく最初の1回だけ実行するメソッドなので、メソッドをまとめたほうが効率的と判断したからです。

 

続いて、ボタンのサイズとレイアウトを設定する機能です。上記の初期化処理の最後でも呼ばれます。最初に、レイアウト機能に関する考え方を取り上げましょう。

今回のモーダルビューを使う際には、ボタンの座標を細かく指定しないと決めました。アプリ側では大まかな指定だけして、ビューのライブラリ側で自動レイアウトする形です。

アプリ側が指定する値としては、ボタンの大きさ、水平方向の広がりの大きさ、垂直方向の広がりの大きさの3つです。それぞれで、7種類の値から選ぶ形にしました。

どちらが大きいのか簡単に識別できるように、服などのサイズ指定で使われているS、M、Lを用いてます。このままだと3種類しかないので、3Sから3Lまで使って7種類としました。中央の値がMですが、これが標準の位置を意味するわけではありません。並び順として、単純に真ん中の値というだけです。もっと良い表現方法があれば良いのですが、思い付きませんでした。

以上の考えをまとめて作ったのが、以下のSwiftコードです。

// ボタンの大きさ
enum ZmvBtnSize: Int {
    case size_3S = 0
    case size_2S = 1
    case size_S = 2
    case size_M = 3
    case size_L = 4
    case size_2L = 5
    case size_3L = 6
}
// ボタン位置のX軸(横方向)の広がり
enum ZmvBtnPosiX: Int {
    case posiX_3S = 0
    case posiX_2S = 1
    case posiX_S = 2
    case posiX_M = 3
    case posiX_L = 4
    case posiX_2L = 5
    case posiX_3L = 6
}
// ボタン位置のY軸(縦方向)の広がり
enum ZmvBtnPosiY: Int {
    case posiY_3S = 0
    case posiY_2S = 1
    case posiY_S = 2
    case posiY_M = 3
    case posiY_L = 4
    case posiY_2L = 5
    case posiY_3L = 6
}

見てのとおり、列挙型の値として作ってあります。7種類から選ぶ項目が3つもあるので、大きさを示すSMLだけでは間違えやすくなります。そうならないように、SMLの前に値の名前を加えました。

 

いよいよレイアウトの実行コードです。

自動レイアウト機能を付けたので、その指定方法を最初に説明する必要があります。指定できる項目が3つあって、それぞれ7種類の値の中から選べることを、ソースコードの先頭で説明しています。

その後に、どんなレイアウトになるかを続けます。レイアウトのイメージが頭の中に浮かぶように、構造を上手に表現する必要があります。いつものように縦軸と横軸で、レイアウトの順に並べる形で変数名などを書きました。

このようなことを考えながら作ったのが、次のSwiftコードです。レイアウト説明の箇所では、変数とインデックスの関係を伝えるためのコメントも付けてあります。

// ======================================== サイズとレイアウトの変更
// 3種類の設定項目があって、それぞれ7つの値から選べる
// メッセージ欄は同じ大きさのまま、上下の位置だけ変わる。いつもボタン直下に置かれて、位置の指定はできない
// ボタンの大きさが7種類、X(水平方向)軸の中央のボタン間隔が7種類、Y(垂直方向)軸の下の余白が7種類

// 上記を整理したレウアウト説明
// ーーーーーーーーーー レイアウト(X軸:横方向):左右対称
// 余白:余り(可変)
let W_BUTTON: [CGFloat] = [120, 140, 160, 200, 240, 280, 320]        // ボタン:キャンセル:W_BUTTON[numBtnSize]
let W_MARGIN_CENTER: [CGFloat] = [50, 100, 150, 200, 250, 300, 350]  // 余白:W_MARGIN_CENTER[numBtnPosiX]
// ボタン:OK:W_BUTTON[numBtnSize](キャンセルと同じ大きさ)
// 余白:余り(可変:上の可変と同じ大きさ)
// ーーーーーーーーーー レイアウト(Y軸:縦方向)
// 余白:余り(可変:このビューへ追加で貼り付けるUI部品は、ここに配置する)
let H_BUTTON: [CGFloat] = [40, 45, 50, 55, 60, 70, 80]               // ボタン:H_BUTTON[numBtnSize]
let H_MARGIN_BOTTOM: [CGFloat] = [350, 300, 250, 200, 150, 100, 50]  // 余白:H_MARGIN_BOTTOM[ZmvBtnPosiY]

// ボタン内の文字サイズ:ボタンサイズに連動
let TEXT_SIZE_BTN: [CGFloat] = [16, 18, 20, 24, 28, 32, 36]          // TEXT_SIZE_BTN[numBtnSize]

// 上記の設定値:配列のインデックス
var numBtnSize: ZmvBtnSize = .size_M
var numBtnPosiX: ZmvBtnPosiX = .posiX_2L
var numBtnPosiY: ZmvBtnPosiY = .posiY_2L

// ボタンのサイズを計算して設定
private func setBtnSizeF() {
    // キャンセルボタン
    let iWidht: CGFloat = W_BUTTON[numBtnSize.rawValue]
    let iHeight: CGFloat = H_BUTTON[numBtnSize.rawValue]
    let iSize: CGSize = CGSizeMake(iWidht, iHeight)
    btnCancel.frame.size = iSize
    btnCancel.titleLabel!.font = UIFont.systemFontOfSize(TEXT_SIZE_BTN[numBtnSize.rawValue])
    // OKボタン
    btnOKay.frame.size = iSize
    btnOKay.titleLabel!.font = UIFont.systemFontOfSize(TEXT_SIZE_BTN[numBtnSize.rawValue])
}
// ボタンとメッセージ欄の位置を計算して設定
private func setBtnPositionF() {
    // キャンセルボタン
    let iX1: CGFloat = (screenWidth - W_MARGIN_CENTER[numBtnPosiX.rawValue]) / 2 - W_BUTTON[numBtnSize.rawValue]
    let iY1: CGFloat = screenHeight - H_MARGIN_BOTTOM[numBtnPosiY.rawValue] - H_BUTTON[numBtnSize.rawValue]
    btnCancel.frame.origin = CGPointMake(iX1, iY1)
    // OKボタン
    let iX2: CGFloat = (screenWidth + W_MARGIN_CENTER[numBtnPosiX.rawValue]) / 2
    btnOKay.frame.origin = CGPointMake(iX2, iY1)
    // メッセージ欄:左右の中央で、ボタン直下(余白は10)に付ける
    let iWidth: CGFloat = lblMsg.frame.size.width
    let iX3: CGFloat = (screenWidth - iWidth) / 2
    let iY3: CGFloat = iY1 + H_BUTTON[numBtnSize.rawValue] + 10
    lblMsg.frame.origin = CGPointMake(iX3, iY3)
}
// ボタンのサイズや位置を設定(それぞれ用意した種類から選ぶ)
func setBtnLayoutF(rNumBtnSize:ZmvBtnSize, _ rNumPosiX:ZmvBtnPosiX, _ rNumPosiY:ZmvBtnPosiY) {
    numBtnSize = rNumBtnSize
    setBtnSizeF()       // ボタンのサイズを設定
    numBtnPosiX = rNumPosiX
    numBtnPosiY = rNumPosiY
    setBtnPositionF()   // ボタンの位置を再計算
}

7種類の値を入れた変数のインデックスも、別な変数(名前がnumで始まる3つの変数)として用意してあります。その初期値としては、ボタンの大きさは真ん中の値、ボタンの位置は一番広い値にしました。これらの値を変更しない場合、ビュー上に置いたUI部品と重なりにくいように配慮したためです。通常の使い方としては、3つの値を必ず設定するはずですが、知らないで使い始めたときのためにです。

上記ソースコードの一番最後が、3つの値を設定するメソッドです。最初に設定したまま使うのが一般的なので、まとめて設定できるようにと、1つのメソッドにまとめました。値を設定するとともに、ボタンの大きさやレイアウトを再計算しています。

ボタンサイズの計算処理では、1つの設定値をもとに、ボタンの幅と高さ、中に表示する文字の大きさを決めています。あらかじめ用意した配列の値から持ってくる形です。細かな組み合わせは選べません。あまり細かく指定できても面倒ですし、変な組み合わせでは見栄えが悪くなります。バランスの良い組み合わせを事前に用意し、その中から選ぶ形が一番使いやすいと考え、このような形にしました。

ボタンとメッセージ欄のレイアウト計算処理では、X軸とY軸で余白を与える形にしてあります。

X(横)軸は、2つのボタンが左右対称に配置され、ボタンの間の余白を配列から持ってきます。ボタン幅とスクリーン幅が決まってますから、残りの長さを左右に分割して、それぞれのボタンのX軸の座標が計算できます。

Y(縦)軸は、下の余白の大きさを配列から持ってきます。ボタン高さとスクリーン高さが決まってますから、残りが上側の余白となり、ボタンのY軸の座標が計算できます。左右対称ですから、2つのボタンが同じ値になります。

メッセージ欄の位置は、常にボタンの下に来るようにしました。X軸は中央に配置するため、自分の幅とスクリーン幅から計算します。ボタンの位置や大きさに関係ありません。Y軸は、ボタンの下端から10だけ離れた位置にしてあります。

 

以上で、モーダルビューのソースコードは終わりです。機能は単純ですが、いろいろと考えて作っているため、ソースコードの量は、最初に思っていたより多くなってしまいました。やはり、ライブラリとして作ると、どうしても増えてしまうようです。

今回のライブラリの肝は、簡単に使える点です。この種のライブラリの場合、実現するための技術的な難しさは、ほとんどありません。思い付いたら、すぐに作り終わるはずです。

でも、実際に使いやすく仕上がるかどうかは、別な問題です。細かな座標を指定して使うなら、最初から作っているのと同じで、ライブラリを使う意味がありません。大まかな指定をするだけで、ボタンが左右対称に配置され、ほど良い感じに仕上げてくれることこそ、この種のライブラリ作成で、労力を一番注ぐべき点だと思います。

今後、より大きなスクリーンサイズのiPadが登場したときも、値を入れている配列に、より大きな値を追加するだけで対応できるでしょう。今の7種類が、9種類や11種類に増える形で。そうした点も考慮しながら、今回のライブラリは作りました。

 

続いて、使い方を紹介します。これを作るきっかけとなった、フォトライブラリから写真を選ぶ機能のライブラリ(当ブログにて以前に紹介)と一緒に使ってみます。つまり、写真を選ぶモーダルビューとして使うわけです。

いつもiOS実験専用アプリで開発し、そこでテストも実行していますから、その中の一部を抜き出して来ました。見やすく整えるのが面倒なので、そのまま紹介します。

まず、OKボタンがタップされたときに実行する関数を、アプリ側で用意します。当然ですが「() -> Void」の形式で作ります。

// OK(伝達)ボタンをタップしたときに実行される関数
func okay13bF() {
    if photoSelector13.isSelectedF() {
        if let iImg: UIImage = photoSelector13.getImageF() {
            // ここに、画像登録の処理を入れる
            // (たとえば、アプリ内の変数へ画像を入れるための処理を呼び出すとか)
            setMsgF(4, "画像を登録しました。")         // アプリ側のメッセージ欄に表示
        } else {
            setMsgF(4, "画像の取得に失敗しました。")   // アプリ側のメッセージ欄に表示
        }
        view13.closeF()
    } else {
        view13.setMsgWTimerF("画像を選択してください。", .Caution) // モーダルビューに表示
     }
}

見てのとおり、この関数がやり取りする主な相手は、モーダルビューではなく、その上に貼り付けられた写真選択機能(photoSelector)です。写真が選択されていなければ、選択を促すメッセージをモーダルビュー側へ出して終了です。モーダルビューは閉じません。

逆に、写真が選択されていれば、if letでUIImageへ代入を試みます。もし成功すれば、画像登録処理を実行し、アプリ側のメッセージ欄にメッセージを出して、モーダルビューを閉じます。代入が失敗した場合は、何もせずに、アプリ側のメッセージ欄にメッセージを出して、モーダルビューを閉じます。どちらの場合にでも、モーダルビューは閉じられ、成功または失敗のメッセージが、アプリ側に残ります。

 

関数が用意できたので、モーダルビューを扱うコードを作ります。モーダルビューとPhotoSelectorのインスタンスを入れる変数を用意して、準備から表示までのSwiftコードは、以下のようになります。

// モーダルビューの使用例:フォトライブラリから写真を選ぶ
var view13: ZModalView!               // モーダルビューの変数
var photoSelector13: PhotoSelector!   // 写真選択ビューの変数

// モーダルビューを用意して設定
view13 = ZModalView()
view13.setupF()                                      // 初期化
view13.setFuncF(okay13bF)                            // 関数の設定
view13.setBtnNameF("キャンセル", "登録")             // ボタン名の設定
view13.setBtnLayoutF(.size_S, .posiX_3L, .posiY_M)   // ボタンのサイズとレイアウトの設定
self.view.addSubview(view13)                         // アプリのビューへ貼り付け
// 写真選択ビューを用意して、モーダルビューに貼り付ける
photoSelector13 = PhotoSelector()
photoSelector13.setupF(50, 100, 900, 400)
view13.addSubview(photoSelector13)                   // モーダルビューへ貼り付け
// モーダルビューを開始
view13.openF()

見てのとおりです。コメントを多めに付けたので、何をしているのか分かるでしょう。ボタンのサイズやレイアウトを決める3つの値の設定でも、SMLに項目名を加えた効果が出て、理解しやすくなっています。

 

モーダルビューを使う際には、その処理全体を関数として用意し、インスタンスを入れる変数も関数内に作ります。そうすれば、モーダルビューを使い終わったとき、変数も一緒に消えて、使用していたメモリーが解放されます。

このようにメモリーの使用と解放を意識した作り方が、他の言語と同様に、Swiftでも必要となりますね。

 

今回は、かなり簡単な機能と言えるモーダルビューのライブラリ化を紹介しました。簡単な機能だからこそ、手間をかけずに使える工夫が重要です。また、将来の拡張性にも配慮しておかないと、後からのメンテが大変になります。

こんな簡単な機能でもライブラリ化できる例として、面白かったのではないでしょうか。今回の投稿を読んで「もしかして、これってライブラリ化できるかも」と思ったアナタ、さっそく作り始めてください。アプリを作るより、ライブラリを作る方が、意外に面白かったりしますので。

 

(使用開発ツール:Xcode 6.3.2, SDK iOS 8.3)