JSF-カスタム検証

JSFで独自のカスタムバリデーターを作成できます。

JSFでのカスタムバリデーターの定義は、3ステップのプロセスです。

Step	Description
1	Create a validator class by implementing javax.faces.validator.Validator interface.
2	Implement validate() method of the above interface.
3	Use Annotation @FacesValidator to assign a unique ID to the custom validator.

ステップ1：検証クラスを作成する：UrlValidator.java

public class UrlValidator implements Validator {
...
}

ステップ2：バリデーターインターフェースメソッドの実装：UrlValidator.java

public class UrlValidator implements Validator {

   @Override
   public void validate(FacesContext facesContext,
      UIComponent component, String value) throws ValidatorException {
      ...
   }
}

ステップ3：バリデーターを登録するための注釈：UrlValidator.java

@FacesValidator("com.finddevguides.test.UrlValidator")
public class UrlValidator implements Validator {
}

JSFページでバリデーターを使用する

<h:inputText id="urlInput" value="#{userData.data}" label="URL" >
   <f:validator validatorId="com.finddevguides.test.UrlValidator"/>
</h:inputText>

応用例

上記のタグをテストするテストJSFアプリケーションを作成しましょう。

Step	Description
1	Create a project with a name helloworld under a package com.finddevguides.test as explained in the JSF - First Application chapter.
2	Create UrlValidator.java as a converter under package com.finddevguides.test as explained below.
3	Create UserData.java as a managed bean under package com.finddevguides.test as explained below.
4	Modify home.xhtml as explained below. Keep rest of the files unchanged.
5	Create result.xhtml in the webapps directory as explained below.
6	Compile and run the application to make sure business logic is working as per the requirements.
7	Finally, build the application in the form of war file and deploy it in Apache Tomcat Webserver.
8	Launch your web application using appropriate URL as explained below in the last step.

UrlValidator.java

package com.finddevguides.test;

import java.net.URI;
import java.net.URISyntaxException;

import javax.faces.application.FacesMessage;
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;

@FacesValidator("com.finddevguides.test.UrlValidator")
public class UrlValidator implements Validator {

   @Override
   public void validate(FacesContext facesContext,
      UIComponent component, Object value)
      throws ValidatorException {
      StringBuilder url = new StringBuilder();
      String urlValue = value.toString();

      if(!urlValue.startsWith("http://", 0)) {
         url.append("http://");
      }
      url.append(urlValue);

      try {
         new URI(url.toString());
      } catch (URISyntaxException e) {
         FacesMessage msg =
            new FacesMessage("URL validation failed","Invalid URL format");
         msg.setSeverity(FacesMessage.SEVERITY_ERROR);
         throw new ValidatorException(msg);
      }
   }
}

UserData.java

package com.finddevguides.test;

import java.io.Serializable;

import javax.faces.bean.ManagedBean;
import javax.faces.bean.SessionScoped;

@ManagedBean(name = "userData", eager = true)
@SessionScoped
public class UserData implements Serializable {
   private static final long serialVersionUID = 1L;
   public String data;

   public String getData() {
      return data;
   }

   public void setData(String data) {
      this.data = data;
   }
}

home.xhtml

<?xml version = "1.0" encoding = "UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns = "http://www.w3.org/1999/xhtml"
   xmlns:h = "http://java.sun.com/jsf/html"
   xmlns:f = "http://java.sun.com/jsf/core">

   <h:head>
      <title>JSF tutorial</title>
   </h:head>

   <h:body>
      <h2>Custom Validator Example</h2>

      <h:form>
         <h:inputText id = "urlInput" value = "#{userData.data}"
            label = "URL" >
            <f:validator validatorId = "com.finddevguides.test.UrlValidator"/>
         </h:inputText>
         <h:commandButton value = "submit" action = "result"/>
         <h:message for = "urlInput" style = "color:red"/>
      </h:form>

   </h:body>
</html>

result.xhtml

<?xml version = "1.0" encoding = "UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns = "http://www.w3.org/1999/xhtml"
   xmlns:f = "http://java.sun.com/jsf/core"
   xmlns:h = "http://java.sun.com/jsf/html"
   xmlns:ui = "http://java.sun.com/jsf/facelets">

   <h:body>
      <h2>Result</h2>
      <hr/>
      #{userData.data}
   </h:body>
</html>

すべての変更を完了したら、JSF-最初のアプリケーションの章で行ったようにアプリケーションをコンパイルして実行します。すべてがアプリケーションで問題ない場合、次の結果が生成されます。

JSFカスタム検証ツール

無効な値を入力して、[送信]ボタンを押します。次のエラーメッセージを参照してください。

JSFカスタムバリデーター1

有効な値を入力して、[送信]ボタンを押します。以下が出力です。

JSFカスタム検証2

Jsf-customvalidator-tag

目次