springboot字段校验,springmvc参数校验

2022-07-31 15:16:25 分类：java 阅读()

　　springboot字段校验,springmvc参数校验

　　00-1010简介1。在1中集成参数验证。SpringBoot 1.1引入依赖1.2定义参数实体类1.3定义测试用验证类1.4打开接口文档模拟提交数据2。将参数exception添加到全局异常处理程序3。自定义参数验证3.1创建自定义注释3.2自定义验证逻辑3.3向字段添加注释3.4体验效果4。分组验证4.1定义分组接口4.2将组分配给模型中的参数4.3反映效果。

　　00-1010日常接口开发中，为了防止非法参数影响业务，经常需要对接口的参数进行检查。比如登录时需要检查用户名和密码是否为空，添加用户时需要检查用户的邮箱和手机号码格式是否正确。用代码逐个检查接口参数太繁琐，代码可读性极差。

　　Validator框架是为了解决开发者在开发过程中编写代码少的问题，提高开发效率。Validator是专门用来验证界面参数的，比如常见的必需验证，邮件格式验证，用户名必须在6到12之间等等。

　　接下来，我们来看看如何在SpringbBoot中集成参数验证框架。

　　

目录

 

　　

介绍

依赖关系groupIdorg.springframework.boot/groupId artifactId spring-boot-starter-validation/artifactId/dependency

 

　　

1.SpringBoot中集成参数校验

包com . Didi plus . modules . sys . domain；导入io . swagger . annotations . API model；导入io . swagger . annotations . API model property；进口龙目岛。数据；导入javax . validation . constraints . email；import javax . validation . constraints . not blank；import javax . validation . constraints . not empty；/* * * Author : Didi Plus * Email : 972479352@qq.com * create time 3360 2022/4/25 * desc 3360字典类型域模型*/@ Data @ API Model(value= Dictionary Type )公共类sysdict Type { @ API Model property( ID )私有字符串ID；@ not blank(message= dictionary name required )@ ApiModelProperty(value= dictionary name ，example= user ID )私有字符串类型名；@NotBlank(message=“字典代码不能为空”)@ApiModelProperty(value=“字典代码”)私有字符串typeCode@Email(message=请填写正确的邮件地址)@ ApiModelProperty(value= dictionary code )私有字符串Email；@ ApiModelProperty(value= dictionary description )私有字符串描述；@NotBlank(message=“字典状态不能为空”)@ApiModelProperty(value=“字典状态”)私有字符串enable}常见的约束注释如下：

 

　　注释函数@AssertFalse可以为null，如果不为null，则一定为false@AssertTrue可以为null，如果不为null， 它必须是true@DecimalMax设置不能超过最大值@DecimalMin设置不能超过最小值@Digits设置必须是数字，并且整数和小数的位数必须在指定的范围内@未来日期必须是当前日期的未来日期@过去日期必须是当前日期的过去日期@Max最大值不能超过此最大值@Min最大值不能小于此最小值@NotNull不能为Null，可以为空@Null必须为null@Pattern必须满足指定的正则表达式@Size集合、数组、映射等。 size()值必须在指定的范围内@Email必须为电子邮件格式@Length必须在指定的范围内@NotBlank字符串不能为null，也不能在字符串trim()后等于 @NotEmpty不能为null，集合和数组

　　ap等size()不能为0；字符串trim()后可以等于""@Range值必须在指定范围内@URL必须是一个URL

 

　　

1.3定义校验类进行测试

package com.didiplus.modules.sys.controller;import com.didiplus.modules.sys.domain.SysDictType;import io.swagger.annotations.Api;import io.swagger.annotations.ApiOperation;import io.swagger.v3.oas.annotations.parameters.RequestBody;import org.springframework.validation.annotation.Validated;import org.springframework.web.bind.annotation.PostMapping;import org.springframework.web.bind.annotation.PutMapping;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RestController;/** * Author: didiplus * Email: 972479352@qq.com * CreateTime: 2022/4/25 * Desc: 数据字典控制器 */@RestController@Api(tags = "数据字典")@RequestMapping("/api/sys/dictType")public class SysDictTypeController { @ApiOperation("字典添加") @PostMapping("/add") public SysDictType add(@Validated @RequestBody SysDictType sysDictType) { return sysDictType; } @ApiOperation("字典修改") @PutMapping("/edit") public SysDictType edit(@Validated @RequestBody SysDictType sysDictType) { return sysDictType; }}

