Struts2 学习系列 (6) 类型转换器

基本概述

  从一个 HTML 表单到一个 Action 对象, 类型转换是从字符串到非字符串.

  HTTP 没有 “类型” 的概念. 每一项表单输入只可能是一个字符串或一个字符串数组. 在服务器端, 必须把 String 转换为特定的数据类型

  在 struts2 中, 把请求参数映射到 action 属性的工作由 Parameters 拦截器负责, 它是默认的 defaultStack 拦截器中的一员. Parameters 拦截器可以自动完成字符串和基本数据类型之间转换.

如果类型转换失败:

  若 Action 类没有实现 ValidationAware 接口： Struts 在遇到类型转换错误时仍会继续调用其 Action 方法, 就好像什么都没发生一样.

  若 Action 类实现 ValidationAware 接口：Struts 在遇到类型转换错误时将不会继续调用其 Action 方法: Struts 将检查相关 action 元素的声明是否包含着一个 name=input 的 result. 如果有, Struts 将把控制权转交给那个 result 元素; 若没有 input 结   果, Struts 将抛出一个异常

类型转换错误消息的定制

  作为默认的 default 拦截器的一员, ConversionError 拦截器负责添加与类型转换有关的出错消息(前提: Action 类必须实现了 ValidationAware 接口)和保存各请求参数的原始值.
若字段标签使用的不是 simple 主题, 则非法输入字段将导致一条有着以下格式的出错消息:

Invalid field value for filed filedName

覆盖默认的出错消息(格式化错误消息)
    在对应的 Action 类所在的包中新建 ActionClassName.properties 文件, ClassName 即为包含着输入字段的 Action 类的类名
    在属性文件中添加如下键值对: invalid.filedvalue.filedName = error message

    例如: invalid.fieldvalue.age=\u9519\u8BEF\u7684\u5E74\u9F84\u683C\u5F0F.
  定制出错消息的样式:
    每一条出错消息都被打包在一个 HTML span 元素里, 可以通过覆盖其行标为 errorMessage 的那个 css 样式来改变出错消息的格式.
    显示错误消息: 如果是 simple 主题, 可以通过 <s:fielderror fieldName=“filedname”></s:fielderror> 标签显示错误消息

    同时我们可以知道,在值栈中,会存在error的一个属性,该属性记录了类型转换的错误信息

定制类型转换器

  自定义类型转换器必须实现 ongl.TypeConverter 接口或对这个接口的某种具体实现做扩展

扩展 StrutsTypeConverter 类

  在大多数类型转换器里, 需要提供从 String 类型到非 String 类型和与此相反的转换功能
  在 StrutsTypeConverter 中有两个抽象方法:

配置自定义的类型转换器

  在应用程序里使用一个自定义的类型转换器之前, 必须先对它进行配置. 这种配置既可以基于字段(局部), 也可以基于类型(全局)

  基于字段配置: 可以为某个 Model（该 Model 类也可能是 Action） 的各个属性分别配置一个自定义的转换器. 
1. 创建一个属性文件: ModelClassName-conversion.properties, 该文件需和相对应的 Model 类放在同一个目录下
2. 编辑属性文件: 

实例:我们在ConversionAction本层目录下面我们添加一个ConversionAction.properties

内容: birth=com.atguigu.struts2.app.converters.DateConverter,这样实现了在局部类型转换的功能.

DateConverter 便是自定义的类型转换器:

package com.atguigu.struts2.app.converters;

import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Map;

import javax.servlet.ServletContext;

import org.apache.struts2.ServletActionContext;
import org.apache.struts2.util.StrutsTypeConverter;

public class DateConverter extends StrutsTypeConverter {

	private DateFormat dateFormat;
	
	public DateConverter() {
		System.out.println("DateConverter's constructor...");
	}
	
	public DateFormat getDateFormat(){
		if(dateFormat == null){
			//获取当前 WEB 应用的初始化参数 pattern
			ServletContext servletContext = ServletActionContext.getServletContext();
			System.out.println(servletContext); 
			String pattern = servletContext.getInitParameter("pattern");
			dateFormat = new SimpleDateFormat(pattern);
		}
		
		return dateFormat;
	}
	
	@Override
	public Object convertFromString(Map context, String[] values, Class toClass) {
		
		System.out.println("convertFromString...");
		
		if(toClass == Date.class){
			if(values != null && values.length > 0){
				String value = values[0];
				try {
					return getDateFormat().parseObject(value);
				} catch (ParseException e) {
					e.printStackTrace();
				}
			}
		}
		
		//若没有转换成功, 则返回 values
		return values;
	}

	@Override
	public String convertToString(Map context, Object o) {
		
		System.out.println("convertToString...");
		
		if(o instanceof Date){
			Date date = (Date) o;
			return getDateFormat().format(date);
		}
		
		//若转换失败返回 null
		return null;
	}

}

基于类型配置: 
在 WEB-INF/classes/ 目录下创建 xwork-conversion.properties 文件. 
在 xwork-conversion.properties 文件里把每一个需要进行类型转换的类与一个类型转换器关联起来

例如: 我们在项目的src目录下添加一个文件,名称为:xwork-conversion.properties

内容: java.util.Date=com.atguigu.struts2.app.converters.DateConverter

到此我们实现了全局类型转换的问题.