文章目錄

一、關于JSR
- 1.1什么是JSR？
- 1.2什么是JSR-303？
- 1.3JSR-303的作用？
二、從if判斷到jsr303
- 2.1提供一個場景
- 2.1首先使用if判斷
- 2.3jsr303使用
三、jsr303相關校驗注解導圖展示
四、@Valid和@Validated的區別
五、@Valid和@Validated高級使用
- 5.1Valid級聯校驗
- 5.2@Validated分組校驗
- - 5.2.1什么是分組校驗
  - 5.2.2.引出jsr303校驗注解的groups方法
  - 5.2.3.@Validated注解value方法開啟指定分組校驗
  - 5.2.4.檢驗結果
  - 5.2.5.結論
- 5.3@Validated分組校驗順序
- - 5.3.1為什么需要？
  - 5.3.2如何實作?
- 5.4@Validated非物體類校驗
- - 5.4.1.使用@Validated注解
  - 5.4.2.GlobalExceptionHandler類添加例外處理方法
  - 5.4.3測驗結果
六、自定義注解校驗
- 6.1自定義注解@ListValue
- 6.2使用自定義注解
- 6.3請求方法
- 6.4測驗結果
七、補充@PathVariable注解校驗
- 7.1@PathVariable作用
- 7.2使用正則運算式校驗路徑變數
- 7.3自定義類實作ErrorController介面
- 7.4測驗結果
八、導圖總結

本文代碼已上傳gitee：https://gitee.com/shang_jun_shu/springboot-exception-jsr303.git
其他系列博客
Java例外處理（一）一例外處理流程
java例外處理（二）—從位元組碼層面看throw關鍵字及try…catch…finally的實作
java例外處理（三）—Springboot全域例外處理(@ControllerAdvice和ErrorController)

一、關于JSR

1.1什么是JSR？

JSR是Java Specification Requests的縮寫，意思是Java規范提案，是指向JCP(Java Community Rrocess)提出新增一個標準化技術規范的正式請求，任何人都可以提交JSR，以向Java平臺增添新的API和服務，

比如：

Web應用技術

Java Servlet 3.0 (JSR 315)
JavaServer Faces 2.0 (JSR 314)
JavaServer Pages 2.2/Expression Language 2.2 (JSR 245)
Standard Tag Library for JavaServer Pages (JSTL) 1.2 (JSR 52)
Debugging Support for Other Languages 1.0 (JSR 45)

1.2什么是JSR-303？

JSR-303是javaee 6中的一項子規范，叫做Bean Validation，Hibernate Validator 是 Bean Validation的參考實作. Hibernate Validator 提供了 JSR 303 規范中所有內置 constraint 的實作，除此之外還有一些附加的 constraint，目前Springboot內置了Hibernate Validator，

1.3JSR-303的作用？

用于對Java Bean的欄位值進行校驗，確保輸入進來的資料在語意上是正確的，使驗證邏輯從業務代碼中脫離出來，

JSR303是運行時資料驗證框架，驗證之后驗證的錯誤資訊會馬上回傳，

二、從if判斷到jsr303

2.1提供一個場景

提供一個物體類，該物體類含有一個屬性

@Data
public class ExceptionQuery {
    private String userName;
}

要求用戶提供的姓名不能為空，下面開始校驗該屬性

2.1首先使用if判斷

@PostMapping("/query")
public Result  getResult(@RequestBody ExceptionQuery query){
    //校驗引數
    if (StringUtils.isEmpty(query.getUserName())){
        //拋出例外
    }
    return Result.buildSuccess(query);
}

這個方法本省是沒有問題的，但是如果入參有很多屬性需要校驗，那么程式中就會存在很多if判斷，這樣顯的代碼很冗余，有沒有方法替代if判斷呢？當然是有的，使用jsr303可以解決該問題

2.3jsr303使用

1.為屬性加@NotBlank屬性

@Data
public class ExceptionQuery {

    @NotBlank(message = "用戶姓名必須提交")
    private String userName;

}

注：像@NotBlank一類的校驗注解都可以重寫message屬性

public @interface NotBlank {
    
