Maison> Java> javaDidacticiel> le corps du texte

Comment SpringBoot effectue-t-il la vérification des paramètres ?

WBOY
Libérer: 2023-05-18 15:52:36
avant
1242 Les gens l'ont consulté

Introduction

Dans le développement quotidien d'interfaces, afin d'éviter que des paramètres illégaux n'affectent l'entreprise, il est souvent nécessaire de vérifier les paramètres de l'interface. Par exemple, il est nécessaire de vérifier si le nom d'utilisateur et le mot de passe sont vides lors de la connexion. dans et lors de l'ajout d'un utilisateur, les formats de l'adresse e-mail et du numéro de téléphone portable de l'utilisateur sont-ils corrects ? Il serait trop fastidieux de s'appuyer sur du code pour vérifier les paramètres de l'interface un par un, et la lisibilité du code serait extrêmement mauvaise.

ValidatorLe framework est conçu pour aider les développeurs à écrire moins de code pendant le développement et à améliorer l'efficacité du développement ; Validator est spécialement utilisé pour vérifier les paramètres d'interface, tels que la vérification requise commune, la vérification du format de courrier électronique, le nom d'utilisateur doit être compris entre 6 et Attendre entre 12. et ainsi de suite.

Voyons ensuite comment intégrer le framework de vérification des paramètres dans SpringbBoot.

1. Vérification des paramètres intégrée dans SpringBoot

1.1 Introduire les dépendances

 org.springframework.boot spring-boot-starter-validation 
Copier après la connexion

1.2 Définir les classes d'entités de paramètres

package com.didiplus.modules.sys.domain; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import lombok.Data; import javax.validation.constraints.Email; import javax.validation.constraints.NotBlank; import javax.validation.constraints.NotEmpty; /** * Author: didiplus * Email: 972479352@qq.com * CreateTime: 2022/4/25 * Desc: 字典类型领域模型 */ @Data @ApiModel(value = "字典类型") public class SysDictType { @ApiModelProperty("ID") private String id; @NotBlank(message = "字典名称必填项") @ApiModelProperty(value = "字典名称",example = "用户ID") private String typeName; @NotBlank(message = "字典编码不能为空") @ApiModelProperty(value = "字典编码") private String typeCode; @Email(message = "请填写正确的邮箱地址") @ApiModelProperty(value = "字典编码") private String email; @ApiModelProperty(value = "字典描述") private String description; @NotBlank(message = "字典状态不能为空") @ApiModelProperty(value = "字典状态") private String enable; }
Copier après la connexion

Les annotations de contraintes courantes sont les suivantes :

Le paramètre ne peut pas dépasser la valeur minimale Le paramètre doit être un nombre et le nombre de chiffres de l'entier et du. le nombre de décimales doit être dans la plage spécifiée La date doit être dans le futur de la date actuelle La date doit être dans le passé de la date actuelle Le maximum ne doit pas dépasser cette valeur maximale Le maximum ne doit pas être inférieur à cette valeur minimale ne peut pas être nul, peut être vide doit être nul doit satisfaire l'expression régulière spécifiée taille des collections, tableaux, cartes, etc. ()La valeur doit être dans la plage spécifiée Doit être au format email La longueur doit être dans la plage spécifiée La chaîne ne peut pas être nulle, la chaîne Après trim(), elle ne peut pas être égal à "" ne peut pas être nul. La taille () des collections, tableaux, cartes, etc. ne peut pas être 0 après trim(), la chaîne peut être égale à "" ; La valeur doit être dans la plage spécifiée doit être une URL
Annotations Fonction
@AssertFal se D'accord, cela peut être nul. Si ce n'est pas nul, cela doit être faux
@Digits
@Future
@Past
@Max
@Min
@NotNull
@Null
@Pattern
@Size
@Email
@Length
@NotBlank
@NotEmpty
@Plage
@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; } }
Copier après la connexion

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

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

Comment SpringBoot effectue-t-il la vérification des paramètres ?

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

Comment SpringBoot effectue-t-il la vérification des paramètres ?

由于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: 默认全局异常处理。 */ @RestControllerAdvice public class RestExceptionHandler { /** * 默认全局异常处理。 * @param e the e * @return ResultData */ @ExceptionHandler(value = {BindException.class, ValidationException.class, MethodArgumentNotValidException.class}) public ResponseEntity> handleValidatedException(Exception e) { Result 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); } }
Copier après la connexion

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

Comment SpringBoot effectue-t-il la vérification des paramètres ?

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[] 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(); } }
Copier après la connexion

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 { private List 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); } }
Copier après la connexion

3.3在字段上增加注解

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

3.4体验效果

Comment SpringBoot effectue-t-il la vérification des paramètres ?

4.分组校验

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

其实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{ } } }
Copier après la connexion

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

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

4.3体现效果

Comment SpringBoot effectue-t-il la vérification des paramètres ?

Comment SpringBoot effectue-t-il la vérification des paramètres ?

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!

Étiquettes associées:
source:yisu.com
Déclaration de ce site Web
Le contenu de cet article est volontairement contribué par les internautes et les droits d'auteur appartiennent à l'auteur original. Ce site n'assume aucune responsabilité légale correspondante. Si vous trouvez un contenu suspecté de plagiat ou de contrefaçon, veuillez contacter admin@php.cn
Derniers téléchargements
Plus>
effets Web
Code source du site Web
Matériel du site Web
Modèle frontal
À propos de nous Clause de non-responsabilité Sitemap
Site Web PHP chinois:Formation PHP en ligne sur le bien-être public,Aidez les apprenants PHP à grandir rapidement!