Struts2数据校验功能实现

前言

数据校验一般是校验表单项的内容。
而验证的主要通过:
前台验证:主要是通过JS验证数据是否合法!
后台验证:通过后台java代码进行验证!
那么,本文主要介绍后端Struts校验的实现。
回顾之前的数据验证,主要是在业务逻辑代码之前增加if条件判断来进行校验的。比如:在登录时候在Action中的login()方法中进行判断,但是我们只想在login()写业务逻辑,不想搞这么复杂的代码,那么,想在系统调用login()方法之前就自动先校验数据了,那么Struts定义了validate数据校验的拦截器,即在执行action中的业务方法之前执行数据校验方法。

struts中数据校验的拦截器为:

<interceptor name="validation" class="org.apache.struts2.interceptor.validation.AnnotationValidationInterceptor"/>

Struts数据校验主要有四种方式。我们分别来讨论。

通过代码方式验证Action中所有的方法

我们来验证注册页面中数据的校验。
Action实现:

public class UserAction extends ActionSupport { 

    // 封装请求数据
    private User user = new User();
    public void setUser(User user) {
        this.user = user;
    }
    public User getUser() {
        return user;
    }

    // 重写数据验证的方法
    @Override
    public void validate() {
        // 用户名非空
        if (user.getUserName() == null || "".equals(user.getUserName())) {
            // 保存错误信息
            super.addFieldError("userName", "用户名必须填写!");
        }
        // 密码
        if (user.getPwd() == null || "".equals(user.getPwd())) {
            super.addFieldError("pwd", "密码必填");
        }
    }
 public String register(){
     return "success";
 }  
}

在ActionSupport类中定义了validate()方法,我们需要重写它。
在验证方法中的super.addFieldError(“userName”, “用户名必须填写!”);其实内部封装了一个map集合来保存校验错误信息的,通过查看源码。

public synchronized void addFieldError(String fieldName, String errorMessage) {
        // 1. 保存错误信息的map集合
        final Map<String, List<String>> errors = internalGetFieldErrors();
        // 2. Map的value值 (一个key,对应的多个值用list存储)
        List<String> thisFieldErrors = errors.get(fieldName);
        // 3. 如果错误信息的map中没有当前的key,就直接创建集合
        if (thisFieldErrors == null) {
            // 创建
            thisFieldErrors = new ArrayList<String>();
            errors.put(fieldName, thisFieldErrors);
        }
         // 4. 添加错误信息
        thisFieldErrors.add(errorMessage);
    }

通过代码方式验证Action中指定的方法

和上面的代码大致相同,只需要修改一点,就是讲Action中的validate()方法名字改为validata+指定校验方法的后缀.
例如:校验register()方法,那么public void validateRegister() {},只会验证当前action的register方法!其他内容不变!

总结代码方式验证
繁琐,设计很多重复的验证逻辑!例如:非空验证、数值验证、email、日期等。

通过XML方式验证Action中所有的方法

Struts对于常用的验证,进行了封装,即提供了验证器, 验证指定的常用业务逻辑!
Struts提供的所有验证器在xwork-core-2.3.4.1.jar/com.opensymphony.xwork2.validator.validators/default.xml中定义:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE validators PUBLIC "-//Apache Struts//XWork Validator Definition 1.0//EN" "http://struts.apache.org/dtds/xwork-validator-definition-1.0.dtd">

<!-- START SNIPPET: validators-default -->
<validators>
    <validator name="required" class="com.opensymphony.xwork2.validator.validators.RequiredFieldValidator"/>
    <validator name="requiredstring" class="com.opensymphony.xwork2.validator.validators.RequiredStringValidator"/>
    <validator name="int" class="com.opensymphony.xwork2.validator.validators.IntRangeFieldValidator"/>
    <validator name="long" class="com.opensymphony.xwork2.validator.validators.LongRangeFieldValidator"/>
    <validator name="short" class="com.opensymphony.xwork2.validator.validators.ShortRangeFieldValidator"/>
    <validator name="double" class="com.opensymphony.xwork2.validator.validators.DoubleRangeFieldValidator"/>
    <validator name="date" class="com.opensymphony.xwork2.validator.validators.DateRangeFieldValidator"/>
    <validator name="expression" class="com.opensymphony.xwork2.validator.validators.ExpressionValidator"/>
    <validator name="fieldexpression" class="com.opensymphony.xwork2.validator.validators.FieldExpressionValidator"/>
    <validator name="email" class="com.opensymphony.xwork2.validator.validators.EmailValidator"/>
    <validator name="url" class="com.opensymphony.xwork2.validator.validators.URLValidator"/>
    <validator name="visitor" class="com.opensymphony.xwork2.validator.validators.VisitorFieldValidator"/>
    <validator name="conversion" class="com.opensymphony.xwork2.validator.validators.ConversionErrorFieldValidator"/>
    <validator name="stringlength" class="com.opensymphony.xwork2.validator.validators.StringLengthFieldValidator"/>
    <validator name="regex" class="com.opensymphony.xwork2.validator.validators.RegexFieldValidator"/>
    <validator name="conditionalvisitor" class="com.opensymphony.xwork2.validator.validators.ConditionalVisitorFieldValidator"/>
