2015年1月14日水曜日

ファイル閲覧機能のライブラリ化(本編1)

Documentsフォルダのファイル閲覧機能をライブラリ化する話の続きです。前回は全体設計まで説明したので、今回は具体的なSwiftコードを紹介します。

 

今回のものは、UIViewのサブクラスとして作ります。また、UITableViewのデリゲートも必要なので、大枠の役目も持つクラスのSwiftコードは次のようになります。

// 今回作るクラス(今回の入れ物:BV_FileView.swift)
class DocsFileView : UIView, UITableViewDelegate, UITableViewDataSource {

}

入れ物だけですから、簡単ですね。

ちなみに、ファイル名は「BV_FileView.swift」としました。独自ライブラリ用の分類コードとして、今までにない分類「BV」の登場です。本当なら「BVC」なのですが、2文字で統一しているために「BV」と短縮しました。「B」で始まる分類コードなので、アプリ独自のSwiftコードではなく、各アプリに共通のライブラリ用Swiftコードだと、ファイル名だけで判別できます。

 

続いてクラスの中身です。最初に、クラス内には定義値を入れます。レイアウトに関係する、余白などの値を定義した変数です。

こうした変数の定義では「定義値の意味を上手に伝える」ことが非常に大事です。データの意味や関係が想像しやすいように、定義値の名前や並べ方などで工夫します。今回は、次のように並べてみました。

// レイアウトに関係する定義値

// 幅の値(左からの並び順)
let W_MARGIN_LEFT : CGFloat = 10     // 左余白
let W_TABLE_VIEW : CGFloat = 260     // TableView(固定幅)
let W_MARGIN_CENTER : CGFloat = 10   // 中央余白
// ここにTextAreaが入る(幅は可変)
let W_MARGIN_RIGHT : CGFloat = 10    // 右余白

// その他の幅の値
let W_LABEL_CHAR_COUNT : CGFloat = 100 // 文字数表示ラベル
let W_BUTTON_COPY : CGFloat = 260      // コピーボタン

// 高さの値(上からの並び順)
let H_MARGIN_TOP : CGFloat = 10        // 上余白
let H_LABEL_W_MARGIN : CGFloat = 30    // 見出しラベル
// ここにTableViewまたはTextAreaが入る(高さは可変)
let H_BUTTON_MARGIN : CGFloat = 10     // ボタン余白
let H_BUTTON : CGFloat = 30
let H_MARGIN_BOTTOM : CGFloat = 0      // 下余白

Wで始まるのが幅(Width)、Hで始まるのが高さ(Height)です。それぞれフルスペルにすると変数名が長くなるので、1文字だけにしました。このように同じ言葉が何度も登場する場合は、1文字に短縮したほうが、コード全体としては読みやすくなりますから。

1つ目のグループは、幅の値を左から右へと並べています。定義しない値もコメント行として挿入し、左右方向での全体構成を想像できるように配慮しました。この構成に含まれない幅の値は、2つ目のグループに入れてあります。

3つ目のグループは、高さの値を上から下へと並べています。こちらも上下方向での全体構成を想像できるように並べていて、定義しない値もコメント行として挿入してあります。

幅でも高さでも、コメント行として挿入した部分が可変する値です。それを示すために、コメント行に「可変」という言葉を入れて表しました。UIViewの大きさを変えると、この部分の値が変わるのだと理解しやすくするためです。

以上のように、全体像が想像しやすい形で定義値を作ると、わざわざ紙に書いて整理する必要がなくなります。ソースコードのテキストエディタ上だけで設計するためには、こうした工夫が欠かせません。同時に、余計なドキュメントが不要なソースコードとして仕上がるメリットも生まれます。

 

続いて、レイアウト関係以外の定義値と、クラスの変数を用意します。次のようになりました。

// クラスの定義値と変数

// TableViewセルのid
let ID_CELL : String = "bvfbCell"

// クラスの重要な値
var viewWidth : CGFloat!   // このViewの幅
var viewHeight : CGFloat!  // このViewの高さ
var aryFName: [String] = [String]()   // ファイル名の一覧
var arySuffix : [String] = ["txt", "plist", "strings", "rtf"] // 内容表示する拡張子の一覧
var enableCopy : Bool = false   // コピー可能なファイルならtrue