这里我们先定义两个方法add,edit，都是使用了@RequestBody注解，用于接受前端发送的json数据。

 

　　

 

　　

1.4打开接口文档模拟提交数据

 

　　通过接口文档看到前三个字段都是必填项。

　　

 

　　由于email的格式不对就被拦截了，提示是因为邮箱地址不对。

　　

 

　　

2.参数异常加入全局异常处理器

虽然我们之前定义了全局异常拦截器，也看到了拦截器确实生效了，但是Validator校验框架返回的错误提示太臃肿了，不便于阅读，为了方便前端提示，我们需要将其简化一下。

 

　　直接修改之前定义的RestExceptionHandler，单独拦截参数校验的三个异常：

　　javax.validation.ConstraintViolationException

　　org.springframework.validation.BindException

　　org.springframework.web.bind.MethodArgumentNotValidException

　　代码如下：

　　

package com.didiplus.common.web.response.Handler;import com.didiplus.common.web.response.Result;import org.springframework.http.HttpStatus;import org.springframework.http.ResponseEntity;import org.springframework.validation.BindException;import org.springframework.validation.ObjectError;import org.springframework.web.bind.MethodArgumentNotValidException;import org.springframework.web.bind.annotation.ExceptionHandler;import org.springframework.web.bind.annotation.RestControllerAdvice;import javax.validation.ConstraintViolation;import javax.validation.ConstraintViolationException;import javax.validation.ValidationException;import java.util.stream.Collectors;/** * Author: didiplus * Email: 972479352@qq.com * CreateTime: 2022/4/24 * Desc: 默认全局异常处理。 */@RestControllerAdvicepublic class RestExceptionHandler { /** * 默认全局异常处理。 * @param e the e * @return ResultData */ @ExceptionHandler(value = {BindException.class, ValidationException.class, MethodArgumentNotValidException.class}) public ResponseEntity<Result<String>> handleValidatedException(Exception e) { Result<String> result = null; if (e instanceof MethodArgumentNotValidException) { MethodArgumentNotValidException ex =(MethodArgumentNotValidException) e; result = Result.failure(HttpStatus.BAD_REQUEST.value(), ex.getBindingResult().getAllErrors().stream() .map(ObjectError::getDefaultMessage) .collect(Collectors.joining(";")) ); } else if (e instanceof ConstraintViolationException){ ConstraintViolationException ex = (ConstraintViolationException) e; result = Result.failure(HttpStatus.BAD_REQUEST.value(), ex.getConstraintViolations().stream() .map(ConstraintViolation::getMessage) .collect(Collectors.joining(";")) ); }else if (e instanceof BindException) { BindException ex = (BindException ) e; result = Result.failure(HttpStatus.BAD_REQUEST.value(), ex.getAllErrors().stream() .map(ObjectError::getDefaultMessage) .collect(Collectors.joining(";")) ); } return new ResponseEntity<>(result,HttpStatus.BAD_REQUEST); }}

美化之后错误信息提示更加友好

 

　　

 

　　

 

　　

3.自定义参数校验

虽然Spring Validation 提供的注解基本上够用，但是面对复杂的定义，我们还是需要自己定义相关注解来实现自动校验。比如上面实体类中添加的sex性别属性，只允许前端传递传 M，F 这2个枚举值，如何实现呢？

 

　　

 

　　

3.1创建自定义注解

