2014年11月29日土曜日

業務アプリはデータ保全が一番大事

業務で使用するアプリの開発は、一般的なアプリと少し違うと思います。少なくとも私は、違うと考えて開発してます。どのような点を重視しているのかというと、入力したデータを可能な限り守ることです。iPadという環境なので大したことはできませんが、できないながらも工夫した点を紹介します。

 

アプリを仕事で使うということは、仕事上のデータを扱うということです。扱うというと抽象的なので、もっと具体的に言うと、仕事上のデータを入力して保存して活用するということです。こうして入力したデータは、会社の財産です。そのため、入力されたデータが失われないことを、業務アプリでは一番重視しています。

データを保存する場所としては、RAMメモリー内よりもフラッシュメモリー内のほうが格段に安全です。RAMメモリー内なら、アプリが異常終了したときに、データが失われてしまいますから。こうした理由から、データを入力した直後に、ファイルへ保存する形で作っています。iPadのファイルはフラッシュメモリー内に保存されるため、機械的なアクセスもなく、ハードディスクよりも安全で高速です。

毎回保存されるのを気にするかもしれませんが、タップ操作でアプリへ入力するデータの量などは、たかが知れています。圧縮などせずにテキストで保存したとしても、データ量が少なく、一瞬で書き出されます。

 

ファイルへ書き出す場合にも注意が必要です。もし書き出し中にエラーが発生したら、そのファイルは正常に読めなくなるかもしれません。もし読めたとしても、途中までのデータしか残っていない可能性があります。

書き出しに失敗した場合を考慮すると、毎回異なるファイル名で書き出し、どんどんと追加する方法もありますが、ファイル数が増え過ぎて現実的ではありません。同じファイル名に書き出しながら、失敗へのリカバリー方法も考慮するという手段が現実的でしょう。

最初に考えたのは、仮のファイル名で書き出し、書き出しが成功したら本来のファイル名に変更する方法でした。でも、先にあったファイル(つまり前回に保存したファイル)を、どう扱えば良いのか悩みました。そして次のような方法を採用しました。

保存するファイル名は毎回同じで、新しく入力したデータを後ろに追加してから保存します。同名の古いファイルは、旧版として過去3世代ほど残しておく方法です。

過去3世代が残っている状態だと、最新ファイルに加えて、old1、old2、old3という3個のファイルが存在することになります。その状態で新しく保存する場合、具体的な実行手順は次のようになります。

3世代を残しながら更新する手順
・old3ファイルを削除する
・old2ファイルをold3に改名する
・old1ファイルをold2に改名する
・最新ファイルをold1に改名する
・新しい最新ファイルを書き出す

oldが存在しない状態(使い始めたときの状態など)もありますから、個々の処理では、改名する前に存在を確認し、存在すれば改名するという形になります。

 

過去3世代のファイルを残しておいても、書き出しが失敗したとき、元に戻す機能がないと無駄です。リカバリー処理の1つとして、過去3世代を1つずつ戻す処理が必要となります。具体的な実行手順は次のとおりです。

旧3世代を1つずつ戻すリカバリー処理
・最新ファイルが存在すれば削除する
・old1ファイルを最新名に改名する
・old2ファイルをold1に改名する
・old3ファイルをold2に改名する

これらでも個々の処理では、改名する前に存在を確認し、存在すれば改名するという形になります。

リカバリー手順は以上で構わないのですが、最新ファイルの書き出しに失敗しているか調べる方法が必要となります。最終的には、人の目で確認するのが一番でしょう。最新ファイルだけでなく、old1〜old3も含めて、中身を見れる機能も用意しました。

通常の作業で、これらのリカバリー処理を使うことはありません。アプリが突然と異常終了したとか、入力後の保存処理で成功メッセージが出なかったときなど、普段と違う表示になったときに利用するものです。調べる手順などをヘルプに書いておき、そのヘルプを読みながら、リカバリー処理を進めるという形にしてあります。

一番長く使われている業務アプリでも、Titanium mobile時代も含めて3年ぐらいしか経過してませんが、異常な状態になったことは一度もありません。そのため、これらリカバリーの処理は何度もテストしましたが、まだ本番では一度も使われたことがないのです。良いことといえば、良いことなのですが。

 

