7.10.1. Bean Validation¶

7.10.1.1.1. ドメインバリデーションができる¶

ドメインごとにバリデーションルールを定義できる機能を提供する。

ドメインバリデーションを使うと、Beanのプロパティにはドメイン名の指定だけを行えばよく、バリデーションルールの変更が容易になる。

詳細は、 ドメインバリデーションを使う を参照。

7.10.1.1.2. よく使われるバリデータが提供されている¶

Nablarchでは、よく使われるバリデータが提供されているため、基本的なバリデーションは何かを作りこむことなく使用できる。

Nablarchで提供しているバリデータは以下のパッケージ内のアノテーション(注釈型)を参照。

• nablarch.core.validation.ee
• nablarch.common.code.validator.ee

7.10.1.3.1. Bean Validationを使うための設定¶

Bean Validationを使うために必要となる設定を以下に示す。

MessageInterpolatorの設定

Bean Validationでバリデーションエラーが発生した際のメッセージを構築するクラス( MessageInterpolator を実装したクラス)を設定する。

設定を省略した場合(デフォルト)は、 メッセージ管理 を使用する NablarchMessageInterpolator が使用される。

例えば、Hibernate Validatorのプロパティファイルからメッセージを構築する実装を使用する場合には、以下のように設定する。

重要

componentの名前は、必ず messageInterpolator とすること。

<!-- コンポーネント名にmessageInterpolatorを指定し、MessageInterpolatorの実装クラスを設定する -->
<compnent name="messageInterpolator"
    class="org.hibernate.validator.messageinterpolation.ResourceBundleMessageInterpolator"/>

ドメインバリデーション用の設定

ドメインバリデーションを使う を参照

ウェブアプリケーションでBean Validationを使うための設定

ウェブアプリケーションのユーザ入力値のチェックを行う を参照

7.10.1.3.2. バリデーションエラー時のエラーメッセージを定義する¶

Bean Validationを使うための設定 で説明したように、デフォルトでは メッセージ管理 を使用してバリデーションエラー時のメッセージを構築する。 このため、メッセージの定義場所などの詳細は、 メッセージ管理 を参照すること。

デフォルトの NablarchMessageInterpolator を使用した場合のメッセージ定義ルールは以下のとおり。

• アノテーションの message 属性に指定された値が { 、} で囲まれていた場合のみ メッセージ管理 を使用してメッセージを構築する。
• メッセージテキスト内には、バリデーションのアノテーションの属性情報を埋め込むためのプレースホルダを使用できる。 プレースホルダは、アノテーションの属性名を { 、 } で囲んで定義する。
• メッセージを動的に組み立てる式(例えばEL式)は使用できない。

以下に例を示す。

Java実装例

public class SampleForm {

  @Length(max = 10)
  @SystemChar(charsetDef = "全角文字")
  @Required
  private String userName;

  @Length(min = 8, max = 8)
  @SystemChar(charsetDef = "半角数字")
  private String birthday;

  // getter、setterは省略
}

メッセージ定義例

アノテーションで指定されているメッセージIDをキーにメッセージを定義する。 アノテーションのmessage属性を指定していない場合は、デフォルト値がメッセージIDとなる。

# Lengthアノテーションに対応したメッセージ
# Lengthアノテーションのminやmax属性に指定した値をメッセージに埋め込むことが出来る
nablarch.core.validation.ee.Length.min.message={min}文字以上で入力してください。
nablarch.core.validation.ee.Length.max.message={max}文字以内で入力してください。
nablarch.core.validation.ee.Length.min.max.message={min}文字以上{max}文字以内で入力してください。

# SystemCharに対応したメッセージ
nablarch.core.validation.ee.SystemChar.message={charsetDef}を入力してください。

7.10.1.3.3. バリデーションルールの設定方法¶

バリデーションルールは、アノテーションをFieldかProperty(getter)に設定することで指定できる。 なお、setterにはアノテーションを指定できないので注意すること。(指定しても意味が無い(無視する))

実装例

