springboot整合JSR303校驗(yàn)功能實(shí)現(xiàn)代碼

更新時(shí)間：2023年01月15日 11:00:43 作者：林尋星辰

這篇文章主要介紹了springboot整合JSR303校驗(yàn)功能實(shí)現(xiàn),JSR303校驗(yàn)方法有統(tǒng)一校驗(yàn)的需求，統(tǒng)一校驗(yàn)實(shí)現(xiàn)以及分組校驗(yàn)，本文結(jié)合實(shí)例代碼給大家介紹的非常詳細(xì)，需要的朋友可以參考下

JSR303簡介

JSR-303 是 JAVA EE 6 中的一項(xiàng)子規(guī)范，叫做 Bean Validation，官方參考實(shí)現(xiàn)是Hibernate Validator。Hibernate Validator 提供了 JSR 303 規(guī)范中所有內(nèi)置 constraint 的實(shí)現(xiàn)，除此之外還有一些附加的 constraint。

4.7 JSR303校驗(yàn)

4.7.1 統(tǒng)一校驗(yàn)的需求

前端請求后端接口傳輸參數(shù)，是在controller中校驗(yàn)還是在Service中校驗(yàn)？

答案是都需要校驗(yàn)，只是分工不同。

Contoller中校驗(yàn)請求參數(shù)的合法性，包括：必填項(xiàng)校驗(yàn)，數(shù)據(jù)格式校驗(yàn)，比如：是否是符合一定的日期格式，等。

Service中要校驗(yàn)的是業(yè)務(wù)規(guī)則相關(guān)的內(nèi)容，比如：課程已經(jīng)審核通過所以提交失敗。

Service中根據(jù)業(yè)務(wù)規(guī)則去校驗(yàn)不方便寫成通用代碼，Controller中則可以將校驗(yàn)的代碼寫成通用代碼。

早在JavaEE6規(guī)范中就定義了參數(shù)校驗(yàn)的規(guī)范，它就是JSR-303，它定義了Bean Validation，即對bean屬性進(jìn)行校驗(yàn)。

SpringBoot提供了JSR-303的支持，它就是spring-boot-starter-validation，它的底層使用Hibernate Validator，Hibernate Validator是Bean Validation 的參考實(shí)現(xiàn)。

所以，我們準(zhǔn)備在Controller層使用spring-boot-starter-validation完成對請求參數(shù)的基本合法性進(jìn)行校驗(yàn)。

4.7.2 統(tǒng)一校驗(yàn)實(shí)現(xiàn)

首先在Base工程添加spring-boot-starter-validation的依賴

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

現(xiàn)在準(zhǔn)備對內(nèi)容管理模塊添加課程接口進(jìn)行參數(shù)校驗(yàn)，如下接口

@ApiOperation("新增課程基礎(chǔ)信息")
@PostMapping("/course")
public CourseBaseInfoDto createCourseBase(@RequestBody AddCourseDto addCourseDto){
    //機(jī)構(gòu)id，由于認(rèn)證系統(tǒng)沒有上線暫時(shí)硬編碼
    Long companyId = 1L;
  return courseBaseInfoService.createCourseBase(companyId,addCourseDto);
}

此接口使用AddCourseDto模型對象接收參數(shù)，所以進(jìn)入AddCourseDto類，在屬性上添加校驗(yàn)規(guī)則。

package com.xuecheng.content.model.dto;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.Size;
import java.math.BigDecimal;

/**
 * @description 添加課程dto
 * @author Mr.M
 * @date 2022/9/7 17:40
 * @version 1.0
 */
@Data
@ApiModel(value="AddCourseDto", description="新增課程基本信息")
public class AddCourseDto {

 @NotEmpty(message = "課程名稱不能為空")
 @ApiModelProperty(value = "課程名稱", required = true)
 private String name;

 @NotEmpty(message = "適用人群不能為空")
 @Size(message = "適用人群內(nèi)容過少",min = 10)
 @ApiModelProperty(value = "適用人群", required = true)
 private String users;

 @ApiModelProperty(value = "課程標(biāo)簽")
 private String tags;

 @NotEmpty(message = "課程分類不能為空")
 @ApiModelProperty(value = "大分類", required = true)
 private String mt;

 @NotEmpty(message = "課程分類不能為空")
 @ApiModelProperty(value = "小分類", required = true)
 private String st;

 @NotEmpty(message = "課程等級不能為空")
 @ApiModelProperty(value = "課程等級", required = true)
 private String grade;

 @ApiModelProperty(value = "教學(xué)模式（普通，錄播，直播等）", required = true)
 private String teachmode;

 @ApiModelProperty(value = "課程介紹")
 private String description;

 @ApiModelProperty(value = "課程圖片", required = true)
 private String pic;