ファイル内容を表示するかどうかは、拡張子で判断すると決めました。該当する拡張子は、ここで配列に入れてあります。あまり深く考えていなくて、必要になった追加すればよいと思っています。

 

変数が用意できたので、今度はメソッドです。最初は、初期化から。

サブクラスとして作る場合、親クラスの初期化との関係を考慮して、いろいろと考えるでしょう。しかし、今回のような使い方では、事情が少し違います。親クラスのUIViewをそのまま使っていて、UIView自体には何の拡張も加えていません。UIViewを普通に使い、その上に別なUI部品を追加しているだけです。

このような使い方の場合、サブクラス内では、init()を使った初期化処理は行なわないほうが良いと思います。親クラスの初期化処理をそのまま実行させ、その後でUI部品を追加するという形が、もっとも安全でしょう。もし親クラスで初期化処理などに仕様変更があっても、何の影響も及ぼさないし何の影響も受けないはずですから。

というわけで、init()は作らずに、次のような形で初期化を用意しました。なお、今回の投稿では、私が普段付けている区切り用のコメント行も、ソースコードに含めています。

// ================================================== 初期処理
func setupF(rX:CGFloat, _ rY:CGFloat, _ rWidth:CGFloat, _ rHeight:CGFloat) {
    if (rWidth < 800) { println("ERROR:DFV_STUP:Viewの幅が不足"); return }
    if (rHeight < 500) { println("ERROR:DFV_STUP:Viewの高さが不足"); return }
    viewWidth = rWidth
    viewHeight = rHeight
    self.frame = CGRectMake(rX, rY, rWidth, rHeight)
    // メッセージ欄を作ってから、ファイル名一覧の取得
    setupMsgF()
    aryFName = zFiles.readFNameListF() // ファイル一覧を取得する
    if (aryFName.count < 1) { // ファイルがゼロ個なら終了
        zBase.setMsgWTimerF(lblMsg, "対象ファイルがゼロ個なので、この機能は使えません。", .Error, TIME_I_MSG_LL)
        return
    }
    // ファイル名一覧がOKなら、UI部品を生成
    setupTblViewF()
    setupTxtViewF()
    setupBtnCopyF()
}

処理全体を見ると、自分自身(UIView)の表示位置と大きさを指定して、必要なUI部品を生成しています。

一番最初は、自分自身の大きさのチェックです。最低限の大きさより小さい場合は、エラーメッセージを出して、UI部品を何も生成しません。画面上では空のUIViewが表示されるだけで、コンソールへのエラーメッセージでエラーを知ることになります。

続いて、ファイル名の一覧を得るのですが、その前にメッセージ欄だけは生成します。ファイル名の一覧が空なら(ファイルが1つもないなら)、他のUI部品を生成せずにメッセージだけ出して終了します。この場合は、コンソールにではなく、画面上でメッセージを出しています。そうする理由ですが、Documentsフォルダ内が空なのは、使い方のエラーではなく、あり得る状態だからです。その状態で正常なこともあり得るわけですから、ユーザーから見て状況が知れるメッセージを表示する必要があります。

ライブラリの使い方(プログラム上での使い方)のエラーなら、エラーメッセージはコンソールへ、その他のエラーなら画面上のメッセージ欄へ表示が、私の場合の基本です。

ファイルが1つでもあると確認できたら、UI部品を生成する処理(名前がsetupで始まる関数)を順番に呼び出します。それぞれの具体的な処理内容は後述します。

ファイル名の一覧を得るreadFNameListFメソッドは、ファイル関係の共通ライブラリです。ファイル関係の処理を集め、どのアプリにでも使えるように、独自ライブラリとして作ったものです。これ以降でも、ファイル関係の処理は、すべて同じライブラリのメソッドを使っています。具体的な処理内容は難しいものではないので、ここでは掲載しません。そういう処理が別に用意されていると考えて、処理内容を読み取ってください。

 

続いて、画面上に表示するUI部品の生成処理を1つずつ見ていきます。

その前に、どのUI部品にも共通する書き方を紹介します。それぞれのUI部品の最初には、区切り用のコメント行が付いていて、区切りを明確に表しています。区切りの先頭には、UI部品用の変数が入ります。その後に空白行を1行を入れて、初期化の関数が続きます。このパターンで作ると、UI部品ごとに変数と関数が集まり、ソースコードが見やすく整うからです。

