javax.validation详解，全局异常处理，如何实现自定义校验注解，以及和spring的validation区别

Koikoi123

已于 2022-01-27 10:39:21 修改

阅读量8.6k

点赞数 6

文章标签： spring java 后端

于 2022-01-14 14:37:41 首次发布

本文链接：https://blog.csdn.net/Koikoi12/article/details/122493338

版权

当进行逻辑处理的时候，我们首先要做的想必一定是参数校验，这时候需要使用javax.validation进行参数校验。

javax.validation可用的注解

空检查

@Null 验证对象是否为null

@NotNull 验证对象是否不为null, 无法查检长度为0的字符串

@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.

@NotEmpty 检查约束元素是否为NULL或者是EMPTY.

Booelan检查

@AssertTrue 验证 Boolean 对象是否为 true

@AssertFalse 验证 Boolean 对象是否为 false

长度检查

@Size(min=, max=) 验证对象（Array,Collection,Map,String）长度是否在给定的范围之内

@Length(min=, max=)
验证字符串的长度是否在给定的范围之内，包含两端

日期检查

@Past 验证 Date 和 Calendar 对象是否在当前时间之前

@Future 验证 Date 和 Calendar 对象是否在当前时间之后

@Pattern 验证 String 对象是否符合正则表达式的规则

数值检查

建议使用在Stirng,Integer类型，不建议使用在int类型上，因为表单值为“”时无法转换为int，但可以转换为Stirng为"",Integer为null

@Min 验证 Number 和 String 对象是否大等于指定的值

@Max 验证 Number 和 String 对象是否小等于指定的值

@DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度

@DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度

@Digits 验证 Number 和 String 的构成是否合法

@Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。

@Range(min=, max=) Checks whether the annotated value lies between (inclusive) the specified minimum and maximum.

@Range(min=10000,max=50000,message=“range.bean.wage”)
private BigDecimal wage;

@Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)

@CreditCardNumber信用卡验证

@Email 验证是否是邮件地址，如果为null,不进行验证，算通过验证。

@ScriptAssert(lang= ,script=, alias=)

@URL(protocol=,host=, port=,regexp=, flags=)

自定义全局异常处理

@Slf4j
@ControllerAdvice
public class GlobalExceptionHandle {
	 /**
     * 处理结构体参数校验异常
     * @param e 参数校验异常
     * @return 错误响应
     */
    @ExceptionHandler({MethodArgumentNotValidException.class})
    public ResponseEntity<CommonResponse> handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
        StringBuilder errorMessage = new StringBuilder();
        for (FieldError fieldError : e.getBindingResult().getFieldErrors()) {
            errorMessage.append(fieldError.getDefaultMessage()).append("；");
        }
        errorMessage.deleteCharAt(errorMessage.length()-1).append("。");
        return ResponseEntity.badRequest().body(new CommonResponse(null, String.valueOf(HttpStatus.BAD_REQUEST.value()), errorMessage.toString()));
    }
}

实体加注解

	@JsonProperty("pri")
    @NotNull(message = ValidationConst.PLEASE_SELECT + ValidationConst.ITEM_CUSTOMER_POINT_PROPROTY)
    @ApiModelProperty(value = "优先级", name = "pri")
    private Integer priority;

    @JsonProperty("nm")
    @NotEmpty(message = ValidationConst.PLEASE_SELECT + ValidationConst.ITEM_CUSTOMER_POINT_NAME)
    @ApiModelProperty(value = "名称", name = "nm")
    private String name;

效果
在这里插入图片描述

实现自定义校验注解

有些时候我们还需要一些自定义的校验

编写自定义校验注解

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import javax.validation.Constraint;
import javax.validation.Payload;

@Target( {ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE })  
@Retention(RetentionPolicy.RUNTIME)  
@Constraint(validatedBy = MyCheckImpl.class)  
public @interface MyCheck {

    String message() default "未知错误";  

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

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

}

实现类

import java.lang.annotation.Annotation;

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

public class MyCheckImpl implements ConstraintValidator<Annotation, String>{

    public void initialize(Annotation arg0) {
    
    }

    public boolean isValid(String arg0, ConstraintValidatorContext arg1) {
        
        // 具体校验方法
        if("男".equals(arg0)||"女".equals(arg0)){
            return true;
        }
    
        return false;

    }

}

在之前的实体类中使用我们的自定义校验
在这里插入图片描述

和spring的validation区别

导包

import org.springframework.validation.annotation.Validated;
import javax.validation.Valid;

在检验Controller的入参是否符合规范时，使用@Validated或者@Valid在基本验证功能上没有太多区别。但是在分组、注解地方、嵌套验证等功能上两个有所不同：

1.1 分组

@Validated：提供了一个分组功能
@Valid：作为标准JSR-303规范，还没有分组的功能。

