JSF - 自定義驗證器

我們可以在 JSF 中建立自己的自定義驗證器。

在 JSF 中定義自定義驗證器是一個三步過程。

步驟	描述
1	透過實現 javax.faces.validator.Validator 介面來建立一個驗證器類。
2	實現上述介面的 validate() 方法。
3	使用註解 @FacesValidator 為自定義驗證器分配一個唯一的 ID。

步驟 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.tutorialspoint.test.UrlValidator")
public class UrlValidator implements Validator {
}

在 JSF 頁面中使用驗證器

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

示例應用程式

讓我們建立一個測試 JSF 應用程式來測試上述標籤。

步驟	描述
1	在 com.tutorialspoint.test 包下建立一個名為 helloworld 的專案，如 JSF - 第一個應用程式章節中所述。
2	如以下所述，在 com.tutorialspoint.test 包下建立 UrlValidator.java 作為轉換器。
3	如以下所述，在 com.tutorialspoint.test 包下建立 UserData.java 作為託管Bean。
4	如以下所述修改 home.xhtml。保持其餘檔案不變。
5	如以下所述在 webapps 目錄中建立 result.xhtml。
6	編譯並執行應用程式以確保業務邏輯按要求工作。
7	最後，將應用程式構建成 war 檔案並將其部署到 Apache Tomcat Web 伺服器中。
8	使用適當的 URL 啟動您的 Web 應用程式，如以下最後一步中所述。

UrlValidator.java

package com.tutorialspoint.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.tutorialspoint.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.tutorialspoint.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.tutorialspoint.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_validation_tags.htm

列印頁面