Struts2學習筆記(七)——類型轉換

1、自動類型轉換

Struts2內部提供大量類型轉換器，用來完成數據類型轉換問題：

• String和boolean、Boolean：完成字符串與布爾值之間的轉換
• String和char、Character：往常字符串與字符之間的轉換
• String和int、Integer：完成字符串與整型之間的轉換
• String和long、Long：完成字符串與長整型值之間的轉換
• String和double、Double：完成字符串與雙精度浮點值的轉換
• String和float、Float：完成字符串和單精度浮點之間的轉換
• String和Date：完成字符串和日期類型之間的轉換，可以接收yyyy-MM-dd格式字符串
• String和數組：可以將多個同名參數，轉換到數組中
• String和Map、List：支持將數據保存到List或者Map集合

自動類型轉換例子：

表單信息：

<form action="${pageContext.servletContext.contextPath}/converterAction.action">
    name:<input type="text" name="name"><br>
    password:<input type="password" name="password"><br>
    age:<input type="text" name="age"><br>
    birthday:<input type="text" name="birthday"><br>
    hobby:<input name="hobby" type="checkbox" value="music">music
        <input name="hobby" type="checkbox" value="movie">movie<br>
    <input type="submit" value="提交">
</form>

Action類：

public class ConverterAction extends ActionSupport {
    private String name;
    private String password;
    private int age;
    private Date birthday;
    private String[] hobby;
    
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getPassword() {
        return password;
    }
    public void setPassword(String password) {
        this.password = password;
    }
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
    public Date getBirthday() {
        return birthday;
    }
    public void setBirthday(Date birthday) {
        this.birthday = birthday;
    }
    public String[] getHobby() {
        return hobby;
    }
    public void setHobby(String[] hobby) {
        this.hobby = hobby;
    }
    
    @Override
    public String execute() throws Exception {
        System.out.println("name: " + name);
        System.out.println("password: " + password);
        System.out.println("age: " + age);
        System.out.println("birthday: " + birthday);
        System.out.print("hobby: ");
        for (int i = 0; i < hobby.length; i++) {
            System.out.print(hobby[i]);
            if (i != hobby.length - 1) {
                System.out.print(", ");
            }
        }
        return SUCCESS;
    }
}

前台輸入信息：

后台顯示信息：

2、自定義類型轉換

  1)基於OGNL的類型轉換器

　　Struts2的類型轉換器實際上是基於OGNL實現的，都需要實現一個TypeConverter接口，該接口位於ognl.jar包內。該接口定義了一個convertValue()方法，實現該接口的類型轉換器實現類都需要重寫該方法來進行類型轉換。

public Object convertValue(Map<String, Object> context, Object target, Member member, String propertyName, Object value, Class toType);

　　由於TypeConverter接口的convertValue()方法過於復雜，OGNL還提供了一個實現TypeConverter接口的類DefaultTypeConverter，開發者只要繼承該類，就可以開發類型轉換器的實現類。DefaultTypeConverter類的子類需要重寫convertValue()方法，來實現字符串類型與復合類型之間的雙向轉換，convertValue()方法有三個參數：Map context：該參數為類型轉換環境的上下文內容；Object value：該參數為需要轉換的參數，是一個字符串數組；Class toType：該參數指的是轉換目標的類型。

　　在Struts2中並沒有直接使用ognl.DefaultTypeConverter實現類，甚至都沒有使用ognl.TypeConverter接口，而是自己定義了一個與ognl.TypeConverter接口一樣的TypeConverter接口，該接口位於com.opensymphony.xwork2.conversion包下，其名稱和接口函數定義完全相同。Struts2自行定義TypeConverter接口的目的在於對外屏蔽類型轉換的實現細節，從而能夠將Struts2對TypeConverter的擴展實現納入到Struts2的容器中進行管理，從而方便對OGNL原始的TypeConverter接口進行擴展並支持更加廣泛的類型轉換邏輯。

　　在Struts2的com.opensymphony.xwork2.conversion包下DefaultTypeConverter實現類有3個convertValue方法：

所以我們在繼承com.opensymphony.xwork2.conversion包下DefaultTypeConverter實現類的時候可以直接重寫convertValue(Object value, Class toType)方法即可。