1.2 注解地方

@Validated：可以用在类型、方法和方法参数上。但是不能用在成员属性（字段）上
@Valid：可以用在方法、构造函数、方法参数和成员属性（字段）上

1.3 嵌套验证

@Validated：用在方法入参上无法单独提供嵌套验证功能。不能用在成员属性（字段）上，也无法提示框架进行嵌套验证。能配合嵌套验证注解@Valid进行嵌套验证。

@Target({ElementType.TYPE, ElementType.METHOD,ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Validated {
	Class<?>[] value() default {}; #需要定义类型做区分,所以提供个接口做分组区分
}

//示例分类接口:
public interface CreateGroup {}

//在需要验证的字段上添加分组即可
public class WebOrderQo {
	/**
	* 用户ID
	*/
    @ApiModelProperty("用户ID")
    @NotNull(message = "用户ID不能为空", groups = {UpdateGroup.class, CreateGroup.class, QueryGroup.class})
   	private Long uid;
}
    
//在Controller里面的方法上加@Validated注解,启动分组需要在@Validated(CreateGroup.class)填上对应的分组类型,默认没有指定分组的校验注解@NotNull，在分组校验情况@Validated({CreateGroup.class})下不生效，只会在@Validated生效；
@RestController
public class ItemController {
	@RequestMapping("/item/add")
	public void addItem(@Validated Item item, BindingResult bindingResult) {
	    doSomething();
	}
}

@Valid：用在方法入参上无法单独提供嵌套验证功能。能够用在成员属性（字段）上，提示验证框架进行嵌套验证。能配合嵌套验证注解@Valid进行嵌套验证

public class Item {

	@NotNull(message = "id不能为空")
	@Min(value = 1, message = "id必须为正整数")
	@ListValue(vals = {0,1})  //自定义注解
	private Long id;

	@Valid // 嵌套验证必须用@Valid
	@NotNull(message = "props不能为空")
	@Size(min = 1, message = "props至少要有一个自定义属性") //嵌套验证
	private List<Prop> props;
}

Validated和Valid和自定义校验注解的组合使用

import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

import javax.validation.Valid;
import javax.validation.constraints.NotEmpty;
import java.util.List;

/**
 * 组合SKU
 *
 * @author lzq
 */
@Api(tags = "xxx")
@RestController
@RequestMapping("xxx/xxx/xxxx")
@Validated
@Slf4j
public class CombinationSkuController {

    @ApiOperation(value = "xxxxx")
    @PostMapping()
    @Trim
    public CommonResponseGeneric<CombinationSkuDetail> updateCombination(@RequestHeader HttpHeaders headers, @RequestBody @Valid UpdateCombinationSkuReq req) {
        log.info("POST /goods/commodity/combination ====> [RequestBody : {}]", req);
        CombinationSkuDetail combinationSkuDetail = combinationSkuBiz.updateCombination(headers, req);
        log.info("POST /goods/commodity/combination <====");
        return CommonResponseGeneric.<CombinationSkuDetail>builder().data(combinationSkuDetail).build();
    }

    @ApiOperation(value = "删除组合sku")
    @PostMapping("delete")
    public CommonResponseGeneric<BatchOperationGenericRes<BatchDeleteSkuRes>> deleteCombination(@RequestHeader HttpHeaders headers,
                                                                    @RequestBody
                                                                    @NotEmpty(message = ValidationConst.PLEASE_SELECT + ValidationConst.ITEM_DELETE_BASE_INFO)
                                                                            List<Long> ids) {
        log.info("POST /goods/commodity/combination/delete ====> [ids : {}]", ids);
        BatchOperationGenericRes<BatchDeleteSkuRes> batchOperationGenericRes = goodsSkuBiz.delete(headers, ids);
        log.info("POST /goods/commodity/combination/delete <====");
        return CommonResponseGeneric.<BatchOperationGenericRes<BatchDeleteSkuRes>>builder().data(batchOperationGenericRes).build();
    }
 }

@NotEmpty中消息传的常量是自定义报错信息

@Trim是自定义注解，用于清除字符串前后的空格注解，aop实现具体参考：
https://github.com/javaniuniu/springboot-buckets/tree/master/springboot-aop-format

Koikoi123

关注

6
点赞
踩
17

收藏

觉得还不错? 一键收藏
0
评论
javax.validation详解，全局异常处理，如何实现自定义校验注解，以及和spring的validation区别

当进行逻辑处理的时候，我们首先要做的想必一定是参数校验，这时候需要使用javax.validation进行参数校验。javax.validation可用的注解空检查@Null 验证对象是否为null@NotNull 验证对象是否不为null, 无法查检长度为0的字符串@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.@NotEmpty 检查约束元素是否为NULL或者是EMPTY.Booelan检查@AssertTrue 验证 Boo
复制链接

扫一扫