项目中java后端实体注解参数校验

与梦想同在

已于 2023-10-11 10:43:28 修改

阅读量3.5k

点赞数 1

分类专栏： JAVA 文章标签： java spring 正则表达式

于 2020-04-27 10:19:20 首次发布

本文链接：https://blog.csdn.net/qq_41973154/article/details/105783778

版权

JAVA 专栏收录该内容

36 篇文章 0 订阅

订阅专栏

首先需要在传参的bean实体类中添加注解。

public class People {
	/** 姓名.*/
    @ApiModelProperty(value = "姓名, 长度: 10", required = false)
    @NotNull
    @Valid
    @Size(max = 10, message = "姓名长度不能超过10")
    private String name;
    /** 年龄.*/
    @ApiModelProperty(value = "年龄, 长度: 10", required = false)
    @Max(value = 150, message = "年龄不允许超过150岁且必须为数字")
    private Integer age;
      /** 手机号.*/
 	@ApiModelProperty(value = "手机号, 长度: 11", required = false)
 	@Pattern(regexp = "^(13[0-9]|14[01456879]|15[0-35-9]|16[2567]|17[0-8]|18[0-9]|19[0-35-9])\d{8}$" ,message = "手机号不合法")
   private Integer phone;
     /** 邮箱.*/
    @ApiModelProperty(value = "邮箱, 长度: 30", required = false)
    @Email(regexp = "^[a-zA-Z0-9_-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$" ,message = "email不合法")
    private String email;
	/** 资产.*/
    @ApiModelProperty(value = "资产, 长度: 100", required = false)
    @Digits(integer=20, fraction=6,,message = "资产最多26位，包含6位小数")
    private Double money;

}

接着需要在Controller的请求参数写入注解实体类

@ApiOperation("添加")
@RequestMapping(value = "", method = RequestMethod.POST)
public BaseResult<String> create(@RequestBody @Valid People input, BindingResult br) {
	//校验参数
    verifyParams(br);
    People people= new People ();
    BeanUtils.copyProperties(input, people);
    busAnalyzePeriodService.saveBusAnalyzePeriod(busAnalyzePeriod);
    return BaseResult.SUCCESS;
}

写一些参数校验的方法

/**
* 参数检查
*/
protected void verifyParams(BindingResult br) {
   if (br.hasErrors()) {
       StringBuilder sb = new StringBuilder();
       List<ObjectError> allErrors = br.getAllErrors();
       for (int i = 0; i < allErrors.size(); i++) {
           sb.append(allErrors.get(i).getDefaultMessage());
           if (i != allErrors.size() - 1) {
               sb.append("|");
           }
       }
       throw new GlobalException(BaseResultEnum.PARAMERROR, sb.toString());
   }
}

/**
* 检查分页参数的正确性
*/
protected void checkPage(Page page) {
   long current = page.getCurrent();
   if (current <= 0) {
       page.setCurrent(DEFAULT_PAGE_CURRENT);
   }
   long size = page.getSize();
   if (size > DEFAULT_PAGE_SIZE_MAX) {
       page.setSize(DEFAULT_PAGE_SIZE_MAX);
   }
   if (size < DEFAULT_PAGE_SIZE_MIN) {
       page.setSize(DEFAULT_PAGE_SIZE_MIN);
   }
}

如果需要多个注解，字段上面增加 @Valid

Spring的相关注解

注解	类型	描述
@AssertFalse	Boolean,boolean	验证注解的元素值是false
@AssertTrue	Boolean,boolean	验证注解的元素值是true
@NotNull	任意类型	验证注解的元素值不是null
@Null	任意类型	验证注解的元素值是null
@Min(value=值)	任何Number或CharSequence（存储的是数字）子类型	验证注解的元素值大于等于@Min指定的value值
@Max（value=值）	和@Min要求一样	验证注解的元素值小于等于@Max指定的value值
@DecimalMin(value=值)	和@Min要求一样	验证注解的元素值大于等于@ DecimalMin指定的value值
@DecimalMax(value=值)	和@Min要求一样	验证注解的元素值小于等于@ DecimalMax指定的value值
@Digits(integer=整数位数, fraction=小数位数)	和@Min要求一样	验证注解的元素值的整数位数和小数位数上限
@Size(min=下限, max=上限)	字符串、Collection、Map、数组等	的元素值的在min和max（包含）指定区间之内，如字符长度、集合大小
@Past	Date,Calendar;Time类库的日期类型	验证注解的元素值（日期类型）比当前时间早
@Future	与@Past要求一样	验证注解的元素值（日期类型）比当前时间晚
@NotBlank	CharSequence子类型	验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的首位空格
@Length(min=下限, max=上限)	CharSequence子类型	验证注解的元素值长度在min和max区间内
@NotEmpty	值不为null且不为空（字符串长度不为0、集合大小不为0）
@Range(min=最小值, max=最大值)	原子类型和包装类型	验证注解的元素值在最小值和最大值之间
@Email(regexp=正则表达式,flag=标志的模式)	CharSequence子类型(如String)	验证注解的元素值是Email，也可以通过regexp和flag指定自定义的email格式
@Pattern(regexp=正则表达式,flag=标志的模式)	String,任何子类型验证	注解的元素值与指定的正则表达式匹配
@Valid	任何非原子类型	指定递归验证关联的对象,如用户对象中有个地址对象属性，如果想在验证用户对象时一起验证地址对象的话，在地址对象上加@Valid注解即可级联验证