JSF - 自定義轉換器

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

在 JSF 中定義自定義轉換器是一個三步過程。

步驟	描述
1	透過實現javax.faces.convert.Converter介面建立一個轉換器類。
2	實現上述介面的getAsObject()和getAsString()方法。
3	使用註解@FacesConvertor為自定義轉換器分配一個唯一ID。

步驟 1：建立轉換器類：UrlConverter.java

public class UrlConverter implements Converter {
...
}

步驟 2：實現轉換器介面方法：UrlConverter.java

建立一個簡單的類來儲存資料：UrlData。此類將儲存一個 URL 字串。

public class UrlData {
   private String url;

   public UrlData(String url) {
      this.url = url;
   }
   ...
}

在getAsObject方法中使用UrlData。

public class UrlConverter implements Converter {
   
   @Override
   public Object getAsObject(FacesContext facesContext,
      UIComponent component, String value) {
      ...
      UrlData urlData = new UrlData(url.toString()); 
      return urlData;
   }

   @Override
   public String getAsString(FacesContext facesContext, 
      UIComponent component, Object value) {
      return value.toString();
   }
}

步驟 3：使用註解註冊轉換器：UrlConverter.java

@FacesConverter("com.tutorialspoint.test.UrlConverter")
public class UrlConverter implements Converter {
}

在 JSF 頁面中使用轉換器

<h:inputText id = "urlInput" value = "#{userData.data}" label = "URL" >
   <f:converter converterId = "com.tutorialspoint.test.UrlConverter" />
</h:inputText>

示例應用程式

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

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

UrlData.java

package com.tutorialspoint.test;

public class UrlData {
   private String url;
   
   public UrlData(String url) {
      this.url = url;
   }
   
   public String getUrl() {
      return url;
   }

   public void setUrl(String url) {
      this.url = url;
   }
   
   public String toString() {
      return url;
   }
}

UrlConvertor.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.convert.Converter;
import javax.faces.convert.ConverterException;
import javax.faces.convert.FacesConverter;

@FacesConverter("com.tutorialspoint.test.UrlConverter")
public class UrlConverter implements Converter {

   @Override
   public Object getAsObject(FacesContext facesContext, 
      UIComponent component, String value) {
      StringBuilder url = new StringBuilder();

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

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

      UrlData urlData = new UrlData(url.toString()); 
      return urlData;
   }

   @Override
   public String getAsString(FacesContext facesContext,
      UIComponent component, Object value) {
         return value.toString();
   }
}

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 UrlData data;

   public UrlData getData() {
      return data;
   }

   public void setData(UrlData 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 Converter Example</h2>
      
      <h:form>
         <h:inputText id = "urlInput" value = "#{userData.data}" 
            label = "URL" >
            <f:converter converterId = "com.tutorialspoint.test.UrlConverter" />
         </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_convertor_tags.htm

列印頁面