..

SpringBoot#JSR303

__震惊了!,一遍一遍在业务逻辑中编写的验证条件被抽离了!

 

是什么:


-

Java Specification Requests 303 ,用于对javaBean 属性的验证。

-


 

 

 

解决了什么问题:


-

1. 业务中充斥着对javabean属性的验证,这些都是很必要的验证,不能缺少,但是又让代码变得不那么可读,也不方便代码的维护,使用jsr303的相关技术,

    就把对bean的验证抽取了出来,是业务代码更清晰。

-


 

 

 

 

要点:


-

1. 使用Bean Validation 的参考实现,如果使用jpa,那么就已经有了;
2. 使用注解限制bean的属性;
3. 在控制器方法中使用Vaild注解,表示当前参数需要被验证;
4. 紧随Valid注解写上Errors参数,用于接收验证参数时候产生的错误;
5. 如果觉得默认的注解不够用,完全可以自定义自己的验证注解。

-


 

 

 

demo1 【基本使用】:


-

pojo:

_

import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.Past;
import java.util.Date;

public class Person {
    @NotEmpty(message = "姓名不能为空")
    private String username;
    @Past(message = "生日只能是过去的日期")
    private Date birthday;
    
// 省略其他方法 }

  

_

controller:

_

@RestController
@RequestMapping("/t")
public class TestController {

    @PostMapping
    public Object binderTest(@RequestBody @Valid Person p, Errors errors) throws Exception {
        if(errors.hasErrors()){
            throw new Exception(errors.getFieldErrors().toString());
        }else{
            // do something
            // do something
            return p;
        }
    }
}

  

_

 

截图:

 

 

 

 

 

-


 

 

demo02:【自定义constraint】


 -

1.  编写验证所需要的注解;

2. 实现javax.validation.ConstraintValidator接口,可以使用Autowired注解注入其他服务进来;

3.覆写boolean isValid(T value, ConstraintValidatorContext context);方法,完成校验的逻辑;

 

代码:

///////////////////////////////////////////////////////////////////////
///注解///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

@Constraint(validatedBy = {StatusValidator.class})
@Documented
@Target({ElementType.ANNOTATION_TYPE, ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Status {
    String message() default "不正确的状态 , 应该是 'created', 'paid', shipped', closed'其中之一";

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

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



///////////////////////////////////////////////////////////////////////
///验证器//////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.Arrays;

public class StatusValidator implements ConstraintValidator<Status, String> {

    // 特别复杂的验证可能需要我们注入多个服务,也有可能一些验证需要查询数据库
    @Autowired
    private UserService userService;

    private final String[] ALL_STATUS = {"created", "paid", "shipped", "closed"};

    public void initialize(Status status) {

    }
    // 验证方法,此方法中可以调用注入的服务,可以对数据库进行查询~
    public boolean isValid(String value, ConstraintValidatorContext context) {

        User lhn = userService.findUserByUsername("lhn");
        System.out.println(lhn);

        if(Arrays.asList(ALL_STATUS).contains(value))
            return true;
        return false;
    }
}



///////////////////////////////////////////////////////////////////////
///使用///////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////
public class Person {
    @NotEmpty(message = "姓名不能为空")
    private String username;
    @Past(message = "生日只能是过去的日期")
    private Date birthday;
    @Status
    private String status;
}

  

-


 

常用注解:

空检查
@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=) Validates that the annotated string is between min and max included.
 
日期检查
@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=) 检查数字是否介于min和max之间.
@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=)
View Code

 

posted @ 2019-07-30 13:28  罗浩楠  阅读(590)  评论(2)    收藏  举报
..