SpringBoot + validation 接口参数校验的思路详解

2023-07-13 11:59:03 268

有参数传递的地方都少不了参数校验。在web开发中，前端的参数校验是为了用户体验，后端的参数校验是为了安全。试想一下，如果在controller层中没有经过任何校验的参数通过service层、dao层一路来到了数据库就可能导致严重的后果，最好的结果是查不出数据，严重一点就是报错，如果这些没有被校验的参数中包含了恶意代码，那就可能导致更严重的后果。

实践

一、引入依赖



org.springframework.boot
spring-boot-starter-validation

二、使用校验

在controller层的参数校验可以分为两种场景：

单个参数校验
实体类参数校验

2.1单参数校验

/**
*参数校验测试控制类
*@authoroyc
*/
@RestController
@RequestMapping("user")
@Validated
publicclassRequestParamsValidatedController{

privateLoggerlogger=LoggerFactory.getLogger(this.getClass());

@GetMapping
publicUsertest(@NotNull(message="姓名不能为空")Stringname,
@NotNull(message="年龄不能为空")@Max(value=99,message="不能大于200岁")Integerage){
logger.info("name:"+name+"-age:"+age);
returnnewUser(name,age);
}
}

2.2 实体类参数校验

/**
*参数校验测试控制类
*@authoroyc
*/
@RestController
@RequestMapping("user")
@Validated
publicclassRequestParamsValidatedController{

privateLoggerlogger=LoggerFactory.getLogger(this.getClass());

@PostMapping
publicUsersave(@ValidatedUseruser){
logger.info(user.toString());
returnuser;
}
}

packagecom.oycbest.springbootvalidated.vo;


importjavax.validation.constraints.*;
importjava.io.Serializable;

/**
*用户实体类
*@authoroyc
*/
publicclassUserimplementsSerializable{
privateStringuserId;

@NotNull(message="用户名不能为空")
privateStringuserName;

@NotNull(message="年龄不能为空")
@Max(value=100,message="年龄不能大于100岁")
privateintage;

@NotNull(message="邮箱不能为空")
@Email(message="邮箱格式不正确")
privateStringemail;

@NotNull(message="电话号码不能为空")
privateStringphoneNumber;

publicUser(@NotNull(message="用户名不能为空")StringuserName,intage){
this.userName=userName;
this.age=age;
}

publicUser(){
}

publicUser(StringuserId,@NotNull(message="用户名不能为空")StringuserName,intage,Stringemail,StringphoneNumber){
this.userId=userId;
this.userName=userName;
this.age=age;
this.email=email;
this.phoneNumber=phoneNumber;
}

publicStringgetUserId(){
returnuserId;
}

publicvoidsetUserId(StringuserId){
this.userId=userId;
}

publicStringgetUserName(){
returnuserName;
}

publicvoidsetUserName(StringuserName){
this.userName=userName;
}

publicintgetAge(){
returnage;
}

publicvoidsetAge(intage){
this.age=age;
}

publicStringgetEmail(){
returnemail;
}

publicvoidsetEmail(Stringemail){
this.email=email;
}

publicStringgetPhoneNumber(){
returnphoneNumber;
}

publicvoidsetPhoneNumber(StringphoneNumber){
this.phoneNumber=phoneNumber;
}

@Override
publicStringtoString(){
return"User{"+
"userId='"+userId+'\''+
",userName='"+userName+'\''+
",age="+age+
",email='"+email+'\''+
",phoneNumber='"+phoneNumber+'\''+
'}';
}
}

2.3定义统一异常处理

packagecom.oycbest.springbootvalidated.exception;

importorg.slf4j.Logger;
importorg.slf4j.LoggerFactory;
importorg.springframework.context.annotation.Bean;
importorg.springframework.http.HttpStatus;
importorg.springframework.stereotype.Component;
importorg.springframework.validation.BindException;
importorg.springframework.validation.FieldError;
importorg.springframework.validation.beanvalidation.MethodValidationPostProcessor;
importorg.springframework.web.bind.annotation.ControllerAdvice;
importorg.springframework.web.bind.annotation.ExceptionHandler;
importorg.springframework.web.bind.annotation.ResponseBody;
importorg.springframework.web.bind.annotation.ResponseStatus;

importjavax.validation.ConstraintViolation;
importjavax.validation.ConstraintViolationException;
importjavax.validation.ValidationException;
importjava.util.List;
importjava.util.Set;

/**
*全局异常处理
*
*@authoroyc
*/
@ControllerAdvice
@Component
publicclassGlobalExceptionHandler{
privateLoggerlogger=LoggerFactory.getLogger(this.getClass());

@Bean
publicMethodValidationPostProcessormethodValidationPostProcessor(){
returnnewMethodValidationPostProcessor();
}

@ExceptionHandler
@ResponseBody
@ResponseStatus(HttpStatus.BAD_REQUEST)
publicStringhandle(ValidationExceptionexception){
logger.error("请求异常："+exception.getMessage());
if(exceptioninstanceofConstraintViolationException){
ConstraintViolationExceptionexs=(ConstraintViolationException)exception;

Set>violations=exs.getConstraintViolations();
for(ConstraintViolationitem:violations){
//打印验证不通过的信息
logger.error("请求异常："+item.getMessage());
}
}
return"请求异常："+exception.getMessage();
}

@ResponseBody
@ExceptionHandler(value=BindException.class)
publicStringbindException(Exceptione){
if(einstanceofBindException){
BindExceptionexs=(BindException)e;
ListfieldErrors=exs.getFieldErrors();
for(FieldErroritem:fieldErrors){
logger.error("请求异常："+item.getDefaultMessage());
}
}
logger.error("数据绑定异常："+e.getMessage());
return"数据绑定异常";
}

@ResponseBody
@ExceptionHandler(value=Exception.class)
publicStringdefaultException(Exceptione){
logger.error("请求异常："+e.getMessage());
return"请求异常"+e.getMessage();
}

}

三、约束性注解(简单)说明

注解	功能
@AssertFalse	可以为null,如果不为null的话必须为false
@AssertTrue	可以为null,如果不为null的话必须为true
@DecimalMax	设置不能超过最大值
@DecimalMin	设置不能超过最小值
@Digits	设置必须是数字且数字整数的位数和小数的位数必须在指定范围内
@Future	日期必须在当前日期的未来
@Past	日期必须在当前日期的过去
@Max	最大不得超过此最大值
@Min	最大不得小于此最小值
@NotNull	不能为null，可以是空
@Null	必须为null
@Pattern	必须满足指定的正则表达式
@Size	集合、数组、map等的size()值必须在指定范围内
@Email	必须是email格式
@Length	长度必须在指定范围内
@NotBlank	字符串不能为null,字符串trim()后也不能等于“”
@NotEmpty	不能为null，集合、数组、map等size()不能为0；字符串trim()后可以等于“”
@Range	值必须在指定范围内
@URL	必须是一个URL

到此这篇关于SpringBoot+validation接口参数校验的文章就介绍到这了,更多相关SpringBoot+validation接口参数校验内容请搜索毛票票以前的文章或继续浏览下面的相关文章希望大家以后多多支持毛票票！

声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。

SpringBoot + validation 接口参数校验的思路详解

热门推荐

随机推荐