 @NotEmpty(message = "收費(fèi)規(guī)則不能為空")
 @ApiModelProperty(value = "收費(fèi)規(guī)則，對應(yīng)數(shù)據(jù)字典", required = true)
 private String charge;

 @ApiModelProperty(value = "價(jià)格")
 private BigDecimal price;

}

上邊用到了@NotEmpty和@Size兩個(gè)注解，@NotEmpty表示屬性不能為空，@Size表示限制屬性內(nèi)容的長短。

在javax.validation.constraints包下有很多這樣的校驗(yàn)注解

規(guī)則如下：

定義好校驗(yàn)規(guī)則還需要開啟校驗(yàn)，在controller方法中添加@Validated注解，如下：

@ApiOperation("新增課程基礎(chǔ)信息")
@PostMapping("/course")
public CourseBaseInfoDto createCourseBase(@RequestBody @Validated AddCourseDto addCourseDto){
    //機(jī)構(gòu)id，由于認(rèn)證系統(tǒng)沒有上線暫時(shí)硬編碼
    Long companyId = 1L;
  return courseBaseInfoService.createCourseBase(companyId,addCourseDto);
}

如果校驗(yàn)出錯(cuò)Spring會(huì)拋出MethodArgumentNotValidException異常，我們需要在統(tǒng)一異常處理器中捕獲異常，解析出異常信息。

代碼如下：

@ResponseBody
@ExceptionHandler(value = MethodArgumentNotValidException.class)
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
public RestErrorResponse doValidException(MethodArgumentNotValidException argumentNotValidException) {

   BindingResult bindingResult = argumentNotValidException.getBindingResult();
   StringBuffer errMsg = new StringBuffer();

   List<FieldError> fieldErrors = bindingResult.getFieldErrors();
   fieldErrors.forEach(error -> {
      errMsg.append(error.getDefaultMessage()).append(",");
   });
   log.error(errMsg.toString());
   return new RestErrorResponse(errMsg.toString());
}

重啟內(nèi)容管理服務(wù)。

使用httpclient進(jìn)行測試，將必填項(xiàng)設(shè)置為空，“適用人群” 屬性的內(nèi)容設(shè)置1個(gè)字。

執(zhí)行測試，接口響應(yīng)結(jié)果如下：

{
"errMessage": "課程名稱不能為空課程分類不能為空課程分類不能為空適用人群內(nèi)容過少 "
}

可以看到校驗(yàn)器生效。

4.7.3 分組校驗(yàn)

有時(shí)候在同一個(gè)屬性上設(shè)置一個(gè)校驗(yàn)規(guī)則不能滿足要求，比如：訂單編號由系統(tǒng)生成，在添加訂單時(shí)要求訂單編號為空，在更新訂單時(shí)要求訂單編寫不能為空。此時(shí)就用到了分組校驗(yàn)，同一個(gè)屬性定義多個(gè)校驗(yàn)規(guī)則屬于不同的分組，比如：添加訂單定義@NULL規(guī)則屬于insert分組，更新訂單定義@NotEmpty規(guī)則屬于update分組，insert和update是分組的名稱，是可以修改的。

下邊舉例說明

我們用class類型來表示不同的分組，所以我們定義不同的接口類型（空接口）表示不同的分組，由于校驗(yàn)分組是公用的，所以定義在 base工程中。如下：

package com.xuecheng.base.execption;
 /**
 * @description 校驗(yàn)分組
 * @author Mr.M
 * @date 2022/9/8 15:05
 * @version 1.0
 */
public class ValidationGroups {

 public interface Inster{};
 public interface Update{};
 public interface Delete{};

}

下邊在定義校驗(yàn)規(guī)則時(shí)指定分組：

@NotEmpty(groups = {ValidationGroups.Inster.class},message = "添加課程名稱不能為空")
 @NotEmpty(groups = {ValidationGroups.Update.class},message = "修改課程名稱不能為空")
// @NotEmpty(message = "課程名稱不能為空")
 @ApiModelProperty(value = "課程名稱", required = true)
 private String name;

在Controller方法中啟動(dòng)校驗(yàn)規(guī)則指定要使用的分組名：

@ApiOperation("新增課程基礎(chǔ)信息")
@PostMapping("/course")
public CourseBaseInfoDto createCourseBase(@RequestBody @Validated({ValidationGroups.Inster.class}) AddCourseDto addCourseDto){
    //機(jī)構(gòu)id，由于認(rèn)證系統(tǒng)沒有上線暫時(shí)硬編碼
    Long companyId = 1L;
  return courseBaseInfoService.createCourseBase(companyId,addCourseDto);
}

再次測試，由于這里指定了Insert分組，所以拋出異常信息：添加課程名稱不能為空。

如果修改分組為ValidationGroups.Update.class，異常信息為：修改課程名稱不能為空。