JAVA欄位校驗(validation)

阿新 • • 發佈：2019-02-12

在開發業務時，不可避免的需要處理一些校驗，如果是寫if-else這種程式碼去校驗，那會有一大段這樣的程式碼。不過還好有個校驗外掛：javax.validation.validation-api，不過一般會引用hibernate的校驗元件：org.hibernate.hibernate-validator，它已經引用了validation-api元件。

基礎校驗型別

JSR303 是一套JavaBean引數校驗的標準，它定義了很多常用的校驗註解，我們可以直接將這些註解加在我們JavaBean的屬性上面，就可以在需要校驗的時候進行校驗了。註解如下：
這裡寫圖片描述

Hibernate validator 在JSR303的基礎上對校驗註解進行了擴充套件，擴充套件註解如下：
這裡寫圖片描述

寫個DEMO看看

校驗工具類:ValidatorUtils

import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.groups.Default;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;

/**
 * Created by saleson on 2017/10/13.
 */ 

public class ValidatorUtils {


    private static Validator validator = Validation.buildDefaultValidatorFactory()
            .getValidator();


    public static <T> Map<String, String> validate(T obj) {
        Map<String, StringBuilder> errorMap = new HashMap<>();
        Set<ConstraintViolation<T>> set = validator.validate(obj, Default.class);
        if 
 (set != null && set.size() > 0) {
            String property = null;
            for (ConstraintViolation<T> cv : set) {
                //這裡迴圈獲取錯誤資訊，可以自定義格式
                property = cv.getPropertyPath().toString();
                if (errorMap.get(property) != null) {
                    errorMap.get(property).append("," + cv.getMessage());
                } else {
                    StringBuilder sb = new StringBuilder();
                    sb.append(cv.getMessage());
                    errorMap.put(property, sb);
                }
            }
        }
        return errorMap.entrySet().stream().collect(Collectors.toMap(k -> k.getKey(), v -> v.getValue().toString()));
    }
}

DemoBean:

import com.fm.core.exceptions.ApiException;
import org.hibernate.validator.constraints.NotEmpty;
import com.fm.framework.api.ApiResultHelper;
import com.fm.framework.json.Json;
import com.fm.framework.utils.StringUtils;
import com.fm.grantauth.domain.ValidateResult;
import com.fm.grantauth.domain.dto.AuthorizationApplyDTO;
import com.fm.grantauth.utils.ValidatorUtils;
import org.junit.Test;

import javax.validation.Valid;
import java.util.Map;

/**
 * Created by saleson on 2017/10/12.
 */
public class DataAuthValidator  {
private static final Logger log = LoggerFactory.getLogger(DataAuthValidator.class);

    @Override
    public ValidateResult validate(AuthorizationApplyDTO applyDTO) {
        String json = applyDTO.getContractParams();
        if (StringUtils.isEmpty(json)) {
            throw new ApiException(ApiResultHelper.newParameterEmpty("contractParams欄位不能為空"));
        }
        DataAuthContractParams params = Json.parseObject(json, DataAuthContractParams.class);
        Map<String, String> validMap = ValidatorUtils.validate(params);
        if (!validMap.isEmpty()) {
            log.warn(validMap.toString());
            throw new ApiException(ApiResultHelper.newBusinessError(lackFieldMessage(validMap.keySet().toArray(new String[0]))));
        }
        return new ValidateResult(true);
    }


    public static class DataAuthContractParams {
        @NotEmpty
        private String businessName;
        @NotEmpty
        private String dataProvider;
        @NotEmpty
        private String personalDataName;
        @NotEmpty
        private String dataDemander;

        public String getBusinessName() {
            return businessName;
        }

        public void setBusinessName(String businessName) {
            this.businessName = businessName;
        }

        public String getDataProvider() {
            return dataProvider;
        }

        public void setDataProvider(String dataProvider) {
            this.dataProvider = dataProvider;
        }

        public String getPersonalDataName() {
            return personalDataName;
        }

        public void setPersonalDataName(String personalDataName) {
            this.personalDataName = personalDataName;
        }

        public String getDataDemander() {
            return dataDemander;
        }

