SpringBoot使用validation-api實現對枚舉類參數校驗

發布時間：2020-11-03 14:49:44 來源：億速云閱讀：388 作者：Leah 欄目：開發技術

SpringBoot使用validation-api實現對枚舉類參數校驗？針對這個問題，這篇文章詳細介紹了相對應的分析和解答，希望可以幫助更多想解決這個問題的小伙伴找到更簡單易行的方法。

ValidationApi框架就是用來解決參數校驗中代碼冗余問題，ValidationApi框架提供一些注解用來幫助我們對請求參數進行校驗。

Maven依賴

<!--參數校驗-->
<dependency>
 <groupId>javax.validation</groupId>
 <artifactId>validation-api</artifactId>
 <version>2.0.1.Final</version>
</dependency>


<!--提供一些字符串操作-->
<dependency>
 <groupId>org.apache.commons</groupId>
 <artifactId>commons-lang3</artifactId>
 <version>3.3.2</version>
</dependency>


<!--lombok-->
<dependency>
 <groupId>org.projectlombok</groupId>
 <artifactId>lombok</artifactId>
 <version>1.18.2</version>
 <optional>true</optional>
</dependency>


<!--knife4j接口-->
<dependency>
 <groupId>com.github.xiaoymin</groupId>
 <artifactId>knife4j-spring-boot-starter</artifactId>
 <version>2.0.4</version>
</dependency>

EnumValidate：用于對枚舉校驗的接口

/**
* 用于實現枚舉類的校驗
*/
public interface EnumValidate<T> {

 /**
  * 校驗枚舉值是否存在
  */
 boolean existValidate(T value);
}

ActionTypeEnumValid：用于對枚舉類校驗的自定義注解

@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = {ActionTypeEnumValidator.class})
@Documented
public @interface ActionTypeEnumValid {

 String message() default "";


 Class<&#63;>[] groups() default {};


 Class<&#63; extends Payload>[] payload() default {};


 Class<&#63;>[] target() default {};

 /**
  * 允許的枚舉
  *
  * @return
  */
 Class<&#63; extends Enum<&#63;>> enumClass();
}

ActionTypeEnumValidator：枚舉校驗器

/**
* 用于校驗ActionTypeEnumValidator
*/
public class ActionTypeEnumValidator implements ConstraintValidator<ActionTypeEnumValid,String> {


 private Class<&#63; extends Enum> enumClass;


 @Override
 public void initialize(ActionTypeEnumValid actionTypeEnumValid) {
  enumClass = actionTypeEnumValid.enumClass();
 }


 @Override
 public boolean isValid(String value, ConstraintValidatorContext context) {
  if (value == null || "".equals(value)) {
   return true;
  }


  EnumValidate[] enums = (EnumValidate[]) enumClass.getEnumConstants();
  if(enums ==null || enums.length == 0){
   return false;
  }


  return enums[0].existValidate(value);
 }

}

ActionTypeEnum：枚舉類

@Getter
public enum ActionTypeEnum implements EnumValidate<String> {


 ACTION_INVOKR("invoke", "invoke"),
 UNKNOWN_ERROR("no", "no");

 /**
  * 狀態值
  */
 private String couponType;

 /**
  * 狀態描述
  */
 private String couponTypeDesc;

 ActionTypeEnum(String couponType, String couponTypeDesc) {
  this.couponType = couponType;
  this.couponTypeDesc = couponTypeDesc;
 }


 public static String getDescByType(String couponType) {
  for (ActionTypeEnum type : ActionTypeEnum.values()) {
   if (type.couponType.equals(couponType) ) {
    return type.couponTypeDesc;
   }
  }
  return null;
 }

 /**
  * 判斷是否在枚舉類當中
  * @param value
  * @return
  */
 @Override
 public boolean existValidate(String value) {
  if (value == null || "".equals(value)) {
   return false;
  }
  for (ActionTypeEnum testEnum : ActionTypeEnum.values()) {
   if (testEnum.getCouponType().equalsIgnoreCase(value)) {
    return true;
   }
  }
  return false;
 }

 public String getcouponTypeStr() {
  return String.valueOf(this.couponType);
 }
}

GlobalExceptionHandler：使用SpringMVC提供的異常處理機制，對ValidationApi的異常進行封裝

@RestControllerAdvice
@Slf4j
public class GlobalExceptionHandler {

 /**
  * 忽略參數異常處理器
  *
  * @param e 忽略參數異常
  * @return Response
  */
 @ResponseStatus(HttpStatus.BAD_REQUEST)
 @ExceptionHandler(MissingServletRequestParameterException.class)
 public ResponseResult parameterMissingExceptionHandler(MissingServletRequestParameterException e) {
  log.error("參數異常", e);
  return new ResponseResult(CouponTypeEnum.PARAMETER_ERROR.getcouponTypeStr(), "請求參數 " + e.getParameterName() + " 不能為空");
 }


