使⽤@RequestBody配合@Valid校验⼊参参数⽬录
@RequestBody配合@Valid校验⼊参参数
⾃定义⼀个Controller
⾃定义实体类
⾃定义全局异常处理器
附录
@Valid校验@RequestBody的参数
希望通过注解校验post请求的body
在request实体类添加注解进⾏校验
可以返回注解配置的错误信息
@RequestBody配合@Valid校验⼊参参数
⾃定义⼀个Controller
ample.demo.pojo.Ur;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
import javax.validation.Valid;
/**
* @Author: luoye
* @Date: 2018-10-12
*/
@RestController
public class ValiController {
@PostMapping(value = "/",produces = "application/json;chart=UTF-8")
public Ur vali(@RequestBody @Valid Ur ur){
return ur;
}
}
⾃定义实体类
import straints.Max;
import straints.NotBlank;
import straints.NotNull;
/**
* @Author: luoye
* @Date: 2018-10-12
*/
public class Ur {
@NotBlank(message = "这个姓名不能为空")
private String name;
@NotNull(message = "这个年龄不能为空")
@Max(value = 105,message = "太⼤了")
private Integer age;
public String getName() {
return name;
}
public void tName(String name) {
this.name = name;
}
public Integer getAge() {
return age;
}
public void tAge(Integer age) {
this.age = age;
}
}
⾃定义全局异常处理器
ample.demo.pojo.ErrorMsg;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.validation.ObjectError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ResponBody;
import java.util.ArrayList;
import java.util.List;
/
**
* @Author luoye
* @Date: 2018/10/12 16:50
*/
@ControllerAdvice
public class ExceptionHandlerContrller {
@ExceptionHandler(MethodArgumentNotValidException.class)
@ResponBody
public List<ErrorMsg> exception(MethodArgumentNotValidException e) {
BindingResult bindingResult = e.getBindingResult();
List<ObjectError> allErrors = AllErrors();
List<ErrorMsg> errorMsgs = new ArrayList<>();
allErrors.forEach(objectError -> {
ErrorMsg errorMsg = new ErrorMsg();
FieldError fieldError = (FieldError)objectError;
errorMsg.Field());
errorMsg.ObjectName());
errorMsg.DefaultMessage());
errorMsgs.add(errorMsg);
});
return errorMsgs;
}
}
PostMan测试下
[
{
"field": "name",
"message": "这个姓名不能为空",
"objectName": "ur"
},
{
"field": "age",
"message": "这个年龄不能为空",
"objectName": "ur"
}
]
附录
@Valid 注解类型的使⽤：
@Null：限制只能为null
@NotNull：限制必须不为null
@AsrtFal：限制必须为fal
@AsrtTrue：限制必须为true
@DecimalMax(value)：限制必须为⼀个不⼤于指定值的数字
@DecimalMin(value)：限制必须为⼀个不⼩于指定值的数字
@Digits(integer,fraction)：限制必须为⼀个⼩数，且整数部分的位数不能超过integer，⼩数部分的位数不能超过fraction
@Future：限制必须是⼀个将来的⽇期
@Max(value)：限制必须为⼀个不⼤于指定值的数字
@Min(value)：限制必须为⼀个不⼩于指定值的数字
@Past：限制必须是⼀个过去的⽇期
@Pattern(value)：限制必须符合指定的正则表达式
@Size(max,min)：限制字符长度必须在min到max之间
@Past：验证注解的元素值（⽇期类型）⽐当前时间早
@NotEmpty：验证注解的元素值不为null且不为空（字符串长度不为0、集合⼤⼩不为0）
@NotBlank：验证注解的元素值不为空（不为null、去除⾸位空格后长度为0），不同于@NotEmpty，@NotBlank只应⽤于字符串且在⽐较时会去除字符串的空格
@Email：验证注解的元素值是Email，也可以通过正则表达式和flag指定⾃定义的email格式
@Valid校验@RequestBody的参数
希望通过注解校验post请求的body
需要⽤到@Valid注解
public String getRespon(@RequestBody @Valid MyRequest request) throws Exception {
xxx
}
在request实体类添加注解进⾏校验
例如⽤@NotNull进⾏判空校验
@Data
public class MyRequest {
@NotNull(message = "id 不能为空")
private Integer id;
@NotNull(message = "name 不能为空")
private String name;
}
结合统⼀异常处理，处理MethodArgumentNotValidException
可以返回注解配置的错误信息
@ControllerAdvice
@Slf4j
public class ExceptionResolver {
@ExceptionHandler(value = {Exception.class})
@ResponBody
public String handleOtherExceptions(final Exception ex) {
if (ex instanceof MethodArgumentNotValidException) {
// ⼊参校验错误
StringBuilder msg = new StringBuilder();
MethodArgumentNotValidException mex = (MethodArgumentNotValidException) ex; BindingResult bindingResult = BindingResult();
List<ObjectError> allErrors = AllErrors();
allErrors.forEach(objectError -> {
FieldError fieldError = (FieldError) objectError;
String oneMsg = DefaultMessage();
msg.append(oneMsg);
msg.append(";");
});
String();
}
}
}
以上为个⼈经验，希望能给⼤家⼀个参考，也希望⼤家多多⽀持。
