java后端验证参数 java接口参数校验

转载

云中谁寄锦书来 2023-09-26 11:57:27

文章标签 java后端验证参数 java 校验字符串 List 文章分类 Java 后端开发

2021-11-19

1 @Validated 
如果是get接口,打散的参数,

需要用校验;@Validated必须放在类上;

JSR303

what

SR-303 是 Java EE 6 中的一项子规范，叫做 Bean Validation，官方参考实现是Hibernate Validator。

此实现与 Hibernate ORM 没有任何关系。 JSR 303 用于对 Java Bean 中的字段的值进行验证。
Spring MVC 3.x 之中也大力支持 JSR-303，可以在控制器中对表单提交的数据方便地验证。
使用场景：一般用于表单提交页面

如何在service层是用

自己手动写

细则

空检查 
@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 对象是否符合正则表达式的规则，被注释的元素符合制定的正则表达式，regexp:正则表达式 flags: 指定 Pattern.Flag 的数组，表示正则表达式的相关选项。

数值检查 
建议使用在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=) 被指定的元素必须在合适的范围内 
@Range(min=10000,max=50000,message=”range.bean.wage”) 
@Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证) 
@CreditCardNumber信用卡验证 
@Email 验证是否是邮件地址，如果为null,不进行验证，算通过验证。 
@ScriptAssert(lang= ,script=, alias=) 
@URL(protocol=,host=, port=,regexp=, flags=)

java接口拿到参数会进行解密或者参数的校验。我一般使用JavaEE的校验工具包：

java后端验证参数 java接口参数校验_List

思想：

直接校验所有的参数，然后抛出异常，你的异常的抛出在接口处进行抓取和返回：

举例：

@PostMapping("/v1.0/cardType")
    public CommonResult cardTypexx(@RequestParam Map entity) {
        JSONObject data ;
        try {
            data = (JSONObject) service.cardType(entity);
        } catch (InvocationTargetException | IllegalAccessException e) {
            e.printStackTrace();
            return new CommonResult(ResultStatusEnum.ERROR);
        }catch (DataValidateException exception) {
            return new CommonResult(ResultStatusEnum.REQUEST_PARAM_ERROR, exception.getMessage());
        } catch (HttpException e) {
            return new CommonResult(ResultStatusEnum.ERROR, e.getMessage());
        }
        return new CommonResult(ResultStatusEnum.SUCCESS, data);
    }

DataValidateException是我自己定义的校验不合格抛出的异常：

public class DataValidateException extends RuntimeException {

	private static final long serialVersionUID = 1L;
	
	private String message;

    public DataValidateException(String message) {
        super(message);
        this.message = message;
    }

    @Override
    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}

自己写个异常的捕获工具类：

private static final Logger log = LoggerFactory.getLogger(AnotationTest.class);
    private static   Validator validator = Validation.buildDefaultValidatorFactory().getValidator();

//如何检验手机号码和身份证号码是否正确？

    /**
     * 参数校验
     * @param t
     * @param <T>
     */
    public static  <T> void validate(T t) {
        Set<ConstraintViolation<T>> constraintViolations = validator.validate(t);//是个集合校验性的东西
        List<String> messageList = new ArrayList<>();
        for (ConstraintViolation<T> constraintViolation : constraintViolations) {
            messageList.add(constraintViolation.getMessage());
        }
        if (messageList != null && messageList.size() != 0) {
            throw new DataValidateException(messageList.get(0));//我这里抛出第一条
        }
    }

你的实体必须写的非常到位，注解和message都必须定义的非常的清楚

举例：

@Data
public class Student {
    @NotNull(message = "name can not be null")
    public String name;
    @NotNull
    public String hbi;

    @Pattern(regexp = "^1\\d{10}$", message = "手机号格式不正确")//message 必须要
    private String phone;

    public Student() {
    }

    public Student(@NotNull(message = "name can not be null") String name, @NotNull String hbi, @NotNull(message = "phone不能为空") @Pattern(regexp = "^1\\d{10}$", message = "手机号格式不正确") String phone) {
        this.name = name;
        this.hbi = hbi;
        this.phone = phone;
    }
}

测试一

public class AllTest {//全部参数的所有校验，使用注解

    public static void main(String[] args) {
        Student student = new Student(null, "", "11");//手机号可以定义位空
        AnotationTest.validate(student);
    }
}

结果：

java后端验证参数 java接口参数校验_字符串_02

测试二

public class AllTest {//全部参数的所有校验，使用注解

    public static void main(String[] args) {
        Student student = new Student("", "", "11");//手机号可以定义位空
        AnotationTest.validate(student);
    }
}

java后端验证参数 java接口参数校验_java后端验证参数_03

总结
一：使用javaEE的包和hibernate下的都是可以的。
hibernate可以参考

二：不要在自己写一堆校验了，使用框架校验更加精确，自己写校验时常费力不讨好
三：校验完毕最好还要使用StringUtils的trim()，将空格去掉！！！！！
四：有问题可以发消息，我会回复的

天坑巨坑大坑

用@Valid

@NotEmpty(message = “beginDate can not be empty”)
@Pattern(regexp = “\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}”, message = "beginDate must format be yyyy-MM-dd HH:mm:ss")
@ApiModelProperty(“开始日期 yyyy-MM-dd HH:mm:ss格式”)
private String beginTime;
坑王，正则校验按照字节走，必须保证在英文下给到空格！呜呜呜呜
中文一个字是两个字节，而一个英文字母是占据一个字节。