では、最初のUI部品となるTableViewの生成処理を。次のようなSwiftコードになります。

// ================================================== ファイル一覧TableView
var tbvFName: UITableView!

private func setupTblViewF() {
    // Label
    let iX : CGFloat = W_MARGIN_LEFT + 5
    let iY : CGFloat = H_MARGIN_TOP
    let iWidth : CGFloat = W_TABLE_VIEW
    let iHeight : CGFloat = H_LABEL_W_MARGIN
    let lblFileList : UILabel = createLblF("作業場所のファイル一覧", 18, ALIGN_LEFT, iX, iY, iWidth, iHeight)
    self.addSubview(lblFileList)
    // TableView
    let iX2 : CGFloat = W_MARGIN_LEFT
    let iY2 : CGFloat = H_MARGIN_TOP + H_LABEL_W_MARGIN
    let iWidth2 : CGFloat = W_TABLE_VIEW
    let iHeight2 : CGFloat = viewHeight - (H_MARGIN_TOP + H_LABEL_W_MARGIN + H_BUTTON_MARGIN + H_BUTTON + H_MARGIN_BOTTOM)
    tbvFName = createTblViewF(iX2, iY2, iWidth2, iHeight2)
    tbvFName.registerClass(UITableViewCell.self, forCellReuseIdentifier:ID_CELL)
    tbvFName.delegate = self
    tbvFName.dataSource = self
    self.addSubview(tbvFName)
    // 最後のセルまでスクロールさせる
    let iRowCount : Int = tbvFName.numberOfRowsInSection(0)
    if (iRowCount > 0) {
        var pathLastRow : NSIndexPath = NSIndexPath(forRow: iRowCount - 1, inSection:0)
        tbvFName.scrollToRowAtIndexPath(pathLastRow, atScrollPosition: .Bottom, animated:true)
    }
}

どのUI部品でも、表示位置と大きさを指定します。そのための計算式では、単純に変数を代入するだけだったり、複数の変数を加算や減算して求めたりします。どの計算でも同じ形になるように、4つの変数をletで宣言して、その変数に代入する形式で書きました。このように書き方を統一することは、全体での読み取りやすさに繋がるでしょう。

また、4つの変数を使い回しせず、別な4つの変数をletで宣言する形にしています。もしvarで変数を宣言して、以降で使い回しすると、前側の変数を削除するときに、後ろ側も一緒に直さなければなりません。このような手間を生じさせないために、別々のlet変数を用いています。最近のコンパイラーは最適化が優秀なので、letで統一したほうが良いコードを生成しそうですし。まあ、大した差は生じないのですけど。

TableViewを生成して設定する処理では、特別に難しいことをしていません。独自ライブラリのグローバル関数createTblViewFを使ってTableViewを生成し、必要最低限の設定をしているだけです。

ファイル名一覧を生成した後、最後のセルまでスクロールさせています。ファイル名は日付を含んだりして、もっとも新しいファイルが一番下に来ている可能性が高いのです。表示した状態で、それが見えたたほうが使い勝手が良いので、この処理を加えています。なお、念のためにですが、セルの数がゼロでないかをチェックしています。

 

TableViewを使う際には、デリゲートに対応したメソッドを用意する必要があります。生成処理に続けて、次のようなSwiftコードを付けました。

// ================================================== TableViewのデリゲート
// Cellが選択されたとき
func tableView(rTbvFName:UITableView, didSelectRowAtIndexPath rIndexPath:NSIndexPath) {
    let iFName : String = aryFName[rIndexPath.row]
    if checkSuffixF(iFName) {
        let iStr : String? = zFiles.readFileDocsF(aryFName[rIndexPath.row])
        if iStr == nil {
            enableCopy = false
            txvFileText.text = "内部エラー:DFV_TV:選択ファイルの読み込みに失敗"
            lblFileSize.text = "文字数:不明"
        } else {
            enableCopy = true
            txvFileText.text = iStr
            lblFileSize.text = "文字数:" + String(countElements(iStr!))
        }
    } else {
        enableCopy = false
        txvFileText.text = "このファイルは、内容表示の対象外です。"
        lblFileSize.text = ""
    }
}
private func checkSuffixF(rFName:String) -> Bool {
    for iSuffix in arySuffix {
        if (rFName as NSString).pathExtension == iSuffix { return true }
    }
    return false
}
// Cellの選択が外れたとき
func tableView(rTbvFName:UITableView, didDeselectRowAtIndexPath rIndexPath:NSIndexPath) {
    // 将来の仕様変更のために用意(現在の処理は空)
}
// Cellの総数を返す
func tableView(rTbvFName:UITableView, numberOfRowsInSection rSection:Int) -> Int {
    return aryFName.count
}
// Cellに値を設定
func tableView(rTbvFName:UITableView, cellForRowAtIndexPath rIndexPath:NSIndexPath) -> UITableViewCell {
    let iCell = rTbvFName.dequeueReusableCellWithIdentifier(ID_CELL, forIndexPath:rIndexPath) as UITableViewCell
    iCell.textLabel!.text = aryFName[rIndexPath.row]
    return iCell
}