package com.didiplus.common.annotation;import javax.validation.Constraint;import javax.validation.Payload;import java.lang.annotation.Documented;import java.lang.annotation.Repeatable;import java.lang.annotation.Retention;import java.lang.annotation.Target;import static java.lang.annotation.ElementType.*;import static java.lang.annotation.RetentionPolicy.RUNTIME;/** * Author: didiplus * Email: 972479352@qq.com * CreateTime: 2022/4/26 * Desc: */@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})@Retention(RUNTIME)@Repeatable(EnumString.List.class)@Documented@Constraint(validatedBy = EnumStringValidator.class)//标明由哪个类执行校验逻辑public @interface EnumString { String message() default "value not in enum values."; Class<?>[] groups() default {}; Class<? extends Payload>[] palyload() default {}; /** * @return date must in this value array */ String[] value(); /** * Defines several {@link EnumString} annotations on the same element. * * @see EnumString */ @Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE}) @Retention(RUNTIME) @Documented @interface List { EnumString[] value(); }}

 

　　

3.2自定义校验逻辑

package com.didiplus.common.annotation;import javax.validation.ConstraintValidator;import javax.validation.ConstraintValidatorContext;import java.util.Arrays;import java.util.List;/** * Author: didiplus * Email: 972479352@qq.com * CreateTime: 2022/4/26 * Desc: */public class EnumStringValidator implements ConstraintValidator<EnumString,String> { private List<String> enumStringList; @Override public void initialize(EnumString constraintAnnotation) { enumStringList = Arrays.asList(constraintAnnotation.value()); } @Override public boolean isValid(String value, ConstraintValidatorContext constraintValidatorContext) { if(value == null) { return true; } return enumStringList.contains(value); }}

 

　　

3.3在字段上增加注解

 @ApiModelProperty(value = "性别") @EnumString(value = {"F","M"}, message="性别只允许为F或M") private String sex;

 

　　

3.4体验效果

 

　　

 

　　

4.分组校验

一个对象在新增的时候某些字段是必填，在更新是有非必填。如上面的SysDictType中id属性在新增操作时都是必填。面对这种场景你会怎么处理呢？

 

　　其实Validator校验框架已经考虑到了这种场景并且提供了解决方案，就是分组校验。要使用分组校验，只需要三个步骤：

　　

 

　　

4.1定义分组接口

package com.didiplus.common.base;import javax.validation.groups.Default;/** * Author: didiplus * Email: 972479352@qq.com * CreateTime: 2022/4/26 * Desc: */public interface ValidGroup extends Default { interface Crud extends ValidGroup{ interface Create extends Crud{ } interface Update extends Crud{ } interface Query extends Crud{ } interface Delete extends Crud{ } }}

 

　　

4.2在模型中给参数分配分组

 @Null(groups = ValidGroup.Crud.Create.class) @NotNull(groups = ValidGroup.Crud.Update.class,message = "字典ID不能为空") @ApiModelProperty("ID") private String id;

 

　　

4.3体现效果

 

　　

 

　　以上就是SpringBoot进行参数校验的方法详解的详细内容，更多关于SpringBoot参数校验的资料请关注盛行IT其它相关文章！

郑重声明：本文由网友发布，不代表盛行IT的观点，版权归原作者所有，仅为传播更多信息之目的，如有侵权请联系，我们将第一时间修改或删除，多谢。

标签：

相关文章阅读

  • ,,详解SpringBoot整合MyBatis详细教程
  • ,,详解SpringBoot中Session超时原理说明
  • ,,浅谈springboot中tk.mapper代码生成器的用法说明
  • ,,SpringBoot项目微信云托管入门部署实践
  • ,,SpringBoot集成JPA持久层框架,简化数据库操作
  • ,,SpringBoot整合Ureport2报表及常见使用方法
  • ,,SpringBoot整合Swagger3生成接口文档过程解析
  • ,,SpringBoot实现动态定时任务
  • ,,Springboot基础之RedisUtils工具类
  • ,,Springboot单元测试无法读取配置文件的解决方案
  • ,,SpringBoot事件发布和监听详解
  • ,,SpringBoot之HandlerInterceptor拦截器的使用详解
  • ,,SpringBoot+阿里云OSS实现在线视频播放的示例
  • ,,SpringBoot+WebSocket实现即时通讯的方法详解
  • ,,SpringBoot+Tess4j实现牛逼的OCR识别工具的示例代码
    • 留言与评论（共有 条评论）
       
    验证码：