アプリのトラブルは、データ入力時に起こるとは限りません。予想もしないトラブルが、突然と発生することも考えられます。たとえば、iPadの調子が悪くなって、どのアプリも不安定な動きになったとかです。こんな状態だと、いつiPadが起動しなくなるのか不安でしょう。真っ先にすべきことは、iPad内の重要なデータを、他のマシンにコピーすることです。

iOSのアプリでは、Macと接続したとき、iTunesでバックアップが取れるようになっています。その際、アプリ側の設定で、iTunesからアプリの保存ファイルが見えて読めるようにもできます。Info.plistファイルの項目で、「Application supports iTunes file sharing」を追加してYESに設定するだけです。こうしておくと、もし近くにMacがあれば、iPadと接続して全ファイルをコピーできます。

近くにMacが無い場合も考慮し、ファイルを添付して送信できるメール機能も追加しました。ファイル一覧をテーブルビューに表示し、添付したいファイルを選んで、他のマシン宛に送信するだけです。

毎日使われている業務アプリでは、この送信機能を通常業務としても利用しています。iPadで入力した業務データは、1日単位でファイルに保存されています。それをメール機能でMacに送信し、Mac側の表計算アプリに取り込んで、業務分析などに利用しているのです。メール機能を付けたために、iPad側は入力中心になってしまいました。将来的な話ですが、iPadがパソコン的に使えるようになったら、分析業務もiPadでやりたいそうです。その前に、クラウド上の表計算機能が使えるようになって、iPadとクラウドだけで十分になりそうですけど。クラウド側だと、バックアップとしても安心ですし。

ちなみに、業務アプリ開発の相談を受けた場合、最初に提案するのがサーバーを立てて、iPadからはウェブブラウザで使う形です。クライアント側のOSやアプリに依存せず、サーバー側だけでシステム更新が可能だからです。でも、パソコン上の表計算アプリでバリバリとデータ解析するような人は、サーバーを立てずに、iPadで入力専用のカスタムアプリを使いがるようです。主に小さなお店のオーナーですけど。

 

アプリ側のトラブル対処機能だけでは、十分な安定性を確保できません。動作環境であるiPadの使い方も、安定性が増すように注意する必要があります。iPad環境をどのように整えたら良いのか、アプリ内のヘルプとして記述しました。

その内容は、一般的なパソコンの注意点と同じです。余計なアプリを、できるだけインストールおよび起動しないこと。フラッシュの空き容量を十分に確保すること。アプリは何日も連続して使えるように作ってありますが、できれば毎日の業務終了後にアプリも終了し、1日1回は再起動してクリーンな状態で使うこと、といった具合です。こういう大事な点を知らせておくと、余計なトラブルを起こさずに済みます。

iPadのように、部品のほとんどが電子化されている機器の場合は、初期不良を除くと、あまり壊れないのではないでしょうか。機器の故障よりも、落下させたなどの人為的なミスで壊れる可能性が高いでしょう。それも、iPadにカバーを付けることで、大きく壊れることは防げます。機械的な破損の場合は、液晶画面が割れたまま動き続ける可能性もあり、その状態でならデータをコピーできます。そういった面も含め、データを守ることの大切さをユーザーに伝えることも、大事な仕事ではないかと思います。

 

アプリが異常終了してもデータを守る話を書きましたが、そもそもアプリが異常終了しないように作るのが大前提です。アプリが安定して動作するように、トリッキーな作り方を避けるのはもちろん、動作が少し遅くなっても構わないので、安全な作り方を選択するように心がけています。また、iOSアプリの基本ルールである「使い終わった画面は終了してメモリーを開放する」という形で、メインメニュー以外の画面を作っています。

おかげさまで、データを失うようなトラブルは、まだ起こっていません。「手を抜かないで真面目に作っているほど、安定して動く」という、先人の言葉を参考にしながら開発しています。

2014年11月27日木曜日

swiftの変数は、積極的に型宣言してます

swiftの変数宣言には、型推論の機能が備わっています。代入する初期値の型により、自動的に変数の型が決められる機能です。これを利用すると、変数宣言のときに、型宣言を付ける必要性が大きく減ります。ソースコードを少しでも短く簡潔に書きたい人には、喜ばれる機能だと思います。

しかし、私は、できるだけ型宣言を付ける方針でコーディングしています。StringやIntのように基本的な型なら省略することもありますが、それ以外の型では、可能な限り型宣言を付けています。その理由を、少し書きます。

 

