2015年1月23日金曜日

AnyとAnyObjectの違い(シリアライズ編)

環境設定機能の独自ライブラリ化で必要なので、Anyのシリアライズを機能確認しました。そうしたら、また面白いことが見付かりました。これらか紹介する内容としては、AnyとAnyObjectの違いになるので、掲げたようなタイトルにしてあります。

 

AnyObjectではIntやFloatなどの区別ができないので、Anyに切り替えようと、Anyを含んだDictionaryのシリアライズを試しました。シリアライズができるようになれば、AnyObjectをAnyに切り替えられるからです。

シリアライズには、NSKeyedArchiverクラスのarchiveRootObjectメソッドを使いました。コーディングしたら、いきなりコンパイルエラーです。iOS実験専用アプリで機能確認してますから、AnyObjectと比較する意味で、同じようなコードをAnyObjectでも作りました。AnyObjectのほうはエラーが出ませんし、実行させると正常に動きます。

前回の投稿で使ったソースコードに加えて試していますが、追加部分だけ掲載すると意味不明でしょうから、関連するコードだけ残したものが、次のSwiftコードです。

// Dictionaryをファイルとして保存
// 変数の準備
let aryTypeName : [String] = ["Int", "Float", "Bool", "String", "Error!!!"]
let iInt : Int = 5
let iFloat : Float = 3.3
let iBool : Bool = false
let iStr : String = "test"
var dicAny : Dictionary<String,Any> = [String:Any]()
var dicAnyObj : Dictionary<String,AnyObject> = [String:AnyObject]()
dicAny[aryTypeName[0]] = iInt
dicAny[aryTypeName[1]] = iFloat
dicAny[aryTypeName[2]] = iBool
dicAny[aryTypeName[3]] = iStr
dicAnyObj[aryTypeName[0]] = iInt
dicAnyObj[aryTypeName[1]] = iFloat
dicAnyObj[aryTypeName[2]] = iBool
dicAnyObj[aryTypeName[3]] = iStr
// Dictionaryをファイルとして保存
let iPathDocs : AnyObject = NSSearchPathForDirectoriesInDomains(.DocumentDirectory, .UserDomainMask, true)
let iPathFile1 : String = iPathDocs[0].stringByAppendingPathComponent("dicAny.plist")
let iPathFile2 : String = iPathDocs[0].stringByAppendingPathComponent("dicAnyObj.plist")
//let iResult1 = NSKeyedArchiver.archiveRootObject(dicAny, toFile:iPathFile1)    // コンパイルエラー
//if !iResult1 { println("ERROR:ファイル書き失敗:Any") }
let iResult2 = NSKeyedArchiver.archiveRootObject(dicAnyObj, toFile:iPathFile2)
if !iResult2 { println("ERROR:ファイル書き失敗:AnyObj") }

上記のコメント化した2行のうち、1行目がコンパイルエラーです。エラーメッセージをから推測すると、シリアライズ処理ではAnyを扱えないようです。つまり、Anyを含んだインスタンスなどは、シリアライズの対象外になるということでしょう。

前回の投稿で書いたとおり、Anyを含んだDictionaryは、NSDictionaryへキャストできませんでした。今回のシリアライズも、根本原因は同じだと思います。AnyはSwiftになってから用意されたものなので、NSDictionaryやNSKeyedArchiverがサポートしていないのでしょう。

 

通常のシリアライズが使えないと判明したものの、別な可能性を探るために、Anyの機能確認を続けてみました。

とりあえず、AnyとAnyObjectで、相互に代入を試しました。これが可能であれば、解決方法が幅広く考えられますので。試したのは、以下のSwiftコードです。

// AnyとAnyObjectでの代入
// 変数の準備
let iInt : Int = 5
let iAnyInt : Any = iInt
let iAnyObjInt : AnyObject = iInt
// 代入
let iAny : Any = iAnyObjInt          // ビルド時にエラー
//let iAnyObj : AnyObject = iAnyInt  // コンパイルエラー(エディタ上で表示)

