オブジェクト指向でやる場合の最初から最後までの流れを、実際の例を挙げて書いていくシリーズ「オブジェクト指向で開発の最初から最後までの手順例」
現在、「いままでのまとめ」にある、「(4)フレームワークにもとづき、クラスなどの開発手順、雛形の確定」をやっています。
で、作らなきゃいけない雛形などのうち、現在、「コントローラー」についてやっていて、そのコントローラーのサンプルの、編集型と検索型を作りました。
今回は、それらの仕様書についてです。
■コントローラーの仕様書について
コントローラーの仕様書についてですが、こんなかんじを考えています。
サーブレット名の日本語はそのサーブレットの名前、英語名は実際のサーブレットのクラス名です。
POST/GETは、POST型か、GET型か、どちらも可か(サーブレットでserviceメソッドに記述している)
編集型、検索型は前回までにやったとおり。
呼び出しクラス、呼び出しメソッドとは、
serviceメソッドのなかで、主処理のところを
//==============================// // 主処理:処理を実行する // //==============================// Shohizei obj = new Shohizei(); int kekka = obj.insert(map);
とか、書きますが、このとき、
Shohizeiが呼び出しクラス、insertが呼び出しメソッドにあたります。
で、これだけで、自動生成上は、十分なのですが、あと、備考として、
引数についてと、結果のXMLについてを記述しています。
引数のほうは分かると思います。
結果のほうは、項目名は、項目(タグまたはパラメータ)の日本語名、
タグ名は、<>でくくるタグ名、またはパラメータ名、
タグ/paraは、その項目がタグ名だったら、”タグ”、
パラメーターだったら"para"にしてください。
内容は、その項目の内容です。
で、のこりの「親」ですが、タグの場合は、自分の親となるタグ、
パラメーターの場合はそのパラメーターを含むタグを書きます。
ただし、名称は一意にならないので、左側のNoで親を指定しても
いいです。
ということで、仕様書の雛形も出来たので、
あと自動化するには。雛形ソースを書けばOKです。
このシリーズの次回は、それについてです。