Strutsの設定ファイルから仕様書を生成する：JavaTips 〜Apache／Jakarta編

　struts-config.xmlは、Strutsアプリケーションの動作を規定する、コアともいえる設定ファイルです。Strutsアプリケーションの仕様書といってもよいでしょう。StrutsDocを利用すれば、このstruts-config.xmlに記述されている内容を、あたかもJavadocで生成したような形式で出力できます。

　なお、執筆時点のバージョンのStrutsDocは、Sturts 1.1だけをサポートしており、Antのタスクとして提供されています。

操作手順

（1)StrutsDocの入手

　SturtsDocは、SourceforgeのStrutsApplicationsのページからダウンロードできます。ダウンロードのリンクから、その時点での最新バージョンを入手してください。ここでは、strutsdoc-0.4.zipを使用します。

（2）StrutsDocの準備

　次に、入手したファイルを展開します。本稿では、「C:\java\jakarta\strutsdoc」に展開したものとします。StrutsDocは、Antのタスクとして提供されているので、Antの設定ファイルであるbuild.xmlに定義を行います。

　SturtsDocの本体である「strutsdoc-0.4.jar」を使用するには、クラスパスの設定を行ってから、taskdefタグにて定義を行います。

　また、StrutsDocタスクの属性には下記の要素を設定します。

（3） StrutsDocの実行

　では、Struts 1.1に添付されているサンプルである「struts-example.war」を例に、試してみましょう。run-strutsdocターゲットを指定して、Antから実行します。

StrutsDocの実行 （クリックすると拡大）

　Eclipseの場合、コンソール上に「BUILD SUCCESSFUL」というメッセージが表示されます。また、api配下にstrutsフォルダが作成されていることを確認します。

（4） StrutsDocの出力結果

　api配下のstrutsというフォルダ内に「index.html」というHTMLファイルが作成されているので、ブラウザで開いて中身を確認します。

　このHTMLファイルの中身は、3つのフレームから構成され、左上がモジュールの選択項目、左下にはActionやActionFormなどのコンテンツがフォルダ形式で表示されています。任意の設定をクリックすると、右側のメインウィンドウにその詳細が表示されます。

LogonFormの内容を表示

　このように、XMLで記述されているため理解しづらい「struts-config.xml」の内容を、Action、Form Beans、Forwards、Message Resources、Plug-Insというカテゴリごとに分類された、JavaDocライクな表示で確認できるようになります。

　なお、StrutsDocはAntのタスクなので、struts-config.xmlを更新するたびに繰り返し生成することが可能で、同期を取ることも容易に行えます。