传智播客课程——Struts2输入校验

输入校验有两种实现方法: 手工编写代码实现和基于XML配置方式实现。

---

1. 手工编写代码实现。

通过重写validate()或validateXxx()方法实现，validate()方法会校验action中所有与execute方法签名相同的方法。 validateXxx()只会校验action中方法名为Xxx的方法。其中Xxx的第一个字母要大写。当某个数据校验失败时，我们应该调用addFieldError()方法往系统的fieldErrors添加校验失败信息（为了使用addFieldError()方法，action可以继承ActionSupport ），如果系统的fieldErrors包含失败信息，struts2会将请求转发到名为input的result。在input视图中可以通过<s:fielderror/>显示失败信息。

validate()使用例子：

@Override

public void validate() {

          if(username==null && "".equals(username.trim()))  this.addFieldError("username", "用户名不能为空");

}

validateXxx()方法使用例子：

public String add() throws Exception{

       return "success";

}    

public void validateAdd(){

          if(username==null && "".equals(username.trim()))  this.addFieldError("username", "用户名不能为空");

}

验证失败后，请求转发至input视图：

<result name="input">/WEB-INF/page/addUser.jsp</result>

在addUser.jsp页面中使用<s:fielderror/>显示失败信息。

---

2. 输入校验的流程

<1> 类型转换器对请求参数执行类型转换，并把转换后的值赋给action中的属性。

<2> 如果在执行类型转换的过程中出现异常，系统会将异常信息保存到ActionContext，conversionError拦截器将异常信息封装到fieldErrors里，然后执行第<3>步。如果类型转换没有出现异常，则直接进入第<3>步。

<3> 系统通过反射技术调用action中的validateXxx()方法，Xxx为方法名。

<4> 调用action中的validate()方法。

<5> 经过上面4步，如果系统中的fieldErrors存在错误信息（即存放错误信息的集合的size大于0)，系统自动将请求转发至名称为input的视图。如果系统中的fieldErrors没有任何错误信息，系统将执行action中的处理方法。 

---

3. 基于XML配置方式实现。

Action类需要继承ActionSupport，然后提供校验文件，如下：

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE validators PUBLIC "-//OpenSymphony Group//XWork Validator 1.0.3//EN" "http://www.opensymphony.com/xwork/xwork-validator-1.0.3.dtd">

<validators>

    <field name="username">

        <field-validator type="requiredstring">

            <param name="trim">true</param>

            <message>用户名不能为空!</message>

        </field-validator>

    </field>

</validators>

<1> 在这个校验文件中，对action中字符串类型的username属性进行验证，首先要求调用trim()方法去掉空格，然后判断用户名是否为空。该文件需要和action类放在同一个包下，文件的取名应遵守ActionClassName-validation.xml规则，其中ActionClassName为action的简单类名，-validation为固定写法。如果Action类为cn.itcast.action.UserAction，那么该文件的取名应为：UserAction-validation.xml。

<2> 这个校验文件中，<field>指定action中要校验的属性，<field-validator>指定校验器，<message>为校验失败后的提示信息,如果需要国际化，可以为message指定key属性，key的值为属性文件中的key。

<3> 上面指定的校验器requiredstring是由系统提供的，系统提供了能满足大部分验证需求的校验器，这些校验器的定义可以在xwork-2.x.jar中的com.opensymphony.xwork2.validator.validators下的default.xml中找到。

<4> 系统提供的校验器如下：

required (必填校验器,要求field的值不能为null)

requiredstring (必填字符串校验器,要求field的值不能为null,并且长度大于0,默认情况下会对字符串去前后空格)

stringlength(字符串长度校验器,要求field的值必须在指定的范围内,否则校验失败,minLength参数指定最小长度,maxLength参数指定最大长度,trim参数指定校验field之前是否去除字符串前后的空格)

regex(正则表达式校验器,检查被校验的field是否匹配一个正则表达式.expression_r参数指定正则表达式,caseSensitive参数指定进行正则表达式匹配时,是否区分大小写,默认值为true)

int(整数校验器,要求field的整数值必须在指定范围内,min指定最小值,max指定最大值)

double(双精度浮点数校验器,要求field的双精度浮点数必须在指定范围内,min指定最小值,max指定最大值)

fieldexpression_r(字段OGNL表达式校验器,要求field满足一个ognl表达式,expression_r参数指定ognl表达式,该逻辑表达式基于ValueStack进行求值,返回true时校验通过,否则不通过)

email(邮件地址校验器,要求如果field的值非空,则必须是合法的邮件地址)

url(网址校验器,要求如果field的值非空,则必须是合法的url地址)

date(日期校验器,要求field的日期值必须在指定范围内,min指定最小值,max指定最大值)

conversion(转换校验器,指定在类型转换失败时,提示的错误信息)

visitor(用于校验action中的复合属性,它指定一个校验文件用于校验复合属性中的属性)

expression_r(OGNL表达式校验器,expression_r参数指定ognl表达式,该逻辑表达式基于ValueStack进行求值,返回true时校验通过,否则不通过,该校验器不可用在字段校验器风格的配置中)

① required  必填校验器

<field-validator type="required">

       <message>性别不能为空!</message>

</field-validator>

② requiredstring  必填字符串校验器

<field-validator type="requiredstring">

       <param name="trim">true</param>

       <message>用户名不能为空!</message>

</field-validator>

③ stringlength：字符串长度校验器

<field-validator type="stringlength">

       <param name="maxLength">10</param>

       <param name="minLength">2</param>

       <param name="trim">true</param>

       <message><![CDATA[产品名称应在1-10个字符之间]]></message>

</field-validator>

④ int：整数校验器

<field-validator type="int">

       <param name="min">1</param>

       <param name="max">150</param>

       <message>年龄必须在1-150之间</message>

</field-validator> 

⑤ 字段OGNL表达式校验器

<field name="imagefile">

       <field-validator type="fieldexpression_r">

              <param name="expression_r"><![CDATA[imagefile.length() > 0]]></param>

              <message>文件不能为空</message>

       </field-validator>

</field>

⑥ email：邮件地址校验器

<field-validator type="email">

       <message>电子邮件地址无效</message>

</field-validator>

⑦ regex：正则表达式校验器

<field-validator type="regex">

     <param name="expression_r"><![CDATA[^13/d{9}$]]></param>

     <message>手机号格式不正确!</message>

</field-validator>

<5> 当校验文件的取名为ActionClassName-validation.xml时，会对 action中的所有处理方法实施输入验证。如果你只需要对action中的某个处理方法实施验证，那么，校验文件的取名应为:ActionClassName-ActionName-validation.xml，其中ActionName为struts.xml中为action配置的名称。例如：在实际应用中，常有以下配置：

<action name="user_*" class="cn.itcast.action.UserAction" method="{1}">

       <result name="success">/WEB-INF/page/message.jsp</result>

       <result name="input">/WEB-INF/page/addUser.jsp</result>

</action>

UserAction中有以下两个处理方法：

public String add() throws Exception{

   ....

}

public String update() throws Exception{

   ....

}

要对add()方法实施验证，校验文件的取名为： UserAction-user_add-validation.xml

要对update()方法实施验证，校验文件的取名为： UserAction-user_update-validation.xml