Javabean Validation

最新推荐文章于 2024-07-28 15:54:46 发布
最新推荐文章于 2024-07-28 15:54:46 发布
阅读量1.2k 收藏
点赞数
文章标签： J2EE JavaBean
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/cmmchenmm/article/details/82804219
版权

JSR 303

    参数校验是我们程序开发中必不可少的过程。用户在前端页面上填写表单时，前端js程序会校验参数的合法性，当数据到了后端，为了防止恶意操作，保持程序的健壮性，后端同样需要对数据进行校验。后端参数校验最简单的做法是直接在业务方法里面进行判断，当判断成功之后再继续往下执行。但这样带给我们的是代码的耦合，冗余。当我们多个地方需要校验时，我们就需要在每一个地方调用校验程序,导致代码很冗余，且不美观。那么如何优雅的对参数进行校验呢？JSR303就是为了解决这个问题出现的.

JSR303 是一套JavaBean参数校验的标准，它定义了很多常用的校验注解，我们可以直接将这些注解加在我们JavaBean的属性上面，就可以在需要校验的时候进行校验了。注解如下

@NotNull 注解元素必须是非空
@Null 注解元素必须是空
@Digits 验证数字构成是否合法
@Future 验证是否在当前系统时间之后
@Past 验证是否在当前系统时间之前
@Max 验证值是否小于等于最大指定整数值
@Min 验证值是否大于等于最小指定整数值
@Pattern 验证字符串是否匹配指定的正则表达式
@Size 验证元素大小是否在指定范围内
@DecimalMax 验证值是否小于等于最大指定小数值
@DecimalMin 验证值是否大于等于最小指定小数值
@AssertTrue 被注释的元素必须为true
@AssertFalse 被注释的元素必须为false
Hibernate validator 在JSR303的基础上对校验注解进行了扩展，扩展注解如下：
@Email 被注释的元素必须是电子邮箱地址
@Length 被注释的字符串的大小必须在指定的范围内
@NotEmpty 被注释的字符串的必须非空
@Range 被注释的元素必须在合适的范围内

Spring 中使用代码示例

  • 下面一段代码就是一个基本的JavaBean对象的校验实例代码
//JavaBean 对象

@Data
public class User {
    @Max(10000L)
    private long id;

    @NotNull
    private String name;

    @CardNumerValidation
    private String cardNumber;
}

//控制层代码
@RestController
public class UserController {

    @PostMapping("/user")
    public User save(@Validated @RequestBody User user){
        return user;
    }
}
  • 演示情况

1534597994891

  • 错误代码
{
    "timestamp": "2018-08-18T13:15:29.503+0000",
    "path": "/user",
    "status": 400,
    "error": "Bad Request",
    "message": "Validation failed for argument at index 0 in method: public cn.hyperchain.validation.User cn.hyperchain.validation.UserController.save(cn.hyperchain.validation.User), with 1 error(s): [Field error in object 'user' on field 'id': rejected value [1000000]; codes [Max.user.id,Max.id,Max.long,Max]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [user.id,id]; arguments []; default message [id],10000]; default message [最大不能超过10000]] ",
    "errors": [
        {
            "codes": [
                "Max.user.id",
                "Max.id",
                "Max.long",
                "Max"
            ],
            "arguments": [
                {
                    "codes": [
                        "user.id",
                        "id"
                    ],
                    "arguments": null,
                    "defaultMessage": "id",
                    "code": "id"
                },
                10000
            ],
            "defaultMessage": "最大不能超过10000",
            "objectName": "user",
            "field": "id",
            "rejectedValue": 1000000,
            "bindingFailure": false,
            "code": "Max"
        }
    ]
}

扩展 Validation

  • 目标 -> 自定义一个校验规则处理
    • 自定义一个注解
    • 自定义一个注解的处理
    • 测试验证
    • 如果可以看看源码

1.自定义注解

  • 首先先观察已有的注解以 @NotNull 为例说明
package javax.validation.constraints;