コメント化した行が、コンパイルエラーが出た部分です。Any変数の値はAnyObject変数に代入できませんでした。テキストエディタへ入力した状態で、コンパイルエラーになりました。

もう片方の、AnyObject変数の値をAny変数に代入するコードは、エディタ上でエラーがでないものの、ビルドするときにエラーが出てビルドが失敗します。通常の書き方では、どちらの方向へも代入できないようです。

 

ここまでの仕様確認の結果から、どんどんと道が閉ざされていると感じます。いったん整理してみましょう。

まず、as演算子でIntなどのデータ型が正しく判定できるのは、Anyだけです。判定が必要なDictionaryでは、Anyを使うしか選択肢がありません。

続いて、Anyを含むDictionaryのシリアライズです。通常の方法では、コンパイルエラーが出て書けません。また、NSDictionaryへキャストしてもエラーが出ます。別な方法を用意して、ファイルに保存する必要があります。

その保存方法に使えないかと考えたのが、Any変数とAnyObject変数を用いた相互の代入です。しかし、どちらの方向への代入でも、エラーが出て使えませんでした。

 

おそらく次のような形なら、ファイルへの保存と復元が実現可能だと思います。

AnyObjectならシリアライズ可能なので、ファイル保存にAnyObjectを用います。ただし、いったんAnyObjectに入れてしまうと、データ型の判定ができません。データ型の情報もファイルへ保存して、Anyへ復元するときに利用するしかないでしょう。

AnyとAnyObjectは相互に代入できないので、通常のデータ型の変数へ代入してから、もう片方のAnyまたはAnyObjectへ代入する方法を使います。ファイル保存時に用いるAnyからAnyObjectへの代入では、Anyがデータ型を判定できるので、その判定結果を用いて、中間変数のデータ型を選びます。続く中間変数からAnyObjectへの代入では、何も判定する必要はありません。

ファイルからの復元時に用いるAnyObjectからAnyへの代入でも、通常のデータ型の変数を通します。AnyObjectではデータ型を正しく判定できないので、保存しておいたデータ型の情報を使って、中間変数のデータ型を選びます。この中間変数を経由してAnyへ代入すれば、データ型が判定可能なAny変数として復元できます。

Dictionaryは、キーと値が対になったデータ構造です。データ型の情報を、どのように保存するのか決めなければなりません。1つの実現方法としては、元のキーから自動生成できる別なキー(元のキーの後ろに決められた文字列を追加するとか)を使って、一緒に入れることも考えられます。しかし、これだとfor文で回すときに、本来のキーかどうかを区別する必要があり、処理が面倒になってお勧めできません。同じキーの別なDictionaryとして用意したほうが、変更への柔軟性が高まるでしょう。まあ、どんな方法を採用するにしても、あまり作りたくない処理ですね。

 

今回、AnyとAnyObjectの違いという話題で、シリアライズに関する機能確認に始まり、相互の代入も調べてみました。

最初に考えていたのとは違って、AnyとAnyObjectは細かな違いがありました。また、相互に代入できないのも驚きでした。せめて代入ができれば、両方の違いを上手に使い分けられるので、非常に残念です。何か別な方法で代入できれば良いのですが。

肝心の機能拡張機能の独自ライブラリですが、改良は延期です。今のままでも普通に使うのぶんには困りませんので、当分は今のままで使いたいと思います。もっとスマートな解決方法が見付かったら、改良するかもしれません。

 

(使用開発ツール:Xcode 6.1.1, SDK iOS 8.1)

2015年1月21日水曜日

AnyとAnyObjectの違い(is演算子編)

以前の投稿で、APIの仕様確認の話を書きました。SwiftやiOS APIのことを、まだ深くは理解していないので、少しずつですが仕様確認を進めています。ちなみに仕様確認とは、APIなどの記述が詳細まで含んでいないため(SwiftやiOSに限らず、一般的なことです)、詳細の動きを調べようと、実際のコードを動作させて確かめる作業のことを意味します。