    //default表明可以重寫message屬性
    String message() default "{javax.validation.constraints.NotBlank.message}";
    //省略...
}

2.在方法入參引數上加@Valid注解

@PostMapping("/query")
public Result  getResult(@Valid @RequestBody ExceptionQuery query){
    return Result.buildSuccess(query);
}

3.postman測驗結果
在這里插入圖片描述
從輸出結果上可以看到重寫后的message屬性，而對于錯誤的輸出結果Spring也提供了對應類存盤錯誤資訊，這個類就是BindingResult，將上面的方法加上BindingResult引數，如下代碼

@PostMapping("/query")
public Result  getResult(@Valid @RequestBody ExceptionQuery query, BindingResult result){
    if(result.hasErrors()){
        Map<String,String> map = new HashMap<>();
        result.getFieldErrors().forEach(item->{
            //獲取發生錯誤時的message
            String message = item.getDefaultMessage();
            //獲取發生錯誤的欄位
            String field = item.getField();
            map.put(field,message);
            System.out.println(field+":"+message);
        });
        return Result.buildFailure(400,"引數錯誤",map);
    }
    return Result.buildSuccess(query);
}

輸出結果
在這里插入圖片描述

然而，咱們不能對每個方法都傳入一個BindingResult引數，可以使用統一例外處理輸出錯誤資訊

4.配合例外處理

首先說下為什么能通過例外處理輸出錯誤資訊？

我們定位到一個類MethodArgumentNotValidException，該類也是Spring提供的，包含BindingResult參考，因此該類可以拿到輸出的錯誤資訊

例外處理代碼

@Slf4j
@RestControllerAdvice(annotations = {RestController.class, Controller.class})
public class GlobalExceptionHandler {
    
    @ResponseStatus(HttpStatus.OK)
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Result handleValidationException(MethodArgumentNotValidException e) {
        log.error(ErrorStatus.ILLEGAL_DATA.getMessage() + ":" + e.getMessage());
        Map<String,Object> map=new HashMap<>();
        
        //拿到例外輸出資訊
        BindingResult bindingResult = e.getBindingResult();
        bindingResult.getFieldErrors().forEach(fieldError -> {
            String message = fieldError.getDefaultMessage();
            String field = fieldError.getField();
            map.put(field,message);
        });
        return Result.buildFailure(ErrorStatus.ILLEGAL_DATA.getCode(),String.valueOf(getFirstOrNull(map)),map);
    }

    //拿到map第一個值
    private static Object getFirstOrNull(Map<String, Object> map) {
        Object obj = null;
        for (Map.Entry<String, Object> entry : map.entrySet()) {
            obj = entry.getValue();
            if (obj != null) {
                break;
            }
        }
        return  obj;
    }
}

加上例外處理后的方法代碼如下所示，關于@ControllerAdvice全域例外處理請看這一篇博客

@PostMapping("/query")
public Result  getResult(@Valid @RequestBody ExceptionQuery query){
    return Result.buildSuccess(query);
}

是不是很簡潔，下面看下輸出結果
在這里插入圖片描述

三、jsr303相關校驗注解導圖展示

在這里插入圖片描述
注意:@Validated和@Valid注解都是開啟注解校驗功能的注解

下面舉個例子說明一下

闡述基本用法可能不是那么適合，到實際應用改下就行
在這里插入圖片描述
輸出結果

四、@Valid和@Validated的區別

上述例子咱們用的是@Valid進行校驗的，用@Validated注解也可以，那么他兩的區別是什么呢？

所屬不同：
該注解所屬包為:javax.validation.Valid，而 @Validated是Spring基于@Valid進一步封裝，并提供了一些高級功能，如分組，分組順序等

使用位置不同：
@Validated：可以用在型別、方法和方法引數上，但是不能用在成員屬性上
@Valid:可以用在方法、建構式、方法引數和成員屬性上

正是由于@Valid能用于成員屬性(欄位)上，因此@Valid可以提供級聯校驗，關于級聯校驗下面就要闡述

五、@Valid和@Validated高級使用

5.1Valid級聯校驗