        public void setDataDemander(String dataDemander) {
            this.dataDemander = dataDemander;
        }

    }



    @Test
    public void test() {
        AuthorizationApplyDTO applyDTO = new AuthorizationApplyDTO();
        DataAuthContractParams params = new DataAuthContractParams();
        params.setBusinessName("f");
        params.setDataDemander("f");
        params.setDataProvider("");
        params.setPersonalDataName("");

        applyDTO.setContractParams(Json.toJSONString(params));
        ValidateResult result = new DataAuthValidator().validate(applyDTO);
        System.out.println(Json.toJSONString(result));
        assert result.isSeccess();
    }
}

執行結果:

[main] WARN com.fm.grantauth.module.authorization.contact.DataAuthValidator - {dataProvider=不能為空, personalDataName=不能為空}

com.fm.core.exceptions.ApiException: 引數contractParams中缺少欄位:dataProvider, personalDataName

自定義校驗規則(Validator)

自定義註解:

package com.fm.core.validation;

import com.fm.core.validation.validator.NotEmptyValidator;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.CONSTRUCTOR;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;

/**
 * Created by saleson on 2017/5/31.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
@Documented
@Constraint(validatedBy = {NotEmptyValidator.class})
public @interface NotEmpty {

    String message() default "引數不能為null或空字串";

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

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

校驗器(validator):

package com.fm.core.validation.validator;

import com.fm.core.validation.NotEmpty;
import com.fm.framework.utils.StringUtils;
import org.apache.commons.collections.MapUtils;

import javax.validation.ConstraintValidatorContext;
import java.lang.reflect.Array;
import java.util.Collection;
import java.util.Map;

/**
 * Created by saleson on 2017/5/27.
 */
public class NotEmptyValidator extends AbstractValidator<NotEmpty, Object> {

    @Override
    protected boolean validNull(ConstraintValidatorContext context) {
        return false;
    }

    @Override
    protected boolean valid(Object value, ConstraintValidatorContext context) {
        if (value instanceof String) {
            return StringUtils.isNotEmpty(value.toString());
        } else if (value instanceof Collection) {
            return !org.springframework.util.CollectionUtils.isEmpty((Collection) value);
        } else if (value instanceof Map) {
            return MapUtils.isNotEmpty((Map) value);
        } else if (value.getClass().isArray()) {
            return Array.getLength(value) > 0;
        }
        return true;
    }


}

將上個demo中引用的org.hibernate.validator.constraints.NotEmpty改為com.fm.core.validation.NotEmpty即可。
執行結果：

WARN com.fm.grantauth.module.authorization.contact.DataAuthValidator - {dataProvider=引數不能為null或空字串, personalDataName=引數不能為null或空字串}

com.fm.core.exceptions.ApiException: 引數contractParams中缺少欄位:dataProvider, personalDataName

級聯校驗

校驗的物件中包含另一個需要校驗的物件時，則可以使用@javax.validation.Valid

import com.fm.core.exceptions.ApiException;
import com.fm.core.validation.NotEmpty;
import com.fm.framework.api.ApiResultHelper;
import com.fm.framework.json.Json;
import com.fm.framework.utils.StringUtils;
import com.fm.grantauth.domain.ValidateResult;
import com.fm.grantauth.domain.dto.AuthorizationApplyDTO;
import com.fm.grantauth.utils.ValidatorUtils;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.validation.Valid;
import java.util.Map;

/**
 * Created by saleson on 2017/10/12.
 */
public class DataAuthValidator implements ContractParamsValidator {
    private static final Logger log = LoggerFactory.getLogger(DataAuthValidator.class);

    @Override
    public ValidateResult validate(AuthorizationApplyDTO applyDTO) {
        String json = applyDTO.getContractParams();
        if (StringUtils.isEmpty(json)) {
            throw new ApiException(ApiResultHelper.newParameterEmpty("contractParams欄位不能為空"));
        }
        DataAuthContractParams params = Json.parseObject(json, DataAuthContractParams.class);
        Map<String, String> validMap = ValidatorUtils.validate(params);
        if (!validMap.isEmpty()) {
            log.warn(validMap.toString());
            throw new ApiException(ApiResultHelper.newBusinessError(lackFieldMessage(validMap.keySet().toArray(new String[0]))));
        }
        return new ValidateResult(true);
    }


