我尝试为play-framework编写检查并看到两种不同的可能性。我描述了两者并想知道我的理解是否正确（所以它更像是一个教程而不是一个问题，特别是因为我没有得到任何我错过了什么的回应）。那么存在哪些可能性。
- 简单的方法：扩展类
Check：
优点：更容易写，更容易阅读
缺点：你不能参数化检查，你只能定义消息。 - 高级方法：基于 OVal 编写检查
AbstractAnnotationCheck。
优点：您可以对检查进行参数化，并且使用注释更简单
缺点：有点复杂。
在我们查看实现之前，我想解释一下这些消息。您始终可以直接设置消息或使用键在消息属性中引用消息。最后一种是更清洁和推荐的方式。每个验证至少有 1 个参数：无效属性的名称。因此，验证或检查特定参数始终以%i$si>1 为参考。消息字符串的格式应遵循Formatter的规则，但我不确定是否支持所有功能。据我所知，仅支持 %s、%d 和 %f 与定位。所以%[argument_index$][flags]conversion转换只能是s，d或f。
让我们看两个例子： 我在模块中用于乐观锁定的简单方法：
/**
* Check with proof if the version of the current edited object is lesser
* than the version in db.
* Messagecode: optimisticLocking.modelHasChanged
* Parameter: 1 the request URL.
* Example-Message: The object was changed. <a href="%2$s">Reload</a> and do your changes again.
*
*/
static class OptimisticLockingCheck extends Check {
/**
* {@inheritDoc}
*/
@Override
public boolean isSatisfied(Object model, Object optimisiticLockingViolatedValue) {
//The comparision of version was made in the setter. Here
//we only have to check the flag.
if (((VersionedModel) model).optimisiticLockingViolated) {
final Request request = Request.current();
//The following doesn't work in 1.0 but in 1.1 see https://bugs.launchpad.net/play/+bug/634719
//http://play.lighthouseapp.com/projects/57987-play-framework/tickets/116
//setMessage(checkWithCheck.getMessage(), request != null ? request.url : "");
setMessage("optimisticLocking.modelHasChanged", request != null ? request.url : "");
}
return !((VersionedModel) model).optimisiticLockingViolated;
}
}
您将此检查与注释一起使用@CheckWith(value=OptimisticLockingCheck.class, message="optimisticLocking.modelHasChanged")
因此，让我们仔细看看它是如何工作的。我们唯一要做的就是扩展类 play.data.validation.Check 并覆盖 isSatisfied 方法。在那里你得到你的模型和属性的值。您所要做的就是在一切正常时返回 true，否则返回 false。在我们的例子中，我们希望将当前 url 设置为参数。这可以通过调用 setMessage() 轻松完成。我们给出在消息属性和参数中定义的消息或消息键。请记住，我们只给出 1 个参数，但用 %2$s 表示，因为第一个参数始终是属性的名称。
现在是基于 Range-check 的复杂方式：首先我们需要定义一个 Annotation
/**
* This field must be lower than and greater than.
* Message key: validation.range
* $1: field name
* $2: min reference value
* $3: max reference value
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Constraint(checkWith = RangeCheck.class)
public @interface Range {
String message() default RangeCheck.mes;
double min() default Double.MIN_VALUE;
double max() default Double.MAX_VALUE;
}
然后检查
@SuppressWarnings("serial")
public class RangeCheck extends AbstractAnnotationCheck<Range> {
final static String mes = "validation.range";
double min;
double max;
@Override
public void configure(Range range) {
this.min = range.min();
this.max = range.max();
setMessage(range.message());
}
public boolean isSatisfied(Object validatedObject, Object value, OValContext context, Validator validator) {
requireMessageVariablesRecreation();
if (value == null) {
return true;
}
if (value instanceof String) {
try {
double v = Double.parseDouble(value.toString());
return v >= min && v <= max;
} catch (Exception e) {
return false;
}
}
if (value instanceof Number) {
try {
return ((Number) value).doubleValue() >= min && ((Number) value).doubleValue() <= max;
} catch (Exception e) {
return false;
}
}
return false;
}
@Override
public Map<String, String> createMessageVariables() {
Map<String, String> messageVariables = new TreeMap<String, String>();
messageVariables.put("2-min", Double.toString(min));
messageVariables.put("3-max", Double.toString(max));
return messageVariables;
}
}
好的，我认为注释不必解释。让我们看看支票。在这种情况下，它是 extends net.sf.oval.configuration.annotation.AbstractAnnotationCheck。我们必须编写一个配置方法，我们可以在其中获取注释并可以复制参数。然后我们必须定义我们的检查。这类似于其他检查的实施。所以我们只写我们的条件并返回真或假，除了一个特殊的行！如果我们使用参数化消息，我们必须调用requireMessageVariablesRecreation();我们的方法。至少我们必须重写方法createMessageVariables。在这里，我们必须了解一点游戏知识（所有其他的东西都在这里描述）。您将消息放入带有键和值的映射中，但 play 只接受值（请参阅ValidCheck.java在框架代码中）。所以它会被位置引用。这就是我更改RangeCheckusingTreeMap而不是HashMap. 此外，我让键从它们可以引用的索引开始。
所以我希望这可以更清楚地说明如何编写自定义验证/检查。我希望描述是正确的。因此问题是我的理解正确吗？