springboot接口參數(shù)校驗(yàn)JSR303的實(shí)現(xiàn)
更新時(shí)間：2022年08月04日 08:36:05 作者：zhm_sky
本文主要介紹了springboot接口參數(shù)校驗(yàn)JSR303的實(shí)現(xiàn)，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
在 javax.validation.constraints包中定義了非常多的校驗(yàn)注解，引入依賴：
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency>
在實(shí)體類上添加對應(yīng)注解即可，
實(shí)體類：
package com.zhmsky.mallproduct.entity;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import java.io.Serializable;
import java.util.Date;
import lombok.Data;
import javax.validation.constraints.NotBlank;
/**
* 品牌
*
* @author zhmsky
* @email zhmsky@gmail.com
* @date 2022-07-30 16:40:28
*/
@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 品牌名
*/
@NotBlank(message = "品牌名不能為空")
private String name;
}
一、在controller接口處理校驗(yàn)異常
message可指定校驗(yàn)說明，
接下來在對應(yīng)的controller接口方法中使用@Valid 注解來指定接口參數(shù)校驗(yàn)，后面緊跟BindingResult來接收校驗(yàn)結(jié)果，當(dāng)發(fā)生校驗(yàn)失敗則封裝并返回校驗(yàn)失敗信息，如果通過校驗(yàn)則執(zhí)行相關(guān)邏輯
@RequestMapping(value = "/save",method = RequestMethod.POST)
public R save(@Valid @RequestBody BrandEntity brand, BindingResult result){
if(result.hasErrors()){
Map<String, String> map = new HashMap<>();
//獲取校驗(yàn)結(jié)果
for (FieldError fieldError : result.getFieldErrors()) {
//獲取錯(cuò)誤提示
String message = fieldError.getDefaultMessage();
//校驗(yàn)錯(cuò)誤的字段
String field = fieldError.getField();
//封裝錯(cuò)誤
map.put(field,message);
}
return R.error(20001,"參數(shù)校驗(yàn)失敗").put("errorMap",map);
}
brandService.save(brand);
return R.ok();
}
二、統(tǒng)一異常處理
如果在每一個(gè)接口都進(jìn)行參數(shù)校驗(yàn)異常處理，工作量比較大，并且代碼比較繁瑣，于是引入全局異常處理，
也就是@RestControllerAdvice+@ExceptionHandler注解的使用。
package com.zhmsky.mallproduct.exception;
import com.zhmsky.common.utils.R;
import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import java.util.HashMap;
import java.util.Map;
/**
* 同意異常處理類
* @author zhmsky
* @date 2022/8/1 21:36
*/
@Slf4j
@RestControllerAdvice(basePackages = {"com.zhmsky.mallproduct.controller"})
public class MallProductControllerAdvice {
//具體的某個(gè)異常類型處理
@ExceptionHandler(MethodArgumentNotValidException.class)
public R handleValidException(MethodArgumentNotValidException e){
log.error("數(shù)據(jù)異常:{},異常類型:{}",e.getMessage(),e.getClass());
BindingResult result = e.getBindingResult();
Map<String, String> map = new HashMap<>();
for (FieldError fieldError : result.getFieldErrors()) {
map.put(fieldError.getDefaultMessage(),fieldError.getField());
}
return R.error().put("errorMap",map);
}
//拋出的所有異常類型處理
@ExceptionHandler(Throwable.class)
public R handleException(Throwable e){
//TODO 處理邏輯
return R.error();
}
}
三、錯(cuò)誤碼枚舉類
package com.zhmsky.common.exception;
/**
* @author zhmsky
* @date 2022/8/1 21:56
*/
public enum ErrorCodeEnum {
UNKNOWN_EXCEPTION(10000, "系統(tǒng)未知錯(cuò)誤"),
VALID_EXCEPTION(10001, "參數(shù)格式校驗(yàn)失敗");
/**
* 錯(cuò)誤碼
*/
private Integer code;
/**
* 錯(cuò)誤提示
*/
private String msg;
ErrorCodeEnum(Integer code, String msg) {
this.code = code;
this.msg = msg;
}
public Integer getCode(){
return this.code;
}
public String getMsg(){
return this.msg;
}
}
四、自定義參數(shù)校驗(yàn)注解
1、編寫自定義校驗(yàn)注解
參照javax.validation.constraints的@NotBlank注解，
@Documented
@Constraint(validatedBy = { })
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Repeatable(List.class)
public @interface NotBlank {
//校驗(yàn)規(guī)則提示信息
String message() default "{javax.validation.constraints.NotBlank.message}";
//分組校驗(yàn)
Class<?>[] groups() default { };
//負(fù)載
Class<? extends Payload>[] payload() default { };
/**
* Defines several {@code @NotBlank} constraints on the same element.
*
* @see NotBlank
*/
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Documented
public @interface List {
NotBlank[] value();
}
}
模仿上面可快速編寫一個(gè)自定義注解：
@Documented
@Constraint(validatedBy = {StatusValueConstraintValidator.class})
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
public @interface statusValue {
//校驗(yàn)規(guī)則提示信息（在配置文件中配置）
String message() default "{com.zhmsky.common.validator.statusValue.message}";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
//注解參數(shù)
int[] values() default {};
}
創(chuàng)建 ValidationMessages.properties 文件，在配置文件中配置自定義的校驗(yàn)規(guī)則提示信息：
com.zhmsky.common.validator.statusValue.message=error.......xxxx
2、編寫自定義校驗(yàn)器
//statusValue就是自定義的注解，Integer就是自定義注解標(biāo)注的字段類型
public class StatusValueConstraintValidator implements ConstraintValidator<statusValue, Integer> {
private Set<Integer> set = new HashSet<>();
//初始化方法
@Override
public void initialize(statusValue constraintAnnotation) {
//字段標(biāo)注的注解里面設(shè)定的值（校驗(yàn)規(guī)則）
int[] values = constraintAnnotation.values();
for (int value : values) {
set.add(value);
}
}
//判斷是否校驗(yàn)成功
@Override
public boolean isValid(Integer value, ConstraintValidatorContext context) {
//value就是字段字段實(shí)際接收到的值
return set.contains(value);
}
}
3、關(guān)聯(lián)自定義注解和自定義校驗(yàn)器
也就是在自定義注解的@Constraint注解中指明自定義的校驗(yàn)器，
4、測試自定義注解@statusValue
@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 品牌名
*/
@NotBlank(message = "品牌名不能為空")
private String name;
/**
* 顯示狀態(tài)[0-不顯示；1-顯示]，指定字段值只能為 0 或 1
*/
@statusValue(values={0,1})
private Integer showStatus;
}
在對應(yīng)的controller接口中使用@Validated注解來進(jìn)行校驗(yàn)，showStatus字段傳入值3，
測試結(jié)果如圖：
到此這篇關(guān)于springboot接口參數(shù)校驗(yàn)JSR303的實(shí)現(xiàn)的文章就介紹到這了,更多相關(guān)springboot接口參數(shù)校驗(yàn)JSR303 內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
淺談java運(yùn)用注解實(shí)現(xiàn)對類中的方法檢測的工具
這篇文章主要介紹了淺談java運(yùn)用注解實(shí)現(xiàn)對類中的方法檢測的工具，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-08-08
SpringBoot通過整合Dubbo解決@Reference注解問題
這篇文章主要介紹了SpringBoot通過整合Dubbo解決@Reference注解問題,文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-03-03
本文主要介紹了servlet與jsp的相關(guān)知識(shí)，并總結(jié)出servlet與jsp之間的關(guān)系，具有很好的參考價(jià)值，下面跟著小編一起來看下吧2017-02-02
SpringMVC中Model和ModelAndView的EL表達(dá)式取值方法
下面小編就為大家分享一篇SpringMVC中Model和ModelAndView的EL表達(dá)式取值方法，具有很好的參考價(jià)值，希望對大家有所幫助。一起跟隨小編過來看看吧2018-03-03
這篇文章主要介紹了淺談Spring refresh的工作流程,refresh 是 AbstractApplicationContext 中的一個(gè)方法，負(fù)責(zé)初始化 ApplicationContext容器,讓我們一起來學(xué)習(xí)一下吧2023-04-04
在Java中當(dāng)try、finally語句中包含return語句時(shí)，執(zhí)行情況到底是怎樣的，finally中的代碼是否執(zhí)行，大家眾說紛紜，有的說會(huì)執(zhí)行，有的說不會(huì)執(zhí)行，到底哪種說法正確，下面我們來詳細(xì)討論下2015-10-10
Java spring事務(wù)及事務(wù)不生效的原因詳解
在日常編碼過程中常常涉及到事務(wù),在前兩天看到一篇文章提到了Spring事務(wù),那么在此總結(jié)下在Spring環(huán)境下事務(wù)失效的幾種原因2021-09-09
這篇文章主要介紹了Java并發(fā)編程之CountDownLatch解讀,是通過一個(gè)計(jì)數(shù)器來實(shí)現(xiàn)的,計(jì)數(shù)器的初始值是線程的數(shù)量,countDownLatch這個(gè)類使一個(gè)線程等待其他線程各自執(zhí)行完畢后再執(zhí)行,需要的朋友可以參考下2023-12-12
這篇文章主要給大家介紹了關(guān)于java中對象的序列化與反序列化的相關(guān)資料，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2018-09-09
今天給大家?guī)淼氖顷P(guān)于SpringMVC攔截器的相關(guān)知識(shí),文章圍繞著SpringMVC攔截器的使用方法展開,文中有非常詳細(xì)的介紹及代碼示例,需要的朋友可以參考下2021-06-06