Vest Open Source Project

Coconuts
   ドキュメント
   ダウンロード
   チュートリアル
   ライセンス

お問い合わせ
訪問者数：6097人

Coconuts チュートリアル

Coconutsチュートリアル

このページでは、初めてCoconutsを使う方を対象に環境設定から実際にCoconutsを使ったサンプルアプリケーションを構築します。

--目次--
■Step 0 -環境作成-
■Step 1 -Hello Coconuts-
■Step 2 -ログ拡張機能を使う-
■Step 3 -QueueInterfaceを使ったキューの登録-
■Step 4 -キューの設定をXMLに置き換える-
■Step 5 -カードのデータを表示する-

■Step 4 -キューの設定をXMLに置き換える-

Step3ではXMLに置き換える前段階として、キューと関連するActionをひとかたまりにする方法を紹介しました。
Step4では実際にキューと関連するActionをXMLに置き換えてみます。

CoconutsにはCoconutsCfgというXML設定用に作られたクラスがあります。
Coconutsは、CoconutsCfgインスタンスをSpringFrameworkを使うことによってXMLから取得します。
Coconuts用XML設定ファイルの制約事項は、このようになっています。
・ファイル名は"coconuts.cfg"
・"coconuts.cfg"はクラスパスの通る場所にあること
・"coconuts.cfg"はCoconutsインスタンスが最初に呼ばれた時点でロードを行う。
・SpringFrameworkを使用してロードを行い、bean名"coconutscfg"をCoconutCfgインスタンスとしてロードする。

ダウンロードしたCoconuts.zipに"coconuts.cfg"が入っています。
このファイルをEclipseのソースフォルダにコピーしてください。

まずは"coconuts.cfg"の説明をします。
"coconuts.cfg"の5行目にこのような記述があります。

<!-- Coconuts設定 -->
  <bean id="coconutscfg" class="jp.co.vest.vosp.coconuts.CoconutsCfg">
    <property name="queueSet">
      <list>
        <!-- QueueInterfaceを登録する -->
        <!-- 
        <ref bean="-- QueueのBean名 --"></ref>
        -->
      </list>
    </property>
  </bean>

ここはCoconutsが管理するキューについて記述します。
ひとかたまりのキューを登録するには、"<list>"から"</list>"で囲まれた中に"<value><ref bean="キューのBean名"></ref></value>"を追加します。

19行目にこのような記述があります。

<!-- Queueテンプレート(QueueInterface) -->
<!-- 
  <bean id="-- QueueのBean名 --" class="jp.co.vest.vosp.coconuts.Queue">
    <property name="queueName"><value>-- キュー名 --</value></property>
    <property name="errorQueueName"><value>-- エラーキュー名 --</value></property>
    <property name="actionSet">
      <list>
        <ref bean="-- ActionのBean名 --"></ref>
      </list>
    </property>
  </bean>
-->

これは"Queue"クラスを使ったひとかたまりのキューを記述するためのテンプレートになります。

<!-- Felica拡張(QueueInterface) -->
<!-- 
  <bean id="felicaQueue" class="jp.co.vest.vosp.coconuts.ext.rfid.felica.FelicaQueue">
    <property name="queueName"></property>
    <property name="errorQueueName"></property>
    <property name="actionSet">
      <list>
      </list>
    </property>
    <property name="readerMap">
      <map>
        <entry key="USB0"><value>USB0</value></entry>
      </map>
    </property>
  </bean>
-->

これはFelicaカードの情報を自動的に読み取るキューを使用するためのテンプレートになります。

<!-- ロギング拡張(Action) -->
<!-- 
  <bean id="loggingAction" class="jp.co.vest.vosp.coconuts.ext.logging.LoggingActionImpl">
    <property name="logLevel"><value>info</value></property>
    <property name="errorLogLevel"><value>error</value></property>
    <property name="messageCreator"><ref bean="messageCreator"></ref></property>
  </bean>
  <bean id="messageCreator" class="-- LogMessageCreatorを実装したクラス名 --">
  </bean>
-->

これはStep2で使ったロギング拡張機能のためのテンプレートになります。

<!-- ファイルリカバリ拡張(Action) -->
<!-- 
  <bean id="fileRecoverableErrorAction" class="jp.co.vest.vosp.coconuts.ext.recovery.FileRecoverableErrorAction">
    <property name="backupDir">.</property>
  </bean>
-->

これはActionが失敗した際にエラーキューに入るイベントをファイルで保管し、後のリカバリを可能にするための拡張アクションのテンプレートになります。

<!-- データベース拡張(Action) -->
<!-- 
  <bean id="insertDBAction" class="jp.co.vest.vosp.coconuts.ext.hibernate.InsertDBAction">
  </bean>
-->

これはhibernateを使用したデータベース登録のための拡張アクションのテンプレートになります。

<!-- HTTP ObjectStream拡張(QueueInterface) -->
<!-- 
  <bean id="objectStreamQueueServelt" class="jp.co.vest.vosp.coconuts.ext.objectstream.ObjectStreamQueueServelt">
    <property name="servletName"></property>
    <property name="queueName"></property>
    <property name="errorQueueName"></property>
    <property name="actionSet">
      <list>
      </list>
    </property>
  </bean>
-->

これはObjectStream通信用の拡張キューのテンプレートです。
送信側は「ObjectStreamSendAction」を使用します。

<!-- HTTP ObjectStream拡張(Action) -->
<!-- 
  <bean id="objectStreamSendAction" class="jp.co.vest.vosp.coconuts.ext.logging.ObjectStreamSendAction">
    <property name="url"></property>
  </bean>