級聯校驗也叫嵌套檢測，嵌套即一個物體類包含另一個物體類

舉個例子
下面有個People物體類
在這里插入圖片描述
該類還有兩個屬性，一個是名字，一個頭發，因為一個人有很多頭發(暫不考慮光頭哈哈)，Hair物體類如下

下面寫一個方法檢測下用戶資料

在方法引數上用@Validated或者@Valid都可以

@PostMapping("/add")
public Result getPeople(@Validated @RequestBody People people){
    return Result.buildSuccess(people);
}

測驗結果如下
在這里插入圖片描述
暴露一個問題

沒有輸出Hair物體類對資料的校驗結果，可以證明@Validated和@Valid加在方法引數前，都不會對嵌套的物體類Hair進行檢測

實作檢測

為了能夠完成對嵌套物體類的檢測，我們需要在屬性上使用@Vaild注解
在這里插入圖片描述

看下此時的輸出結果
在這里插入圖片描述

5.2@Validated分組校驗

5.2.1什么是分組校驗

分組校驗是由@Validated的value方法提供的，用于開啟指定的組校驗，分別作用不同的業務場景中，下面舉個例子說明下

5.2.2.引出jsr303校驗注解的groups方法

假如使用Mybatis做持久化框架(其他也可以)，我們知道當向資料庫插入一條資料時，這條資料id是自動生成，不用用戶傳入的，而當我們修改一條資料時，id需要用戶傳入，因此在修改操作時需要對id進行校驗，像以上修改和插入對id不同的操作，這個時候就要使用groups方法對id進行分組，如下圖所示

在這里插入圖片描述
為了涵蓋多種情況，加入了兩個屬性，personName屬性在AddGroup.class,UpdateGroup.class時都會校驗，personAge屬性在不指定分組時校驗

5.2.3.@Validated注解value方法開啟指定分組校驗

在這里插入圖片描述

5.2.4.檢驗結果

下面使用一樣的資料請求三個方法，得到的結果如下

模擬資料，該資料都不符合要求
{
    "personId":"",
    "personName":"",
    "personAge":0
}

getPerson方法不指定分組
校驗了@Range(min=1,max=400,message="年齡提交有誤")，該注解不含groups方法
{
    "success": false,
    "code": 10003,
    "msg": "年齡提交有誤",
    "data": {
        "personAge": "年齡提交有誤"
    }
}


addPerson方法指定AddGroup分組
校驗了@NotBlank(message = "名字不能為空",groups = {AddGroup.class,UpdateGroup.class})
{
    "success": false,
    "code": 10003,
    "msg": "名字不能為空",
    "data": {
        "personName": "名字不能為空"
    }
}

updatePerson方法指定UpdateGroup分組
校驗了@NotBlank(message = "id不能為空",groups = UpdateGroup.class)和
@NotBlank(message = "名字不能為空",groups = {AddGroup.class,UpdateGroup.class})
{
    "success": false,
    "code": 10003,
    "msg": "名字不能為空",
    "data": {
        "personName": "名字不能為空",
        "personId": "id不能為空"
    }
}

5.2.5.結論

如果校驗注解添加上groups方法并指定分組，只有@Validated注解value方法指定該分組，才會開啟校驗注解的校驗資料功能，

同樣的如果校驗注解沒有groups指定分組，則@Validated注解value方法為默認分組時才會開啟

5.3@Validated分組校驗順序

5.3.1為什么需要？

默認情況下，分組間的約束驗證是無序的，然而某些情況下分組間的校驗順序卻很重要，比如第二組約束驗證依賴于第一組穩定狀態來進行，這個時候需要分組按照順序校驗，

5.3.2如何實作?

分組校驗順序由@GroupSequence注解實作

舉個例子

1.列出分組順序

public interface First {}

public interface Second {}

//此時first、second順序校驗
@GroupSequence({First.class,Second.class})
public interface Group {}

2.物體類及請求方法

@Data
public class UserGroupSequence {

    @NotEmpty(message = "id不能為空",groups = First.class)
    private String userId;

