開発ガイド

• Actionクラス
• レスポンダ
• 例外処理
• HTMLファイル
• アクションの呼出
• イベントハンドラ
• Javaオブジェクトの読込
• テーブルの読込
• データの保存
• ページの移動

• Actionの呼出し
  クライアントから "WEBアプリケーションパス/action/アクション名" もしくは "WEBアプリケーションパス/アクション名.do" というリクエストを受け取ると jp.simm.jaxson.servlet.JaxsonServlet が呼び出されます。 JaxsonServletはリクエストされたURLパターンからアクション名を抽出して WEB-INF/action-mappings.xml の設定に従ってActionインスタンスを生成して実行します。 アクション名抽出の際に拡張子は削除されますので、 WEB-INF/action-mappings.xml のアクション名の設定には拡張子を付けないでください。

  <?xml version="1.0" encoding="UTF-8"?>
   <action-settings>
       <action>
           <action-name>
               BusinessSheet                     <!-- アクション名 -->
           </action-name>
           <action-class>
               package.name.ExcelDownloadAction  <!-- アクションクラス -->
           </action-class>
       </action>
   </action-settings> 

  "WEBアプリケーションパス/action/アクション名" で呼び出す場合はクライアントから呼び出すアクション名に自由に拡張子を付加できます。 上記の場合 "/application-path/action/BusinessSheet.xls" という要求に対して package.name.ExcelDownloadAction オブジェクトが生成されます。 jaxson.jsのアクションを呼び出す関数は アクション名として'/'で始まる絶対パスを指定しない限り "/WEBアプリケーションパス/action/引数で指定したアクション名" に変換します。
  "action-package"を記述しておくと 要求されたアクション名をクラス名とするアクションクラスをパッケージ内で検索します。

  <action-package>
      <package-name>
          package.name
      </package-name>
  </action-package> 

  この例の場合 "/application-path/action/BusinessSheet.xls" という要求に対して package.name.ExcelDownloadActionというクラスを検索します。 action-package要素には複数のpackage-name要素を記述することができます。
  
  ファイルをダウンロードする場合などでファイル名を動的に設定したい場合は URLパターンでアクションを指定せずに "actionName" というリクエストパラメータでアクションを指定します。

  **** HTML ****
  <form id="sheetDownload">
      ....
      <input type="hidden" name="actionName" value="SheetDownload" />
      <input type="submit" value="請求書ダウンロード" />
  </form>
  
  **** JavaSctipt ****
  $("sheetDownload").onsubmit = function() {
      var dd = new Date();
      $("sheetDownload").action = toActionPath((dd.getMonth() + 1) + "月分請求書.xls");
      return true;
  } 

• Actionクラス
  アクションクラスは jp.simm.jaxson.service.ServiceAction を継承します。
  JaxsonServletは生成したActionオブジェクトに対して下記の順にメソッドを呼び出します。
  1. preprocess
  2. execute
  3. doResponse
  4. postprocess
  preprocessおよびpostprocessは任意メソッドで、 データベース接続等のリソースの取得解放等、必要に応じて実装してください。 postprocessは他のメソッドで例外がスローされても必ず実行されるようになっています。 preprocess、execute、doResponseで例外がスローされた場合にはdoErrorメソッドが呼ばれますので、 トランザクションをロールバックする等に使用します。
  executeは必須メソッドで、ここに処理の本体を実装します。
  doResposeはServiceActionで実装されているため通常は実装する必要はありません。
  doResponseはexecuteメソッドが返すオブジェクトをレスポンダに渡して出力を行います。 出力処理に関しては下記のレスポンダの項を参照してください。
  