Cellが選択されたときの処理は、選択されたCellからファイル名を得て、登録されている拡張子かどうか調べます。該当する拡張子なら、ファイルを読みにいきます。正常に読めなければエラーメッセージを出し、正常に読めたらTextViewにファイル内容を、Labelに文字数を表示します。また、登録されている拡張子と一致しない場合は、TextViewへのメッセージで知らせます。

ここでは、TextViewやLabelへのアクセスで間接参照を利用せず、値を直接入れています。どちらのUI部品も、ここでしか使わないので、わざわざ間接参照を使いませんでした。このように小さな処理の場合には、間接参照を使わないこともあります。

拡張子を調べる関数checkSuffixFは、NSStringのpathExtensionを使っています。NSStringは機能が充実しているので、SwiftのStringをNSStringにキャストして使うことが多いです。

Cellの選択を外れたときのメソッドは、入れ物だけあって、中身の処理は空のままです。これを付けなくても構わないのですが、あとから仕様変更するときに、わざわざ調べて追加する手間をなくそうと、入れておきました。これを入れても、実害が出るほど遅くならないので入れています。当然ですが、空の状態であることをコメントで表しています。

 

長くなったので、ここで一旦区切ります。続きは、次の投稿にて。

 

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

2015年1月9日金曜日

ファイル閲覧機能のライブラリ化(全体設計編)

今まで作ったアプリには、Documentsフォルダ内のファイルを閲覧する機能を付けました。アプリで作成したデータや、環境設定ファイルなどを、Documentsフォルダに保存しているからです。ファイル閲覧機能があると、どんな状態なのか簡単に調べられ、トラブル発生時に役立つと考えたからです。その機能を最近になって独自ライブラリに加え、どのアプリにも簡単に追加できる形に仕上げました。それを何回かに分けて紹介します。

 

Documentsフォルダのファイル閲覧機能と言っても、作り方は様々です。私が作ったのは、画面の左側にTableViewを配置し、そこにファイル名の一覧を表示させます。その中の1ファイルを選択すると、画面の右側に配置したTextViewにファイルの内容が表示されます。全部を一度に表示できない場合でも、スクロール可能に設定してあるため、ファイルの内容は最後まで見れます。

表示されたファイルは編集できないものの、全体または部分を選択して、クリップボードへコピーする機能を付けています。選択機能はiOSに付属のものを利用して、選択した部分だけコピーする形です。さらに使い勝手を考慮し、ファイル全体をコピーするために専用ボタンも追加しました。

ちなみにクリップボードですが、iOS上ではペーストボードという名前です。しかし、開発したアプリのユーザーの多くがパソコンと併用しているため、アプリが表示する名前をクリップボードで統一してあります。これ以降の説明でもクリップボードで通しますで、ご注意を。

アプリがDocumentsフォルダに保存するファイルはテキスト形式だけなので、該当する形式のファイル名だけをTableViewに表示しています。その中の1つを選択すると、選ばれたファイルの内容をTextViewに表示するという形です。

このように単純な機能なのですが、アプリのDocumentsフォルダの状態が簡単に見れて、iPad実機で何か調べたいときに重宝します。実機のままだと、Documentsフォルダが簡単に覗けませんので。

 

ライブラリ化するために、よく考えて仕様を決める必要があります。まずは、設計方針からです。このような機能を作る場合、画面表示も含めて、いくらでも凝れます。しかし、凝れば凝るほど、iOSが何度も更新されるに従って、互換性が低下する可能性が増します。できるだけ長く、修正せずに済ませられるように、まったく凝らないという設計方針にしました。