Nablarchで提供しているバリデータ を参照し、アノテーションを設定する。

補足

個別にアノテーションを設定した場合、実装時のミスが増えたりメンテナンスコストが大きくなるため、 後述する ドメインバリデーション を使うことを推奨する。

public class SampleForm {

  @Length(max = 10)
  @SystemChar(charsetDef = "全角文字")
  @Required
  private String userName;

  @Length(min = 8, max = 8)
  @SystemChar(charsetDef = "半角数字")
  private String birthday;

  // getter、setterは省略
}

7.10.1.3.4. ドメインバリデーションを使う¶

ドメインバリデーションを使うための設定や実装例を示す。

ドメインごとのバリデーションルールを定義したBeanの作成

ドメインバリデーションを使用するには、まずドメインごとのバリデーションルールを持つBean(ドメインBean)を作成する。

このBeanクラスには、ドメインごとのフィールドを定義し、フィールドに対してアノテーションを設定する。 フィールド名がドメイン名となる。以下の例では name と date の２つのドメインが定義されている。

補足

必須項目を表す @Required アノテーションは、ドメインBeanに設定するのではなく個別のBean側に設定すること。 必須かどうかはドメイン側で強制できるものではなく、機能の設計によるため。

package sample;

import nablarch.core.validation.ee.Length;
import nablarch.core.validation.ee.SystemChar;

public class SampleDomainBean {

    @Length(max = 10)
    @SystemChar(charsetDef = "全角文字")
    String name;

    @Length(min = 8, max = 8)
    @SystemChar(charsetDef = "半角数字")
    String date;

}

ドメインBeanを有効化

ドメインBeanを有効化するには、 DomainManager 実装クラスを作成する。 getDomainBean では、ドメインBeanのクラスオブジェクトを返す。

package sample;

public class SampleDomainManager implements DomainManager<SampleDomainBean> {
  @Override
  public Class<SampleDomainBean> getDomainBean() {
      // ドメインBeanのClassオブジェクトを返す
      return SampleDomainBean.class;
  }
}

DomainManager 実装クラスの SampleDomainBean をコンポーネント設定ファイルに定義することで、 SampleDomainBean を使用したドメインバリデーションが有効となる。

<!-- DomainManager実装クラスは、domainManagerという名前で設定すること -->
<component name="domainManager" class="sample.SampleDomainManager"/>

各Beanでドメインバリデーションを使う

Beanのバリデーション対象プロパティに @Domain アノテーションを設定することで、ドメインバリデーションが行われる。

この例では、 userName に対して SampleDomainBean の name フィールドに設定したバリデーションが行われる。 同じように birthday に対しては、 date フィールドに設定したバリデーションが行われる。

※userNameは必須項目となる。

public class SampleForm {

  @Domain("name")
  @Required
  private String userName;

  @Domain("date")
  private String birthday;

  // getter、setterは省略
}

7.10.1.3.5. 文字種バリデーションを行う¶

システム許容文字のバリデーション機能を使用することで、文字種によるバリデーションを行うことが出来る。

文字種によるバリデーションを行うには、文字種毎に許容する文字のセットを定義する。 例えば、半角数字という文字種には、半角の 0 から 9 を許容するといった定義が必要となる。

以下に文字種毎の許容文字セットの定義方法を示す。

コンポーネント定義に許容文字のセットを定義する

許容文字のセットは、以下のクラスの何れかを使って登録する。 登録する際には、コンポーネント名には文字種を表す任意の名前を設定すること。

• RangedCharsetDef (範囲で許容文字セットを登録する場合に使用する)
• LiteralCharsetDef (リテラルで許容文字を全て登録する場合に使用する)
• CompositeCharsetDef (複数のRangedCharsetDefやLiteralCharsetDefからなる許容文字を登録する場合に使用する)

設定例は以下のとおり。

<!-- 半角数字 -->
<component name="半角数字" class="nablarch.core.validation.validator.unicode.LiteralCharsetDef">
  <property name="allowedCharacters" value="01234567890" />
  <property name="messageId" value="numberString.message" />
