SpringBoot는 매개변수 확인을 어떻게 수행합니까?-java지도 시간-php.cn

소개

일상적인 인터페이스 개발에서는 불법적인 매개변수가 비즈니스에 영향을 미치는 것을 방지하기 위해 인터페이스의 매개변수를 확인해야 하는 경우가 많습니다. 예를 들어 로그인 시 사용자 이름과 비밀번호가 비어 있는지 확인해야 합니다. 사용자를 추가할 때 사용자의 이메일 주소와 휴대전화 번호의 형식이 올바른가요? 인터페이스 매개변수를 하나씩 확인하기 위해 코드에 의존하는 것은 너무 번거롭고 코드의 가독성도 매우 낮습니다.

Validator이 프레임워크는 개발자가 개발 중에 코드 작성을 줄이고 개발 효율성을 향상시키는 데 도움이 되도록 설계되었습니다. 유효성 검사기는 공통 필수 확인, 이메일 형식 확인과 같은 인터페이스 매개변수를 확인하는 데 특별히 사용됩니다. 사용자 이름은 6에서 12 사이여야 합니다. 등등.

다음으로 SpringbBoot에 매개변수 검증 프레임워크를 통합하는 방법을 살펴보겠습니다.

1. SpringBoot의 통합 매개변수 확인

1.1 종속성 소개

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

로그인 후 복사

1.2 매개변수 엔터티 클래스 정의

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;
}

로그인 후 복사

일반적인 제약 조건 주석은 다음과 같습니다.

설정은 최소값을 초과할 수 없습니다설정은 숫자여야 하며 정수의 자릿수여야 합니다. 소수점 이하 자릿수는 지정된 범위 내에 있어야 합니다날짜는 현재 날짜보다 미래여야 합니다. 날짜는 현재 날짜보다 과거여야 합니다최대값은 이 최대값을 초과해서는 안 됩니다.최대값은 이 최소값보다 작을 수 없습니다.null일 수 없으며 비어 있을 수 있습니다null이어야 합니다지정된 정규 표현식을 충족해야 합니다컬렉션, 배열, 맵 등의 크기입니다. ()값은 지정된 범위 내에 있어야 합니다. 이메일 형식이어야 합니다길이는 지정된 범위 내에 있어야 합니다String은 null일 수 없습니다. string Trim() 이후에는 불가능합니다. ""은 null일 수 없습니다. 컬렉션, 배열, 맵 등의 size()는 0일 수 없습니다. @Range 값은 지정된 범위 내에 있어야 합니다.@URLURL이어야 합니다

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打开接口文档模拟提交数据

SpringBoot는 매개변수 확인을 어떻게 수행합니까?

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

SpringBoot는 매개변수 확인을 어떻게 수행합니까?

由于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<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);
    }
}

로그인 후 복사

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

SpringBoot는 매개변수 확인을 어떻게 수행합니까?

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体验效果

SpringBoot는 매개변수 확인을 어떻게 수행합니까?

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;

로그인 후 복사