逍遥阁

springBoot验证

关键词: spring boot

springBoot验证

### 引入依赖

```
<dependency>
	<groupId>org.hibernate.validator</groupId>
	<artifactId>hibernate-validator</artifactId>
</dependency>
```

### 在类的属性上应用注解

类需要添加`@Data`注解

```
@NotNull(message = "错误消息")
```

### 控制器方法上添加注解@Validated

```
@PostMapping("post")
public Object post(@RequestBody @Validated TestDTO dto, BindingResult bindingResult) {
	if (bindingResult.hasErrors()) {

}
}
```

可以不写第二个参数，系统会自动抛出异常org.springframework.web.bind.MethodArgumentNotValidException，可以全局捕获该异常统一返回。

### 按顺序校验

1.定义分组序列

```
public interface Group1 {}

public interface Group2 {}

@GroupSequence({Group1.class, Group2.class})
public interface Group {}
```

2.给每个验证注解添加分组信息

```
@NotNull(message = "错误消息", groups = Group1.class)
```

3.调整写法

```
@Validated(Group.class)
```

### 手动验证

```
package com.example.demo;

import com.example.demo.dto.TestDTO;

import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import java.util.Set;

/**
 * @author demo
 */
public class ValidUtil {

public static void valid(TestDTO t, Class<?>... classes) {
        Set<ConstraintViolation<TestDTO>> constraintViolations = Validation.buildDefaultValidatorFactory().getValidator().validate(t, classes);
        if (!constraintViolations.isEmpty()) {
            constraintViolations.forEach(o -> {
                TestDTO dto = o.getRootBean();
                String messaage = o.getMessage();
                throw new MyException(messaage);
            });
        }
    }

}
```

```
@PostMapping("post")
public Object post(@RequestBody TestDTO dto) {
    ValidUtil.valid(dto);
    return "ok";
}
```

### 常用验证

```
Length
Pattern
Null
NotNull
NotBlank
NotEmpty
Min
Max
DecimalMin
DecimalMax
Range
Size
Email
```

### 自已定义一个验证

```
package com.example.demo;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

/**
 * @author demo
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Constraint(validatedBy = ValidatorSexImpl.class)
public @interface ValidatorSex {

String[] list();

String message();

Class<?>[] groups() default {};

Class<? extends Payload>[] payload() default {};

}
```

```
package com.example.demo;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

/**
 * 第1个泛型对应initialize第1个参数类型
 * 第2个泛型对应isValid第1个参数类型
 *
 * @author demo
 */
public class ValidatorSexImpl implements ConstraintValidator<ValidatorSex, String> {

private ValidatorSex validatorSex;

@Override
    public void initialize(ValidatorSex validatorSex) {
        this.validatorSex = validatorSex;
    }

@Override
    public boolean isValid(String value, ConstraintValidatorContext constraintValidatorContext) {
        boolean result = false;
        if (value == null || "".equals(value)) {
            return false;
        }
        String[] list = validatorSex.list();
        for (String s : list) {
            if (s.equals(value)) {
                result = true;
                break;
            }
        }
        return result;
    }

}
```

```
@ValidatorSex(list = {"1", "2", "3"}, message = "性别取值只能是1 2 3")
private String sex;
```

admin
2021-11-01 20:00:45
phantoscope

文章分类

文章标签

文章归档

友情链接

springBoot验证