</component>

<!-- ASCII(制御コードを除く) -->
<component name="ascii" class="nablarch.core.validation.validator.unicode.RangedCharsetDef">
  <property name="startCodePoint" value="U+0020" />
  <property name="endCodePoint" value="U+007F" />
  <property name="messageId" value="ascii.message" />
</component>

<!-- 英数字 -->
<component name="英数字" class="nablarch.core.validation.validator.unicode.CompositeCharsetDef">
  <property name="charsetDefList">
    <list>
      <!-- 半角数字の定義 -->
      <component-ref name="半角数字" />

      <!-- 半角英字の定義 -->
      <component class="nablarch.core.validation.validator.unicode.LiteralCharsetDef">
        <property name="allowedCharacters"
            value="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ" />
      </component>
    </list>
  </property>
  <property name="messageId" value="asciiAndNumberString.message" />
</component>

アノテーションで文字種を指定する

文字種バリデーションを行うプロパティには、 @SystemChar アノテーションを設定する。 このアノテーションの charsetDef 属性には、許容する文字種を表す名前を設定する。 この名前は、上記のコンポーネント設定ファイルに文字種セットを登録した際のコンポーネント名となる。

この例では、 半角数字 を指定しているので、上記のコンポーネント定義に従い「0123456789」が許容される。

public class SampleForm {

    @SystemChar(charsetDef = "半角数字")
    public void setAccountNumber(String accountNumber) {
        this.accountNumber = accountNumber;
    }
}

<component name="半角数字" class="nablarch.core.validation.validator.unicode.CachingCharsetDef">
  <property name="charsetDef">
    <component class="nablarch.core.validation.validator.unicode.LiteralCharsetDef">
      <property name="allowedCharacters" value="01234567890" />
    </component>
  </property>
  <property name="messageId" value="numberString.message" />
</component>

サロゲートペアを許容する

このバリデーションでは、デフォルトではサロゲートペアを許容しない。 （例え LiteralCharsetDef で明示的にサロゲートペアの文字を定義していても許容しない）

サロゲートペアを許容する場合は次のようにコンポーネント設定ファイルに SystemCharConfig を設定する必要がある。

ポイント

• コンポーネント名は ee.SystemCharConfig とすること

<component name="ee.SystemCharConfig" class="nablarch.core.validation.ee.SystemCharConfig">
  <!-- サロゲートペアを許容する -->
  <property name="allowSurrogatePair" value="true"/>
</component>

7.10.1.3.6. 相関バリデーションを行う¶

複数の項目を使用した相関バリデーションを行うには、Bean Validationの @AssertTrue アノテーションを使用する。

実装例

この例では、メールアドレスと確認用メールアドレスが一致していることを検証している。 検証エラーとなった場合は、 message プロパティに指定したメッセージがエラーメッセージとなる。

public class SampleForm {
  private String mailAddress;

  private String confirmMailAddress;

  @AssertTrue(message = "{compareMailAddress}")
  public boolean isEqualsMailAddress() {
    return Objects.equals(mailAddress, confirmMailAddress);
  }
}

@AssertTrue(message = "{compareMailAddress}")
public boolean isEqualsMailAddress() {
  if (StringUtil.isNullOrEmpty(mailAddress) || StringUtil.isNullOrEmpty(confirmMailAddress)) {
    // どちらかが未入力の場合は、相関バリデーションは実施しない。(バリデーションOKとする)
    return true;
  }
  return Objects.equals(mailAddress, confirmMailAddress);
}

7.10.1.3.7. データベースとの相関バリデーションを行う¶

データベースとの相関バリデーションは、以下理由により業務アクション側で実装すること。

理由

Bean Validationを使ってデータベースに対する相関バリデーションを実施した場合、 バリデーション実施前の安全ではない値を使ってデータベースアクセスを行うことになる。 (Bean Validation実行中のオブジェクトの値は、安全である保証がない。) これは、SQLインジェクションなどの脆弱性の原因となるため、さけるべき実装であるため。

