SpringBoot controller參數校驗方法詳細講解

Posted on by

參數校驗主要使用兩個標簽@Validated和@Valid；

@Valid是Hibernate的註解校驗，@Validated是spring的，是@Valid的增強；這兩個標簽也有一些不同之處，@Valid可以標註在成員屬性上也可以嵌套校驗，而@Validated不行，但是@Validated可以使用分組校驗；

maven導入：

	<dependency>
	    <groupId>org.springframework.boot</groupId>
	    <artifactId>spring-boot-starter-validation</artifactId>
	    <version>2.7.5</version>
	</dependency>

通常用到的註解基本都在javax.validation.constraints包下，基本都有value（設定值）、message（設置錯誤消息）、groups（指定分組）屬性：

  • @AssertFalse：必須為false，支持boolean和Boolean，null是有效的；
  • @AssertTrue：必須為true，支持boolean和Boolean，null是有效的；
  • @DecimalMax：必須是一個小於或者小於等於設定值的數字，可以用inclusive指定是否包含數字（默認true），並且value是String類型的，支持BigDecimal、BigInteger、CharSequence、byte / short / int / long以及它們的包裝類（由於舍入原因不支持double和float），null是有效的；
  • @DecimalMin：必須是一個大於或者大於等於設定值的數字，其他同@DecimalMax；
  • @Digits：設定可接受范圍內的數字，必須指定integer（整數位數）和fraction（小數位數），支持BigDecimal、BigInteger、CharSequence、byte / short / int / long以及它們的包裝類，null是有效的；
  • @Email：必須是一個正確格式的郵箱，可以使用regexp指定正則表達式（默認是任意字符串），可以使用flags指定正則表達式的選項，null是有效的；
  • @Future：必須是一個未來的瞬間、日期或時間（Now是虛擬機默認的當前時區的時間），支持java.util.Date、java.util.Calendar、java.time.Instant、java.time.LocalDate、java.time.LocalDateTime、java.time.LocalTime、java.time.MonthDay、java.time.OffsetDateTime、java.time.OffsetTime、java.time.Year、java.time.YearMonth、java.time.ZonedDateTime、java.time.chrono.HijrahDate、java.time.chrono.JapaneseDate、java.time.chrono.MinguoDate、java.time.chrono.ThaiBuddhistDate，null是有效的；
  • @FutureOrPresent：必須是現在或未來的瞬間、日期或時間，其他同@Future；
  • @Max：必須是小於等於指定值的數字，value是long類型，支持BigDecimal、BigInteger、byte / short / int / long以及它們的包裝類（不支持float和double），null是有效的；
  • @Min：必須是大於等於指定值的數字，其他同@Max；
  • @Negative：必須是一個嚴格的負數，0為無效值，支持BigDecimal、BigInteger、byte / short / int / long / float / double以及它們的包裝類，null是有效的；
  • @NegativeOrZero，必須是負數或者0，其他同@Negative；
  • @NotBlank：不能為null，並且至少包含一個非空白字符，接受CharSequence；
  • @NotEmpty：不能為null或空（集合），支持CharSequence（字符序列長度）、Collection（集合size）、Map（map size）、Array（數組長度）；
  • @NotNull：不能為null，支持所有類型；
  • @Null：必須為null，支持所有類型；
  • @Past：必須是一個過去的瞬間、日期或時間，其他同@Future；
  • @PastOrPresent：必須是現在或過去的瞬間、日期或時間，其他同@Future；
  • @Pattern：必須符合指定的正則表達式，必須使用regexp參數指定正則表達式；
  • @Positive：必須是一個嚴格的正數，0為無效值，其他同@Negative；
  • @PositiveOrZero：必須是正數或者0，其他同@Negative；
  • @Size：指定元素大小必須在指定范圍內（包括邊界值），使用min指定下邊界（默認0），使用max指定上邊界（默認Integer.MAX_VALUE），支持CharSequence、Collection、Map、Array，null是有效的；

單參數校驗

在controller類上添加@Validated標簽，在方法的參數前加驗證標簽，並且同一個參數可以添加多個標簽；