• パラメータ
  アクションクラスのフィールドに@ContextParam注釈を行う事により リクエスト、セッション、サーブレットコンテキスト、 application-settings.xmlに記述したパラメータを取得することができます。
  ContextParam.Scopeにはそれぞれ REQUEST, SESSION, SERVLET, APPLICATION というenum値を用意してあります。
  

  // このフィールドにはセッション属性から取得した値がセットされる
  @ContextParam(ContextParam.Scope.SESSION)
  private String currentID; 

  パラメータはフィールドの型に変換されますが、 変換に失敗した場合は値がセットされませんので御注意ください。 (jp.simm.jaxson.util.BeanUtils.convertObject(Object,Class) のjavadocを参照)
  例えばフォームのサブミットにより呼び出された場合、 同じname属性の要素が複数ある場合はセッタメソッドの引数をString配列とする必要があります。
  フィールド名に対応する値がそのスコープに存在せず、 そのフィールドの値がnullの場合は、 そのフィールド型のオブジェクトを生成してそれにパラメータをセットしようと試みます。

  *** Java ***
  
  // アクションクラス
  public class HogeHogeAction extends ServiceAction {
  
      // HogeHogeFormBeanオブジェクトを生成してセット
      @ContextParam
      private HogeHogeFormBean formBean;
      
      ...
  }
  
  // フォームビーンクラス
  // 各フィールドにリクエストパラメータがセットされる
  public Class HogeHogeFormBean implements Serializable {
  
      private String name;
      
      private String address;
      
      public String getName() {
          return name;
      }
      public String getAddress() {
          return address;
      }
  }
  
  *** JavaScript ***
  
  var param = {
      name : "日本太郎",
      address : "東京都港区"
  };
  
  doAction("HogeHogeAction", param, function() {
      ...
  });
  					

  ServiceActionクラスは他にsession、request、responseという変数を定義していて、 それぞれセッションオブジェクトおよびリクエストオブジェクト、レスポンスオブジェクトにアクセスすることができます。
  アクションクラスのクラス変数以外でパラメータを取得する場合は ParemeterManager#getParameter(HttpServletRequest, String, ContextParam.Scope) を使用します。

  String defaultName = ParameterManager.getInstance()
          .getParameter(request, "defaultName", ContextParam.Scope.APPLIDATION);

  この例の場合はアプリケーション設定ファイルからパラメータを取得しているので requestはnullでもかまいません。
  この他にオブジェクトの@ContextParam注釈されたフィールドに値をセットする ParameterManager#setFieldParameters(Object, HttpServletRequest, HttpServletResponse) メソッドなどもありますので詳しくはAPIドキュメントを参照してください。