    @NotEmpty(message = "姓名不能空",groups = First.class)
    @Size(min = 3,max = 8,message = "姓名長度在3到8之間",groups = Second.class)
    private String userName;
}


@RestController
@RequestMapping("/group")
public class UserGroupSequenceController {

    //此時用的是value方法指定的是Group介面
    @PostMapping("/add")
    public Result addGroup(@Validated(value = Group.class) @RequestBody UserGroupSequence sequence){
        return Result.buildSuccess(sequence);
    }
}

3.測驗結果

模擬資料
{
    "userId":"",
    "userName":""
}

結果
{
    "success": false,
    "code": 10003,
    "msg": "姓名不能空",
    "data": {
        "userName": "姓名不能空",
        "userId": "id不能為空"
    }
}

4.結論

@GroupSequence注解指定分組順序時，如果First標識的校驗注解沒有通過，則Second標識的注解不會生效，

讀者可以測驗下，如果把userName上兩個校驗注解groups去掉，輸出結果是"姓名不能空"及"姓名長度在3到8之間"交替出現

5.4@Validated非物體類校驗

上面校驗都是對物體類的校驗，下面來介紹下對非物體類的校驗

5.4.1.使用@Validated注解

這里特別要注意一點就是@Validated注解對于非物體類的校驗，在類上注解才會起效果

@Validated
public class AnnotationController {
    
    @GetMapping("/getage")
    public Result getAge(@Range(min = 3,max = 8,message = "年齡在3-8歲") @RequestParam String age){
        return Result.buildSuccess(age);
    }
}

5.4.2.GlobalExceptionHandler類添加例外處理方法

    @ExceptionHandler(ConstraintViolationException.class)
    @ResponseBody
    public Result resolveConstraintViolationException(ConstraintViolationException ex){

        Set<ConstraintViolation<?>> constraintViolations = ex.getConstraintViolations();
        
        //對例外資訊進行處理
        if(!CollectionUtils.isEmpty(constraintViolations)){
            StringBuilder msgBuilder = new StringBuilder();
            for(ConstraintViolation constraintViolation :constraintViolations){
                msgBuilder.append(constraintViolation.getMessage()).append(",");
            }
            String errorMessage = msgBuilder.toString();
            if(errorMessage.length()>1){
                errorMessage = errorMessage.substring(0,errorMessage.length()-1);
            }
            return Result.buildFailure(ErrorStatus.ILLEGAL_DATA.getCode(),errorMessage);
        }
        return Result.buildFailure(ErrorStatus.ILLEGAL_DATA.getCode(),ex.getMessage());
    }

5.4.3測驗結果

http://localhost:8082/annotation/getage?age=1

{
    "success": false,
    "code": 10003,
    "msg": "年齡在3-8歲",
    "data": null
}

六、自定義注解校驗

提供一個場景，假如一個欄位只能讓用戶傳入特定的值，比如判斷是否顯示的屬性isShow，只能取0和1，下面我們實作這一個功能

6.1自定義注解@ListValue

@Documented
//該注解由哪個類校驗
@Constraint(validatedBy = {ListValue.ListValueConstraintValidator.class})
@Target({ ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE })
@Retention(RUNTIME)
public @interface ListValue {

    String message() default "{com.thinkcoder.annotation.ListValue.message}";

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

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

    int[] value();

    class ListValueConstraintValidator implements ConstraintValidator<ListValue,Integer> {
        private Set<Integer> set=new HashSet<>();

        //獲取value屬性指定的數字,存入set集合
        @Override
        public void initialize(ListValue constraintAnnotation) {
            int[] value = constraintAnnotation.value();
            for (int i : value) {
                set.add(i);
            }
        }

        //校驗用戶輸入資料是否在set集合中
        //isValid第一個引數傳入要校驗屬性的型別
        @Override
        public boolean isValid(Integer value, ConstraintValidatorContext context) {
            return  set.contains(value);
        }
    }
}

上面的代碼需要說明以下幾點

校驗類要實作ConstraintValidator<ListValue,Integer>介面;第一個泛型引數是自定義注解，第二個泛型引數是要校驗的屬性型別
initalize方法:獲取到用戶使用自定義注解中的資料
isValid方法:實作校驗邏輯，結果是回傳boolean型別
@Constraint注解:將自定義注解和校驗類聯系起來

