JSSP Validator¶

前提条件¶

JSSP Validatorは下記の関数に使用可能です。

• js初期化時に実行されるinit関数
• imartタグのaction属性に指定されたアクション関数

• <imart type=”form” />
• <imart type=”submit” />
• <imart type=”link” />

バリデーションの仕組み¶

JSSP Validatorは下記の流れで処理を実行します。

1. クライアントからリクエストが送信されます。
2. JSSP Validatorがバリデーション設定ファイルに記述されたルールに基づきリクエストパラメータを検証します。
3. 検証に失敗した場合、エラーオブジェクトにエラーメッセージを追加します。
4. エラーオブジェクトにエラーメッセージが有る場合はエラーハンドラ関数を実行します。エラーメッセージが無い場合は init関数またはformなどのaction属性で指定されたアクション関数を実行します。

バリデーションルール¶

下記はバリデーションルールの一覧です。各ルールの詳細は バリデーションルール リファレンス を参照してください。

JSSP Validatorアノテーション¶

バリデーションを行う関数にアノテーションを記述します。 関数のコメントに @validate と @onerror アノテーションを記述してください。

/**
 * 初期化処理
 *
 * ・・・
 * @validate foo/bar_validation#init
 * @onerror handleErrors
 */
function init(request){
 ...
}

バリデーション設定ファイル¶

変数の宣言を記述し、その属性には検証を行うパラメータ名を記述します。 パラメータ名の属性には検証をするバリデーションルールのキーを記述してください。

caption 属性はエラーメッセージを生成するために必要な属性です。必ず記述してください。 エラーメッセージについては エラーメッセージ を参照してください。

下記の例ではリクエストパラメータ「xxx_name」に必須項目かつ50文字以下であるかを検証しています。

var init = {
  'xxx_name': { // リクエストパラメータ名
       caption: "CAP.Z.EXAMPLE.NAME", // エラーメッセージのキャプション
       required: true,
       maxlength: 50
   }
}

バリデーション設定ファイルには複数の設定の記述が可能です。変数名を設定ファイル内で固有のものとしてください。

var init = {
  'xxx_name': {
     ・・・
   }
}

var updateXXX = {
  'xxx_name': {
     ・・・
   }
}

var deleteXXX = {
  'xxx_name': {
     ・・・
   }
}

エラーメッセージ¶

リクエスト検証に失敗した場合エラーメッセージを生成します。

バリデーション設定ファイルに記述された caption 属性の値が「CAP.Z.EXAMPLE.NAME」であり、 バリデーションルールが「required」と「maxlength」となっている場合を例に説明します。

var init = {
  'xxx_name': { // リクエストパラメータ名
       caption: "CAP.Z.EXAMPLE.NAME", // エラーメッセージのキャプション
       required: true,
       maxlength: 50
   }
}

この例では「名前」をキャプションとします。

CAP.Z.EXAMPLE.NAME=\u540d\u524d

この例では、バリデーションルールに「required」と「maxlength」が設定されているため、 リクエスト検証に失敗した場合のエラーメッセージは下記の通りです。

名前は必須です。
名前は50文字以内でなければなりません。

エラーオブジェクト¶

エラーオブジェクトには検証に失敗したリクエストパラメータのエラーメッセージが格納されています。下記の図はその例です。

エラーオブジェクトの属性にはリクエストパラメータ名の配列が格納されており、 その属性には検証に失敗したルールのキーがありその値にはエラーメッセージが格納されています。 検証に成功したルールのキーは存在しません。 検証の失敗がひとつもないパラメータは属性がないオブジェクトが格納されています。

getMessagesメソッドはすべてのリクエストパラメータの検証に失敗したルールのエラーメッセージを配列で返します。

エラーハンドラ関数¶

全てのリクエストパラメータを検証した結果、ひとつでも検証に失敗しているパラメータがある場合は、 エラーハンドラ関数を実行します。@onerror アノテーションに記述した名前の関数を記述してください。

エラーハンドラ関数の第1引数にはリクエストオブジェクト、第2引数にはエラーオブジェクトを渡されます。 エラーオブジェクトに格納されているエラーメッセージを取得しエラー処理を行ってください。

下記の例ではリクエストパラメータの値とエラーメッセージを取得しエラーページにフォーワードしています。

エラーオブジェクトについては エラーオブジェクト を参照してください。

/**
 * 初期化処理
 *
 * ・・・
 * @onerror handleErrors
 */
function init(request){
 ...
}

/**
 * エラーハンドラ関数
 *
 * ・・・
 */
function handleErrors(request, validationErrors) {
  var param = {
    foo: request.foo,
    errors: validationErrors.getMessages()
  };
  forward("foo/bar_error", param);
}

JavaScriptで実装¶

/**
 * カスタムバリデータ
 *
 * ・・・
 */
function validate(request, config, paramName, caption) {
  var value = request.getParameterValue(paramName);
  if (条件) {
    return {isValid: true};
  } else {
    return {isValid: false, message: "検証失敗"};
  }
}

validate関数の引数には下記のオブジェクトが渡されます。

validate関数の戻り値には下記の構造のオブジェクトを返してください。 isValid 属性は検証成功時にはtrue、失敗時にはfalseを設定してください。 検証失敗時には message プロパティにエラーメッセージを設定してください。

Javaで実装¶

jp.co.intra_mart.foundation.jssp.validation.Validatorインタフェース の実装クラスを作成してください。

package foo;

import jp.co.intra_mart.foundation.jssp.validation.InitParam;
import jp.co.intra_mart.foundation.jssp.validation.RequestInfo;
import jp.co.intra_mart.foundation.jssp.validation.ValidationResult;
import jp.co.intra_mart.foundation.jssp.validation.Validator;
import jp.co.intra_mart.system.javascript.Context;
import jp.co.intra_mart.system.javascript.Scriptable;

public class CustomValidator implements Validator {

    @Override
    public void destroy() {
    }

    @Override
    public ValidationResult validate(RequestInfo info) {
        final String value = info.getRequest().getParameter(info.getParameterName());
        if (条件) {
            return ValidationResult.ok();
        } else {
            return ValidationResult.ng("検証失敗");
        }
    }

    @Override
    public void init(InitParam params, Context cx, Scriptable scope) {
    }
}

引数、戻り値の説明についてはAPIリストを参照してください。

jssp-validation-configの設定¶

<?xml version="1.0" encoding="UTF-8"?>
<jssp-validation-config
    xmlns="http://intra-mart.co.jp/system/jssp-validation"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://intra-mart.co.jp/system/jssp-validation ../../schema/jssp-validation-config.xsd">

  <!-- JavaScript の設定例 -->
  <validator>
    <validator-name>js_example</validator-name>
    <validator-script>foo/custom_validator</validator-script>
  </validator>

  <!-- Java の設定例 -->
  <validator>
    <validator-name>java_example</validator-name>
    <validator-class>foo.CustomValidator</validator-class>
  </validator>
</jssp-validation-config>