• レスポンダ
  executeメソッドが返す処理結果はレスポンダに渡されて出力されます。 出力形式はデフォルトはJSONですが、他にも様々な出力形式を用意してあり、 レスポンダを指定することで出力形式を変更できます。
  レスポンダの指定はActionクラスをResponder注釈することで行います。

  @Responder(ExcelResponder.class)
  public class ExcelDownloadAction extends ServiceAction {
      .... 

  Responder注釈を省略すると jp.simm.jaxson.responder.JsonResponder が使用されます。 各種出力形式に関しては レスポンダ をご覧ください。
  処理によりレスポンダを変更する場合は setResponder によりレスポンダをセットします。

  public Object execute() throws Exception {
      ...
      if (hasError) {  // エラーの場合はクライアントでアラートを表示する
          setResponder(new JsWarningResponder());
          return errorMessage;
      }
      ...
  } 

• JsonResponder
• JavascriptResponder
• JsWarningResponder
• TextResponder
• HtmlResponder
• ByteStreamResponder
• JpegImageResponder
• GifImageResponder
• ExcelResponder
• DispatchResponder

*** Java ***
@Responder(JsonResponder.class) // デフォルトのため省略可
public class MessageSearchAction extends ServiceAction {

    public Object execute() {
        String message;
        // messageをセットする
        return message;
    }
    
}

*** JavaSctipt ***
// MessageSearchActionを呼び出して結果をidが"message"の要素内に表示する
function getMessage() {
    var param = ....
    doAction('MessageSearchAction', param, function(message) {
        // 結果オブジェクトには"value"属性に格納される
        $("message").innerHTML = message.value;
    });
}

// ライブラリ関数を使用してgetMessageと同じ処理を行う
function getMessage2() {
    var param = ....
    doAction('MessageSearchAction', param, function(message) {
        // setElementValueはオブジェクトに"value"属性がある場合は自動的に取り出す
        setElementValue($("message"), message);
    });
} 

<script type="text/javascript">
    <!--
    function setMessage(message) {
        $("message").innerHTML = message.value;
    }
    //-->
</script>

<!-- MessageSearchActionの処理結果を引数としてsetMessageを実行します。 -->
<script type="text/javascript"
    src="http://hostname/action/MessageSearchAction?callback=setMessage">
</script> 

*** Java ***
@Responder(JavascriptResponder.class)
public class MessageSearchAction extends ServiceAction {

    public Object execute() {
        String message;
        // messageをセットする
        return "alert('" + message + "')";
    }
    
}

*** JavaScript ***
// メッセージをアラートに表示する
function showMessage() {
    var param = ....
    doAction('MessageSearchAction', param);
} 

*** Java ***
@Responder(JsWarningResponder.class)
public class MessageSearchAction extends ServiceAction {
    
    public Object execute() {
        String message;
        // messageをセットする
        // messageはアラートに表示する内容になります
        return message;
    }

}

*** JavaScript ***
// メッセージをアラートに表示する
function showMessage() {
    var param = ....
    doAction('MessageSearchAction', param);
} 

*** Java ***
@Responder(ByteStreamResponder.class)
public class MusicDownloadAction extends ServiceAction {

    // クライアントから渡された"id"パラメータをセットします。
    @ContextParam
    String id;
    
    public Object execute() {
        Object result = new File(id + ".mp3");
        // ダウンロードできるようにレスポンスヘッダを設定します。
        response.setContentType("audio/mp3");
        response.setHeader("Content-disposition", "attachment;");
        return result;
    }
    
}

*** HTML ***
<a href="/application-path/action/MusicDownloadAction.mp3?id=0123">
クリックするとダウンロードを開始します。
</a>
                

*** Java ***
@Responder(DispatchResponder.class)
public class ForwardPageAction extends ServiceAction {
    ...
}

*** HTML ***
<a href="/application-path/ForwardPageAction.do?nextPage=NextPage.html&id=1234" >
    ページを移動します。
</a> 

request.setAttribute("nextPage", "NextPage.html"); 

*** Java ***

public class PageData {

    public String getMessage() {
        return xxx;
    }
    
    public String getName() {
        return xxx;
    }
    
    public int getCategory() {
        return xxx;
    }

    pubic List getCustomers() {
        return xxx;
    }
}

*** HTML ***

メッセージ : <span id="message"></span>
<form id="searchForm">
名前 <input type="text" id="name"/><br />
種別 <select id="category">
        <option value="1">Windows</option>
        <option value="2">Macintosh</option>
    </select>
</form>
<table id="customers">
    <thead>
        <tr>
            <td id="nameCol">名前</td>
            <td id="addressCol">住所</td>
        </tr>
    </thead>
    <tbody>
    <tbody>
</table>

*** JavaScript ***

// CreatePageDataはPageDataオブジェクトを出力するアクション
doAction("CreatePageData", param, function(pageData) {
    loadToDocument(pageData);  // アクション完了後に読込
}); 

// 'category'というidの要素に値をセットするときに値をコード値に変換します。
$("category").valueFilter = function(value) {
    if (value == 'Windows') {
        return 1;
    } else {
        return 2;
    }
}); 

*** Java ***                

// 顧客情報検索アクション
public class CustomerSearchAction extends ServiceAction {

    /** 検索を実行します。 */
    public Object execute() {
        List<CustomerDTO> rows;
        ...
        return customerDAO.select(condition);
    }
    
}

// 顧客情報を保持するクラス
public class CustomerDTO implements Serializable {

    /** 顧客名を返します。 */
    public String getName() {
        return name;
    }
    
    /** アドレスを返します。 */
    public String getAddress() {
        return address;
    }
}

*** HTML ***

<table id="customerTable">
    <thead>
        <tr>
            <td id="name">顧客名</td>
            <td id="address">アドレス</td>
        </tr>
    </thead>
    <tbody>
    </tbody>
</table>

*** JavaScript ***

doAction("CustomerSearchAction", param, function(customerList) {
    setElementValue($("customerTable"), customerList);
}); 

*** JavaScript ***
// SomActionを実行してその結果を初期データとしてNext.htmlに遷移する
doAction("SomeAction", param, function(data) {
    forward("NextPage.html", data);
});

*** HTML ***
<form>
    <input type="text" name="xxx">
    ....
    <input type="button" value="実行"
        onclick="doForm('SomeAction',this.parentNode,'NextPage.html')"/>
</form>

*** Java ***
@Responder(DispatchResponder.class)
public class UploadAction extends ServiceAction {
    ...
}

*** HTML ***
<form method="POST" enctype="multipart/form-data"
        action="/application-path/UploadAction.do">
    ファイル : <input type="file" name="uploadFile"/><br />
    <!-- 遷移先は "nextPage" で指定 -->
    <input type="hidden" name="nextPage" value="NextPage.html">
    <input type="submit" value="ファイルアップロード"/>
</form>