変数宣言で型も一緒に宣言するのは、iOSのAPIに含まれる様々な型を明示するためです。私の場合は、よく使う機能を独自ライブラリの形で作るので、細かなAPIを覚えることがほとんどありません。もちろん作るときには、おそらく他の人よりも詳しく、ウェブ上のAPI資料を見ます。でも、ライブラリとして作り終わると、ライブラリ内の関数またはメソッドを呼び出すだけなので、個々のAPIの処理内容はすぐに忘れてしまいます。覚える気も最初からありません。だからこそ、忘れても構わないように、後から思い出しやすい形でコーディングしているわけです。

APIに含まれる型を変数宣言に入れると、変数の型で検索しやすくなります。そのため、後で機能を拡張したい時や、バグが発生したときに調べやすくなります。完全に忘れてしまっても大丈夫です。

 

加えて、複数のメソッドを連続して書くのではなく、途中に一時的な変数を挿入するようにもしています。その変数はletで宣言し、変数の型も宣言に含めます。型を指定して途中に変数を使うと、自分が正しく理解しながらコーディングしているかの確認にもなります。swiftは型チェックが厳しい言語なので、間違っているとコンパイラーがエラーを知らせてくれるからです。

APIの中身に詳しくないまま自動変換を使っていると、コンパイルエラーが消えないとか、コンパイルは通ったものの、実行させると正常に動作しないといった状況が生じることもあります。原因を探るために、途中に変数を入れたりするでしょう。

ところが、最初から途中で変数を使い、しかも型宣言までしていると、その変数が何の型なのかは明白です。たいていは実行前にコンパイルエラーとなり、自分の理解が間違っていることを知ることができます。API資料を見直して、正しく理解する作業に移れます。無駄な実行や、遠回りのデバッグを大きく減らせる手段でもあるのです。

最近のコンパイラーは最適化の機能が凄いので、途中に変数を入れても遅くなりません。もし遅くなったとしても、通常の動作に影響するほどは遅くなりません。安心して、途中に変数を入れています。

当たり前のことですが、変数の型が正しいだけでは、処理内容をきちんと理解していることにはなりません。でも、変数の型すら間違っているなら、正しい理解の最低限もクリアーしていないことを意味します。変数の型が正しいのか確認することは、最低限をクリアーしていることの確認でもあります。

途中に変数を入れる目的は、もう1つあります。将来、自分以外の開発者がアプリをメンテする可能性を考慮しての判断です。メンテできる開発者を少しでも増やすには、処理内容が理解しやすいコーディングが欠かせません。途中に変数を入れて、その型を明示することで、APIの内容を解析しやすく仕上げられます。メンテする必要が生じたとき、優秀な開発者を確保できるとは限りませんから。

 

iOSのAPIには、中身は同じなのに型が違うものが数多くあります。StirngとNSString、FloatとCGFloatなどは分かりやすい例でしょう。これらの型は、同じように見えても、使えるメソッドなどが違っています。NSStringにはdoubleValueメソッドがあり、Doubleに変換するのが便利といった具合に。違いを知って、上手に使い分ける必要があります。

これらとは違って、中身が分かりにくい型もあります。NSTimeIntervalの中身がDoubleというのはAPI資料を見ないと知り得ません。きちんと理解してコーディングするためには、NSTimeIntervalの中身がDoubleと知っておくのがベストです。中身の型が違っていると、自動的に変換してくれなかったり、変数の種類による精度の違いからバグが生じたりもします。

余計なトラブルを事前に避けるためには、中身の型を意識しながらコーディングし、中身の型ができるだけ見えるような形で途中の変数を使います。この場合、途中の変数が基本的な型であっても、変数宣言の中に、あえて型宣言を入れます。または、明示的にキャストを使ったりもします。

 

私の勝手な推測ですが、swiftの開発者は、厳密な型宣言や型チェックを重視したかったのではないでしょうか。Optionalなんかも、その一環と思えます。でも、それだけだと、ものぐさな開発者(失礼)に見向きもされないため、仕方なく型推論の機能を付けたのではないかと。それは現実的な解であり、選択肢が多いほうが良いだけに、何の文句もありません。

私のように、どんなに注意深く実行しても人間はミスすると思っている人は、可能な限り多くのことをコンパイラーに頼ります。変数の型を積極的に宣言するコーディング方法は、そのための一番の方法だと考えています。実際に何度も、実行前にミスを見付けてもらっています。今後も、変数宣言に型を入れ続けるでしょう。

 