具体的には、次のように配慮します。互換性が一番低下しそうなのは、UI部品でしょう。そこで、UI部品は素のまま使い、余計な機能は何も追加しません。TableViewの選択表示も素のまま使い、TextViewの選択機能もそのまま利用します。

実現する形としては、どの画面にでも貼付けやすくしたいので、UIViewのサブクラスとして作ることにします。そうすればUIViewが持つすべての機能が使えるとともに、余計な機能を作らなくて済むため、将来への互換性も高く維持できるはずです。

UIViewではなく、UIViewControllerとして作るという方法もあります。この2つの違いというか使い分けに関して、いろいろと調べましたが、納得できるほどの方法は得られていません。今のところ、画面全体を扱う場合はUIViewControllerを、画面の一部として貼付ける場合はUIViewを用いています。この使い分け方が、それぞれの本来の役割に近い形ではないかと思うからです。今回のものは画面の一部になるため、UIViewを選びました。

 

UIView形式で作るときに問題となるのが、表示する大きさに合わせたレイアウト変更です。指定されたサイズに合わせて、表示するUI部品の大きさも変更しなければなりません。こうしたレイアウトの表示ルールをきちんと決めておかないと、見た目や使いやすさなどが低下してしまいます。

ただし、どんな大きさを指定しても大丈夫に作るのは無理ですから、最初に最低の大きさを決めます。今回の場合は、あえて小さく表示する必要がないため、とりあえず幅が800で高さが500と仮決めしました。このような値は、作成後に使ってみて調整すれば良いでしょう。

次に決めるのが、要素の大きさと配置です。今回のUIViewは配置が決まってますから、各UI部品の大きさだけです。左側のTableViewは、幅を狭くすると長いファイル名が読めなくなるので、幅は固定としました。右側のTextViewの幅だけが可変です。縦方向は、TableViewもTextViewも同じ高さで、両方とも可変です。

その他のUI部品としては、右下にコピーボタンを付けます。TextViewで選択したファイル内容を、クリップボードにコピーするための機能です。さらに、コピーボタンの左側にメッセージ欄を加えます。コピーの成功など、操作結果を知らせるためのメッセージ表示に使います。

あと全体で、余白も付けることにしました。UIViewの境界ギリギリにUI部品などを表示させると、高解像度のモニターで描画が正しくない可能性もあるので、安全のために余白は必須だと思います。

 

境界ギリギリも含めて、描画については少し説明が必要でしょう。iOSの描画機能は、座標をCGFloatで管理し、最終的な表示装置に向けてビットマップ画像を生成します。これが、実は曲者なのです。

すべての線には、描く太さがあります。例として、太さ1(単位の名前は不明:CGFloatの値が1)の黒線を描く場合を考えましょう。描く座標の位置は、値が10の位置とします。解像度が2倍のレチナ・ディスプレイなら、2ピクセル幅の黒線として描かれます。

しかし、解像度が1倍の通常ディスプレイなら、1ピクセル幅の黒線ではなく、2ピクセル幅のグレー線として描かれます。こうなる理由は、描く座標の位置に深く関係しています。座標10の位置は、ディスプレイのピクセルの境目にあります。そこを中心に描くのですから、座標10の位置の両側に、幅0.5の線が描かれる結果となります。しかし、通常ディスプレイの解像度は1です。幅0.5の線は描けず、幅1のグレー線として描かれるわけです。幅0.5の線2本を描いた結果として、2ピクセル幅のグレー線になってしまいます。

逆に、解像度が2倍のレチナ・ディスプレイは、ピクセルの幅が0.5ですから、座標10の両側に幅0.5の線を描くのに適しています。結果として、2ピクセル幅(合わせた線の太さは幅1)の黒線が描かれるというわけです。

以上のように、ディスプレイの解像度の違いにより、また描く座標位置の違いにより、同じ線でも描かれ方は少しずつ変わります。さらに、これがUIViewの境界に接していたら、どうなるでしょうか。考えたくもないですね。描く線の幅にもよりますが、最低でも幅1以上の余白を確保するのが、極めて賢明な選択だと分かるでしょう。