@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Repeatable(List.class)  //暂时没有使用到
@Documented
@Constraint(validatedBy = { })  //该注解的处理器类数组
public @interface NotNull {

    //该注解进行校验如果校验失败返回的提示信息
    //这里Javax 默认使用的是国际化的处理方式
	String message() default "{javax.validation.constraints.NotNull.message}";

    //分组处理 暂时不用
	Class<?>[] groups() default { };
    //不太懂 有待提高了解
	Class<? extends Payload>[] payload() default { };

	/**
	 * 这个内部类就更加不懂咯
	 * Defines several {@link NotNull} annotations on the same element.
	 *
	 * @see javax.validation.constraints.NotNull
	 */
	@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
	@Retention(RUNTIME)
	@Documented
	@interface List {

		NotNull[] value();
	}
}
  • 查看处理器定义
package javax.validation;

public interface ConstraintValidator<A extends Annotation, T> {

    /**
     * 初始化方法
     * 不过看样子好像也没有什么必要去重写，所以定义的时候直接就给了默认实现方法
     **/
	default void initialize(A constraintAnnotation) {
	}

    /**
     * 核心的校验方法  成功 true  失败 false
     * 
     * T 定义的值类型
     * validation 上下文环境
     **/
	boolean isValid(T value, ConstraintValidatorContext context);
}
  • 开始搞事
/**
 * 自定义注解
 * @author chenmingming
 * @date 2018/8/18
 */
@Target({ FIELD})
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {CardNumberValidator.class})
public @interface CardNumerValidation {
    String message() default "{自定义校验字段不通过}";

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

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

}


/**
 * 自定义注解处理器
 * @author chenmingming
 * @date 2018/8/18
 */
public class CardNumberValidator implements ConstraintValidator<CardNumerValidation,String> {

    @Override
    public void initialize(CardNumerValidation constraintAnnotation) {

    }


    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        String[] split = StringUtils.split(value, "-");
        
        //不开心就搞事 往默认的提示信息里面加点料
        ConstraintValidatorContext.ConstraintViolationBuilder builder =
                context.buildConstraintViolationWithTemplate("没想到吧哈哈哈");

        ConstraintValidatorContext constraintValidatorContext = builder.addConstraintViolation();

        if(ArrayUtils.getLength(split) < 2){
            return false;
        }
        boolean prefix = split[0].equals("CMM");
        boolean suffix = split[split.length-1].endsWith("END");
        return prefix && suffix;
    }
}
  • Postman 测试结果 Response 的响应体
{
    "timestamp": "2018-08-18T13:50:02.905+0000",
    "path": "/user",
    "status": 400,
    "error": "Bad Request",
    "message": "Validation failed for argument at index 0 in method: public cn.hyperchain.validation.User cn.hyperchain.validation.UserController.save(cn.hyperchain.validation.User), with 2 error(s): [Field error in object 'user' on field 'cardNumber': rejected value [CMM-END111]; codes [CardNumerValidation.user.cardNumber,CardNumerValidation.cardNumber,CardNumerValidation.java.lang.String,CardNumerValidation]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [user.cardNumber,cardNumber]; arguments []; default message [cardNumber]]; default message [没想到吧哈哈哈]] [Field error in object 'user' on field 'cardNumber': rejected value [CMM-END111]; codes [CardNumerValidation.user.cardNumber,CardNumerValidation.cardNumber,CardNumerValidation.java.lang.String,CardNumerValidation]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [user.cardNumber,cardNumber]; arguments []; default message [cardNumber]]; default message [{自定义校验字段不通过}]] ",
    "errors": [
        {
            "codes": [
                "CardNumerValidation.user.cardNumber",
                "CardNumerValidation.cardNumber",
                "CardNumerValidation.java.lang.String",
                "CardNumerValidation"
            ],
            "arguments": [
                {
                    "codes": [
                        "user.cardNumber",
                        "cardNumber"
                    ],
                    "arguments": null,
                    "defaultMessage": "cardNumber",
                    "code": "cardNumber"
                }
            ],
            "defaultMessage": "没想到吧哈哈哈",  
            "objectName": "user",
            "field": "cardNumber",
            "rejectedValue": "CMM-END111",
            "bindingFailure": false,
            "code": "CardNumerValidation"
        },
        {
            "codes": [
                "CardNumerValidation.user.cardNumber",
                "CardNumerValidation.cardNumber",
                "CardNumerValidation.java.lang.String",
                "CardNumerValidation"
            ],
            "arguments": [
                {
                    "codes": [
                        "user.cardNumber",
                        "cardNumber"
                    ],
                    "arguments": null,
                    "defaultMessage": "cardNumber",
                    "code": "cardNumber"
                }
            ],
            "defaultMessage": "{自定义校验字段不通过}",
            "objectName": "user",
            "field": "cardNumber",
            "rejectedValue": "CMM-END111",
            "bindingFailure": false,
            "code": "CardNumerValidation"
        }
    ]
}
  • 读读源码
  1. 经过 HttpMessageConvertor 处理反序列化成一个JavaBean