6.2使用自定義注解

@Data
public class AnnotationQuery {

    @ListValue(value = {0,1},message = "數值只能是0或者1")
    private Integer isShow;
}

6.3請求方法

@PostMapping("/add")
public Result addAnnotation(@Validated @RequestBody AnnotationQuery query){
    return Result.buildSuccess(query);
}

6.4測驗結果

模擬資料
{
    "isShow":-1
}

測驗結果
{
    "success": false,
    "code": 10003,
    "msg": "數值只能是0或者1",
    "data": {
        "isShow": "數值只能是0或者1"
    }
}

七、補充@PathVariable注解校驗

7.1@PathVariable作用

用來對指定請求的URL路徑里面的變數，比如@GetMapping("/get/{id}")，其中{id}就是這個請求的變數，可以通過@PathVariable來獲取，

和@RequestParam的區別是，@RequestParam用來獲得靜態的URL請求入參，

7.2使用正則運算式校驗路徑變數

下面正則運算式表示id值只能是數字，如果不是數字報出404路徑找不到的例外

@GetMapping("/get/{id:\\d+}")
public Result getId(@PathVariable(name="id") String userId){
    return Result.buildSuccess(userId);
}

7.3自定義類實作ErrorController介面

說下為什么要這么做？

@ControllerAdive注解只能處理進入控制器方法拋出的例外，ErrorController介面可以處理全域例外，而404路徑找不到例外不是控制器方法拋出的，此時還沒有進入控制器方法，ErrorController處理404例外時會跳轉到/error路徑，此時會回傳錯誤的html頁，為了讓回傳結果統一，重寫下ErrorController介面的getErrorPath方法

@RestController
public class MyErrorController extends BasicErrorController {

    @Autowired
    public MyErrorController(ErrorAttributes errorAttributes,
                             ServerProperties serverProperties,
                             List<ErrorViewResolver> errorViewResolvers) {
        super(errorAttributes, serverProperties.getError(), errorViewResolvers);
    }

    //處理html請求
    @Override
    public ModelAndView errorHtml(HttpServletRequest request,
                                  HttpServletResponse response) {
        HttpStatus status = getStatus(request);
        Map<String, Object> model = getErrorAttributes(
                request, isIncludeStackTrace(request, MediaType.TEXT_HTML));
        ModelAndView modelAndView = new ModelAndView("myErrorPage", model, status);
        return modelAndView;
    }

    //處理json請求
    @Override
    public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
        Map<String, Object> body = getErrorAttributes(request,
                isIncludeStackTrace(request, MediaType.ALL));

        Map<String,Object> resultBody=new HashMap<>(16);
        resultBody.put("success",false);
        resultBody.put("code",body.get("status"));
        resultBody.put("msg",body.get("error"));

        return new ResponseEntity<>(resultBody, HttpStatus.OK);
    }
}

7.4測驗結果

實體:
http://localhost:8082/get/aa

結果:
{
    "success": false,
    "code": 404,
    "msg": "請求介面不存在請檢查路徑",
}

八、導圖總結

通過以上敘述基本包含了常用開發用到的校驗注解，下面用導圖總結下
在這里插入圖片描述
參考博客

https://www.jb51.net/article/115431.htm

@Validated和@Valid區別

兩個注解的區別

https://blog.csdn.net/gaojp008/article/details/80583301

創作不易，覺得有幫助，點個贊吧，您的支持是我最大的動力
在這里插入圖片描述

商俊帥

CSDN認證博客專家 Java csdn博客專家

代碼路上的小學生，主要涉及有Java、Spring、分布式、微服務等，熱愛技術，樂于分享，一起成長，遇見未知的自己

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/265105.html

標籤：java

上一篇：yolov5深度剖析+原始碼debug級講解系列（二）backbone構建

下一篇：使用ArrayList實作斗地主案例（無序版）

java例外處理（四）—還在用if判斷校驗引數？試試SpringBoot全域例外+JSR303校驗吧！