 /**
  * 缺少請求體異常處理器
  *
  * @param e 缺少請求體異常
  * @return Response
  */
 @ResponseStatus(HttpStatus.BAD_REQUEST)
 @ExceptionHandler(HttpMessageNotReadableException.class)
 public ResponseResult parameterBodyMissingExceptionHandler(HttpMessageNotReadableException e) {
  log.error("缺少請求體異常", e);
  return new ResponseResult(CouponTypeEnum.PARAMETER_ERROR.getcouponTypeStr(), "參數體不能為空");
 }


 /**
  * 參數效驗異常處理器
  *
  * @param e 參數驗證異常
  * @return ResponseInfo
  */
 @ResponseStatus(HttpStatus.BAD_REQUEST)
 @ExceptionHandler(MethodArgumentNotValidException.class)
 public ResponseResult parameterExceptionHandler(MethodArgumentNotValidException e) {
  log.error("參數驗證異常", e);
  // 獲取異常信息
  BindingResult exceptions = e.getBindingResult();
  // 判斷異常中是否有錯誤信息，如果存在就使用異常中的消息，否則使用默認消息
  if (exceptions.hasErrors()) {
   List<ObjectError> errors = exceptions.getAllErrors();
   if (!errors.isEmpty()) {
    // 這里列出了全部錯誤參數，按正常邏輯，只需要第一條錯誤即可
    FieldError fieldError = (FieldError) errors.get(0);
    return new ResponseResult(CouponTypeEnum.PARAMETER_ERROR.getcouponTypeStr(), fieldError.getDefaultMessage());
   }
  }
  return new ResponseResult(CouponTypeEnum.PARAMETER_ERROR);
 }


 /**
  * 自定義參數錯誤異常處理器
  *
  * @param e 自定義參數
  * @return ResponseInfo
  */
 @ResponseStatus(HttpStatus.BAD_REQUEST)
 @ExceptionHandler({BusinessException.class})
 public ResponseResult paramExceptionHandler(BusinessException e) {
  log.error("業務異常", e);
  // 判斷異常中是否有錯誤信息，如果存在就使用異常中的消息，否則使用默認消息
  if (!StringUtils.isEmpty(e.getMessage())) {
   return new ResponseResult(CouponTypeEnum.PARAMETER_ERROR.getcouponTypeStr(), e.getMessage());
  }
  return new ResponseResult(CouponTypeEnum.PARAMETER_ERROR);
 }


 /**
  * 其他異常
  *
  * @param e
  * @return
  */
 @ResponseStatus(HttpStatus.BAD_REQUEST)
 @ExceptionHandler({Exception.class})
 public ResponseResult otherExceptionHandler(Exception e) {
  log.error("其他異常", e);
  // 判斷異常中是否有錯誤信息，如果存在就使用異常中的消息，否則使用默認消息
  if (!StringUtils.isEmpty(e.getMessage())) {
   return new ResponseResult(CouponTypeEnum.UNKNOWN_ERROR.getcouponTypeStr(), e.getMessage());
  }
  return new ResponseResult(CouponTypeEnum.UNKNOWN_ERROR);
 }
}

驗證

請求的封裝類

/**
* 指令的封裝類
*/
@Getter
@Setter
@ToString
public class CommandPOJO implements Serializable {
 private static final long serialVersionUID = -8497328408069586664L;

 //指令
 @NotNull(message = "指令為必填項，不得為空")
 @ActionTypeEnumValid(message = "該指令暫不支持,暫時只支持invoke", enumClass = ActionTypeEnum.class)
 private String action ="invoke";

}

請求接口

@Valid 用于開啟請求參數校驗

@RestController
@Slf4j
@Api(value = "遠程調用模塊")
@RequestMapping("/xiyuanrpc")
public class RPCController {

 @PostMapping("/rpcNettybyInvoke")
 @ApiOperation(value = "rpc遠程調用")
 @InvokeParameterCheck
 @MethodLogPrint
 public ResponseResult rpcNettybyInvoke(@Valid @RequestBody CommandPOJO pojo) {
  return NettyClientUtil.rpcNetty(pojo);
 }

}

通過Knife4j訪問對應接口

SpringBoot使用validation-api實現對枚舉類參數校驗

關于SpringBoot使用validation-api實現對枚舉類參數校驗問題的解答就分享到這里了，希望以上內容可以對大家有一定的幫助，如果你還有很多疑惑沒有解開，可以關注億速云行業資訊頻道了解更多相關知識。

向AI問一下細節

91超碰碰碰碰久久久久久综合_超碰av人澡人澡人澡人澡人掠_国产黄大片在线观看画质优化_txt小说免费全本

SpringBoot使用validation-api實現對枚舉類參數校驗

猜你喜歡

91超碰碰碰碰久久久久久综合_超碰av人澡人澡人澡人澡人掠_国产黄大片在线观看画质优化_txt小说免费全本

SpringBoot使用validation-api實現對枚舉類參數校驗

猜你喜歡

最新資訊

相關推薦

相關標簽