JAVA中的字段校驗(validation)

更新時間：2024年07月04日 09:04:36 作者：Saleson

這篇文章主要介紹了JAVA中的字段校驗(validation)用法,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

基礎校驗類型

JSR303 是一套JavaBean參數(shù)校驗的標準，它定義了很多常用的校驗注解，我們可以直接將這些注解加在我們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) {
                //這里循環(huán)獲取錯誤信息，可以自定義格式
                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: 參數(shù)contractParams中缺少字段:dataProvider, personalDataName

自定義校驗規(guī)則(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 "參數(shù)不能為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=參數(shù)不能為null或空字符串, personalDataName=參數(shù)不能為null或空字符串}

com.fm.core.exceptions.ApiException: 參數(shù)contractParams中缺少字段:dataProvider, personalDataName

級聯(lián)校驗

校驗的對象中包含另一個需要校驗的對象時，則可以使用@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=參數(shù)不能為null或空字符串, dataProvider=參數(shù)不能為null或空字符串, personalDataName=參數(shù)不能為null或空字符串}

com.fm.core.exceptions.ApiException: 參數(shù)contractParams中缺少字段:r.d, dataProvider, personalDataName

分組校驗

對同一個Model，我們在增加和修改時對參數(shù)的校驗也是不一樣的，這個時候我們就需要定義分組驗證。

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) {
                //這里循環(huán)獲取錯誤信息，可以自定義格式
                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=參數(shù)不能為null或空字符串, personalDataName=參數(shù)不能為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=參數(shù)不能為null或空字符串, r.d=參數(shù)不能為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=參數(shù)不能為null或空字符串, r.d=參數(shù)不能為null或空字符串, personalDataName=參數(shù)不能為null或空字符串}

spring mvc上使用分組校驗：

@org.springframework.validation.annotation.Validated({GroupFirst.class, GroupSecond.class})

總結

以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

您可能感興趣的文章:

java高并發(fā)下解決AtomicLong性能瓶頸方案LongAdder
這篇文章主要為大家介紹了java高并發(fā)下解決AtomicLong性能瓶頸方案LongAdder，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪
2022-12-12
Java實戰(zhàn)之校園外賣點餐系統(tǒng)的實現(xiàn)
這篇文章主要介紹了如何利用Java實現(xiàn)簡易的校園外賣點餐系統(tǒng)，文中采用的技術有：JSP、Spring、SpringMVC、MyBatis 等，感興趣的可以了解一下
2022-03-03
java中數(shù)組的定義及使用方法(推薦)
下面小編就為大家?guī)硪黄猨ava中數(shù)組的定義及使用方法(推薦)。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧
2016-07-07
學習在一臺新電腦上配置JAVA開發(fā)環(huán)境
本文主要介紹了如何在一臺新電腦上配置JAVA開發(fā)環(huán)境，每一個步驟都有對應的截圖和文字說明，需要的朋友可以參考下
2015-07-07
Java實現(xiàn)茶葉售賣商城系統(tǒng)(java+SSM+JSP+EasyUi+mysql)
這篇文章主要介紹了基于SSM框架實現(xiàn)的一個茶葉售賣商城系統(tǒng)，應用到的技術有Jsp、SSM 、EasyUi，文中的示例代碼具有一定的學習價值，需要的朋友可以參考一下
2021-12-12
Java Servlet上傳圖片到指定文件夾并顯示圖片
在學習Servlet過程中，針對圖片上傳做了一個Demo,如果大家對Java Servlet上傳圖片到指定文件夾并顯示圖片功能感興趣的朋友大家通過本文一起學習吧
2017-08-08
Nebula?Graph介紹和SpringBoot環(huán)境連接和查詢操作
Nebula?Graph?是一款開源的、分布式的、易擴展的原生圖數(shù)據(jù)庫，能夠承載包含數(shù)千億個點和數(shù)萬億條邊的超大規(guī)模數(shù)據(jù)集，并且提供毫秒級查詢，這篇文章主要介紹了Nebula?Graph介紹和SpringBoot環(huán)境連接和查詢,需要的朋友可以參考下
2022-10-10
JAVA封裝多線程實現(xiàn)的方式及原理
這篇文章主要介紹了Java中封裝多線程的原理和常見方式,通過封裝可以簡化多線程的使用,提高安全性,并增強代碼的可維護性和可擴展性,需要的朋友可以參考下
2025-03-03
Mybatis的Mapper中的方法為什么不能重載
這篇文章主要介紹了Mybatis的Mapper中的方法為什么不能重載，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧
2020-09-09
Shiro在springboot中快速實現(xiàn)方法
Apache Shiro是一個Java的安全（權限）框架，可以容易的開發(fā)出足夠好的應用，既可以在JavaEE中使用，也可以在JavaSE中使用，這篇文章主要介紹了Shiro在springboot中快速實現(xiàn),需要的朋友可以參考下
2023-02-02