無論是繼承ongl包下的DefaultTypeConverter還是繼承com.opensymphony.xwork2.conversion包下DefaultTypeConverter，在自定義類型轉換的時候，實現方式都一樣。

  2)基於Struts2的類型轉換器

　　Struts2框架提供了一個類型轉換器的StrutsTypeConverter抽象類，可以繼承該類來開發自定義的類型轉換器實現類。 該抽象類實際上繼承了DefaultTypeConverter類，在該類的基礎上進行了簡化。StrutsTypeConverter類中提供了兩個抽象方法，分別實現"form字符串參數-Struts復合類型"之間的雙向轉換。

3、注冊類型轉換器

在Struts2框架中使用自定義類型轉換器需要注冊，這樣Struts2框架在處理用戶請求的時候才知道使用哪個類型轉換器進行轉換。Struts2有兩種方式注冊類型轉換器：

 1)注冊局部類型轉換器

　　局部類型轉換器僅僅對某個Action的屬性其作用，注冊局部類型轉換器需要建立一個命名規則為ActionName-conversion.properties的屬性文件，該屬性文件保存在與Action類文件相同的目錄下。ActionName就是使用類型轉換器的Action類的類名，而-conversion.properties是固定的格式。該文件是一個標准的屬性文件，內容為標准的Key-Value格式，該鍵值對定義如下：

<!--propertyName為要進行轉換的屬性名-->
propertyName=類型轉換器

如果在model中有兩個類User和Product，它們都有Date類型屬性，都需要在頁面上輸入，但是它們格式不一樣，例如:

　　User birthday 格式：yyyy/MM/dd

　　Product producttime 格式：yyyy-MM-dd

如果遇到這種情況，可以在model所在的包下創建注冊的properties文件，名稱的命名規則為modelname-conversion.properties，該屬性文件的內容和上面的一樣：

<!--propertyName為要進行轉換的屬性名-->
propertyName=類型轉換器

 2)注冊全局類型轉換器

　　全局類型轉換器對所有Action的特定屬性都會生效，注冊一個全局類型轉換器，需要建立一個xwork-conversion.properties屬性文件，該文件需要保存在class路徑的根目錄下，如WEB-INF/classes。該文件的內容為"復合類型-對應的類型轉換器"，其中復合類型就是Action中需要進行類型轉換的屬性所屬於的類型，對應的類型轉換器就是轉換該復合類型的對應轉換器，比如要對Date類型的屬性進行轉換：

java.util.Date=com.sunny.converter.DateConverter

4、類型轉換器的實現

在類型轉換器的實現例子中自定義類型轉換器繼承的是DefaultTypeConverter，注冊局部類型轉換器。

表單信息：

<form action="${pageContext.servletContext.contextPath}/converterAction.action">
    name:<input type="text" name="name"><br>
    password:<input type="password" name="password"><br>
    age:<input type="text" name="age"><br>
    birthday:<input type="text" name="birthday"><br>
    hobby:<input name="hobby" type="checkbox" value="music">music
        <input name="hobby" type="checkbox" value="movie">movie<br>
    <input type="submit" value="提交">
</form>

自定義類型轉換器類：

public class DateConverter extends DefaultTypeConverter {
    @Override
    public Object convertValue(Object value, Class toType) {
        if (value == null || toType == null) {
            return false;
        }
        
        if (toType != Date.class) {
            return false;
        }
        
        /*
         * 對於DefaultTypeConverter轉換器而言,它必須考慮到最通用的情形，
         * 因此他把所有請求參數都視為字符串數組而不是字符串。
         */
        if (value instanceof String[]) {
            String str[] = (String[])value;
            if (str[0] != null && str[0].length() > 0) {
                SimpleDateFormat sdf = new SimpleDateFormat("yyyy/MM/dd");
                try {
                    //把請求參數轉換成特定格式的date類
                    return sdf.parse(str[0]);
                } catch (ParseException e) {
                    /*
                     *  在struts2框架里，自定義的類型轉換器，
                     *  如果我們不手動拋出異常，struts2框架只捕獲異常，但是並不拋出。
                     *  所以框架就會認為類型轉換器轉換成功，轉向成功頁面。
                     */
                    throw new RuntimeException(e);
                }
            }
        }
        return new Date();
    }
}

注冊局部類型轉換器，對Date類型的birthday進行轉換，接收yyyy/MM/dd類型字符串：