AnyObjectの仕様確認を行なったとき、面白い結果が得られたので、もう少し実験してみました。AnyObjectと似たようなAnyも一緒に。そうしたら面白い結果が得られたので、ここに紹介します。

 

最初にAnyとAnyObjectの違いをネットで調べたのですが、曖昧な記述が多くて、それぞれの明確な仕様は得られませんでした。かろうじて得られた情報から、大まかには次にような感じだと思います。

AnyもAnyObjectも、いろいろな種類の型を入れられる汎用的なデータ型です。このうちAnyObjectは、クラスのインスタンスを入れるのが役割のようです。もう片方のAnyは、より広いデータ型を入れられ、関数も含むほとんどのデータ型が入れられるようです。

とは言うものの、AnyObjectにもIntなどのデータ型が入れられますし、そういった例が探せば見付かります。また、実際に試してもコンパイルエラーにならず、実行させても正常な様子で動きます。こうなると、違いがますます不明になりますね。

 

以前に紹介した開発例では、AnyObjectに入れたデータでの、is演算子での動きが期待どおりではありませんでした。そこで、同類であるAnyの動作結果も知りたくなり、実際に実行させて試したというわけです。

それぞれに入れるデータ型としては、Int、Float、Bool、Stringの4つを用意しました。それぞれのデータをAnyとAnyObjectの変数に入れて、is演算子での判定結果がどうなるかという試験です。具体的なSwiftコードは次のようにしました。

// AnyとAnyObjectで、is演算子の判定結果を調べる試験(配列)

// 変数の準備
let aryTypeName : [String] = ["Int", "Float", "Bool", "String", "Error!!!"]
let iInt : Int = 5
let iFloat : Float = 3.3
let iBool : Bool = false
let iStr : String = "test"
var aryAny : [Any] = [Any]()
var aryAnyObj : [AnyObject] = [AnyObject]()
aryAny.append(iInt)
aryAny.append(iFloat)
aryAny.append(iBool)
aryAny.append(iStr)
aryAnyObj.append(iInt)
aryAnyObj.append(iFloat)
aryAnyObj.append(iBool)
aryAnyObj.append(iStr)
// is演算子のテスト
println("Test:Any - (Int Float Bool String)\n")
for i in 0..<aryAny.count {
    let iBoolInt : Bool = aryAny[i] is Int
    let iBoolFloat : Bool = aryAny[i] is Float
    let iBoolBool : Bool = aryAny[i] is Bool
    let iBoolStr : Bool = aryAny[i] is String
    println("\(i) \(aryTypeName[i]) -- > \(iBoolInt) \(iBoolFloat) \(iBoolBool) \(iBoolStr) \n")
}
println("\nTest:AnyObject - (Int Float Bool String)\n")
for i in 0..<aryAnyObj.count {
    let iBoolInt : Bool = aryAnyObj[i] is Int
    let iBoolFloat : Bool = aryAnyObj[i] is Float
    let iBoolBool : Bool = aryAnyObj[i] is Bool
    let iBoolStr : Bool = aryAnyObj[i] is String
    println("\(i) \(aryTypeName[i]) -- > \(iBoolInt) \(iBoolFloat) \(iBoolBool) \(iBoolStr) \n")
}

難しい処理ではないので、見て簡単に理解できると思いますが、注意した点だけ書きます。

変数aryTypeNameでは、5番目の要素として、エラー表示の文字列を含めました。これを表示したときは何か間違っていることを意味し、異常終了させずに気付かせるのが目的です。異常終了が嫌いなので、このような作り方をよくやります。

AnyとAnyObjectへ入れる値は、データ型を確定させるために、型を指定した変数に入れました。こうすることで、間違いなくデータ型が確定できます。また、実際のコードでも変数に入れた値を代入することがほとんどでしょうから、実際のコードに近い条件で試験することにもなります。