-->

これはObjectStream通信用の拡張Actionのテンプレートです。
「ObjectStreamQueueServelt」へイベントを送信するために使用します。

実際にXML設定ファイルを使ってみましょう。
今回は「Coconuts設定」「Queueテンプレート」「ロギング拡張」を使います
また、HelloAction用のXMLを記述します。

ロギング拡張用のXMLを作ってみましょう。
まずはロギング拡張テンプレート部分のコメントを外してください。
そして、"-- LogMessageCreatorを実装したクラス名 --"の部分にStep2で作った「HelloLogMessageCreator」のクラス名を記述します。
このようになります

<!-- ロギング拡張(Action) -->
  <bean id="loggingAction" class="jp.co.vest.vosp.coconuts.ext.logging.LoggingActionImpl">
    <property name="logLevel"><value>info</value></property>
    <property name="errorLogLevel"><value>error</value></property>
    <property name="messageCreator"><ref bean="messageCreator"></ref></property>
  </bean>
  <bean id="messageCreator" class="HelloLogMessageCreator">
  </bean>

次にHelloActionのXMLを作ってみましょう。
SpringFrameworkではインスタンスを生成するにはこのように定義します。

  <bean id="Bean名" class="生成するインスタンスのクラス名">
    <property name="設定箇所">値</property>
    …
  </bean>

インスタンスは<bean>～</bean>までに記述します。
"id="にはBean名を記入します。
"class="にはクラス名を記入します。
<property>～</property>にはインスタンスの設定値を記入します。
"name="にはsetterメソッドの"set"無しかつ、先頭小文字の文字列を記入します。
<property>～</property>の間には実際の設定値を記入します。
また、<bean>～</bean>として設定したインスタンスは"<ref bean="Bean名">"として代入できます。
詳細はSpringFrameworkを参照してください。

今回のHelloActionはBeam名を"helloAction"とするとこのようになります。

  <bean id="helloAction" class="HelloAction">
  </bean>

ではこれらをひとかたまりのキューにします。
「Queueテンプレート」のコメントを外してください。
"-- QueueのBean名 --"を"helloQueue"にしてください。
"-- キュー名 --"を"helloQueue"にしてください
"-- エラーキュー名 --"はnullですので"<null/>"と記入します。
Actionは<list>～</list>の間に記入します。
今回はHelloActionとロギング拡張を使用しますので、Bean名"helloAction"と"loggingAction"を追加します。
「Queueテンプレート」はこのようになります。

<!-- Queueテンプレート(QueueInterface) -->
  <bean id="helloQueue" class="jp.co.vest.vosp.coconuts.Queue">
    <property name="queueName"><value>helloQueue</value></property>
    <property name="errorQueueName"><null/></property>
    <property name="actionSet">
      <list>
        <ref bean="helloAction"></ref>
        <ref bean="loggingAction"></ref>
      </list>
    </property>
  </bean>

最後にCoconutsの設定です。
「Coconuts設定」の<list>～</list>の間にQueueを追加します。
今回は、QueueのBean名が"helloQueue"ですのでこのようになります。

<!-- Coconuts設定 -->
  <bean id="coconutscfg" class="jp.co.vest.vosp.coconuts.CoconutsCfg">
    <property name="queueSet">
      <list>
        <!-- QueueInterfaceを登録する -->
        <ref bean="helloQueue"></ref>
      </list>
    </property>
  </bean>

これでXMLの設定は終了です。
確認のため使用する箇所のみのXML設定ファイル(coconuts.cfg)を記述します。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE beans PUBLIC "-//SPRING/DTD BEAN/EN" 
 "http://www.spriongframework.org/dtd/spring-beans.dtd">
<beans>
<!-- Coconuts設定 -->
  <bean id="coconutscfg" class="jp.co.vest.vosp.coconuts.CoconutsCfg">
    <property name="queueSet">
      <list>
        <!-- QueueInterfaceを登録する -->
        <ref bean="helloQueue"></ref>
      </list>
    </property>
  </bean>
<!-- Queueテンプレート(QueueInterface) -->
  <bean id="helloQueue" class="jp.co.vest.vosp.coconuts.Queue">
    <property name="queueName"><value>helloQueue</value></property>
    <property name="errorQueueName"><null/></property>
    <property name="actionSet">
      <list>
        <ref bean="helloAction"></ref>
        <ref bean="loggingAction"></ref>
      </list>
    </property>
  </bean>
  
  <bean id="helloAction" class="HelloAction">
  </bean>
  
<!-- ロギング拡張(Action) -->
  <bean id="loggingAction" class="jp.co.vest.vosp.coconuts.ext.logging.LoggingActionImpl">
    <property name="logLevel"><value>info</value></property>
    <property name="errorLogLevel"><value>error</value></property>
    <property name="messageCreator"><ref bean="messageCreator"></ref></property>
  </bean>
  <bean id="messageCreator" class="HelloLogMessageCreator">
  </bean>

</beans>

これでキューとActionの関連は全てXMLに移行しましたので、HelloMain.javaはこうなります

import jp.co.vest.vosp.coconuts.Coconuts;

public class HelloMain {

  /**
   * @param args
   */
  public static void main(String[] args) {
    try {
      Coconuts.getInstance().putEvent("HelloQueue","Coconuts");
    } catch (InterruptedException e) {
      e.printStackTrace();
    }
  }
}

では実際に起動してみましょう。
Step2と同様の結果が出ているはずです。