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.
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency>
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;
}Les annotations de contraintes courantes sont les suivantes :
| 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 | |
| @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 这里我们先定义两个方法 1.4打开接口文档模拟提交数据
通过接口文档看到前三个字段都是必填项。
由于email的格式不对就被拦截了，提示是因为邮箱地址不对。 2.参数异常加入全局异常处理器虽然我们之前定义了全局异常拦截器，也看到了拦截器确实生效了，但是 直接修改之前定义的
代码如下： 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<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);
}
}Copier après la connexion 美化之后错误信息提示更加友好
3.自定义参数校验虽然Spring Validation 提供的注解基本上够用，但是面对复杂的定义，我们还是需要自己定义相关注解来实现自动校验。 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();
}
}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<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);
}
}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体验效果
4.分组校验一个对象在新增的时候某些字段是必填，在更新是有非必填。如上面的 其实 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体现效果
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
Article précédent：Comment implémenter la journalisation dans CompletableFuture en Java
Article suivant：Comment utiliser des flux pour trier des tableaux en Java
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 articles par auteur
Derniers numéros
Rubriques connexes
Plus>
|
![[Web front-end] Démarrage rapide de Node.js](https://img.php.cn/upload/course/000/000/067/662b5d34ba7c0227.png)