    public static class DataAuthContractParams {
        @NotEmpty
        private String businessName;
        @NotEmpty
        private String dataProvider;
        @NotEmpty
        private String personalDataName;
        @NotEmpty
        private String dataDemander;
        //        @NotEmpty
        @Valid
        private Re r;

        public String getBusinessName() {
            return businessName;
        }

        public void setBusinessName(String businessName) {
            this.businessName = businessName;
        }

        public String getDataProvider() {
            return dataProvider;
        }

        public void setDataProvider(String dataProvider) {
            this.dataProvider = dataProvider;
        }

        public String getPersonalDataName() {
            return personalDataName;
        }

        public void setPersonalDataName(String personalDataName) {
            this.personalDataName = personalDataName;
        }

        public String getDataDemander() {
            return dataDemander;
        }

        public void setDataDemander(String dataDemander) {
            this.dataDemander = dataDemander;
        }

        public Re getR() {
            return r;
        }

        public void setR(Re r) {
            this.r = r;
        }
    }


    public static class Re {

        @NotEmpty
        private String d;

        public String getD() {
            return d;
        }

        public void setD(String d) {
            this.d = d;
        }
    }

    @Test
    public void test() {
        AuthorizationApplyDTO applyDTO = new AuthorizationApplyDTO();
        DataAuthContractParams params = new DataAuthContractParams();
        params.setBusinessName("f");
        params.setDataDemander("f");
        params.setDataProvider("");
        params.setPersonalDataName("");
        Re r = new Re();
        params.setR(r);

        applyDTO.setContractParams(Json.toJSONString(params));
        ValidateResult result = new DataAuthValidator().validate(applyDTO);
        System.out.println(Json.toJSONString(result));
        assert result.isSeccess();
    }
}

執行結果：

WARN com.fm.grantauth.module.authorization.contact.DataAuthValidator - {r.d=引數不能為null或空字串, dataProvider=引數不能為null或空字串, personalDataName=引數不能為null或空字串}

com.fm.core.exceptions.ApiException: 引數contractParams中缺少欄位:r.d, dataProvider, personalDataName

分組校驗

對同一個Model，我們在增加和修改時對引數的校驗也是不一樣的，這個時候我們就需要定義分組驗證。
com.fm.core.validation.NotEmpty#groups()就是用於分組校驗的

新增兩個用於分組校驗的介面：

public static interface GroupFirst {

}

public static interface GroupSecond {

}

校驗改成:

    public static class DataAuthContractParams {
        @NotEmpty
        private String businessName;
        @NotEmpty
        private String dataProvider;
        @NotEmpty(groups = GroupFirst.class)
        private String personalDataName;
        @NotEmpty(groups = {GroupFirst.class, GroupSecond.class})
        private String dataDemander;
        //        @NotEmpty
        @Valid
        private Re r;

        public String getBusinessName() {
            return businessName;
        }

        public void setBusinessName(String businessName) {
            this.businessName = businessName;
        }

        public String getDataProvider() {
            return dataProvider;
        }

        public void setDataProvider(String dataProvider) {
            this.dataProvider = dataProvider;
        }

        public String getPersonalDataName() {
            return personalDataName;
        }

        public void setPersonalDataName(String personalDataName) {
            this.personalDataName = personalDataName;
        }

        public String getDataDemander() {
            return dataDemander;
        }

        public void setDataDemander(String dataDemander) {
            this.dataDemander = dataDemander;
        }

        public Re getR() {
            return r;
        }

        public void setR(Re r) {
            this.r = r;
        }
    }


    public static class Re {

        @NotEmpty(groups = GroupSecond.class)
        private String d;

        public String getD() {
            return d;
        }

        public void setD(String d) {
            this.d = d;
        }
    }

修改ValidatorUtils

package com.fm.grantauth.utils;

import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.groups.Default;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;

/**
 * Created by saleson on 2017/10/13.
 */
public class ValidatorUtils {


    private static Validator validator = Validation.buildDefaultValidatorFactory()
            .getValidator();