実際には、後から線を太くする変更もあり得るため、その際でも余白の値を変更しなくてよい形に作るべきです。そのためには、もっと多くの余白を確保したほうが安全です。今回は、境界ギリギリまで描く必要がないため、キリのよい値として上下左右とも幅10の余白を付けることにしました。こうすれば、UIView境界の描画を気にする必要はありません。

 

次は、TableViewに表示するファイル一覧に関してです。今まではテキスト形式のファイルだけでしたが、ライブラリ化する以上、それ以外のファイルが存在する前提で考える必要があります。テキスト形式以外のファイルが含まれていても正常に動くのはもちろん、それらが存在することが分かるように作るべきでしょう。

ファイル名の一覧には、別な役割もあります。Documentsフォルダ内のファイル名一覧を表示することは、フォルダ内の状態を見せる意味もあります。表示できないファイルも含めて、フォルダ内にある全部のファイル名を表示したら、それはそれで何かの役に立つでしょう。

ということで、次のような仕様にしました。テキスト形式以外のファイル名も一覧には表示し、テキスト形式ファイルと明らかに分かっているファイルだけ、右側のTextViewに内容を表示します。テキスト形式かどうかは、ファイル名の拡張子で判断します。予め決められた拡張子のファイルだけで、ファイル内容を表示する形です。

 

もう1つ考えなければならないのは、ファイル名一覧の更新機能です。これまで作ったものは、更新機能がありません。表示したときに一覧を表示して、そのまま最後まで使います。

更新機能を付けないのには、理由があります。iOSアプリの場合は、ウィンドウを開いて使い終わったら、消してメモリーを開放するというのがマナーになっています。見終わったら削除し、再び見るときには新たに表示するので、更新機能が不要というわけです。今回も、そのマナーに従い、更新機能は付けないことにしました。

 

ここまでの検討で、全体の仕様が見えてきました。箇条書きで整理すると、次のようになります。

ファイル閲覧機能の大まかな仕様
・UIViewのサブクラスとして作る
・表示サイズをチェックして、最低値より小さいならエラー
・凝った機能は追加せず、UI部品を素のままで使う
・構成するUI部品は以下のとおり
 ・TableView:ファイル名の一覧で、1つを選択可能
 ・TextView:選択したファイルの内容を表示(テキスト形式のファイルのみ)
 ・Button:TextViewで選択したテキストを、クリップボードにコピー
 ・Label:各種メッセージの表示
・レイアウトに関して
 ・上下左右に幅10の余白
 ・横位置の計算:TableViewは固定、TextViewは可変
 ・縦位置の計算:TableViewもTextViewも可変
・実装する機能
 ・ファイル名の一覧を、TableViewに表示する(オープン時に自動で実行)
 ・TableViewで選んだファイルの内容を、TextViewに表示する
 ・TextViewの表示内容を、クリップボードにコピーする

今まで作ってきたクラスとは異なり、用意したメソッドを呼び出して動かす形ではありません。最初に表示した状態で、それぞれのUI部品に機能を割当てます。UI部品が操作されたときに、割り当てられた機能が実行されるという形です。

こうした形なので、仕様では「メソッドの一覧」の代わりに、「実装する機能」としてまとめました。

 

ここまで仕様が固まると、あとは作るだけです。しかし今回は、過去のアプリ内で作ったSwiftコードがあります。それを使えば、最初から作るよりは、はるかに簡単です。

UIViewのサブクラスとして作るわけですから、全体の大枠は変わります。でも、ソースコードの多くは、該当する箇所へコピーして使えました。仕様が変わった部分だけ手直しして、変更も意外に早く終わりました。いったん作ったものなので、構成を変えるだけだと簡単ですね。

次回の投稿では、そのSwiftコードを取り上げます。

2015年1月5日月曜日

当ブログの中心は、アプリ開発の設計視点

当ブログにおける今までの投稿をほとんど読んだ方なら、他のブログとは違った視点から書かれていることに、お気づきだと思います。今回は、その辺の話を少し書いてみます。

 

世の中には、ブログだけでなく雑誌も含め、プログラミングに関する多くの情報が出回っています。また、新しい情報が次々の加わってもいます。それらの情報をたくさん手に入れたら、アプリ開発が上手になるのでしょうか。