啟動類：（使用默認配置，端口8080）

package testspringboot.test6paramvalidation;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class Test6Main {
	/**
	 * @param args
	 */
	public static void main(String[] args) {
		SpringApplication.run(Test6Main.class, args);
	}
}

controller類：

package testspringboot.test6paramvalidation;
import java.util.List;
import java.util.stream.Collectors;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import org.springframework.validation.BindingResult;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/test6")
@Validated
public class Test6Controller {
	@RequestMapping("/a")
	public String a(@NotNull(message = "參數s不能為null") String s, @Min(5) @Max(value = 10) long a) {
		System.out.println(s);
		System.out.println(a);
		return String.format("s:%s a:%d", s, a);
	}
}

postman測試：

返回的錯誤msg也可以使用自定義設定，使用@RestControllerAdvice註釋一個類，然後在類裡定義各種錯誤msg，就像這樣：

package testspringboot.test6paramvalidation;
import java.util.List;
import java.util.stream.Collectors;
import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import org.springframework.validation.ObjectError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
@RestControllerAdvice
public class ValidException {
	@ExceptionHandler(value = MethodArgumentNotValidException.class)
    public String handleValidException(MethodArgumentNotValidException e) {
        List<String> msgList = e.getBindingResult().getAllErrors()
        		.stream()
        		.map(ObjectError::getDefaultMessage)
        		.collect(Collectors.toList());
        return "MethodArgumentNotValidException: " + msgList.toString();
    }
    @ExceptionHandler(value = ConstraintViolationException.class)
    public String handleConstraintViolationException(ConstraintViolationException e) {
        List<String> msgList = e.getConstraintViolations()
                .stream()
                .map(ConstraintViolation::getMessage)
            	.collect(Collectors.toList());
        return "ConstraintViolationException: " + msgList.toString();//返回錯誤描述
    }
}

再次測試結果：

默認驗證所有參數，即使前面驗證不通過也會繼續驗證，可以設置快速失敗，使驗證失敗立即返回不繼續驗證；

自定義註入Validator類：

package testspringboot.test6paramvalidation;
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;
import org.hibernate.validator.HibernateValidator;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class ValidatConfig {
	@Bean
	public Validator validator() {
		ValidatorFactory vfactory = Validation.byProvider(HibernateValidator.class)
				.configure()
				.failFast(true)//開啟快速失敗
				.buildValidatorFactory();
		return vfactory.getValidator();
	}
}

再次測試結果，隻顯示一個錯誤msg瞭：

實體類校驗

隻需要在controller類的方法實體類參數前加@Validated或者@Valid標簽，實體類裡的屬性前加驗證標簽，controller類上可以不用@Validated標簽也行；

實體類：

package testspringboot.test6paramvalidation;
import javax.validation.constraints.Max;
import javax.validation.constraints.NotNull;
public class Bparam {
	@NotNull
	public String s;
	@Max(value = 10, message = "Bparam的x參數不能超過10")
	public int x;
	public String getS() {
		return s;
	}
	public void setS(String s) {
		this.s = s;
	}
	public int getX() {
		return x;
	}
	public void setX(int x) {
		this.x = x;
	}
	@Override
	public String toString() {
		return "Bparam [s=" + s + ", x=" + x + "]";
	}
}

controller類裡的方法：

	@RequestMapping("/b")
	public String b(@Valid Bparam b) {
		return b.toString();
	}

測試：

另外錯誤消息也可以在controller類的方法參數裡接收，參數裡使用BindingResult就可以處理：

	@RequestMapping("/b")
	public String b(@Valid Bparam b, BindingResult result) {
		if (result.hasErrors()) {
			List<String> errors = result.getAllErrors().stream().map(x -> x.getDefaultMessage()).collect(Collectors.toList());
			return "BindingResult Errors: " + errors.toString();
		}
		return b.toString();
	}

