詳解Java后端優(yōu)雅驗證參數合法性
更新時間：2021年02月18日 15:39:12 作者：奮斗的小方
這篇文章主要介紹了詳解Java后端優(yōu)雅驗證參數合法性，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧
1、首先創(chuàng)建一個測試實體類Person，并攜帶如上注解，其注解的作用描述在message
package com.clickpaas.pojo;
import com.fasterxml.jackson.annotation.JsonFormat;
import lombok.Data;
import org.hibernate.validator.constraints.Length;
import org.hibernate.validator.constraints.Range;
import javax.validation.constraints.*;
import java.math.BigDecimal;
import java.util.Date;
import java.util.List;
/**
* @author 方延杰
* @version 1.0
* @since 2020/12/10 9:04 下午
*/
@Data
public class Person {
@Null(message = "death必須為null")
private String death;
@AssertTrue(message = "bool必須為true")
private boolean bool;
@AssertFalse(message = "fal必須為false")
private boolean fal;
@Min(value = 1, message = "min必須為數字,其值大于或等于指定的最小值")
private Integer min;
@Max(value = 10, message = "max必須為數字,其值小于或等于指定的最大值")
private Integer max;
@DecimalMin(value = "1", message = "minDeci最小不能小于1")
private BigDecimal minDeci;
@DecimalMax(value = "10", message = "maxDeci最大不能大于10")
private BigDecimal maxDeci;
@Size(min = 1, max = 2, message = "list集合的長度最小不能小于1,最大不能大于2")
private List<Object> list;
@Digits(integer = 4, fraction = 2, message = "digits整數位不能超過4個,小數位不能超過2個")
private BigDecimal digits;
/**
* 將前臺傳來的日期數據映射到此字段
*/
@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
@Past(message = "past必須為過去的日期")
private Date past;
@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
@Future(message = "future必須為將來的日期")
private Date future;
@Pattern(regexp = "^1[3|4|5|7|8][0-9]{9}$", message = "phone必須符合正則表達式")
private String phone;
@Email(message = "email必須是郵箱格式")
private String email;
@Length(min = 1, max = 2, message = "length長度最小不能小于1,最大不能大于2")
private String length;
@NotEmpty(message = "id不能為null，長度大于0")
private String id;
@Range(min = 1, max = 12, message = "month最小不能小于1,最大不能大于12")
private Integer month;
@NotBlank(message = "name不能為null,字段串長度大于0（限字符串）")
private String name;
}
2、封裝返回響應體
package com.clickpaas.response;
import lombok.AllArgsConstructor;
import lombok.Data;
/**
* @author 方延杰
* @version 1.0
* @since 2019/7/3 4:32 下午
*/
@Data
@AllArgsConstructor
public class CodeMsg {
private int code;
private String msg;
/**
* 失敗
*/
public static CodeMsg SERVER_ERROR = new CodeMsg(500, "服務端異常");
}
package com.clickpaas.response;
import lombok.AllArgsConstructor;
import lombok.Data;
/**
* @author 方延杰
* @version 1.0
* @since 2019/7/3 4:35 下午
*/
@Data
@AllArgsConstructor
public class Result<T> {
/**
* 返回狀態(tài)碼 除200其余全部失敗
*/
private int code;
/**
* 返回信息 除success其余全部失敗
*/
private String msg;
/**
* 泛型數據
*/
private T data;
/**
* 成功時返回的類型
*
* @param data 數據
* @param <T> 泛型
* @return 泛型數據
*/
public static <T> Result<T> success(T data) {
return new Result<>(200, "success", data);
}
public static <T> Result<T> fail(CodeMsg codeMsg) {
return new Result<>(codeMsg);
}
private Result(CodeMsg codeMsg) {
if (codeMsg == null) {
return;
}
this.code = codeMsg.getCode();
this.msg = codeMsg.getMsg();
}
}
3、創(chuàng)建使用增強器攔截并返回異常信息
package com.clickpaas.config;
import com.clickpaas.response.CodeMsg;
import com.clickpaas.response.Result;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import javax.servlet.http.HttpServletRequest;
import java.util.Objects;
/**
* @author 方延杰
* @version 1.0
* @since 2018/12/10 4:59 下午
*/
@RestControllerAdvice
public class GlobalExceptionInterceptor {
@ExceptionHandler(value = MethodArgumentNotValidException.class)
public Result<Object> exceptionHandler(HttpServletRequest request, Exception e) {
String errMsg = "處理失敗";
if (e instanceof MethodArgumentNotValidException) {
// 拿到參數校驗具體異常信息
errMsg = Objects.requireNonNull(((MethodArgumentNotValidException) e).getBindingResult().getFieldError()).getDefaultMessage();
}
return Result.fail(new CodeMsg(500, errMsg));
}
}
4、創(chuàng)建控制層測試
package com.clickpaas.controller;
import com.clickpaas.pojo.Person;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
/**
* @author 方延杰
* @version 1.0
* @since 2020/12/10 9:03 下午
*/
@RestController
public class ValidController {
@PostMapping("/valid")
public String valid(@Validated @RequestBody Person person) {
return "success";
}
}
5、測試符合驗證請求體訪問，請求體如下：
{
"death":null,
"bool":true,
"fal":false,
"min":1,
"max":10,
"minDeci":1,
"maxDeci":10,
"list":[
{},{}
],
"digits":1144.12,
"past":"2020-10-01 10:00:00",
"future":"2022-10-01 10:00:00",
"phone":"15900445584",
"email":"yanjie.fang@clickpaas.com",
"length":"ab",
"id":" ",
"name":"a"
}
6、故意修改不符合驗證的數據
7、如果想做整體驗證，如下：
package com.clickpaas.uitl;
import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;
/**
* Bean整體校驗工具類
*
* @author 方延杰
* @version 1.0
* @since 2020/12/10 10:08 下午
*/
public class ValidatorUtils {
private static final Validator VALIDATOR = Validation.buildDefaultValidatorFactory().getValidator();
/**
* Bean整體校驗，有不合規(guī)范，拼接message
*/
public static String validate(Object obj, Class<?>... groups) {
StringBuilder errorMessage = new StringBuilder();
Set<ConstraintViolation<Object>> resultSet = VALIDATOR.validate(obj, groups);
if (resultSet.size() > 0) {
//如果存在錯誤結果，則將其解析并進行拼湊后異常拋出
List<String> errorMessageList = resultSet.stream().map(ConstraintViolation::getMessage).collect(Collectors.toList());
errorMessageList.forEach(o -> errorMessage.append(o).append(";"));
}
return errorMessage.toString();
}
}
8、整體測試類
到此這篇關于詳解Java后端優(yōu)雅驗證參數合法性的文章就介紹到這了,更多相關Java 驗證參數合法性內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
詳解spring cloud中使用Ribbon實現客戶端的軟負載均衡
這篇文章主要介紹了詳解spring cloud中使用Ribbon實現客戶端的軟負載均衡，小編覺得挺不錯的，現在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-01-01
這篇文章主要介紹了Java線程優(yōu)先級和守護線程原理解析,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-03-03
這篇文章介紹了java 連接Redis的小例子，有需要的朋友可以參考一下2013-09-09
前端要預覽服務器PDF 可直接將要blob流返回給前端,即可用瀏覽器自帶pdf預覽功能打開,本文就來介紹一下如何實現,感興趣的可以了解一下2023-09-09
這篇文章主要介紹了如何使用bootstrap.yml讀取配置中心的配置文件問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-07-07
在Java中，final關鍵字可以用來修飾類、方法和變量（包括成員變量和局部變量)，下面通過本篇文章給大家介紹java中的final關鍵字，對java fina關鍵字相關知識感興趣的朋友一起看看吧2015-12-12
這篇文章主要介紹了Java游戲服務器之數據庫表存取封裝的相關資料,需要的朋友可以參考下2015-11-11
SpringSecurity?用戶帳號已被鎖定的問題及解決方法
這篇文章主要介紹了SpringSecurity?用戶帳號已被鎖定,本文給大家分享問題原因及解決方式，需要的朋友可以參考下2023-12-12
配置hadoop環(huán)境mapreduce連接不上hdfs解決
這篇文章主要為大家介紹了配置hadoop環(huán)境mapreduce連接不上hdfs解決方法,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2023-10-10
這篇文章主要給大家介紹了關于Java中如何實現不可變Map的相關資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作工具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2018-12-12