</validators>
<!-- END SNIPPET: validators-default -->

写XML文件注意
1)XML文件名称语法: ActionClassName-validation.xml
注意:此xml需要与当前要验证的action在同一个目录:
举例:UserAction-validation.xml
2)写XML内容
在struts源代码中找到定义了xml书写规则(xwork-validator-1.0.3.dtd文件中)

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE validators PUBLIC "-//Apache Struts//XWork Validator 1.0.3//EN" "http://struts.apache.org/dtds/xwork-validator-1.0.3.dtd">

<validators>

    <!-- 验证的每一个字段用field表示 -->
    <field name="user.userName">
        <!-- 指定使用的验证器 -->
        <field-validator type="requiredstring">
            <!-- 验证失败的错误提示信息 -->
            <message>用户名不能为空!</message>
        </field-validator>
    </field>

    <!-- 验证pwd -->
    <field name="user.pwd">

        <!-- 非空 -->
        <field-validator type="requiredstring">
            <message>密码不能为空!</message>
        </field-validator>

        <!-- 长度 -->
        <field-validator type="stringlength">
            <param name="minLength">6</param>
            <param name="maxLength">8</param>
            <message>密码必须为6-8位!</message>
        </field-validator>
    </field>

    <!-- 验证日期 -->
    <field name="user.birth">
        <field-validator type="date">
            <message>日期格式不对!</message>
        </field-validator>
    </field>

    <!-- 验证Email -->
    <field name="user.email">
        <field-validator type="email">
            <message>邮箱格式错误!</message>
        </field-validator>
    </field>

</validators>       

上面主要是验证UserAction类的所有方法!

XML方式验证Action中指定的方法

与上面xml验证方式大致相同: 验证xml文件内容不变;
文件命名修改为:
语法:ActionClassName-ActionName-validation.xml
举例:UserAction-user_register-validation.xml,这里是配置文件中Action的name属性值。
验证UserAction中的register方法

Struts验证总结

代码:
重写validate() , 验证action所有方法
Validate+方法名(), 验证指定“方法名”的方法
Xml:
验证所有方法: ActionClassName-validation.xml
验证指定方法: ActionClassName-actionName-validation.xml

代码验证,
比较灵活,可以满足所有的需求.
比较繁琐,要写重复的验证判断逻辑!
适合: 表单字段较少的情况用!
XML验证:
通用,但不够灵活; 可以验证特定简单的业务。
适合: 验证表单字段较多,可以大大简化代码!
(配置文件过多)

数据校验错误信息处理

Struts在进行数据效验的时候,验证失败,会返回input视图,要求我们要在struts.xml中配置input视图对应的错误页面!
Struts.xml

<!-- 注册失败跳转到注册页面,显示失败信息 -->
        <global-results>
            <result name="input">/register.jsp</result>
        </global-results>

Jsp显示错误

<form action="${pageContext.request.contextPath }/admin_login.action" method="post"> 
      用户名:<input type="text" name="admin.name">
        <s:fielderror fieldName="admin.name">
        </s:fielderror>
      <br/>
      密码:<input type="password" name="admin.password">
       <s:fielderror fieldName="admin.password">
        </s:fielderror>
      <br/>
      <input type="submit" value="登录">
   </form>

什么都不输入,显示如下:
《Struts2数据校验功能实现》
struts标签的<s:fielderror>有一定的样式,审查元素可以看到,添加了ul标签。
《Struts2数据校验功能实现》

为了页面美观,我们可以修改Struts标签默认的样式。主要有两种方式。

第一种,在页面中加入css样式,如下:

<!-- 修改struts标签默认的样式: 不让换行 --> 
    <style type="text/css"> ul{ display: inline; } ul li{ display: inline; color: red; } </style>

显示结果如下:
《Struts2数据校验功能实现》

第二种方式:修改Struts源码中配置文件。
修改标签定义的模板
找到fielderror标签定义的模板文件:
Struts-core.jar\template\simple\ fielderror.ftl

把修改后的fielderror.ftl文件内容,把ul标签和换行符等去除,然后放到src/ template/ simple/ fielderror.ftl,服务器会先加载Struts中的文件,然后在加载src中的文件,发现文件名一致,那么前者将会被覆盖掉,这样标签显示的样式就修改了!

    原文作者:nwpu_geeker
    原文地址: https://blog.csdn.net/nwpu_geeker/article/details/79014365
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