在上一篇文章中我们集成了swagger ui,搭建了一个restful风格的接口，当进行逻辑处理的时候，我们首先要做的想必一定是参数校验，这篇文章描述了使用javax.validation进行参数校验。
1.新建实体类，加上javax.validation的注解
import org.hibernate.validator.constraints.NotBlank;
import org.hibernate.validator.constraints.Range;
public class Student {
@Range(min = 18, max = 60, message = "年龄不合适")
private int age;
@NotBlank(message = "学校不能为空")
private String school;
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
public String getSchool() {
return school;
}
public void setSchool(String school) {
this.school = school;
}
}
2.在controller进行如下修改
@ApiImplicitParam(name = "student", value = "普通用户", required = true, dataType = "Student")
@RequestMapping(value = "/second", method = RequestMethod.POST)
public Result test2(@RequestBody @Valid Student student, BindingResult bindingResult){
//在这里，我们判断参数是否通过校验
if (bindingResult.hasErrors()) {
String message = bindingResult.getFieldError().getDefaultMessage();
//自定义的返回，并将错误信息返回
return Result.error(message);
}
return Result.commonSuccess();
}
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=)
3.当然，有些时候我们还需要一些自定义的校验
编写自定义校验注解
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;
}
}
在之前的实体类中使用我们的自定义校验
企业微信截图_15263948059898.png
4.测试下效果：
企业微信截图_15263950374943.png
[图片上传中...(企业微信截图_15263952481263.png-f7b8ab-1526395323239-0)]
企业微信截图_15263952481263.png
企业微信截图_15263952657919.png
网友评论