birthday=com.sunny.converter.DateConverter

Action類：

public class ConverterAction extends ActionSupport {
    private String name;
    private String password;
    private int age;
    private Date birthday;
    private String[] hobby;
    
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getPassword() {
        return password;
    }
    public void setPassword(String password) {
        this.password = password;
    }
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
    public Date getBirthday() {
        return birthday;
    }
    public void setBirthday(Date birthday) {
        this.birthday = birthday;
    }
    public String[] getHobby() {
        return hobby;
    }
    public void setHobby(String[] hobby) {
        this.hobby = hobby;
    }
    
    @Override
    public String execute() throws Exception {
        System.out.println("name: " + name);
        System.out.println("password: " + password);
        System.out.println("age: " + age);
        System.out.println("birthday: " + birthday);
        System.out.print("hobby: ");
        for (int i = 0; i < hobby.length; i++) {
            System.out.print(hobby[i]);
            if (i != hobby.length - 1) {
                System.out.print(", ");
            }
        }
        return SUCCESS;
    }
}

前台輸入信息：

后台顯示信息：

注意事項：

• 在進行自定義類型轉換時，如果轉換錯誤，我們不手動拋出異常，struts2框架只捕獲異常，並不拋出，框架就會認為轉換成功，轉向成功頁面，所以一定要手動拋出異常。
• 不管是自動類型轉換還是自定義類型轉換，如果類型轉換錯誤，會跳轉到input視圖，如果在struts.xml文件中沒有name值為"input"的<result>，會跳轉到錯誤頁面。

5、錯誤處理機制

 Struts2的錯誤處理是由conversionError攔截器自動完成的，當發生類型轉換錯誤時，conversionError攔截器攔截此錯誤並封裝成fieldError，將此錯誤信息放入ActionContext中，並返回input邏輯視圖，我們前面提到過此時必須在struts.xml文件中有name值為"input"的<result>，在jsp頁面中可以使用<s:fielderror/>即可顯示錯誤信息，默認顯示的錯誤信息是在屬性文件xwork-messages.properties中定義的：

xwork.error.action.execution=Error during Action invocation
xwork.exception.missing-action=There is no Action mapped for action name {0}.
xwork.exception.missing-package-action=There is no Action mapped for namespace {0} and action name {1}.
xwork.default.invalid.fieldvalue=Invalid field value for field "{0}".

當birthday輸入格式錯誤時，根據action中的<result name="input">/error.jsp</result>會跳轉到error.jsp頁面，

jsp頁面信息：

<body>
<s:fielderror fieldName="birthday"/>
</body>

jsp頁面顯示信息：

如果我們需要配置顯示的錯誤信息，有方式有兩種：

1)在國際化資源文件中配置

xwork.default.invalid.fieldvalue={0},錯誤;

在項目中建立一個國際化資源文件converter.properties，文件名可以隨便，在文件中輸入下面內容：

xwork.default.invalid.fieldvalue={0},錯誤;

然后，在struts.xml文件中配置<constant name="struts.custom.i18n.resources" value="com.sunny.action.converter" />

<struts>
    <constant name="struts.devMode" value="true" />
    <constant name="struts.custom.i18n.resources" value="com.sunny.action.converter" />
    <package name="default" namespace="/" extends="struts-default">
        <action name="converterAction" class="com.sunny.action.ConverterAction">
            <result>/success.jsp</result>
            <result name="input">/error.jsp</result>
        </action>
    </package>

</struts>

說明：資源文件的定義有好幾種方式，會在國際化中講到

如果birthday輸入格式錯誤，顯示如下：

2)配置Action特定屬性錯誤信息

在Action所在包中，創建ActionName.properties，在文件中配置提示信息： invalid.fieldvalue.屬性名= 錯誤信息，其中invalid.fieldvalue為固定格式

invalid.fieldvalue.birthday=日期類型轉換錯誤,要求格式必須是yyyy/MM/dd;

顯示效果：

這種配置方式的內容：invalid.fieldvalue.birthday=日期類型轉換錯誤,要求格式必須是yyyy/MM/dd;也可以配置在國際化資源文件中，同樣可以起作用。

注意：類型轉換的Action在struts.xml中配置所在包需要extends="struts-default"，因此在此文件中包含conversionError攔截器