AnyとAnyObjectの変数は、配列にしました。こちらも、配列の形で使うことが多いと思ったからです。もしかしたら、私だけかもしれませんが。

is演算子の判定テストでは、すべての組み合わせを実行しています。AnyとAnyObjectのそれぞれで、配列に入れた1つのデータに対して、is演算子で4種類のデータ型を順番に判定しました。配列の1要素ごとに、1行の実行結果が得られます。

println文には、実行結果が少しでも見やすくなるように改行を入れてあります。最初は入れてなかったのですが、試しに入れたらだいぶ見やすくなったので、この形で確定しました。

 

上記のコードを実行させて、得られた結果(コンソールへの出力)は次のとおりです。

Test:Any - (Int Float Bool String)

0 Int -- > true false false false 

1 Float -- > false true false false 

2 Bool -- > false false true false 

3 String -- > false false false true 


Test:AnyObject - (Int Float Bool String)

0 Int -- > true true true false 

1 Float -- > true true true false 

2 Bool -- > true true true false 

3 String -- > false false false true 

見てのとおり、AnyとAnyObjectでは違う結果となりました。

Anyに入れたデータは、is演算子の判定結果が期待どおりになっています。IntとFloatとBoolは区別され、一致しているときだけtrueを返します。つまり、データ型の判定が正しく行なわれているということです。

AnyObjectに入れたデータは、is演算子の判定結果が期待どおりではありません。IntとFloatとBoolは区別されず、それらのどの組み合わせでもtrueを返します。データ型が一致しているかではなく、データが代入可能かどうかで判定しているように見えます。

AnyとAnyObjectで、このような違いがあるとは想像もしませんでした。この結果を見たとき、正直、大きな驚きがありました。

 

結果は同じになると予想しますが、配列ではなくDictionaryに入れた場合も試しました。予想外のことが起こらないとは限りませんので、実際に試すことは大事ですから。Swiftコードは、次のとおりです。

// AnyとAnyObjectで、is演算子の判定結果を調べる試験(Dictionary)
// 変数の準備
let aryTypeName : [String] = ["Int", "Float", "Bool", "String", "Error!!!"]
let iInt : Int = 5
let iFloat : Float = 3.3
let iBool : Bool = false
let iStr : String = "test"
var dicAny : Dictionary<String,Any> = [String:Any]()
var dicAnyObj : Dictionary<String,AnyObject> = [String:AnyObject]()
dicAny[aryTypeName[0]] = iInt
dicAny[aryTypeName[1]] = iFloat
dicAny[aryTypeName[2]] = iBool
dicAny[aryTypeName[3]] = iStr
dicAnyObj[aryTypeName[0]] = iInt
dicAnyObj[aryTypeName[1]] = iFloat
dicAnyObj[aryTypeName[2]] = iBool
dicAnyObj[aryTypeName[3]] = iStr
// is演算子のテスト
println("Test:Any - (Int Float Bool String)\n")
for i in 0..<dicAny.count {
    let iBoolInt : Bool = dicAny[aryTypeName[i]] is Int
    let iBoolFloat : Bool = dicAny[aryTypeName[i]] is Float
    let iBoolBool : Bool = dicAny[aryTypeName[i]] is Bool
    let iBoolStr : Bool = dicAny[aryTypeName[i]] is String
    println("\(i) \(aryTypeName[i]) -- > \(iBoolInt) \(iBoolFloat) \(iBoolBool) \(iBoolStr) \n")
}
println("\nTest:AnyObject - (Int Float Bool String)\n")
for i in 0..<dicAnyObj.count {
    let iBoolInt : Bool = dicAnyObj[aryTypeName[i]] is Int
    let iBoolFloat : Bool = dicAnyObj[aryTypeName[i]] is Float
    let iBoolBool : Bool = dicAnyObj[aryTypeName[i]] is Bool
    let iBoolStr : Bool = dicAnyObj[aryTypeName[i]] is String
    println("\(i) \(aryTypeName[i]) -- > \(iBoolInt) \(iBoolFloat) \(iBoolBool) \(iBoolStr) \n")
}

