Develop/lifecycle

開発手順

以下では、開発ライフサイクルにあわせて、開発およびテストのやり方を簡単に解説します。

ソースの取得

次のコマンドを実行することで、dev.tyzoh.jp 上のソースコードリポジトリから、最新のソースコードを取得できます。

cd 適切な作業ディレクトリ
mvn checkout http://dev.tyzoh.jp/svn/mcodepf

すると、このコマンドを実行したディレクトリ直下に mcodepf というディレクトリが新たに作成されます。このディレクトリが、今後開発していくためのベースディレクトリになります。
なお、この手順は、通常、最初の一度だけ行えば、その後は必要ありません。2回目以降は、次のコマンドで、ソースコードリポジトリ上の最新データを取り出します。

svn update

編集

ソースコードを編集するツールには特に制約はありません。vi でも emacs でも Eclipse でも、好きなツールを使ってください。

メインのソースコードは src/main/java 以下にあります。また、単体テスト用のソースコードは src/test/java 以下にあります。適切に追加・編集・削除してください。

なお、単体テスト用のソースコードを追加・削除した場合、pom.xml の <testIncludes> への追加・削除も忘れないで下さい。

プロパティファイル

マルチコードプラットフォームではXMLで記述したプロパティファイルを複数指定できます。開発環境・テスト環境では、次のプロパティファイルを利用します。

ファイル名説明
src/main/config/mcode-conf.xml本番で、そのまま使用される開発環境定義です。

コンパイルとJavadoc

次のコマンドを実行することで、コンパイルされます。

mvn compile

エラーが出たら、修正して、リトライです。

なお、大幅にソースコードを修正した場合など、中間成果物(*.classなど)とソースコードとの整合性が取れなくなる場合があります。その場合、次のコマンドを実行して、中間成果物をクリアしましょう。

mvn clean

コンパイルが成功したらJavadocも作っておきます。

mvn javadoc:javadoc

この時点で警告などが出ないか、また、ブラウザで表示してみて、自分の意図どおりに表現できているか、確認しましょう。

単体テスト

次のコマンドを実行することで、単体テストプログラムがコンパイルされます。

mvn test-compile

エラーが出たら、修正して、リトライです。

一通り、コンパイルができたところで、Tomcat や AXIS に対しデプロイしたり、必要なサービスを起動したりします。そのために、次のコマンドを用います。

コマンド 説明
ant wsdd.deploy Web Service(SOAP) の定義を AXIS に登録します。
ant wsdd.undeploy Web Service(SOAP) の定義を AXIS に登録解除します。
ant release Web Service(SOAP) の実行モジュールを AXIS に反映します。
ant run.service RwThreadManager、および、EventNotificationServiceの起動

(※) マルチコードプラットフォームの開発環境に適したテストのためのスクリプトは Ant を使って記述しています。Maven は定型的な開発とテストをするには大変優れたツールですが、特定な開発環境に依存したテストには小回りがききにくいのが弱点です。Maven が十分に育つまでは、Ant と Maven を使い分けるのが正しい姿のようです。

"ant run.service" を実行すると、二つのコマンドプロンプトが起動され、それぞれ、RwThreadManager(XML形式のTCP/IPデータ読み込み)、および、EventNotificationService(UDP/IPデータ読み込み)が動作しています。 これらを、終了するときには "Ctrl-C" を用います。

その後、単体テストプログラムを実行します。

mvn test

リポジトリへの更新

一通り、単体テストが終了したら、ソースコードリポジトリを更新します。まず、次のコマンドを実行してください。

mvn clean
svn status

その結果が望ましいものであれば、次のコマンドでソースコードリポジトリを更新します。

mvn commit -m "Reasons"

"Reasons" には今回更新する内容を簡潔に表現した文を記述します。

結合テスト

結合テストの方法については、今後、記述します。

Tips

  • ant -v を使うと、Ant実行中の詳細メッセージが表示される。
  • mvn -e を使うと、Maven実行結果の詳細なエラーメッセージが表示される。