バリデーション実行後に業務アクションでバリデーションを行うことで、 バリデーション済みの安全な値を使用してデータベースへアクセスできる。

7.10.1.3.8. 特定の項目に紐づくバリデーションエラーのメッセージを作りたい¶

データベースとの相関バリデーション のようにアクションハンドラで行うバリデーションでエラーが発生した場合に、 画面上で対象項目をエラーとしてハイライト表示したい場合がある。

この場合には、下記の実装例のように ValidationUtil#createMessageForProperty を使用してエラーメッセージを構築し、 ApplicationException を送出する。

throw new ApplicationException(
        ValidationUtil.createMessageForProperty("form.mailAddress", "duplicate.mailAddress"));

7.10.1.3.9. 一括登録のようなBeanを複数入力する機能でバリデーションを行う¶

一括登録のように同一の情報を複数入力するケースがある。 このような場合には、バリデーション対象のBeanに対してネストしたBeanを定義することで対応する。

以下に例を示す。

// 一括入力された全ての情報を保持するForm
public class SampleBulkForm {

  // ネストしたBeanに対してもバリデーションを実行することを
  // しめすValidアノテーションを設定する。
  @Valid
  private List<SampleForm> sampleForm;

  public SampleBulkForm() {
    sampleForm = new ArrayList<>();
  }

  // setter、getterは省略
}


// 一括入力された情報の1入力分の情報を保持するForm
public class SampleForm {
  @Domain("name")
  private String name;

  // setter、getterは省略
}

7.10.1.3.10. ネストしたBeanをバリデーションする際の注意点¶

ブラウザの開発者ツールでhtmlを改竄されたり、Webサービスで不正なJsonやXMLを受信した際にネストしたBeanの情報が送信されない場合がある。 この場合、ネストしたBeanが未初期化状態(null)となり、バリデーション対象とならない問題がある。 このため、確実にネストしたBeanの状態がバリデーションされるよう実装する必要がある。

以下に幾つかの実装例を示す。

親BeanとネストしたBeanが1対Nの場合

ネストしたBeanをバリデーション対象にし、親のBean初期化時にネストしたBeanのフィールドも初期化する。 ネストしたBeanの情報が必須(最低1つは選択 or 入力されていること)の場合は、 Size アノテーションを設定する。

// Sizeアノテーションを設定することで、必ず1つは選択されていることをバリデーションする。
@Valid
@Size(min = 1, max = 5)
private List<SampleNestForm> sampleNestForms;

public SampleForm() {
  // インスタンス作成時にネストしたBeanのフィールドを初期化する
  sampleNestForms = new ArrayList<>();
}

親BeanとネストしたBeanが1対1の場合

BeanをネストさせずにフラットなBeanにできないか検討すること。 接続先からの要求で対応できない場合には、ネストしたBeanに対するバリデーションが確実に実行されるよう実装すること。

// ネストしたBeanをバリデーション対象にする
@Valid
private SampleNestForm sampleNestForm;

public SampleForm() {
  // インスタンス作成時にネストしたBeanのフィールドを初期化する
  sampleNestForm = new SampleNestForm();
}

7.10.1.3.11. ウェブアプリケーションのユーザ入力値のチェックを行う¶

ウェブアプリケーションのユーザ入力値のチェックは InjectForm インターセプタ を使用して行う。 詳細は、 InjectForm インターセプタ を参照。

InjectForm インターセプタ でBean Validationを使用するためには、コンポーネント設定ファイルに定義する必要がある。 以下例のように、 BeanValidationStrategy を validationStrategy という名前でコンポーネント定義すること。

<component name="validationStrategy" class="nablarch.common.web.validator.BeanValidationStrategy" />

7.10.1.3.12. バリデーションエラー時にもリクエストパラメータをリクエストスコープから取得したい¶