基本的に、配列の場合のコードとほとんど同じです。入れ物をDictionaryに置き換えただけですから、コードの説明は不要でしょう。その実行結果は、次のとおりです。

Test:Any - (Int Float Bool String)

0 Int -- > true false false false 

1 Float -- > false true false false 

2 Bool -- > false false true false 

3 String -- > false false false true 


Test:AnyObject - (Int Float Bool String)

0 Int -- > true true true false 

1 Float -- > true true true false 

2 Bool -- > true true true false 

3 String -- > false false false true 

期待したとおりの結果で、予想外のことは何も起こりませんでした。AnyとAnyObjectでの判定結果は、配列の場合とまったく同じです。

 

実際に試したかったのは、これから先の処理です。Dictionaryに入れたデータをファイルとして保存し、AnyとAnyObjectで違いがあるのか見たかったのです。

以前に紹介した、環境設定機能のライブラリ化でも、Dictionaryの内容をファイルに保存しました。そのコードを、そのまま用います。DictionaryをNSDictionaryにキャストして、writeToFileメソッドで書き出すだけです。

書き出すためには、ファイルの保存場所を指定するパスが必要です。それも加えて、次のようなSwiftコードを、前のコードの後ろに追加しました。

// Dictionaryをファイルとして保存(前のSwiftコードの続き)
let iPathDocs : AnyObject = NSSearchPathForDirectoriesInDomains(.DocumentDirectory, .UserDomainMask, true)
let iPathFile1 : String = iPathDocs[0].stringByAppendingPathComponent("dicAny.plist")
let iPathFile2 : String = iPathDocs[0].stringByAppendingPathComponent("dicAnyObj.plist")
//let iResult1 : Bool = (dicAny as NSDictionary).writeToFile(iPathFile1, atomically:true)
//if !iResult1 { println("ERROR:ファイル書き失敗:Any") }
let iResult2 : Bool = (dicAnyObj as NSDictionary).writeToFile(iPathFile2, atomically:true)
if !iResult2 { println("ERROR:ファイル書き失敗:AnyObj") }

Any側でファイルを保存する2行だけを、コメント行にしてあります。実は、コンパイルエラーが出たので、コメント化したわけです。もう片方のAnyObjectでは、コンパイルエラーも発生せず、実行も正常に終了しました。

Anyでだけ、コンパイルエラーが出たのですが、そのエラーメッセージが意味不明でした。おそらく、何か別な原因でエラーが出ているものの、1行の中に複数の命令が含まれているため、エラーメッセージが正常に出ないと推測しました。ということで、試しに次の行を挿入してみました。

// エラーメッセージを変えるために、前のコードでコメント化した2行の前に挿入
let iNSDic : NSDictionary = dicAny as NSDictionary  // コンパイルエラー

エラーメッセージが変わり、NSDictionaryへはキャストできないことが判明しました。どうやら、Anyを含むDictionaryは、NSDictionaryへキャストできないようです。AnyとAnyObjectでは、is演算子の判定結果だけでなく、いろいろな点で細かな違いがありそうですね。

コンパイルエラーになったので、目的の比較が出来ませんでした。別な方法でシリアライズすれば比較できるのですが、最近は忙しいこともあり、また別な機会にしましょう。

ここまで見てきた結果から推測すると、AnyとAnyObjectには、別な違いもありそうです。それを究明する確約は出来ませんが、やる可能性はあるということで、タイトルを(is演算子編)と括弧付きにしました。でも、あまり期待しないでください。正直、誰かが代わりにやってくれると助かります。

 

簡単な実験でしたが、AnyとAnyObjectで予想外の違いがあり、かなり驚きました。

