使用Oval作参数检查

2016-08-10

参数检查

在服务器接收参数的时候，总会做一些检查，比如不能为空或者不能大于多少小于多少，Oval就是一个工具通过注解来完成这些工作

<!--Oval-->
<dependency>
    <groupId>net.sf.oval</groupId>
    <artifactId>oval</artifactId>
    <version>${oval.version}</version>
</dependency>

检查工具类

首先我们要使用Oval创建一个检查工具，用于我们检查模型

public class VerifyUtil {

    private static Validator validator = new Validator();

    /**
     * 请求参数非空、格式验证，请求对象
     * @param object 请求校验参数
     */
    public static void validateObject(Object object) throws Exception {
        List<ConstraintViolation> list = validator.validate(object);
        if (null != list && !list.isEmpty()) {
            throw new Exception();
        }
    }

    /**
     * 校验参数是否非空
     * @param object 待验证对象
     * @throws Exception 参数为空
     */
    public static void validateNull(Object object) throws Exception {
        if (object == null) {
            throw new Exception();
        }
    }
}

使用注解进行参数检查

当我们一个类有很多个参数的时候，可能一个一个去校验，只需要在参数参数上打上注解，然后使用 VerifyUtil.validateObject() 就可以对注解进行检查了

public class UserReqDTO implements Serializable{
  @Length(max = 100, message = "inflName应当小于${max}个字符") <==== 对String进行长度检查
  private String inflName;  

  @Range(min = 0, max = 6, message = "userStatus应该处于${min}和${max}之间") <==== 对Integer进行长度检查
  private Integer userStatus;
}

使用检查工具检查

1 2	UserReqDTO userReqDTO = new UserReqDTO(); VerifyUtil.validateObject(userReqDTO);

甚至还可以使用自定义函数进行检查

@ValidateWithMethod(methodName = "isValidDay", parameterType = int.class)
private int day = 31;

private boolean isValidDay(int day)
{
  ........
  return true;
}

${}取值

在编辑返回错误信息的时候有个${}符号可以动态的取max和min的值，但是也有个问题

@Length 中 max 和 min 是整数，看到的返回消息还没问题
@Range 中 max 和 min 是Double类型，取出来的消息总是20.0, 1.0这种带小数点的

至于这个 带小数点的问题如何解决 我在官方文档里也没找到合适解决方式，希望知道的留言或者联系我，十分感谢

Oval都有哪些注解

以下只是作为参考，我随便写的，还是以官方文档为主

注解参数	参数注解
无参数	@NotNull、@NotBlank、@Url、@Email、@NotNegative、@CFuture、@CPast
一个参数	@Max、@Min
两个参数	@Length、@Range、@DateRange、@HasSubstring
自定义	@Assert、@CheckWith、@ValidateWithMethod、@MatchPatternCheck