私の開発スタンスは、APIの細かな名前などは基本的に覚えない(もちろん大まかな仕組みは理解しておく)、忘れても思い出せるようにコーディングするというものです。それを実現するためのコーディングとして、途中で挿入する変数を増やし、その変数宣言で型を明示するようにしています。

このようなスタンスは、覚えるのが苦手な人にも適していると思います。自分に向いているスタンスだと感じた方は、swiftでも積極的に型宣言しましょう。

2014年11月20日木曜日

管理しやすい分類情報付きファイル名を使おう

アプリを開発するとき、ソースコードだけでも何個ものファイルを作るでしょう。その名前(ファイル名のことですが)を、どのように付けていますか。機能を表す言葉を名前に付けるのは当然として、他に何か工夫してますか。

アプリの規模が大きくなるほど、ソースコードのファイル数が増えます。多くなったファイルを管理するために、どのような工夫ができるでしょうか。いろいろな工夫が考えられる中、今回はファイル名を使った工夫を取り上げてみます。

実は今まで、ファイル名の命名ルールに関してだけでも、何度かの改良を加えてきました。使用するOSや言語や開発ツールによっても異なるため、次々に良くしていったわけではなくて、使用環境ごとに合わせながら変えてきたわけです。ここで紹介するのは、Xcode+swiftという開発環境に合わせた工夫です。それでもオブジェクト指向の言語に共通する工夫だと思いますから、考え方は参考になるでしょう。興味のある方は読んでください。

 

ファイル管理のために、ソースコードのファイル名を工夫する方法では、ファイル名に分類情報を含めることで実現します。分類情報といっても、難しいことではありません。私の場合は、大まかな種類を示すために、先頭の2文字に役割を持たせるのが中心です。

具体的には、ファイル名の先頭に2文字の略号を加える方法で実現しています。実際に使っている略号は、今のところ、以下の5種類です。

// ファイル名の先頭に付ける主な分類情報
・AC:特定の条件(装置など)に依存する共通ライブラリのクラス(複数アプリで利用)
・BC:共通ライブラリのクラス(複数アプリで利用)
・BP:共通ライブラリの関数や定義値など(複数アプリで利用)
・MC:アプリで使うモデルのクラス
・VC:アプリで使うビューのクラス

見て分かるように、上から3つが自作の共通ライブラリで、どのアプリにでも使えるように作っています。何かのアプリを開発し始めたとき、必要なものを選んでプロジェクトに追加します。もちろん、開発途中に追加することもあります。

「BC」は、日付処理やファイル処理といった共通機能を、クラスとして実現したライブラリです。続く「BP」は、クラス以外の形で実現した共通ライブラリです。UI部品の生成関数や、目的別の色定義など、どのアプリでも使いそうな内容を入れています。

「AC」は、どのアプリでも共通に使えるライブラリの中でも、特定の装置に依存するとか、特定の環境だけで動くとか、何かの条件があるものが対象です。以前に紹介した、小型プリンタRoltoを制御するクラスなどが、この分類に入ります。

下から2つが、アプリごとに作成するクラスです。「MC」は、扱うモデルごとに作るクラスで、「VC」は、表示する画面ごとに作るクラスです。複数のモデルを使って、印刷用のレイアウト画像を生成するクラスなどは、「MC」に入れます。

5つのうち4つが、クラスとして作成するソースコードです。各ソースコードの中には、大きなクラスだけでなく、関連する小さなクラスも入れます。小さなクラスを独立したファイルとして保存すると、数が急激に増えてしまいます。それが嫌いなので、ファイル数を増やさないようにと、関連するものは一緒に入れています。

 

先頭に略号を付けるという話だけでは、どんな感じなのか想像しづらいでしょう。ということで、実際のファイル名に使った場合の例を挙げてみます。長くならないように、一部を抜粋した感じのファイル名一覧です。

// ファイル名一覧の一例(抜粋版)
・AC_Print_Net.swift
・AC_Print_Rolto.swift
・BC_Date.swift
・BC_DrawCG.swift
・BC_Files.swift
・BP_Base.swift
・MC_Pref.swift
・MC_Products.swift
・MC_Sales.swift
・VC_Env_Brows.swift
・VC_Env_Manag.swift
・VC_Main.swift
・VC_Pref_Edit.swift
・VC_Prod_Edit.swift
・VC_Sales_Brows.swift
・VC_Sales_Edit.swift
・VC_Sales_Graph.swift
・VC_Sales_Input.swift