そもそもAnyObjectには、IntやFloatが入れられないということ(本当?)なのに、コンパイルエラーになりません。何か特別に、自動変換して代入しているのでしょうか。変換して代入しているので、is演算子の判定結果が代入可能という形になっているのでしょうか。疑問は深まるばかりです。

AnyObjectのDictionaryは、XML形式のファイルとして保存できました。それを見る限りは、Intは「integer」型の値として、Floatは「real」型の値として、Boolは「true」または「false」のどちらかの値として、Stringは「string」型の値として保存されています。データ型の違いが、きちんと区別されて保存されているのが確認できました。それなのに、is演算子の結果は期待どおりになっていません。やはり、疑問は深まるばかりです。

原因は不明ですが、実行結果がこうなっている限り、それを受け入れて使うしかありません。入れたデータ型を明確に区別したい場合は、AnyObjectではなくAnyを使うしかないでしょう。

また、今回の実験結果から、仕様確認は非常に重要だと改めて感じました。これからも少しずつですが、SwiftとiOS APIの仕様確認を続けたいと思います。また何か発見したら、ここで紹介するつもりです。

 

ちなみに今回の実験も、いつものようにiOS実験専用アプリで行ないました。実験アプリで作るときは、通常ならラベルへ出力します。しかし今回は、コンソールへの出力を使いました。1回しか実行しないので、実行しながら結果を何度も確認する必要はありません。また、行数の多い処理結果に、ラベルは適しません。このような場合は、コンソールへの出力を使うことが多いです。複数行を表示できるTextAreaなどを用意するより簡単ですから。

今回の実験内容はアプリごと保存できるため、いつでも実行が可能です。XcodeやSDKのバージョンが変わる度に、試してみようと思います。

 

(使用開発ツール:Xcode 6.1.1, SDK iOS 8.1)

2015年1月19日月曜日

ファイル閲覧機能のライブラリ化(本編2+使用例編)

Documentsフォルダのファイル閲覧機能をライブラリ化する話の続きです。前回はTableViewだけを生成したので、残りのUI部品の生成を順番に取り上げます。

 

続きの最初は、ファイル内容を表示するTextViewの生成処理です。見出しテキストと文字数を表示する2つのラベルが付きます。ラベルが付きます。

これらの3つのUI部品は、自分で何か処理するわけではなく、TableViewを操作したときに値を設定されるだけの存在です。そのため、単に生成してUIViewに貼付けるだけです。具体的なSwiftコードは、次のようになりました。

// ================================================== ファイル内容を表示
var txvFileText: UITextView! // ファイル内容を表示
var lblFileSize: UILabel!  // 文字数を表示
 
private func setupTxtViewF() {
    // Label
    let iX : CGFloat = W_MARGIN_LEFT + W_TABLE_VIEW + W_MARGIN_CENTER + 5
    let iY : CGFloat = H_MARGIN_TOP
    let iWidth : CGFloat = 300
    let iHeight : CGFloat = H_LABEL_W_MARGIN
    let lblFileText : UILabel = createLblF("選択ファイルの内容", 18, ALIGN_LEFT, iX, iY, iWidth, iHeight)
    self.addSubview(lblFileText)
    // TextView
    let iX2 : CGFloat = W_MARGIN_LEFT + W_TABLE_VIEW + W_MARGIN_CENTER
    let iY2 : CGFloat = H_MARGIN_TOP + H_LABEL_W_MARGIN
    let iWidth2 : CGFloat = viewWidth - (W_MARGIN_LEFT + W_TABLE_VIEW + W_MARGIN_CENTER + W_MARGIN_RIGHT)
    let iHeight2 : CGFloat = viewHeight - (H_MARGIN_TOP + H_LABEL_W_MARGIN + H_BUTTON_MARGIN + H_BUTTON + H_MARGIN_BOTTOM)
    txvFileText = createTxtViewF("", 12, ALIGN_LEFT, iX2, iY2, iWidth2, iHeight2)
    self.addSubview(txvFileText)
    // Label(文字数の表示)
    let iX3 : CGFloat = viewWidth - (W_LABEL_CHAR_COUNT + W_MARGIN_RIGHT + 10)
    let iY3 : CGFloat = H_MARGIN_TOP + 5
    let iWidth3 : CGFloat = W_LABEL_CHAR_COUNT
    let iHeight3 : CGFloat = 20
    lblFileSize = createLblF("", 14, ALIGN_RIGHT, iX3, iY3, iWidth3, iHeight3)
    self.addSubview(lblFileSize)
}

