@NotNull @NotBlank @NotEmpty 踩过的一些坑

@NotNull @NotBlank @NotEmpty 踩过的一些坑

作为一种优雅的参数校验的注解,在使用中稍微不小心就会出现一些错误.这些注解作用在VO实体类中的成员变量上.

首先导入坐标

<!-- javax.validation -->
<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>2.0.1.Final</version>
</dependency>
<!-- javax.annotation -->
<dependency>
    <groupId>javax.annotation</groupId>
    <artifactId>javax.annotation-api</artifactId>
    <version>1.3.2</version>
</dependency>

import com.fasterxml.jackson.annotation.JsonFormat;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.*;

import javax.persistence.Temporal;
import javax.persistence.TemporalType;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
import java.io.Serializable;
import java.util.Date;

@Getter
@Setter
@AllArgsConstructor
@NoArgsConstructor
@Builder(toBuilder = true)
@ApiModel("更改订单基本信息")
public class ScddGgxx implements Serializable {
    private static final long serialVersionUID = 1L;
    @NotBlank(message = "scdh不能为空!")
    private String tenantid;

    @NotBlank(message = "scdh不能为空!")
    private String scdh;

    @NotBlank(message = "jmscdh不能为空!")
    private String jmsch;

    @Temporal(TemporalType.DATE)
    @JsonFormat(shape = JsonFormat.Shape.STRING, timezone = "GMT+8", pattern = "yyyy-MM-dd")
    private Date qwjq;
    
    @NotBlank(message = "khmc不能为空!")
    private String khmc;

    private String sfjj;

    @NotNull(message = "sl不能为空!")
    private int sl;

    @NotBlank(message = "zdl不能为空!")
    private String zdl;

    @NotNull(message = "zsl不能为空!")
    private int zsl;

}

@NotNull 非空校验 可以校验任何类型的参数比如 Map Integer Double 如果这些参数为空的话就会提示校验不通过

@NotBlank 同样是非空校验,不同的是,NotBlank注解只作用于String 类型的参数,如在int类型上的参数加上NotBlank会报异常

@NotEmpty 也是非空校验,可以校验任何类型的参数,与NotBlank不同的是除了非空还保证参数长度大于1否则会提示校验不通过

最最重要的是 想让上面的注解生效必须在控制层的VO前加一个 @Validated注解否则上面的注解不会生效

@RestController
@RequestMapping("/oms")
@Api(tags = "接收OMS款式内容接口")
public class KsContentController {
	 @Autowired
    private KsContentService ksContentService;
/**
 * OMS订单更改接口
 *
 * @param scddGgxx
 * @return Rs
 */
@PostMapping("/rest/updateorder")
@ApiOperation("OMS订单更改接口")
public Rs updateOrder(@Validated @RequestBody ScddGgxx scddGgxx) {
    return ksContentService.updateOrder(scddGgxx);
}
}

此时再次运行程序 别人传参时你自己设置的校验就会生效了除了上面的注解还有很多

@Null 被注释的元素必须为 null

@NotNull 被注释的元素必须不为 null

@AssertTrue 被注释的元素必须为 true

@AssertFalse 被注释的元素必须为 false

@Min(value) 被注释的元素必须是一个数字，其值必须大于等于指定的最小值

@Max(value) 被注释的元素必须是一个数字，其值必须小于等于指定的最大值

@DecimalMin(value) 被注释的元素必须是一个数字，其值必须大于等于指定的最小值

@DecimalMax(value) 被注释的元素必须是一个数字，其值必须小于等于指定的最大值

@Size(max=, min=) 被注释的元素的大小必须在指定的范围内

@Digits (integer, fraction) 被注释的元素必须是一个数字，其值必须在可接受的范围内

@Past 被注释的元素必须是一个过去的日期

@Future 被注释的元素必须是一个将来的日期

@Pattern(regex=,flag=) 被注释的元素必须符合指定的正则表达式

其实你会发现这样写参数校验是多么的优雅!!!