17

Play 1.0 带有一个基于http://oval.sourceforge.net/的全功能验证框架。

随着 2.0 的发布，我的自定义验证器不再工作。

如何使用 Play Framework 2.0 创建自定义验证器？

4

1 回答 1

41

在 Play 2.0 中，验证框架超出了对数据的实际验证，因为它达到了：

  • 注释 - 使用“@”符号轻松声明验证约束
  • 验证器 - 它实际上实现了验证背后的逻辑
  • 消息 - 显示参数化错误消息（符合 i18 标准）
  • 最后，HTML 助手——将所有以前的东西粘合在一起

HTML Helpers 是 Play 2.0 的新功能。在 1.x 中，Play 已经非常擅长执行定义良好的验证框架。它功能强大且易于使用。然而，我们仍然必须将 HTML 表单和验证框架连接在一起。这对初学者来说可能有点混乱。

在 Play 2.0 中，这现在是自动完成的。

但是让我们专注于答案并提供一些指导：我们将创建一个AllUpperCase验证器，它会在以下情况下生成错误：

  • 输入不是字符串
  • 输入为空
  • 其中一个字符是小写的。

验证者

package myvalidators;

import javax.validation.*;

public class AllUpperCaseValidator 
        extends play.data.validation.Constraints.Validator<Object> 
        implements ConstraintValidator<AllUpperCase, Object> {

    /* Default error message */
    final static public String message = "error.alluppercase";

    /**
     * Validator init
     * Can be used to initialize the validation based on parameters
     * passed to the annotation.
     */
    public void initialize(AllUpperCase constraintAnnotation) {}

    /**
     * The validation itself
     */
    public boolean isValid(Object object) {
        if(object == null)
            return false;

        if(!(object instanceof String))
            return false;

        String s = object.toString();  
        for(char c : s.toCharArray()) {
            if(Character.isLetter(c) && Character.isLowerCase(c))
                return false;
        }

        return true;
    }

    /**
     * Constructs a validator instance.
     */
    public static play.data.validation.Constraints.Validator<Object> alluppercase() {
        return new AllUpperCaseValidator();
    }
}

您可能会注意到的第一件事是导入：Play 2.0 确实符合 JSR 303 - Bean Validation Framework。在这种情况下，验证器需要实现ConstraintValidator。在我们的例子中，它转化为作为类的注释AllUpperCase（我们将在稍后介绍）和作为泛型的ObjectT。

验证器是直截了当的：
我们定义了方法public boolean isValid(Object object)，它返回一个布尔值，如果为 true，则验证通过。还有一个消息 id 和一个实例化验证器的方法。

注释

下面的类定义了一个名为的注解@AllUpperCase，它不带参数但强制执行之前定义的验证。提供与注释框架相关的详细信息超出了本文的范围。

package myvalidators;

import java.lang.annotation.*;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*;

import javax.validation.*;

@Target({FIELD})
@Retention(RUNTIME)
@Constraint(validatedBy = AllUpperCaseValidator.class)
@play.data.Form.Display(name="constraint.alluppercase")
public @interface AllUpperCase {
    String message() default AllUpperCaseValidator.message;
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

请注意注释如何与拼图的其他部分粘合在一起。

  • @Constraint，一个 JSR 303 注释，链接到验证器
  • @play.data.Form.Display，将注释链接到播放 html 帮助程序。请注意，名称很重要：我们正在定义一个名为alluppercase的约束。Play 使用此信息调用Validator 上的方法。public static play.data.validation.Constraints.Validator<Object> alluppercase()
  • 最后请注意，默认消息是在注释界面中设置的。

用法

我们现在有了自定义验证器和注释

import myvalidators.*;
public static class MyData {
    @AllUpperCase
    public String name;
}

描述用法超出了本文的范围，请在此URL找到工作示例

于 2011-11-13T22:04:26.723 回答