他のUI部品と同じように、表示位置や大きさを4行で計算しています。それぞれのUI部品の生成は、独自ライブラリとして用意しているグローバル関数を使い、どれも1行で書いています。

 

続いて、処理終了やエラーを伝える、メッセージ欄のLabelです。これも同じで、次のようなSwiftコードとなります。

// ================================================== メッセージ欄
var lblMsg : UILabel!

private func setupMsgF() {
    let iX : CGFloat = W_MARGIN_LEFT
    let iY : CGFloat = viewHeight - (H_MARGIN_BOTTOM + 25)
    let iWidth : CGFloat = viewWidth - (W_MARGIN_LEFT + W_BUTTON_COPY + W_MARGIN_RIGHT + 10)
    let iHeight : CGFloat = 25
    lblMsg = createLblF("", 16, ALIGN_RIGHT, iX, iY, iWidth, iHeight)
    self.addSubview(lblMsg)
}

こちらも、他のUI部品と同じような形で生成しています。この次に紹介するコピーボタンの処理結果を、このメッセージ欄に表示します。

 

最後は、TextViewに表示したファイル内容を、クリップボードへとコピーするためのボタンです。ボタンを生成するための関数と、ボタンをタップしたときに呼ばれる関数の2つを用意します。次のようなSwiftコードで。

// ================================================== ファイル内容をコピー
var btnCopy: UIButton!
let psbFileCont : UIPasteboard = UIPasteboard.generalPasteboard()

private func setupBtnCopyF() {
    // ファイル内容をコピーするボタン
    let iX : CGFloat = viewWidth - (W_BUTTON_COPY + W_MARGIN_RIGHT)
    let iY : CGFloat = viewHeight - (H_BUTTON + H_MARGIN_BOTTOM)
    let iWidth : CGFloat = W_BUTTON_COPY
    let iHeight : CGFloat = H_BUTTON
    btnCopy = createBtnF("選択ファイルの内容をコピー", FONT_SIZE_BTN_S, iX, iY, iWidth, iHeight)
    btnCopy.addTarget(self, action:"copyFileTextF:", forControlEvents: .TouchUpInside)
    self.addSubview(btnCopy)
}
// 選択したファイルの内容をコピーする
func copyFileTextF(rSender:UIButton) {
    if enableCopy {
        psbFileCont.setValue(txvFileText.text, forPasteboardType:"public.text") // クリップボードへコピー
        // 完了メッセージを表示
        zBase.setMsgWTimerF(lblMsg, "クリップボードにコピーしました。", .OK, TIME_I_MSG_OK_S)
    } else {
        // 警告メッセージを表示
        zBase.setMsgWTimerF(lblMsg, "コピー可能なファイルを選んでください。", .Caution, TIME_I_MSG_CAU_S)
    }
}

ボタンを生成するsetupBtnCopyF関数では、他のUI部品と同じように、位置と大きさを計算してから生成関数を呼び出しているだけです。ボタンをタップしたときに呼び出される関数を設定している点だけが異なります。

呼び出される関数では、コピーできるファイルかどうかを調べて、可能ならコピーします。コピーの有無に関わらず、結果のメッセージを表示して知らせます。

