Struts2数据校验

作者: 重山杨 | 来源:发表于2017-02-08 17:18 被阅读0次

Struts2的输入校验和类型转换都是对请求参数进行处理。
输入校验顾名思义就是请求参数是否能够满足一定的要求;

客户端校验是指在浏览器这端通过JavaScript进行初步校验,为了减轻服务器端的负载;

服务器端校验是校验数据的最后一道防线;

只需要一个配置文件,对相应的校验规则进行配置,即可使用struts2自带的校验器

自行在action中进行自定义的校验则不需要配置规则文件


一、使用struts2自带的校验器

1.数据校验规则文件规则:

1.此文件中规定了参数的一些校验条件;
2.可以包括字段型校验器和非字段型校验器;
3.命名规则:ActionName-validation.xml,其中ActionName是Action类的名字;
4.每个Action都有一个validation文件,规则文件放在和Action同目录下;
5.在前面我们讲到的配置逻辑action中,如果需要对某个逻辑Action配置数据校验文件,则命名规则为:ActionName-LogicActionName-validation.xml;
6.注意:当需要对逻辑action进行校验时,如果存在一般形式的ActionName-validaton.xml文件,则也会对此逻辑Action进行校验;
7.输入校验失败后,和类型转换一样,会将错误封装成fieldError,并放入Action Context中,因此在JSP中添加<s:fielderror/>可显示错误,此内容也是我们在数据校验文件中配置的;
8.当输入校验失败后,和类型转换一样,返回逻辑视图为input,因此在struts.xml中必须配<result name="input"></input>
9.输入校验失败后,struts表单标签也会自动输出错误提示;

字段型校验器&非字段型校验器

字段型校验器:以每个Action属性为一个单位进行编写,即以如下风格编写:

属性1
        规则1
        规则2
属性2
        规则1
        规则2
(1)<field name="">为一个属性,name为Action属性名称;
(2)<field-validator type="">为配置一个校验器,type为校验器的类型;
(3)<param>为配置参数,比如最小值、最大值;
(4)<message>为错误信息,如果需要对错误提示信息进行国际化,则可以在全局国际化资源文件中配置,在校验规则文件中编写如下形式:<message key="key"/>,key为国际化资源文件的key即可;

非字段型校验器:以规则为一个单位,以如下风格编写:

规则1
        属性
规则2
        属性
规则3
        属性
(1)<validator type="">表示一个校验器,type属性表示校验器的类型;
(2)<param name="fieldName"></param> 此元素是必要的,指定Action属性的名称;
(3)<message>表示错误信息;

2.数据校验文件内容

数据校验文件以<validators>为根元素;

字段型校验器是以属性为单位的,内容模板:

<validators>  
    <field name="">  
        <field-validator type="">  
            <param name=""></param>  
            <message></message>  
        </field-validator>  
    </field>  
  
</validators>  

非字段型校验器是以校验器为单位的,内容模板:

<validator type="">  
        <param name="fieldName"></param>  
        <param name=""></param>  
        <message></message>  
</validator>  

3、示例:

输入页面:

<%@ taglib prefix="s" uri="/struts-tags" %>
<%--
  Created by IntelliJ IDEA.
  User: yangcs
  Date: 2017/2/8
  Time: 14:40
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>参数校验</title>
</head>
<body>
<s:form action="Action011">
    <s:textfield label="姓名(String,示例:傻逼)" name="name"></s:textfield>
    <s:textfield label="年龄(int,示例:23)" name="age"></s:textfield>
    <s:textfield label="日期(Date, 示例:2017-02-02)" name="date"></s:textfield>
    <s:submit value="提交"></s:submit>
</s:form>
<s:fielderror></s:fielderror>
</body>
</html>

数据处理action:

package test002;

import com.opensymphony.xwork2.ActionSupport;

import java.util.Date;

/**
 * Created by yangcs on 2017/2/8.
 * 这个action用于struts2校验器示例
 */
public class Validation01Action extends ActionSupport{
    private String name;

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    private int age;
    private Date date;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Date getDate() {
        return date;
    }

    public void setDate(Date date) {
        this.date = date;
    }

    @Override
    public String execute() throws Exception{
        return SUCCESS;
    }

}

action配置:

<action name="Action011" class="test002.Validation01Action">
    <result name="success">/JSP/validationResult.jsp</result>
    <result name="input">/JSP/validationError.jsp</result>
</action>

校验规则文件Validate01Action-validation.xml:

<!DOCTYPE validators PUBLIC
        "-//Apache Struts//XWork Validator 1.0.2//EN"
        "http://struts.apache.org/dtds/xwork-validator-1.0.2.dtd">

