Jsf-customconvertor-tag
提供:Dev Guides
JSF-カスタムコンバーター
JSFで独自のカスタムコンバーターを作成できます。
JSFでのカスタムコンバーターの定義は、3つのステップから成るプロセスです。
Step | Description |
---|---|
1 | Create a converter class by implementing javax.faces.convert.Converter interface. |
2 | Implement getAsObject() and getAsString() methods of above interface. |
3 | Use Annotation @FacesConvertor to assign a unique id to the custom convertor. |
ステップ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.finddevguides.test.UrlConverter")
public class UrlConverter implements Converter {
}
JSFページでコンバーターを使用する
<h:inputText id = "urlInput" value = "#{userData.data}" label = "URL" >
<f:converter converterId = "com.finddevguides.test.UrlConverter"/>
</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 UrlData.java under package com.finddevguides.test as explained below. |
3 | Create UrlConvertor.java as a converter under package com.finddevguides.test as explained below. |
4 | Create UserData.java as a managed bean under package com.finddevguides.test as explained below. |
5 | Modify home.xhtml as explained below. Keep rest of the files unchanged. |
6 | Create result.xhtml in the webapps directory as explained below. |
7 | Compile and run the application to make sure the business logic is working as per the requirements. |
8 | Finally, build the application in the form of war file and deploy it in Apache Tomcat Webserver. |
9 | Launch your web application using appropriate URL as explained below in the last step. |
UrlData.java
package com.finddevguides.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.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.convert.Converter;
import javax.faces.convert.ConverterException;
import javax.faces.convert.FacesConverter;
@FacesConverter("com.finddevguides.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.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 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.finddevguides.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-最初のアプリケーションの章で行ったようにアプリケーションをコンパイルして実行します。 すべてがアプリケーションで問題ない場合、次の結果が生成されます。
無効な値を入力して、[送信]ボタンを押します。 次のエラーメッセージを参照してください。
有効な値を入力して、[送信]ボタンを押します。 次の結果を参照してください。