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中各類框架、方法的註解真的不少，不一直使用或作對應的筆記真的很容易忘記，仍是須要多多積累和記錄的。