package org.springframework.validation.beanvalidation;

SpringValidatorAdapter

@Override
public void validate(@Nullable Object target, Errors errors) {
	if (this.targetValidator != null) {
		processConstraintViolations(this.targetValidator.validate(target), errors);
	}
}
  1. 进入上面代码中的this.targetValidator.validate里面去看看（这里是hibernate）
  • 包名称 org.hibernate.validator.internal.engine 类名称ValidatorImpl 类定义如下
public class ValidatorImpl implements Validator, ExecutableValidator {
    ...
}
  • 进入validate方法
    @Override
	public final <T> Set<ConstraintViolation<T>> validate(T object, Class<?>... groups) {
		Contracts.assertNotNull( object, MESSAGES.validatedObjectMustNotBeNull() );
		sanityCheckGroups( groups );
        
        //获取验证的上下文环境
		ValidationContext<T> validationContext = getValidationContextBuilder().forValidate( object );

		if ( !validationContext.getRootBeanMetaData().hasConstraints() ) {
			return Collections.emptySet();
		}
    
		ValidationOrder validationOrder = determineGroupValidationOrder( groups );
		ValueContext<?, Object> valueContext = ValueContext.getLocalExecutionContext(
				validatorScopedContext.getParameterNameProvider(),
				object,
				validationContext.getRootBeanMetaData(),
				PathImpl.createRootPath()
		);

		return validateInContext( validationContext, valueContext, validationOrder );
	}
  • 进入validateInContext方法
	private <T, U> Set<ConstraintViolation<T>> validateInContext(ValidationContext<T> validationContext, ValueContext<U, Object> valueContext,
			ValidationOrder validationOrder) {
		if ( valueContext.getCurrentBean() == null ) {
			return Collections.emptySet();
		}

		BeanMetaData<U> beanMetaData = valueContext.getCurrentBeanMetaData();
		if ( beanMetaData.defaultGroupSequenceIsRedefined() ) {
			validationOrder.assertDefaultGroupSequenceIsExpandable( beanMetaData.getDefaultGroupSequence( valueContext.getCurrentBean() ) );
		}

		// process first single groups. For these we can optimise object traversal by first running all validations on the current bean
		// before traversing the object.
		//分组处理
		Iterator<Group> groupIterator = validationOrder.getGroupIterator();
		while ( groupIterator.hasNext() ) {
			Group group = groupIterator.next();
			valueContext.setCurrentGroup( group.getDefiningClass() );
			//我们的核心处理代码就是在这一步调用处理的
			validateConstraintsForCurrentGroup( validationContext, valueContext );
			if ( shouldFailFast( validationContext ) ) {
				return validationContext.getFailingConstraints();
			}
		}
		groupIterator = validationOrder.getGroupIterator();
		while ( groupIterator.hasNext() ) {
			Group group = groupIterator.next();
			valueContext.setCurrentGroup( group.getDefiningClass() );
			validateCascadedConstraints( validationContext, valueContext );
			if ( shouldFailFast( validationContext ) ) {
				return validationContext.getFailingConstraints();
			}
		}

		// now we process sequences. For sequences I have to traverse the object graph since I have to stop processing when an error occurs.
		Iterator<Sequence> sequenceIterator = validationOrder.getSequenceIterator();
		while ( sequenceIterator.hasNext() ) {
			Sequence sequence = sequenceIterator.next();
			for ( GroupWithInheritance groupOfGroups : sequence ) {
				int numberOfViolations = validationContext.getFailingConstraints().size();

				for ( Group group : groupOfGroups ) {
					valueContext.setCurrentGroup( group.getDefiningClass() );

					validateConstraintsForCurrentGroup( validationContext, valueContext );
					if ( shouldFailFast( validationContext ) ) {
						return validationContext.getFailingConstraints();
					}

					validateCascadedConstraints( validationContext, valueContext );
					if ( shouldFailFast( validationContext ) ) {
						return validationContext.getFailingConstraints();
					}
				}
				if ( validationContext.getFailingConstraints().size() > numberOfViolations ) {
					break;
				}
			}
		}
		return validationContext.getFailingConstraints();
	}
  • 验证后续处理
    包名称org.springframework.web.reactive.result.method.annotation
    类名称AbstractMessageReaderArgumentResolver
    方法名validate
    private void validate(Object target, Object[] validationHints, MethodParameter param, BindingContext binding, ServerWebExchange exchange) {
        String name = Conventions.getVariableNameForParameter(param);
        WebExchangeDataBinder binder = binding.createDataBinder(exchange, target, name);
        binder.validate(validationHints);
        //要是有出现错误就抛出异常
        if (binder.getBindingResult().hasErrors()) {
            throw new WebExchangeBindException(param, binder.getBindingResult());
        }
    }
    
    //后续就只能交由 Spring MVC 或 WebFlux 处理   
    //经过本人调试 MVC 与 WebFlux 貌似这一步之后的处理逻辑不同