InjectForm インターセプタを使用すると、バリデーション成功後にリクエストスコープにバリデーション済みのフォームを格納される。 これを使用することでリクエストパラメータが参照できるが、バリデーションエラー時にも同様にリクエストスコープからパラメータを取得したい場合がある。

例えば、JSTLタグ(EL式)を使用する場合、Nablarchカスタムタグとは異なりリクエストパラメータを暗黙的に参照する[2] ことはできないので、 次のような処理を追加する必要がある。

• 一度Nablarchタグ <n:set> を使用してリクエストパラメータの値を変数に格納する
• 暗黙オブジェクト param を使用してリクエストパラメータにアクセスする

前者の <n:set> を使用する例を以下に示す。

<%-- リクエストパラメータの値をJSTL(EL式)でも参照できるよう変数に代入する --%>
<n:set var="quantity" name="form.quantity" />
<c:if test="${quantity >= 100}">
  <%-- 数量が100以上の場合... --%>

このような場合、 BeanValidationStrategyのプロパティ copyBeanToRequestScopeOnError を true に設定することで、バリデーションエラー時にも、リクエストパラメータをコピーしたBeanをリクエストスコープに格納できる。 以下に設定例を示す。

<component name="validationStrategy" class="nablarch.common.web.validator.BeanValidationStrategy">
  <!-- バリデーションエラー時にリクエストスコープに値をコピーする -->
  <property name="copyBeanToRequestScopeOnError" value="true"/>
</component>

リクエストスコープには、 @InjectForm の name で指定されたキー名でBeanが格納される（InjectForm インターセプタの通常動作と同じ）。

この機能を有効にすることで、前述のJSPは以下のように記述できる。

<%-- リクエストスコープ経由でリクエストパラメータの値をJSTL(EL式)でも参照できる --%>
<c:if test="${form.quantity >= 100}">
  <%-- 数量が100以上の場合... --%>

7.10.1.3.13. バリデーションエラー時のメッセージに項目名を含めたい¶

Bean Validation(JSR349)の仕様では、項目名をメッセージに含めることができないが、 要件などによってはメッセージに項目名を含めたい場合がある。 このため、NablarchではBean Validationを使用した場合でもメッセージにエラーが発生した項目の項目名を含める機能を提供している。

以下に使用方法を示す。

コンポーネント設定ファイル

メッセージに項目名を含めるメッセージコンバータを生成するファクトリクラスを設定する。 コンポーネント名には、 constraintViolationConverterFactory を設定し、 クラス名には ItemNamedConstraintViolationConverterFactory を設定する。

<component name="constraintViolationConverterFactory"
    class="nablarch.core.validation.ee.ItemNamedConstraintViolationConverterFactory" />

バリデーション対象のForm

package sample;

public class User {

  @Required
  private String name;

  @Required
  private String address;
}

項目名の定義

項目名は、メッセージとして定義する。 項目名のメッセージIDは、バリデーション対象のクラスの完全修飾名 + ”.” + 項目のプロパティ名とする。

上記のFormクラスの場合、 sample.User が完全修飾名で name と address の２つのプロパティがある。 項目名の定義には、以下のように sample.User.name と sample.User.address が必要となる。

なお、項目名を定義しなかった場合、メッセージに項目名は付加されない。

# Requiredのメッセージ
nablarch.core.validation.ee.Required.message=入力してください。

# 項目名の定義
sample.User.name = ユーザ名
sample.User.address = 住所

生成されるメッセージ

生成されるメッセージは、エラーメッセージの先頭に項目名が付加される。 項目名は [ 、 ] で囲まれる。

[ユーザ名]入力してください。
[住所]入力してください。

7.10.1.4.1. プロジェクト固有のアノテーションとバリデーションロジックを追加したい¶

よく使われるバリデータが提供されている に記載のバリデータで要件を満たすことができない場合は、 プロジェクト側でアノテーション及びバリデーションのロジックを追加すること。

実装方法などの詳細については、以下のリンク先及びNablarchの実装を参照。

• Hibernate Validator(外部サイト、英語)
• JSR349(外部サイト、英語)