残念なことですが、非常に重要な要素が欠けています。アプリ開発において一番重要かもしれない、全体設計の話です。アプリの大まかな構造をどのようにして導きだすのか、どんな点に注意して設計すれば良いか、どのような視点でアプリを改良するべきか、といった話です。残念なことですが、そのような情報はほとんど(まったく?)出回っていません。

ちなみに、ブログや雑誌で扱っている主な情報を挙げると、次のようになります。

世の中に出回っている主な情報
・開発ツールの操作方法
・プログラミング言語の説明
・目的の機能を実現するためのソースコードと解説
・設計の小技(デザインパターンなど) 
・オブジェクト指向などの基礎的な考え方

これらに該当する話は、検索すれば数多く見付けられます。また、どんどんと新しい内容に更新されてもいます。しかし、より上位の設計の話は、ほとんどないのが実状です。

 

ソフトウェア設計の技というと、最近ならデザインパターンを思い浮かべる人が多いと思います。デザインパターンを短い言葉で表現するなら、オブジェクト指向ならではのクラス構成術というのがピッタリでしょう。

デザインパターンも、ソフトウェア設計には含まれますが、アプリ全体の設計を考えるレベルの設計術ではありません。もっと細かな機能を、オブジェクト指向的に作るためのパターンです。あえて最良と書かずに、オブジェクト指向的と書いたのは、それが別な視点で見たとき、最良の設計とは限らないからです(この辺の話は、機会があれば詳しく書きます)。

けっして、デザインパターンが不要だと言っているのではありません。それよりも上位の設計術が大事で、その設計内容に従った形で、デザインパターンが使われるということです。投稿「雑誌などのソースコードは再構成して使う」で書いたように、私の分類では3番目に位置するのがデザインパターンです。

変更への柔軟性や、再利用を重視したソースコードを作る視点(再掲載)
1. 機能の切り分け(インターフェースの標準化も含む)
2. 間接参照を多用する
3. オブジェクト指向の利点を利用する(デザインパターンも含めて)

この3段階の視点は、アプリ設計における重要な順番で並べてあります。このうちの上位2つが、このブログで中心に置いている視点です。

 

ただし、この上位2つの視点も、当ブログが重視している視点の結果でしかありません。もっと基本的な視点により、アプリ開発の重要点をノウハウ化しようと努力しています。具体的な視点を挙げると、次のようになります。

ブログで取り上げている重要な点
・どのような視点で設計しているのか?
・どんな点に注意しながら設計すれば良いのか?
・設計の質を高めるには、どうすれば良いのか?
・トラブルを未然に防ぐためには、どんな点に注意すべきか?
・メンテしやすい設計とは?
・ユーザーが安心して使える設計とは?

思いつくまま挙げたので上手に整理されていませんが、言いたいことは伝わると思います。全体としては、アプリ開発における、より上位の視点を集めたものと言えるでしょう。

 

視点だけが良くても、書く内容の質は高められません。やはり、書き方も重要です。できるだけ役に立つ内容に仕上げようと、次のような点を心掛けています。

書くときに注意している点
・どんな点を考えて設計しているのかを、一番重視して書く
・細かな考慮点も、できるだけ取り上げる
・考えられる選択肢を列挙して、判断基準や選択結果を示す
・仕方なく選択した点なども、その理由とともに判断過程を説明する
・最終的には、ソースコードとして仕上げる
・示したソースコードに仕上げた理由も、できるだけ説明する
・開発資料(API資料やサンプルコードなど)の問題点やその対処方法も取り上げる
・調べれば簡単に分かる内容(APIの基礎的な使い方など)の説明はできるだけ省く

すべて出来ているとは言えませんが、私としては頑張って書いているつもりです。

 

以上のようなことを考えながら、このブログを書いています。時間の制約もありますし、伝えるのが難しい内容だけに、どれぐらい書けているか(読み手にも影響を受けますが、どれぐらい伝わっているか)は、少し不安を持っています。それでも、書ける範囲内で書き続けていたいと思います。同じ方向性のことを書いている人が、ほとんどいませんので。

 

アプリ開発で何が大事かは、作る人によって違うでしょう。もし当ブログで書いてある内容に共感できるなら、役立つ情報(しかも他では得られにくい情報)が数多くあると思います。どんどんと吸収し、自分なりのノウハウとして改良しながら、活用してください。