<!--字段类型的校验配置-->
<validators>
    <field name="name">
        <field-validator type="requiredstring">
            <param name="trim">true</param>
            <message>姓名不能为空</message>
        </field-validator>
        <field-validator type="regex">
            <param name="trimExpression"><![CDATA[(\w{4,10})]]></param>
            <message>姓名要在4-10位之间</message>
        </field-validator>
    </field>
    <field name="age">
        <field-validator type="required">
            <message>年龄不能为空</message>
        </field-validator>
        <field-validator type="int">
            <param name="min">1</param>
            <param name="max">100</param>
            <message>年龄限制1到100</message>
        </field-validator>
    </field>
    <field name="date">
        <field-validator type="required">
            <message>日期不能为空</message>
        </field-validator>
        <field-validator type="date">
            <param name="min">2017-01-01</param>
            <param name="max">2017-12-31</param>
            <message>日期在2017-01-01到2017-12-31之间</message>
        </field-validator>
    </field>

</validators>

结果展示页面:

<%@ taglib prefix="s" uri="/struts-tags" %>
<%--
  Created by IntelliJ IDEA.
  User: yangcs
  Date: 2017/2/8
  Time: 14:45
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>数据校验结果展示</title>
</head>
<body>
姓名:<s:property value="name"></s:property> <br>
年龄:<s:property value="age"></s:property> <br>
日期:<s:property value="date"></s:property>
</body>
</html>

另有非字段类型规则配置文件示例:

<!DOCTYPE validators PUBLIC  
        "-//Apache Struts//XWork Validator 1.0.2//EN"  
        "http://struts.apache.org/dtds/xwork-validator-1.0.2.dtd">  
  
<validators>  
    <validator type="requiredstring" short-circuit="true">  
        <param name="fieldName">name</param>  
        <param name="trim">true</param>  
        <message key="aa"></message>  
    </validator>  
    <validator type="requiredstring" short-circuit="true">  
        <param name="fieldName">age</param>  
        <param name="trim">true</param>  
        <message>年龄不能为空</message>  
    </validator>  
    <validator type="requiredstring" short-circuit="true">  
        <param name="fieldName">email</param>  
        <param name="trim">true</param>  
        <message>邮箱不能为空</message>  
    </validator>  
    <validator type="requiredstring" short-circuit="true">  
        <param name="fieldName">date</param>  
        <param name="trim">true</param>  
        <message>日期不能为空</message>  
    </validator>  
    <validator type="regex">  
        <param name="fieldName">name</param>  
        <param name="expression"><![CDATA[(\w{4,10})]]></param>  
        <message>姓名要在4-10位之间</message>  
    </validator>  
    <validator type="int">  
        <param name="fieldName">age</param>  
        <param name="min">0</param>  
        <param name="max">200</param>  
        <message>年龄范围在0-200之间</message>  
    </validator>  
    <validator type="email">  
        <param name="fieldName">email</param>  
        <message>邮箱格式不正确</message>  
    </validator>  
    <validator type="date">  
        <param name="fieldName">date</param>  
        <param name="min">2010-01-01</param>  
        <param name="max">2010-12-31</param>  
        <message>日期在2010-01-01到2010-12-31之间</message>  
    </validator>  
</validators>  

4、客户端校验方法:

在JSP的<s:form>元素中添加属性 validate="true";添加后,在校验规则文件的规则会转变为客户端校验规则,即任何校验都不需要接触服务器;

需要注意的是:如果直接访问JSP页面,并不能体现出客户端校验,只有通过访问某个action然后跳转到JSP页面才可以让客户端校验生效

5、短路校验器

一般来说,如果我们为name配置了两个校验器:第一个是“不能为空”,第二个是“长度大于4且小于10”,则如果name字段为空时,则会同时输出这两条提示,但是实际上,如果用户输入为空的情况下,只应该输出“不能为空”,这就需要短路校验器;

在<validator>或<field-validator>元素中添加short-circut="true"即可;

短路校验器的规则

1.当非字段校验器校验失败,则其后的所有字段校验器都不会执行,而不会影响其他非字段校验器;
2.字段校验器校验失败时,其后的所有字段校验器都不会执行;

校验器的运行顺序

1.非字段校验器比字段校验器先执行;
2.从前往后执行;

6、struts2提供的校验器列表:

  • required:必填校验器,要求field的值不能为null)
  • requiredstring:必填字符串校验器,要求field的值不能为null,并且长度大于0,默认情况下会对字符串去前后空格
  • stringlength:字符串长度校验器,要求field的值必须在指定的范围内,否则校验失败,minLength参数指定最小长度,maxLength参数指定最大长度,trim参数指定校验field之前是否去除字符串前后的空格
  • regex:正则表达式校验器,检查被校验的field是否匹配一个正则表达式,expression参数指定正则表达式,caseSensitive参数指定进行正则表达式匹配时,是否区分大小写,默认值为true
  • int:整数校验器,要求field的整数值必须在指定范围内,min指定最小值,max指定最大值
  • double:双精度浮点数校验器,要求field的双精度浮点数必须在指定范围内,min指定最小值,max指定最大值
  • fieldexpression:字段OGNL表达式校验器,要求field满足一个ognl表达式,expression参数指定ognl表达式,该逻辑表达式基于ValueStack进行求值,返回true时校验通过,否则不通过
  • email:邮件地址校验器,要求如果field的值非空,则必须是合法的邮件地址
  • url:网址校验器,要求如果field的值非空,则必须是合法的url地址
  • date:日期校验器,要求field的日期值必须在指定范围内,min指定最小值,max指定最大值
  • conversion:转换校验器,指定在类型转换失败时,提示的错误信息
  • visitor:用于校验action中的复合属性,它指定一个校验文件用于校验复合属性中的属性
  • expression:OGNL表达式校验器,expression参数指定ognl表达式,该逻辑表达式基于ValueStack进行求值,返回true时校验通过,否则不通过,该校验器不可用在字段校验器风格的配置中

