springmvc、springboot 參數校驗

參數校驗在項目中是必不可少的，不僅前端需要校驗，爲了程序的可靠性，後端也需要對參數進行有效性的校驗。下面將介紹在springmvc或springboot項目中參數校驗的方法

準備工作：

引入校驗需要用到的依賴

 

 首先放上我們的測試對象

方法一、全部使用註解的方式進行校驗

可以看到，我們在測試對象中加上了@NotBlank和@NotEmpty註解，表示該字段需要進行校驗，下面我們進行測試

我們在需要校驗的對象前面加上@Valid註解

測試方法：

運行結果：

這樣我們就完成了參數校驗，並且獲取到了錯誤的信息。但是需要注意的是，我們想要拿到錯誤信息的時候還需要用到BindingResult對象，如果項目中有多處需要進行校驗的話，BindResult參數用到得特別頻繁，導致代碼看起來很多餘，所以我們使用第二種方法，自定義參數校驗。

方法二、自定義參數校驗方法

自定義校驗類的代碼如下

import com.google.common.base.Preconditions;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.me.exception.ParamException;
import org.apache.commons.collections.MapUtils;

import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;
import java.util.*;

public class BeanValidator {
    // Validator工廠
    private static ValidatorFactory validatorFactory = Validation.buildDefaultValidatorFactory();

    // Map<String,String> 中 key表示錯誤的字段，value表示錯誤信息

    /**
     * 校驗單個對象
     *
     * @param t
     * @param groups
     * @param <T>
     * @return
     */
    public static <T> Map<String, String> validate(T t, Class... groups) {
        Validator validator = validatorFactory.getValidator();
        // 傳入參數，並獲取校驗結果
        Set validatorErrors = validator.validate(t, groups);
        // 若校驗爲空，說明校驗通過,返回空集合
        if (validatorErrors.isEmpty()) {
            return Collections.emptyMap();
        } else {
            LinkedHashMap<String, String> errors = Maps.newLinkedHashMap();
            // 對校驗錯誤信息進行遍歷
            Iterator iterator = validatorErrors.iterator();
            while (iterator.hasNext()) {
                ConstraintViolation violation = (ConstraintViolation) iterator.next();
                // 放入key,value
                errors.put(violation.getPropertyPath().toString(), violation.getMessage());
            }
            return errors;
        }
    }

    /**
     * 校驗多個對象
     *
     * @param collection
     * @return
     */
    public static Map<String, String> validateList(Collection<?> collection) {
        // 判斷是否爲空，爲空時拋出異常
        Preconditions.checkNotNull(collection);
        Iterator iterator = collection.iterator();
        Map errors;
        do {
            if (!iterator.hasNext()) {
                return Collections.emptyMap();
            }
            // 取到當前值
            Object object = iterator.next();
            errors = validate(object, new Class[0]);
        } while (errors.isEmpty());
        return errors;
    }

    public static Map<String, String> validateObject(Object first, Object... objects) {

        if (objects != null && objects.length > 0) {
            return validateList(Lists.asList(first, objects));
        } else {
            return validate(first, new Class[0]);
        }
    }

    public static void check(Object param) throws ParamException {
        Map<String, String> errors = validateObject(param);
        if (MapUtils.isNotEmpty(errors)) {
            throw new ParamException(errors.toString());
        }

    }
}

 

我們對拋出的異常進行了全局捕獲

同樣，我們需要標誌校驗規則

測試方法：

運行結果：