| アプリケーションサーバ/コンテナ活用編 |
|
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に定義を行います。
| build.xml |
| <?xml version="1.0" encoding="Shift_JIS"?> <project name="project" default="run-strutsdoc" basedir="."> <description>StrutsDocのサンプル</description> <!-- @strutsdoc-0.4.jarをクラスパスとして指定--> <path id="classpath"> <pathelement location="C:\java\jakarta\strutsdoc\lib\strutsdoc -0.4.jar"/> </path> <!-- Astrutsdocというタスク名で登録--> <taskdef name="strutsdoc" classname="strutsdoc.Main" classpathref ="classpath" /> <!-- BSturtsDocを出力するターゲット--> <target name="run-strutsdoc"> <!-- SturtsDocタスク--> <strutsdoc destdir="api/struts" servlet="action" webxml="WEB- INF/web.xml"/> </target> </project> |
SturtsDocの本体である「strutsdoc-0.4.jar」を使用するには、クラスパスの設定を行ってから、taskdefタグにて定義を行います。
なお、Eclipseを使用している場合には、[ウィンドウ(W)]メニューから[設定(P)]を選択して表示される、[設定]ダイアログの[Ant]ツリー選択時に表示される[クラスパス]タブで@の設定と、[タスク]タブでAの設定を行うことができます。この設定を行った場合、build.xmlにはBの設定を記述するだけで十分です。
また、StrutsDocタスクの属性には下記の要素を設定します。StrutsDocタスクの属性の設定値
| 属性名称 | 説明 | 必須 |
| destdir | StrutsDocを出力するフォルダ | Yes |
| webxml | web.xmlの場所を示すフォルダ | Yes |
| servlet | web.xmlの中で定義されているAction Servletの名前 | action以外の場合はYes |
(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を更新するたびに繰り返し生成することが可能で、同期をとることも容易に行えます。
| 「Java TIPS」 |
- 実運用の障害対応時間比較に見る、ログ管理基盤の効果 (2017/5/9)
ログ基盤の構築方法や利用方法、実際の案件で使ったときの事例などを紹介する連載。今回は、実案件を事例とし、ログ管理基盤の有用性を、障害対応時間比較も交えて紹介 - Chatwork、LINE、Netflixが進めるリアクティブシステムとは何か (2017/4/27)
「リアクティブ」に関連する幾つかの用語について解説し、リアクティブシステムを実現するためのライブラリを紹介します - Fluentd+Elasticsearch+Kibanaで作るログ基盤の概要と構築方法 (2017/4/6)
ログ基盤を実現するFluentd+Elasticsearch+Kibanaについて、構築方法や利用方法、実際の案件で使ったときの事例などを紹介する連載。初回は、ログ基盤の構築、利用方法について - プログラミングとビルド、Androidアプリ開発、Javaの基礎知識 (2017/4/3)
初心者が、Java言語を使ったAndroidのスマホアプリ開発を通じてプログラミングとは何かを学ぶ連載。初回は、プログラミングとビルド、Androidアプリ開発、Javaに関する基礎知識を解説する。
|
|






