Muitas anotações de validação são definidas no pacote javax.validation.constraints e as dependências são introduzidas:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
Basta adicionar as anotações correspondentes na classe da entidade,
Classe de entidade:
package com.zhmsky.mallproduct.entity;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import java.io.Serializable;
import java.util.Date;
import lombok.Data;
import javax.validation.constraints.NotBlank;
/**
* 品牌
*
* @author zhmsky
* @email [email protected]
* @date 2022-07-30 16:40:28
*/
@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 品牌名
*/
@NotBlank(message = "品牌名不能为空")
private String name;
}
1. Tratamento de exceções de verificação na interface do controlador
A mensagem pode especificar a descrição da verificação
e, em seguida, usar a anotação @Valid no método de interface do controlador correspondente para especificar a verificação do parâmetro da interface, seguida por BindingResult para receber o resultado da verificação. Quando a verificação falhar, ela encapsulará e retornará as informações de falha da verificação , se a verificação for aprovada, a lógica relevante será executada
@RequestMapping(value = "/save",method = RequestMethod.POST)
public R save(@Valid @RequestBody BrandEntity brand, BindingResult result){
if(result.hasErrors()){
Map<String, String> map = new HashMap<>();
//获取校验结果
for (FieldError fieldError : result.getFieldErrors()) {
//获取错误提示
String message = fieldError.getDefaultMessage();
//校验错误的字段
String field = fieldError.getField();
//封装错误
map.put(field,message);
}
return R.error(20001,"参数校验失败").put("errorMap",map);
}
brandService.save(brand);
return R.ok();
}
2. Tratamento unificado de exceções
Se o tratamento de exceção de verificação de parâmetro for executado em cada interface, a carga de trabalho é relativamente grande e o código é complicado, então o tratamento de exceção global é introduzido, ou seja, o
uso de anotações @RestControllerAdvice+@ExceptionHandler.
package com.zhmsky.mallproduct.exception;
import com.zhmsky.common.utils.R;
import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import java.util.HashMap;
import java.util.Map;
/**
* 同意异常处理类
* @author zhmsky
* @date 2022/8/1 21:36
*/
@Slf4j
@RestControllerAdvice(basePackages = {
"com.zhmsky.mallproduct.controller"})
public class MallProductControllerAdvice {
//具体的某个异常类型处理
@ExceptionHandler(MethodArgumentNotValidException.class)
public R handleValidException(MethodArgumentNotValidException e){
log.error("数据异常:{},异常类型:{}",e.getMessage(),e.getClass());
BindingResult result = e.getBindingResult();
Map<String, String> map = new HashMap<>();
for (FieldError fieldError : result.getFieldErrors()) {
map.put(fieldError.getDefaultMessage(),fieldError.getField());
}
return R.error().put("errorMap",map);
}
//抛出的所有异常类型处理
@ExceptionHandler(Throwable.class)
public R handleException(Throwable e){
//TODO 处理逻辑
return R.error();
}
}
3. Classe de enumeração de código de erro
package com.zhmsky.common.exception;
/**
* @author zhmsky
* @date 2022/8/1 21:56
*/
public enum ErrorCodeEnum {
UNKNOWN_EXCEPTION(10000, "系统未知错误"),
VALID_EXCEPTION(10001, "参数格式校验失败");
/**
* 错误码
*/
private Integer code;
/**
* 错误提示
*/
private String msg;
ErrorCodeEnum(Integer code, String msg) {
this.code = code;
this.msg = msg;
}
public Integer getCode(){
return this.code;
}
public String getMsg(){
return this.msg;
}
}
4. Anotação de verificação de parâmetro personalizado
1. Escreva anotações de validação personalizadas
Consulte a anotação @NotBlank de javax.validation.constraints,
@Documented
@Constraint(validatedBy = {
})
@Target({
METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Repeatable(List.class)
public @interface NotBlank {
//校验规则提示信息
String message() default "{javax.validation.constraints.NotBlank.message}";
//分组校验
Class<?>[] groups() default {
};
//负载
Class<? extends Payload>[] payload() default {
};
/**
* Defines several {@code @NotBlank} constraints on the same element.
*
* @see NotBlank
*/
@Target({
METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Documented
public @interface List {
NotBlank[] value();
}
}
Imite o acima para escrever rapidamente uma anotação personalizada:
@Documented
@Constraint(validatedBy = {
StatusValueConstraintValidator.class})
@Target({
METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
public @interface statusValue {
//校验规则提示信息（在配置文件中配置）
String message() default "{com.zhmsky.common.validator.statusValue.message}";
Class<?>[] groups() default {
};
Class<? extends Payload>[] payload() default {
};
//注解参数
int[] values() default {
};
}
Crie um arquivo ValidationMessages.properties e configure prompts de regra de validação customizada no arquivo de configuração:
com.zhmsky.common.validator.statusValue.message=error.......xxxx
2. Escreva um validador personalizado
//statusValue就是自定义的注解，Integer就是自定义注解标注的字段类型
public class StatusValueConstraintValidator implements ConstraintValidator<statusValue, Integer> {
private Set<Integer> set = new HashSet<>();
//初始化方法
@Override
public void initialize(statusValue constraintAnnotation) {
//字段标注的注解里面设定的值（校验规则）
int[] values = constraintAnnotation.values();
for (int value : values) {
set.add(value);
}
}
//判断是否校验成功
@Override
public boolean isValid(Integer value, ConstraintValidatorContext context) {
//value就是字段字段实际接收到的值
return set.contains(value);
}
}
3. Associar anotações personalizadas e validadores personalizados
Ou seja, especifique o validador personalizado na anotação @Constraint da anotação personalizada,
4. Teste a anotação personalizada @statusValue
@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 品牌名
*/
@NotBlank(message = "品牌名不能为空")
private String name;
/**
* 显示状态[0-不显示；1-显示]，指定字段值只能为 0 或 1
*/
@statusValue(values={
0,1})
private Integer showStatus;
}
Use a anotação @Validated na interface do controlador correspondente para verificar e o campo showStatus passa em um valor de 3.
O resultado do teste é mostrado na figura:
