ウェブサイト検索

JSF バリデーション例チュートリアル - バリデータタグ、カスタムバリデータ

JSF検証モデルは、UIコンポーネントを検証するための標準クラスのセットを定義しています。JSFライブラリは、javax.faces.validator.Validator実装に対応するコアタグのグループを定義しています。標準エラーメッセージの他にも、検証モデルではカスタム検証を定義することができます。JSFの検証は、命令型と宣言型に分類できます。

JSF検証 - 宣言型バリデータ

JSFの標準バリデータまたはBeanバリデータを使用して発火するバリデーションは、宣言型のタイプに該当します。JSFの標準バリデータの例には、長さバリデータや必須バリデータなどがあります…標準バリデータの例を考えてみましょう。mobile.xhtmlとしてmobile.xhtmlを作成します。

<?xml version='1.0' encoding='UTF-8' ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="https://www.w3.org/1999/xhtml"
	xmlns:h="https://java.sun.com/jsf/html">
<h:head>
</h:head>
<h:body>
	<h3>Add Mobile Details</h3>
	<h:form>
		<h:panelGrid columns="3">
			<h:outputLabel for="mname">Mobile Name:</h:outputLabel>
			<h:inputText id="mname" required="true"
				requiredMessage="Mobile Name is mandatory"></h:inputText>
			<br>
			<br>

			<h:outputLabel for="color">Color:</h:outputLabel>
			<h:inputText id="color" required="true"></h:inputText>
			<br>
			<br>

			<h:outputLabel for="model">Model Number:</h:outputLabel>
			<h:inputText id="model"></h:inputText>
			<br>
			<br>

			<h:commandButton value="Submit"></h:commandButton>
		</h:panelGrid>
	</h:form>
</h:body>
</html>

ここでは、必要な属性を true に設定しています。これにより、フィールドが必須になり、カラーフィールドには「値が必要です」というカスタムメッセージが表示され、モバイル名フィールドには requiredmessage 属性に指定されたメッセージに従ってユーザー定義のメッセージが表示されます。アプリケーションを実行すると、送信ボタンを押すと以下の出力が表示されます。

JSFの命令的バリデーション

標準の検証メッセージはすべてのケースで十分ではなく、時には複雑な検証が必要になることがあります。命令的検証は、ユーザーがこれを行うことを可能にします。

  1. Beanメソッドからのバリデーションを実行する
  2. 実行時にクラス内で@FacesValidatorアノテーションを使用してください。

Beanメソッドからの検証の実行 このタイプの検証では、UIコンポーネントを検証するためにBean内にメソッドを書き、そのメソッドをinputTextタグのvalidator属性を介してjsfページから呼び出します。では、Beanから検証を実行する例を見てみましょう。mob.xhtml

<?xml version='1.0' encoding='UTF-8' ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="https://www.w3.org/1999/xhtml"
	xmlns:h="https://java.sun.com/jsf/html">
<h:head>
</h:head>
<h:body>
	<h3>Add Mobile Details</h3>
	<h:form>
		<h:outputLabel for="mno">Model Number:</h:outputLabel>
		<h:inputText id="mno" value="#{mobile.mno}" required="true" size="4"
			disabled="#{mobile.mno}" validator="#{mobile.validateModelNo}">
		</h:inputText>
		<h:commandButton value="Submit"></h:commandButton>
	</h:form>
</h:body>
</html>

このページでは、validatorタグ属性でJava BeanのvalidateModelnoメソッドを呼び出しています。Mobile.javaを作成します。

package com.journaldev.jsf.bean;

import java.io.Serializable;
import javax.faces.application.FacesMessage;
import javax.faces.bean.ManagedBean;
import javax.faces.bean.SessionScoped;
import javax.faces.component.UIComponent;
import javax.faces.component.UIInput;
import javax.faces.context.FacesContext;

@ManagedBean
@SessionScoped
public class Mobile implements Serializable {

	private static final long serialVersionUID = -7250065889869767422L;

	// @NotNull(message="Please enter the model number")
	private String mno;

	public String getMno() {
		return mno;
	}

	public void setMno(String mno) {
		this.mno = mno;
	}

	public void validateModelNo(FacesContext context, UIComponent comp,
			Object value) {

		System.out.println("inside validate method");

		String mno = (String) value;

		if (mno.length() < 4) {
			((UIInput) comp).setValid(false);

			FacesMessage message = new FacesMessage(
					"Minimum length of model number is 4");
			context.addMessage(comp.getClientId(context), message);

		}

	}

}

ここでは、モデル番号の長さを確認しており、長さが4未満の場合は、「モデル番号の最小長は4です」とメッセージを指定しています。さて、次にアプリケーションを実行し、次の出力を生成します。

Bean内で@FacesValidatorを使用する - カスタムJSFバリデーター

この方法では、@FacesValidator アノテーションを使用し、バリデータの名前を指定し、validate メソッドをオーバーライドしてバリデータを実装します。mobvalidator.xhtml

<?xml version='1.0' encoding='UTF-8' ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="https://www.w3.org/1999/xhtml"
	xmlns:h="https://xmlns.jcp.org/jsf/html"
	xmlns:f="https://java.sun.com/jsf/core">
<h:head>
</h:head>
<h:body>
	<h:form>
		<h3>Validation using Faces validator</h3>
		<h:outputLabel for="mno" value="Model Number: " />
		<h:inputText id="mno" value="#{mobileValidator.mno}">
		<f:validator validatorId="mobileValidator" />
		</h:inputText>
		<h:message for="mno" style="color:blue" />
		<p></p>
		<h:commandButton value="Submit"></h:commandButton>
	</h:form>
</h:body>
</html>

この中では、 タグの validatorId 属性で「mobileValidator」というカスタムバリデーターを呼び出しています。MobileValidator.java を作成します。

package com.journaldev.jsf.bean;

import javax.faces.application.FacesMessage;
import javax.faces.bean.ManagedBean;
import javax.faces.bean.SessionScoped;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.validator.FacesValidator;
import javax.faces.validator.Validator;
import javax.faces.validator.ValidatorException;

@ManagedBean
@SessionScoped
@FacesValidator("mobileValidator")
public class MobileValidator implements Validator {

	private String mno;

	public String getMno() {
		return mno;
	}

	public void setMno(String mno) {
		this.mno = mno;
	}

	int maximumlength = 6;

	public MobileValidator() {
	}

	@Override
	public void validate(FacesContext fc, UIComponent uic, Object obj)
			throws ValidatorException {

		String model = (String) obj;

		if (model.length() > 6) {
			FacesMessage msg = new FacesMessage(
					" Maximum Length of 6 is exceeded.Please enter values within range");
			msg.setSeverity(FacesMessage.SEVERITY_ERROR);

			throw new ValidatorException(msg);
		}

	}

}

ここでは、標準の validate メソッドをオーバーライドし、入力フィールドを検証するための独自のロジックを実装します。アプリケーションを実行して、以下のように出力を確認してください。

JSFバリデーション例プロジェクトをダウンロードする

関連記事: