Java学习笔记(八）——数据校验（Hibernate validation）

公司转java开发也有一段时间了，在实际开发过程中还是会遇到一些问题的，本篇主要记录下接口服务中参数验证相关的开发过程和一些知识点。

在接口服务开发中，难免会校验传入方的参数校验，尤其在post请求时，验证字符长度，字符类型是否满足数据库中字段的最大长度及类型，如果不符合条件应及时拦截并返回，避免后续的流程。

hibernate validator constraint 注解

先了解下提供的注解，基本上常用的都提供了，在代码编写时还是比较方便的，一个注解解决了验证逻辑。

/**Bean Validation 中内置的 constraint**/
@Null   //被注释的元素必须为 null    
@NotNull    //被注释的元素必须不为 null    
@AssertTrue     //被注释的元素必须为 true    
@AssertFalse    //被注释的元素必须为 false    
@Min(value)     //被注释的元素必须是一个数字，其值必须大于等于指定的最小值    
@Max(value)     //被注释的元素必须是一个数字，其值必须小于等于指定的最大值    
@DecimalMin(value)  //被注释的元素必须是一个数字，其值必须大于等于指定的最小值    
@DecimalMax(value)  //被注释的元素必须是一个数字，其值必须小于等于指定的最大值    
@Size(max=, min=)   //被注释的元素的大小必须在指定的范围内    
@Digits (integer, fraction)     //被注释的元素必须是一个数字，其值必须在可接受的范围内    
@Past   //被注释的元素必须是一个过去的日期    
@Future     //被注释的元素必须是一个将来的日期    
@Pattern(regex=,flag=)  //被注释的元素必须符合指定的正则表达式    
    
/**Hibernate Validator 附加的 constraint**//    
@NotBlank(message =)   //验证字符串非null，且长度必须大于0    
@Email  //被注释的元素必须是电子邮箱地址    
@Length(min=,max=)  //被注释的字符串的大小必须在指定的范围内    
@NotEmpty   //被注释的字符串的必须非空    
@Range(min=,max=,message=)  //被注释的元素必须在合适的范围内

简单使用

验证字段添加需要的注解

    /**
     * 订单号
     */
    @Range(min=1,message = "不是正确的订单号")
    private Long e_order_id;
    /**
     * 产品code
     */
    @NotBlank(message = "不是正确的产品code")
    private String product_code;

BindingResult接收

在controller中，我们通过BindingResult来接收对应的验证信息

    @ApiOperation(value = "修改订单状态", notes = "若找不到结果则返回 null。")
    @RequestMapping(value = "/status", method = RequestMethod.PUT)
    @ResponseBody
    public String PutOrderStatus(@RequestBody @Validated @NotNull OrderStatusReq req, BindingResult bindingResult) {
        String validResult = assertParameterValid(bindingResult);
        if (validResult != null) {
            return validResult;
        }
        return iOrderStatusService.putOrderStatus(req).toString();
    }

protected String assertParameterValid(BindingResult bindingResult) {
        if (bindingResult.hasErrors()) {
            FieldError error = bindingResult.getFieldError();
            return new Response<>(BusinessReturnCode.VALIDATION_FAILURE, String.format("[%s] %s.", error.getField(), error.getDefaultMessage()), null).toString();
        }
        return null;
    }

枚举Enum校验

可惜的是，Hibernate validation中没有提供枚举相关的校验，而实际业务场景中会有很多校验类型、状态等，这里我们只能自定义了。

首先我们需要自定义一个annotation来标记你的验证字段，因为Validator框架里面的基础annotation已经不够用。

然后自定义一个Validator（继承ConstraintValidator），并将annotation类型给到ConstraintValidator的泛型列表，相当于做了一个绑定。然后implement ConstraintValidator的两个方法，在isValid方法里面用要验证的枚举验证参数。

可以看下一个简单的demo：

@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = {EnumValidAnnotation.EnumValidtor.class})
@Documented
public @interface EnumValidAnnotation {
    String message() default "枚举不在范围内";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

    Class<?>[] target() default {};

    public class EnumValidtor implements ConstraintValidator<EnumValidAnnotation, Integer> {

        Class<?>[] cls; //枚举类

        @Override
        public void initialize(EnumValidAnnotation constraintAnnotation) {
            cls = constraintAnnotation.target();
        }

        @Override
        public boolean isValid(Integer value, ConstraintValidatorContext context) {
            System.out.println("枚举值" + value);
            if (cls.length > 0) {
                for (Class<?> cl : cls) {
                    try {
                        if (cl.isEnum()) {
                            //枚举类验证
                            Object[] objs = cl.getEnumConstants();
                            Method method = cl.getMethod("getCode");
                            for (Object obj : objs) {
                                Object code = method.invoke(obj);
                                if (value.equals(code)) {
                                    return true;
                                }
                            }
                        }
                    } catch (NoSuchMethodException e) {
                        e.printStackTrace();
                    } catch (IllegalAccessException e) {
                        e.printStackTrace();
                    } catch (InvocationTargetException e) {
                        e.printStackTrace();
                    }
                }
            }
            return false;
        }
    }

这样的话在你要验证的字段上加上对应的注解即可：

    /**
     * 更新类型 
     */
    @EnumValidAnnotation(target = OrderStatusEnum.class)
    private int stype;

总结

java中注解还是挺有意思的，类似c#中的attribute,但java中各种框架、方法的注解真的很多，不一直使用或做对应的笔记真的很容易忘记，还是需要多多积累和记录的。