見てのとおり、ファイル名を並べただけでも、きっちりと分類されている感じに見えます。また、先頭に付けた略号の変わり目では、非常に弱くですが、水平の区切り線があるようにも見えます。もちろん、そのような効果も狙っての命名ルールなのです。

先頭の略号に続けて、半角のアンダースコアを入れています。この1文字が、全体を見やすくするとともに、区切り線が見えるようにもしているのです。ファイル名の中に入れた2番目のアンダースコアも同様で、言葉の区切りを明確に見せています。

 

ファイル名の付け方では、先頭の略号以外にも、いくつかのルールを決めています。まず、名前を長くしないことです。短くて内容が推測できるように、長い言葉は略して付けるように決めています。

先頭の略号以外では、2段階の分類としての役割を持たせています。とくに画面ごとのクラスは、同じデータを扱いながら、入力用や閲覧用やメンテ用などの複数画面を作ります。それらの画面を区別しながら、同じデータを扱うことも表さなければなりません。扱うデータの種類を中分類に、役割の違いを小分類として命名すれば、先頭の略号を大分類として、3段階の分類階層が実現できます。

こうした階層による分類は、Xcode以外でファイルを扱うときにも役立ちます。Xcodeのプロジェクト上では、好きな並び順に動かせますが、Finderなどのファイル管理ソフト上では、ファイル名による並び順に変わります。そんなときも、階層で分類したファイル名なら、きっちりと区分けされた形でファイル名が並ぶのです。オープンダイアログでも同じで、探しているファイルが見付けやすくなります。

3階層の分類を使うのは、おもに「AC」と「VC」です。「AC」では、中分類に「Print」と付けることで、印刷関係のクラスだとが表現できます。「AC」での中分類は、共通ライブラリとして決まった言葉を用いることが大原則です。もう一方の「VC」では、中分類にモデルの種類を付けることで、1つのモデルを扱う複数画面を1つに束ねられます。また、どの「MC」と関係しているのかも明確に表せます。複数のモデルを扱う「VC」の場合は、複数のモデル名を短縮して、中分類に入れることになります。

複数ある「VC」の中でも、「VC_Main」だけは特別です。名前から分かるように、最初に表示される画面です。最初に表示されるわけですから、アプリ全体に関係する初期処理なども入れます。また、アプリで使う共通の定義値なども宣言します。これらを別に分けても構わないのですが、メイン画面に入れることで、初期処理中に何か重大なトラブルがあった場合に、トラブル内容の細かな表示が作りやすいメリットが生まれます。

今までやったことはないのですが、外から持ってきたソースコードのファイルを追加する場合のルールも決めています。そのようなファイルは名前を変えずに、元のまま追加するだけす。先頭の略号が付いていないことで、自分が作成したソースコードではないと区別できます。また、元のままのファイル名を残すことで、どこから来たのか探しやすくもなります。

 

先頭に付ける略号が、今の形に決まるまでは、何度か変更がありました。XcodeとSwiftを使ってアプリを作っていく中で、前に使っていたルールを変更しながら、今は上記の形になりました。つい最近のことです。

少し前までは、「AC」と「BC」の区別はなく、どちらも「ZC」としていました。また「BP」は、「ZZ」としていました。「Z」で始まる言葉が少ないので、ライブラリは「Z」で始めるのは良いかなと考えてのことです。でも、先頭に付ける略号なので、一般の言葉との重複を気にする必要はないと考え始めました。そこで、「Base」の頭文字を使った「B」に落ち着いたという流れです。「B」から分離した「A」は、名前でソートしたときに「B」の近くに並ぶ言葉を探し、思い浮かんだ「Add」の頭文字から取りました(深い意味はありません)。

このブログの何回か前に、「ZZ_Base」という記述が出てきたと思います。今は「BP_Base」に変えています。ようやく今回の形で、一応落ち着いたかなという感じですね。今後は、大きく変えないでしょう。略号の追加はあると思いますが。

 

Xcode上で作るswiftソースコードのファイル名は、クラス名と同一にする必要はありません。それよりも、自分が使いやすい(または管理しやすい)名前をつけることで、間違いを少しでも減らしたり、再利用する際に扱いやすくするほうが大事でしょう。そのような視点でファイル名の付け方を考えると、いろいろなアイデアが出てくるのではないでしょうか。この機会に、ファイル名に加える分類情報を考えて、自分なりに扱いやすい命名方法を見付けてください。