使用post的消息體接收參數也一樣，在參數前多加一個@RequestBody：

	@RequestMapping("/b")
	public String b(@RequestBody @Validated Bparam b, BindingResult result) {
		if (result.hasErrors()) {
			List<String> errors = result.getAllErrors().stream().map(x -> x.getDefaultMessage()).collect(Collectors.toList());
			return "BindingResult Errors: " + errors.toString();
		}
		return b.toString();
	}

分組校驗

可以為同一屬性設置不同情況下應用不同的註解標簽，需要在註解標簽裡使用groups參數，groups是一個class集合，一個標簽可以設置多個group，在controller類裡方法的參數前的@Validated標簽裡使用value指定要使用的group驗證（可以指定多個group驗證），沒有設置groups的標簽默認屬於Default.class的group，設置group的class通常使用interface，可以寫在外面或者直接寫到實體類內部；

實體類：

package testspringboot.test6paramvalidation;
import javax.validation.constraints.AssertFalse;
import javax.validation.constraints.AssertTrue;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Size;
public class Cparam {
	@AssertTrue(message = "b應為true", groups = CparamBTrue.class)
	@AssertFalse(message = "b應為false", groups = CparamBFalse.class)
	public boolean b;
	@NotBlank
	@Size(min = 1, max = 5, message = "s的長度1~5")
	public String s;
	@Min(20)
	public int i;
//	interface CparamBTrue{}
//	interface CparamBFalse{}
}
interface CparamBTrue{}
interface CparamBFalse{}

controller方法：

	@RequestMapping("/c1")
	public String c1(@RequestBody @Validated(CparamBTrue.class) Cparam c, BindingResult result) {
		if (result.hasErrors()) {
			List<String> errors = result.getAllErrors().stream().map(x -> x.getDefaultMessage()).collect(Collectors.toList());
			return "BindingResult Errors: " + errors.toString();
		}
		return "OK";
	}
	@RequestMapping("/c2")
	public String c2(@RequestBody @Validated(value = {CparamBFalse.class, Default.class}) Cparam c, BindingResult result) {
		if (result.hasErrors()) {
			List<String> errors = result.getAllErrors().stream().map(x -> x.getDefaultMessage()).collect(Collectors.toList());
			return "BindingResult Errors: " + errors.toString();
		}
		return "OK";
	}

分組測試：

c1隻驗證瞭group是CparamBTrue的成員b，c2除瞭驗證瞭group是CparamBFalse的成員b，也驗證瞭沒有設置groups的s和i；

另外也可以設置動態組校驗，根據某些條件和情況設置驗證的groups，需要在實體類上添加@GroupSequenceProvider標簽指定實現瞭DefaultGroupSequenceProvider接口並實現接口裡getValidationGroups方法的class，getValidationGroups方法返回List<Class<?>>，即為當前請求需要使用的groups（返回值相當於controller類方法參數前@Validated標簽裡的value的作用）；

例如根據實體類內boolean值指定int值使用正負數：

實體類：

package testspringboot.test6paramvalidation;
import javax.validation.constraints.Negative;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Positive;
import org.hibernate.validator.group.GroupSequenceProvider;
@GroupSequenceProvider(value = C3paramGroupProvider.class)
public class C3param {
	@NotNull(message = "b不能為null")
	public boolean b;
	@NotNull
	@Positive(message = "b為true時i應大於0", groups = BTrue.class)
	@Negative(message = "b為false時i應小於0", groups = BFalse.class)
	public int i;
	@Override
	public String toString() {
		return "C3param [b=" + b + ", i=" + i + "]";
	}
	interface BTrue{}
	interface BFalse{}
}

GroupProvider：

package testspringboot.test6paramvalidation;
import java.util.ArrayList;
import java.util.List;
import org.hibernate.validator.spi.group.DefaultGroupSequenceProvider;
public class C3paramGroupProvider implements DefaultGroupSequenceProvider<C3param> {
	@Override
	public List<Class<?>> getValidationGroups(C3param object) {
		System.out.println("obj:" + object);
		List<Class<?>> groupList = new ArrayList<>();
		groupList.add(C3param.class);//實體類需要加入
		if (object != null) {//該方法會調用多次，object可能為null
			//b為true時使用BTrue.class組，b為false時使用BFalse.class組
			groupList.add(object.b ? C3param.BTrue.class : C3param.BFalse.class);
		}
		return groupList;
	}
}