メッセージの表示には、数秒後に自動で消えるメソッドを使っています。このメソッドは、共通ライブラリとして作ったもので、以前の投稿「数秒後に自動で消えるメッセージ表示」で紹介しました。消えるまでの時間も、メッセージの役割別に複数用意してあり、その中から選んで使っています。メッセージの表示には、このメソッドを使うので、メッセージ欄のLabelにアクセスする関数を別に用意してはいません。

 

ここまで紹介した全てのUI部品は、生成する関数の形で用意して、最初に取り上げた初期処理から呼ばれます。繰り返しになりますが、このような形式で作ることにより、ソースコードがUI部品ごとに区切られ、読みやすさが向上します。

今回作ったクラスのSwiftコードは、以上で終わりです。必要最低限の機能しか作らなかったので、短いソースコードとなりました。これだけでも実用的には十分ですし、iOSの将来の更新にも対応しやすく配慮してもあります。

UIViewの大きさも、ある程度までですが変更可能で、そこそこですが使いやすくできました。このクラスのインスタンスを生成して貼付ければ、Documentsフォルダの中身が見れるようになります。

 

続いて、このクラスの使い方を紹介します。使うのは非常に簡単ですから、手短に。インスタンスを生成してから、位置と大きさを設定して、使う画面に貼り付けるだけです。操作されたときの処理は、TableViewやボタンに付けられるので、生成後に設定する処理はありません。具体的には、次のようなSwiftコードになります。

// 今回のクラスを、アプリで使う例
...
// アプリの初期処理で、共通ライブラリのインスタンス生成
zBase = BaseFunc()      // 基本機能(メッセージなど)
zFiles = BaseFiles()    // ファイル管理機能を開始
...
// この機能を使うUIViewControllerクラス内で、インスタンスを生成して貼り付ける
...
let viewFileBrows = DocsFileView()       // インスタンス生成
viewFileBrows.setupF(50, 100, 900, 600)  // 初期化(表示位置とサイズを指定)
self.view.addSubview(viewFileBrows)      // 親Viewへ貼り付け
...

今回のクラスは、メッセージ表示やファイル処理で、他の共通ライブラリを使っています。それらのインスタンスを先に生成する必要があります。その生成処理は、アプリの初期処理で行ないます。

このクラスを使うのは、対象となる画面表示のUIViewControllerクラス内です。このクラスのインスタンスを生成して、自分のビューに貼り付けるだけです。

貼り付けた画面を使い終わったとき、UIViewControllerのインスタンスが開放されるともに、このクラスのインスタンスも開放されます。

 

大きさが可変のUIViewなので、作成後のテストでは、いろいろな大きさで表示させてみます。最小サイズで正しく動くかはもちろん、サイズを変えてもバランスが悪くならないかなど、主に使い勝手を試します。

もし使い勝手が悪いと感じたら、レイアウトの変更を考えなければなりません。どこを可変にするのか、計算式が複雑になりすぎないか、などを検討します。

ただし、このような機能は、アプリの本来の処理ではありません。何か問題があったときに調べる処理ですから、使い勝手が少しぐらい悪くても、できるだけ単純なアルゴリズムで作れることを重視すべきでしょう。トラブル時に使う処理がトラブったのでは、シャレになりませんので。

 

以上が、独自ライブラリとして作ったファイル閲覧機能クラスの紹介です。今後は最低限の記述だけで、どのアプリにもファイル閲覧機能が付けられます。

サイズの可変にする場合の注意点、レイアウトを想像しやすい定義値の書き方、親クラス自体の機能を拡張しないサブクラスでの配慮点など、作る際に考えていることをいくつか書きました。共感できた点があれば、自分のプログラムでも使ってみてください。

ここまで書き終えてから、改めて気付いた点があります。UIViewを継承しながら、UIView自体を何も拡張していないので、初期化処理としてinit()を付けませんでした。そのような考えは、何か残さないと気付きませんから、ソースコードにコメントとして残すべきですね。これを書き終わった後で、追加しておきます。

 

(使用開発ツール:Xcode 6.1.1, SDK iOS 8.1)