一、自定义嵌套参数的校验注解规则
1. 接受前台参数
//AlyUrgentOutStoreApplyAddDto 为嵌套参数类
public Result add(@Valid @RequestBody AlyUrgentOutStoreApplyAddDto alyUrgentOutStoreApplyAddDto, HttpServletRequest request) {
alyUrgentOutService.insertUrgentOutStoreApply(alyUrgentOutStoreApplyAddDto, request);
return ResultGenerator.genSuccessResult();
}
2. 接收参数的实体类
import cn.com.magnequench.alloy.web.paramscheck.UrgentOutStoreAnno;
import java.util.Date;
import java.util.List;
/**
* @Desc TODO @UrgentOutStoreAnno注解为自定义注解
**/
@UrgentOutStoreAnno
public class AlyUrgentOutStoreApplyAddDto {
private String applyMemo;
private Date claimTime;
private List<AlyUrgentOutStoreUseDataDto> selected;
public String getApplyMemo() {
return applyMemo;
}
public void setApplyMemo(String applyMemo) {
this.applyMemo = applyMemo;
}
public Date getClaimTime() {
return claimTime;
}
public void setClaimTime(Date claimTime) {
this.claimTime = claimTime;
}
public List<AlyUrgentOutStoreUseDataDto> getSelected() {
return selected;
}
public void setSelected(List<AlyUrgentOutStoreUseDataDto> selected) {
this.selected = selected;
}
}
3. 自定义注解
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;
@Documented
@Target({ ElementType.METHOD, ElementType.FIELD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = { UrgentOutStoreValidator.class})
/**
* @Desc //TODO 自定义校验注解，UrgentOutStoreValidator为自定义校验规则的类
**/
public @interface UrgentOutStoreAnno {
String message() default "msg";// 校验的失败的时候返回的信息,可以指定默认值
Class<?>[] groups() default { };
Class<? extends Payload>[] payload() default {};
}
4. 自定义校验注解的规则
import cn.com.magnequench.alloy.dto.AlyUrgentOutStoreApplyAddDto;
import cn.com.magnequench.alloy.dto.AlyUrgentOutStoreUseDataDto;
import common.core.utils.StringUtils;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.List;
/**
* @Desc TODO
**/
public class UrgentOutStoreValidator implements ConstraintValidator<UrgentOutStoreAnno,AlyUrgentOutStoreApplyAddDto> {
@Override
public void initialize(UrgentOutStoreAnno constraintAnnotation) {
}
@Override
public boolean isValid(AlyUrgentOutStoreApplyAddDto alyUrgentOutStoreApplyAddDto, ConstraintValidatorContext context) {
// 处理校验逻辑
return false;
}
}
二、元注解
元注解的作用就是负责注解其他注解
1. @Documented
Documented 可以作用于类上及类方法上，表明这个注释是由 javadoc记录的，在默认情况下也有类似的记录工具。 如果一个类型声明被注释了文档化，它的注释成为公共API的一部分
2. @Target
是用来修饰注解的元注解，它有一个属性ElementType是枚举类型
- ElementType.TYPE:类、接口（包括注释类型）或枚举声明
- ElementType.FIELD:字段声明（包括枚举常量）
- ElementType.METHOD:方法声明
- ElementType.PARAMETER:形式参数声明
- ElementType.CONSTRUCTOR:构造函数声明
- ElementType.LOCAL_VARIABLE:局部变量声明
- ElementType.ANNOTATION_TYPE:批注类型声明
- ElementType.PACKAGE:包声明
- ElementType.TYPE_PARAMETER:类型参数声明
- ElementType.TYPE_USE:类型的使用
- ElementType.MODULE:模块声明
3. @Retention
是用来修饰注解的元注解，它有一个属性RetentionPolicy是枚举类型
- RetentionPolicy.SOURCE:注释将被编译器丢弃
- RetentionPolicy.CLASS:注释将由编译器记录在类文件中，但不需要在运行时由VM保留。这是默认行为
- RetentionPolicy.RUNTIME:注释将由编译器记录在类文件中，并在运行时由VM保留，因此可以反射地读取注释
4. @Constraint(validatedBy = { })
validatedBy属性指定了需要进行校验的策略类集合，这是一个数组
{} 数组中的类要 implements ConstraintValidator<UrgentOutStoreAnno,AlyUrgentOutStoreApplyAddDto>接口，ConstraintValidator第一个类型是自定义校验注解，第二个是使用自定义注解接受参数的实体类