    public static <T> Map<String, String> validate(T obj) {
        Set<ConstraintViolation<T>> set = validator.validate(obj, Default.class);
        return convertErrorMap(set);
    }


    public static <T> Map<String, String> validate(T obj, Class<?>... groups) {
        Set<ConstraintViolation<T>> set = validator.validate(obj, groups);
        return convertErrorMap(set);
    }


    private static <T> Map<String, String> convertErrorMap(Set<ConstraintViolation<T>> set) {
        Map<String, StringBuilder> errorMap = new HashMap<>();
        if (set != null && set.size() > 0) {
            String property = null;
            for (ConstraintViolation<T> cv : set) {
                //這裡迴圈獲取錯誤資訊，可以自定義格式
                property = cv.getPropertyPath().toString();
                if (errorMap.get(property) != null) {
                    errorMap.get(property).append("," + cv.getMessage());
                } else {
                    StringBuilder sb = new StringBuilder();
                    sb.append(cv.getMessage());
                    errorMap.put(property, sb);
                }
            }
        }
        return errorMap.entrySet().stream().collect(Collectors.toMap(k -> k.getKey(), v -> v.getValue().toString()));
    }
}

測試GroupFirst.class:

    @Test
    public void test() {
        DataAuthContractParams params = new DataAuthContractParams();
        params.setBusinessName("f");
        params.setDataDemander("");
        params.setDataProvider("f");
        params.setPersonalDataName("");
        Re r = new Re();
        params.setR(r);



        Map<String, String> validMap = ValidatorUtils.validate(params, GroupFirst.class);
        System.out.println("error is: " + validMap);
    }

執行結果:
error is: {dataDemander=引數不能為null或空字串, personalDataName=引數不能為null或空字串}

測試GroupSecond.class:

    @Test
    public void test() {
        DataAuthContractParams params = new DataAuthContractParams();
        params.setBusinessName("f");
        params.setDataDemander("");
        params.setDataProvider("f");
        params.setPersonalDataName("");
        Re r = new Re();
        params.setR(r);



        Map<String, String> validMap = ValidatorUtils.validate(params, GroupSecond.class);
        System.out.println("error is: " + validMap);
    }

執行結果:
error is: {dataDemander=引數不能為null或空字串, r.d=引數不能為null或空字串}

測試GroupFirst.class+GroupSecond.class:

    @Test
    public void test() {
        DataAuthContractParams params = new DataAuthContractParams();
        params.setBusinessName("f");
        params.setDataDemander("");
        params.setDataProvider("f");
        params.setPersonalDataName("");
        Re r = new Re();
        params.setR(r);



        Map<String, String> validMap = ValidatorUtils.validate(params, GroupFirst.class, GroupSecond.class);
        System.out.println("error is: " + validMap);
    }

執行結果:
error is: {dataDemander=引數不能為null或空字串, r.d=引數不能為null或空字串, personalDataName=引數不能為null或空字串}

spring mvc上使用分組校驗：@org.springframework.validation.annotation.Validated({GroupFirst.class, GroupSecond.class})

JAVA欄位校驗(validation)

在開發業務時，不可避免的需要處理一些校驗，如果是寫if-else這種程式碼去校驗，那會有一大段這樣的程式碼。不過還好有個校驗外掛：javax.validation.validation-api，不過一般會引用hibernate的校驗元件：org.hibern

SpringBoot專案總結--（1）欄位校驗與加密

一、多欄位校驗提供Validator的實現類，並且實現Validator介面的supports和validate方法。supports方法用於判斷當前類是不是需要校驗的類。只有當supports方法返回的結果為true時，validate方法才會執行進行校驗。 p

AntDesign Form表單欄位校驗的三種方式