NewshiJ
关注
Bean Validation技术实现对Javabean的校验
08-11
NULL 博文链接：https://ihenu.iteye.com/blog/2231893
Java Bean Validation
weixin_34310369的博客
01-02 125
案例概述 在这本文中，我们将介绍使用标准框架验证Java bean的基础知识 - JSR 380，也称为Bean Validation 2.0。 当然，验证用户输入在大多数应用程序中是一个超常见的要求，Java Bean Validation框架已经成为处理这种逻辑的事实上的标准。 JSR 380 JSR 380是用于bean验证的Java API的规范，是JavaEE和JavaSE的一部...
Java中的数据绑定与验证：Bean Validation
最新发布
微赚淘客系统开发者博客
07-28 357
通过本文的示例，我们展示了Java中的数据绑定与验证技术，特别是Bean Validation。Bean Validation通过注解的方式为Java开发者提供了一种声明式的数据验证方式，极大地简化了验证逻辑的实现。它通过注解的方式，在Java Bean上定义约束条件，然后在运行时对这些条件进行验证。接下来，我们定义一个Java Bean，并使用Bean Validation的注解来声明验证规则。除了内置的验证注解，Bean Validation还允许我们创建自定义的验证注解。在这个示例中，我们创建了。
java的Bean Validation 2.0
weixin_34363171的博客
05-06 523
2019独角兽企业重金招聘Python工程师标准>>> ...
javaBean hibernate Validation
猎人在吃肉
05-26 462
文章目录javaBean hibernate Validation 介绍依赖：注解类型入门使用（ 验证的普通 JavaBean ）要校验的对象校验工具类测试自定义校验器定义校验器接口：校验器接口的实现：要验证的对象测试：hibernate的校验模式1、普通模式（默认）2、快速失败返回模式3、配置SpringBoot 时，将 校验模式对象 添加到容器中 javaBean hibernate Vali...
Spring Validation方法实现原理分析
08-27
Spring Validation是Spring框架中的一种校验机制，用于验证JavaBean的属性是否符合JSR-303规范。该机制可以在应用程序中自动验证JavaBean的属性，从而确保数据的正确性和完整性。 在Spring Validation中，Validator...
Spring-Validation 后端数据校验的实现
08-18
这些 annotation 可以被应用于 JavaBean 的成员变量、方法和构造函数参数上，以指定它们的校验规则。 在 Spring Validation 中，常用的 annotation 有： * @NotBlank：验证字符串是否不为空 * @Length：验证字符串...
Java Validation Api使用方法实例解析
09-07
Java Validation API，作为JSR 303标准的一部分，为JavaBean提供了一种优雅的方式来执行数据验证。这个API允许开发者通过注解来定义验证规则，从而简化了业务逻辑中的参数校验。下面我们将详细讨论其使用方法和常见...
JavaBean valication验证实现方法示例
08-24
* 使用 Java 的内置验证机制，例如使用 `javax.validation` 包。 * 使用第三方验证库，例如 Hibernate Validator。 * 使用自定义的验证机制，以满足特殊的业务需求。 6. JavaBean 验证的实例讲解 下面是一个 ...
java validator 框架_Javad的Validator框架概述
weixin_33193480的博客
02-13 562
Java EE 6提出了Bean Validation规范，使用注解的方式对JavaBean 进行约束验证，不局限于某一层次或者某一编程模型，灵活易用。下边将向您系统的介绍该规范的各种特性。概述 Bean Validation 规范Bean 是 Java Bean 的缩写，在 Java 分层架构的实际应用中，从表示层到持久化层，每一层都需要对 Java Bean 进行业务符合性验证，如图...
JavaBean简介及使用
热门推荐
Joywy的专栏
07-23 23万+
一、JavaBean简介 JavaBean是使用Java语言开发的一个可重用的组件，在JSP的开发中可以使用JavaBean减少重复代码，使整个JSP代码的开发更简洁。JSP搭配JavaBean来使用，有以下的优点： 1.可将HTML和Java代码分离，这主要是为了日后维护的方便。如果把所有的程序代码（HTML和Java）写到JSP页面中，会使整个程序代码又多又复杂，造成日后维护上的困难。
JAVA参数校验：Bean Validation
玩具熊猫的博客
01-22 1514
关于 Bean Validation在任何时候，当你要处理一个应用程序的业务逻辑，数据校验是你必须要考虑和面对的事情。应用程序必须通过某种手段来确保输入进来的数据从语义上来讲是正确的。在通常的情况下，应用程序是分层的，不同的层由不同的开发人员来完成。很多时候同样的数据验证逻辑会出现在不同的层，这样就会导致代码冗余和一些管理的问题，比如说语义的一致性等。为了避免这样的情况发生，最好是将验证逻辑与相应...
Validation 参数验证
日拱一卒
01-24 603
https://www.cnblogs.com/xiaogangfan/p/5987659.html
Javabean
molimoli0的博客
05-20 103
JavaBean是一种Java类，而且是一种特殊的、可重用的类。 必须具有无参数的构造器； 所有的属性都是private的； 通过提供setter和getter方法来实现对成员属性的访问。 特点： 是一种约定和习惯； getXxx setXxx isXxx 不是技术，而是一种习惯。 JavaBeans是Java中一种特殊的类，可以将多个对象封装到一个对象（bean）中。特点是可序列化，提供无参构造器，提供getter方法和setter方法访问对象的属性。名称中的“Bean”是用于Ja
JavaBean
qq_43721152的博客
06-08 103
使用者对类内部定义的属性(对象的成员变量)的直接操作会导致数据的错误、混乱或安全性问题 如下例子，将对象的age设为负数，显然不合常理。所以要将age保护起来，防止乱用。 public class Test { public String name; public int age; } public class A { public static void main(String[] args){ Test test=new Test(); test.age=-100; System..
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值