二、使用自定义的校验器

通过重写ActionSupport类的validate()方法,action可实现自定义的输入校验,validate()方法会校验action中所有与execute方法签名相同的方法。

当某个数据校验失败时,我们可以调用addFieldError()方法往系统的fieldErrors添加校验失败信息。

如果系统的fieldErrors包含失败信息,sturts2会将请求转发到名为input的result。在input视图中,可以通过 <s:fielderror/>标签显示失败信息。

示例

输入页面:

<%@ taglib prefix="s" uri="/struts-tags" %>
<%--
  Created by IntelliJ IDEA.
  User: yangcs
  Date: 2017/2/8
  Time: 16:05
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>数据校验</title>
</head>
<body>
<s:form action="Action012">
    <s:textfield label="姓名(示例:傻逼)" name="name" ></s:textfield>
    <s:textfield label="电话(示例:18252040618)" name="mobile"></s:textfield>
    <s:textfield label="日期(示例:2017-02-02)" name="date"></s:textfield>
    <s:submit value="提交"></s:submit>
</s:form>

</body>
</html>

配置了自定义的校验器的action:

package test002;

import com.opensymphony.xwork2.ActionSupport;

import java.util.Date;
import java.util.regex.Pattern;

/**
 * Created by yangcs on 2017/2/8.
 * 在action中重写public void validate()方法,自定义校验器,实现此方法后不需要再配置校验器xml文件
 */
public class Validation02Action extends ActionSupport{
    private String name;

    public String getMobile() {
        return mobile;
    }

    public void setMobile(String mobile) {
        this.mobile = mobile;
    }

    private String mobile;
    private Date date;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }


    public Date getDate() {
        return date;
    }

    public void setDate(Date date) {
        this.date = date;
    }

    @Override
    public String execute() throws Exception{
        return SUCCESS;
    }
    @Override
    public void validate() {//validate()会对action中的所有方法校验
        if(this.name==null || "".equals(this.name.trim())){
            this.addFieldError("name", "用户名不能为空");
        }
        if(this.mobile==null || "".equals(this.mobile.trim()))
        {
            this.addFieldError("mobile", "手机号不能为空");
        }else{
            //使用正则表达式判断手机号,第一个数字为1,第二个数字为3或5或8,后面跟9位数字
            if(!Pattern.compile("^1[358]\\d{8}$").matcher(mobile).matches()){
                this.addFieldError("mobile", "手机号格式不正确");
            }
        }
        if(this.date==null||"".equals(this.date)){
            this.addFieldError("date", "日期不能为空");
        }
    }
}

action配置:

<action name="Action012" class="test002.Validation02Action">
    <result name="success">/JSP/validationResult02.jsp</result>
    <result name="input">/JSP/validationError.jsp</result>
</action>

结果展示页面:

<%@ taglib prefix="s" uri="/struts-tags" %>
<%--
  Created by IntelliJ IDEA.
  User: yangcs
  Date: 2017/2/8
  Time: 16:09
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>数据校验</title>
</head>
<body>
姓名:<s:property value="name"></s:property><br>
电话:<s:property value="mobile"></s:property><br>
日期:<s:property value="date"></s:property>
</body>
</html>

对action中指定方法进行校验

上述方法会对action中的所有方法都进行输入校验,若只想对action中的指定方法进行校验,只需将PersonAction中的validate()方法名称改成validateXxx()即可,其中Xxx为对应的方法名称,Xxx的第一个字母要大写。

输入校验的流程

a. 类型转换器对请求参数执行类型转换,并把转换后的值赋给action中的属性。 
b. 如果在执行类型转换的过程中出现异常,系统会将异常信息保存到ActionContext,conversionError拦截器将异常信息封装到fieldErrors里。不管类型转换是否出现异常,都会进入第c步。 
c. 系统通过反射技术先调用action中的validateXxx()方法,Xxx为方法名。 
d. 再调用action中的validate()方法。 
e. 经过上面4步,如果系统中的fieldErrors存在错误信息(即存放错误信息的集合的size大于0),系统自动将请求转发至名称为input的视图。如果系统中的fieldErrors没有任何信息,系统将执行action中的处理方法。

相关文章

网友评论

    本文标题:Struts2数据校验

    本文链接:https://www.haomeiwen.com/subject/ytcbittx.html