1.使用getFieldDecorator的rules規則最簡單的方法就是使用getFieldDecorator中的rules驗證。rules中定義校驗規則，message為校驗不通過時的提示文字。 {getFieldDecorator('inputContent', {

Element 表單驗證，取消部分表單欄位校驗結果

struts2的欄位校驗型別和struts2實現檔案上傳

使用struts2的輸入校驗欄位校驗器配置風格 <field name=”被校驗的欄位”> <field-validator type=”校驗器名”> <param name=”引數名”>引

Java參數校驗工具validation實踐

jar包依賴 pos jar包 compile mpi 創建 pri nal void 介紹　　在項目開發當中，數據校驗是你必須要考慮和面對的事情，為此要寫上一大串的代碼進行校驗，這樣就會導致代碼冗余和一些管理的問題。例如下面的代碼： 1 public void pu

Java 正則校驗金額，只能是正整數或2位小數以內

參考：https://blog.csdn.net/u012402177/article/details/52604725 public class Test { public static boolean isNumber(String str) {

java正則校驗必須包括字母、數字和字元（6-12位）

java正則校驗，必須包括字母數字字元 public static String checkPassword(String passwordStr) { if (passwordStr !=

java bean 校驗validation

引數校驗是我們程式開發中必不可少的過程。為了保持程式的健壯性，需要對資料進行校驗。簡單的校驗在po實體類中添加註解 import org.hibernate.validator.constraints.Length; /** * 通知記錄 *

java身份證號碼校驗、郵箱校驗、手機號碼/電話號碼校驗

i++ start exceptio span cas table mail pub sys import java.text.ParseException; import java.text.SimpleDateFormat; import java.util.

18位身份證號碼最後一位校驗

void i++ apt div 身份證號碼 ++ print col str 1 package com.jdk7.chapter5; 2 3 /** 4 * 僅能校驗15位或18位身份證號的校驗碼 5 * @author Administrator

java正則校驗，密碼必須由字母和數字組成

mat AR bottom exception click popu 功能 log statistic 一個匹配數字和字母密碼的正則表達式 2011 年 12 月 14 日 | Filed under: 正則表達式 and tagged with: 密碼 , 正則

java 使用註釋校驗數據有效性

spa 元素 java 業務 lmin als 類庫 sequence 數據驗證註解驗證的數據類型說明空檢查 @Null 任意類型驗證註解的元素值是null

java modbus crc16校驗碼 socket給傳送的資料新增crc校驗碼

首先crc16校驗碼的生成的原理在上一篇部落格裡面已經說過了；前提：xframe配置京金華伺服器的埠號，繫結ip地址和埠號程式要實現什麼？這個程式主要實現的是伺服器傳送資料到客戶端，然後客戶端傳送資料到伺服器端；是一問一答的形式；只有伺服器傳送，客戶端才會應答傳送

java身份證合法性校驗並獲取並根據身份證號提取身份證相關資訊

原文地址：https://blog.csdn.net/ycb1689/article/details/52352147 /** * 身份證前6位【ABCDEF】為行政區劃數字程式碼（簡稱數字碼）說明（參考《GB/T 2260-2007 中華人民共和國行政區劃程式碼》）： *

java 欄位覆蓋(field)

欄位的覆蓋： public class Father { public String name="Father"; public static void main(String[] args) { Son son=new Son(); Syste

java方法引數校驗實踐

在 spring 的validation 驗證框架還沒有釋出出來，怎麼很優雅地對引數合法性做校驗呢？有兩種時間方式：（1） result = method1(); if (result is error){ //根據返回結果判斷是否

JAVA-使用gson校驗字串是否是json

使用gson校驗字串是否是json格式： public static boolean validate(String jsonStr) { JsonElement jsonEle

ios或安卓登入java後臺token校驗機制簡介

ios或者安卓在登入的時候為了統一校驗，一般的的情況下會到一個共同的介面進行檢驗，這裡用java做了一個簡單的後臺介面用於ios或者安卓登入校驗。後臺的java框架是SSM框架。下邊是校驗的流程：使用的maven，以下是pom.xml: <project xml

java 實現CRC32校驗

https://blog.csdn.net/yjk2515279130/article/details/46045939 實現了CRC32校驗，本來java那邊是很簡單的，直接用 java.util.zip.CRC32 這個類就可以了，可是如果要和Delphi那裡

JAVA欄位校驗(validation)

基礎校驗型別

寫個DEMO看看

自定義校驗規則(Validator)

級聯校驗

分組校驗

相關推薦