javax.validation 参数校验

人,一定要靠自己 没有人会关心你付出过多少努力,撑得累不累,摔得痛不痛,他们只会看你最后站在什么位置,然后羡慕或者鄙夷 本文由博客端 https://www.zhaozhizheng.com 主动推送

参数校验往往让人心塞,各种判断匹配。基本的参数校验例如实体校验可以通过如下方法解决,但是因为我们的请求响应结果都是加密字符,需要解密后才能校验,所以在此的基础上增加第二段的方式,通过封装工具类的方法完成。

————————————————
版权声明:本文为 CSDN 博主「LailaiMonkey」的原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接及本声明。
原文链接:https://blog.csdn.net/h273979586/article/details/105572872
如果是 Spring 项目那么这个架构依赖会自动引用,如果是非 Spring 项目得手动引用一下依赖。本文以 Spring 项目为主:

<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>2.0.1.Final</version>
</dependency>
<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.0.16.Final</version>
    <scope>compile</scope>
</dependency>

这是注解包里面元素:

@AssertFalse 被注释的元素必须为 false
@AssertTrue 被注释的元素必须为 true
@DecimalMax(value) 被注释的元素必须是一个数字,其值必须小于等于指定的最大值
@DecimalMin(value) 被注释的元素必须是一个数字,其值必须大于等于指定的最小值
@Digits (integer, fraction) 被注释的元素必须是一个数字,其值必须在可接受的范围内
@Email 被注释的元素必须是电子邮箱地址
@Future 被注释的元素必须是一个将来的日期
@Max(value) 被注释的元素必须是一个数字,其值必须小于等于指定的最大值
@Min(value) 被注释的元素必须是一个数字,其值必须大于等于指定的最小值
@NotBlank 验证注解的元素值不为空(不为 null 并去除首尾位空格)
@NotEmpty 验证注解的元素值不为 null 且不为空(字符串长度不为 0、集合大小不为 0)
@NotNull 不为 null
@Null 为 null
@Past 限制必须是一个过去的日期
@Pattern(value) 限制必须符合指定的正则表达式
@Size(max,min) `B 限制字符长度必须在 min 到 max 之间
验证规则
在 Spring 项目中定义一个需要验证的 model 内容如下:
@Data
public class ValidatorModel {

@NotBlank(message = "姓名不能为空")
    private String name;
    
    @Size(min = 3, max = 6)
    private List<String> friendNames;
    
    @Min(value = 18, message = "年龄未满18岁")
    @Max(value = 60, message = "年龄必须在60岁以下")
    private Integer age;
    
    private String tel;
    
    @DecimalMin(value = "30", message = "金钱不能小于30")
    private BigDecimal money;

service 接口内容如下:
因为是 javax 的验证构架所以在没有 Spring 时候也可以进行验证,注解得写在接口上,如果写在实现类将无效!!!

//开启验证注解
@Validated
public interface ValidatorService {
    void validator(@Valid ValidatorModel model, @NotNull String param);
}

service 实现类就是正常逻辑处理这里不在演示了。

controller 内容如下:
controller 接收参数传递给 service,在 service 接口进行参数验证,如果失败将抛出异常。

@RestController
public class ValidatorController {

    @Autowired
    private ValidatorService validatorService;
    
    @GetMapping
    public void validator() {
        ValidatorModel model = new ValidatorModel();
        model.setName("张三");
        model.setFriendNames(Arrays.asList("李四", "王五"));
        model.setAge(20);
        model.setTel("188888888881");
        model.setMoney(new BigDecimal(100));
        validatorService.validator(model,"也可以在参数上做验证");
    }
}

异常截图:
以上是 Javax Validation 校验常用方法,可以满足多数情况,但是项目中遇到的都是少数情况,例如:
添加时候需要对所有参数进行验证,更新时候只需要对某个几参数或有值的参数进行验证(分组验证)。
可不可以自定义验证规则,我要验证性别,只能是男或女(自定义验证规则)。
分组验证
添加时候需要验证 friendNames 字段,更新时候需要验证 name 字段,这时得引用分组验证,修改 ValidatorModel 如下:

@Data
public class ValidatorModel {

    /**
     * 添加分组
     */
    public interface Create {
    }
    
    /**
     * 更新分组
     */
    public interface Update {
    }
    
    /**
     * 分组可以指定多个,用{}表示
     * 分组为:默认分组、更新分组
     */
    @NotBlank(message = "姓名不能为空", groups = {Default.class, Update.class})
    private String name;
    
    /**
     * 分组为添加分组
     */
    @Size(min = 3, max = 6, groups = {Create.class})
    private List<String> friendNames;
    
    @Min(value = 18, message = "年龄未满18岁")
    @Max(value = 60, message = "年龄必须在60岁以下")
    private Integer age;
    
    private String tel;
    
    @DecimalMin(value = "30", message = "金钱不能小于30")
    private Integer money;
}

把校验参数注解写在 Controller 上,别忘了在 Controller 上加 @Validated 注解哈!!!

@Validated
@RestController
public class ValidatorController {

    @Autowired
    private ValidatorService validatorService;
    
    @GetMapping
    public void validator() {
        ValidatorModel model = new ValidatorModel();
        model.setName("张三");
        model.setFriendNames(Arrays.asList("李四", "王五"));
        model.setAge(2);
        model.setTel("188888888881");
        model.setMoney(100);
        model.setEmail("a");
        validatorService.validator(model, "也可以在参数上做验证");
    }
    
    @GetMapping("/group")
    public void validatorGroup(@Validated({ValidatorModel.Create.class}) ValidatorModel model) {
        validatorService.validatorGroup(model, "也可以在参数上做验证");
    }
}

这样就可以实现分组验证了。
注意:model 里有一个默认分组,如果指定分组就按分组来验证参数,而没有指定的分组属于默认分组,上图的 Controller 不会对默认分组进行验证,写成 @Validated({ValidatorModel.Create.class, Default.class})把默认分组加进去就可以验证了。如下:

@GetMapping("/group")
	public void validatorGroup(@Validated({ValidatorModel.Create.class, Default.class}) ValidatorModel model) {
	    validatorService.validatorGroup(model, "也可以在参数上做验证");
	}

自定义验证规则
那如果我想验证手机怎么办呢?它里面没有提供,不要慌小朋友,使用自定义注解验证就可以了,它提供了接口我们只需要实现一下就好了。

首先需要我们自定义一个验证手机号的注解(MonkeyTel),并指定其实现类,在实现写验证的逻辑就可以了。注解如下:

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.PARAMETER, ElementType.FIELD})
// 指定真正实现校验规则的类
@Constraint(validatedBy = MonkeyJavaTelImpl.class)
public @interface MonkeyJavaTel {
    String message() default "手机号必须是11位";

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

实现类如下:

/**
 * @Author: LailaiMonkey
 * @Description:
 * String:参数类型
 * @Date:Created in 2020-04-17 15:19
 * @Modified By:
 */
 public class MonkeyJavaTelImpl implements ConstraintValidator<MonkeyJavaTel, String> {

    /**
     * 手机号是十一位为ture
     * @param value 值
     * @param context
     * @return
     */
     @Override
     public boolean isValid(String value, ConstraintValidatorContext context) {
        return  value.length() == 11;
     }
  }

项目结构如下:
忽略 monkeyValidator 包,自定义注解校验规则,有兴趣的小伙伴可以看下一篇博客:自定义校验注解框架自定义校验注解框架

自定义验证规则
缺点:
此注解只能写有接口或 Controller 上才管用,如果写在实现类上是无效的。而且逻辑都写在实现类上,不知道哪些参数进行验证,还得返回到接口或 Controller 上查询才可以。
不支持 List 集合验证,实现起来困难,只支持简单 model 验证。
分组验证只能写在 Controller 上,写在接口不起作用(坑)。
如果一个接口有多个实现类这个注解就不能再用了。

优点:
自定义注解实现简单,上手快。

使用工具类校验
校验工具类:

package com.alibaba.banff.web.util;
 
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
 
import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.groups.Default;
 
/**
 * 校验工具类
 * 
 * @author lizhilong
 */
public class ValidationUtils {
 
    private static Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
 
    public static <T> ValidationResult validateEntity(T obj) {
        ValidationResult result = new ValidationResult();
        Set<ConstraintViolation<T>> set = validator.validate(obj, Default.class);
        // if( CollectionUtils.isNotEmpty(set) ){
        if (set != null && set.size() != 0) {
            result.setHasErrors(true);
            Map<String, String> errorMsg = new HashMap<String, String>();
            for (ConstraintViolation<T> cv : set) {
                errorMsg.put(cv.getPropertyPath().toString(), cv.getMessage());
            }
            result.setErrorMsg(errorMsg);
        }
        return result;
    }
 
    public static <T> ValidationResult validateProperty(T obj, String propertyName) {
        ValidationResult result = new ValidationResult();
        Set<ConstraintViolation<T>> set = validator.validateProperty(obj, propertyName, Default.class);
        if (set != null && set.size() != 0) {
            result.setHasErrors(true);
            Map<String, String> errorMsg = new HashMap<String, String>();
            for (ConstraintViolation<T> cv : set) {
                errorMsg.put(propertyName, cv.getMessage());
            }
            result.setErrorMsg(errorMsg);
        }
        return result;
    }
}

校验工具类返回的数据 ValidationResult(省略 getset):

package com.aliyun.prophet.facade.partner.flaw;
 
import java.util.Map;
 
/**
 * 校验结果
 * 
 * @author lizhilong
 */
public class ValidationResult {
 
    // 校验结果是否有错
    private boolean             hasErrors;
 
    // 校验错误信息
    private Map<String, String> errorMsg;
}

Person 类(省略 getset):

package com.aliyun.prophet.facade.partner.flaw;
 
import org.hibernate.validator.constraints.Length;
import org.hibernate.validator.constraints.NotEmpty;
import org.hibernate.validator.constraints.Range;
 
public class Person {
    @Length(max=20,message="姓名长度不能大于20")
    @NotEmpty(message="姓名不能为空")
    private String name;
    @Range(min = 0, max = 1, message = "性别只能输入只能输入0或1")
    private Integer gender;
    private Integer age;
}

使用方法:

/**
 * 
 * @author: lizhilong
 */
public class Test {
    @org.junit.Test
    public void testValidation(){
        Person person = new Person();
        person.setAge(12);
        person.setGender(2);
//       person.setName("李智龙");
        ValidationResult result = ValidationUtils.validateEntity(person);
        Map<String, String> map = result.getErrorMsg();
        boolean isError = result.isHasErrors();
        System.out.println("isError: " +isError);
        System.out.println(map);
    }
}

打印结果:

isError: true
{gender=性别只能输入只能输入0或1, name=姓名不能为空}

是不是很简单呀,几步搞定,根本不用 spring 便可封装一个好用的工具类
————————————————
版权声明:本文为 CSDN 博主「熬夜是小狗」的原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接及本声明。
原文链接:https://blog.csdn.net/icannotdebug/article/details/78708202

  • Java

    Java 是一种可以撰写跨平台应用软件的面向对象的程序设计语言,是由 Sun Microsystems 公司于 1995 年 5 月推出的。Java 技术具有卓越的通用性、高效性、平台移植性和安全性。

    2990 引用 • 8141 回帖 • 593 关注
  • Spring

    Spring 是一个开源框架,是于 2003 年兴起的一个轻量级的 Java 开发框架,由 Rod Johnson 在其著作《Expert One-On-One J2EE Development and Design》中阐述的部分理念和原型衍生而来。它是为了解决企业应用开发的复杂性而创建的。框架的主要优势之一就是其分层架构,分层架构允许使用者选择使用哪一个组件,同时为 JavaEE 应用程序开发提供集成的框架。

    897 引用 • 1443 回帖 • 559 关注

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...