controller方法：

	@RequestMapping("/c3")
	public String c3(@RequestBody @Validated C3param c3, BindingResult result) {
		System.out.println("param:" + c3);
		if (result.hasErrors()) {
			List<String> errors = result.getAllErrors().stream().map(x -> x.getDefaultMessage()).collect(Collectors.toList());
			return "BindingResult Errors: " + errors.toString();
		}
		return "OK";
	}

測試：

嵌套校驗

實體類成員為另一個級聯的類時，需要在成員前使用@Valid標簽（支持嵌套），並且提供該級聯的成員屬性的get方法，另外級聯類內部也需要提供需要驗證的成員屬性的get方法（不驗證的成員不用get方法）

第一層實體類：

package testspringboot.test6paramvalidation;
import javax.validation.Valid;
import javax.validation.constraints.AssertTrue;
public class D1param {
	@AssertTrue(message = "D1param.b必須為true")
	public boolean b;
	@Valid
	public D2param d2;
	public D2param getD2() {//級聯對象需要get方法
		return d2;
	}
}

第二層實體類：

package testspringboot.test6paramvalidation;
import javax.validation.Valid;
import javax.validation.constraints.Positive;
public class D2param {
	@Positive(message = "D2param.i必須為正數")
	public int i;
	public String s;//不驗證，不需get方法
	@Valid
	public D3param d3;
	public int getI() {//成員需要get方法
		return i;
	}
	public D3param getD3() {//級聯對象需要get方法
		return d3;
	}
}

第三層實體類：

package testspringboot.test6paramvalidation;
import javax.validation.constraints.NotNull;
public class D3param {
	@NotNull(message = "D3param.s不能為null")
	public String s;
	public String getS() {//成員需要get方法
		return s;
	}
}

controller方法：

	@RequestMapping("/d")
	public String d(@RequestBody @Validated D1param d1, BindingResult result) {
		if (result.hasErrors()) {
			List<String> errors = result.getAllErrors().stream().map(x -> x.getDefaultMessage()).collect(Collectors.toList());
			return "BindingResult Errors: " + errors.toString();
		}
		return "OK";
	}

測試：

自定義註解

定義一個註解，使用@Retention、@Target、@Constraint標簽註釋，並攜帶三個方法message()、groups()、payload()，並在@Constraint標簽裡使用validatedBy屬性指定自定義驗證類，自定義驗證類實現ConstraintValidator<A extends Annotation, T>接口的boolean isValid(T value, ConstraintValidatorContext context)方法，判斷驗證是否通過；

自定義註解：（功能：驗證是偶數）

package testspringboot.test6paramvalidation;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import javax.validation.Constraint;
import javax.validation.Payload;
@Retention(RUNTIME)
@Target(FIELD)
@Constraint(validatedBy = EValidator.class)
public @interface EAnnotation {
	String message() default "應該是偶數";
	Class<?>[] groups() default {};
	Class<? extends Payload>[] payload() default {};
}

對應的驗證類：

package testspringboot.test6paramvalidation;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
public class EValidator implements ConstraintValidator<EAnnotation, Integer> {
	@Override
	public boolean isValid(Integer value, ConstraintValidatorContext context) {
		return value % 2 == 0;
	}
}

實體類：

package testspringboot.test6paramvalidation;
public class Eparam {
	@EAnnotation
	public int i;
}

controller方法：

	@RequestMapping("/e")
	public String e(@RequestBody @Validated Eparam e, BindingResult result) {
		if (result.hasErrors()) {
			List<String> errors = result.getAllErrors().stream().map(x -> x.getDefaultMessage()).collect(Collectors.toList());
			return "BindingResult Errors: " + errors.toString();
		}
		return "OK";
	}

測試：

到此這篇關於SpringBoot controller參數校驗方法詳細講解的文章就介紹到這瞭,更多相關SpringBoot controller 內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：