资讯专栏INFORMATION COLUMN

Java学习笔记(八)——数据校验(Hibernate validation)

snowell / 1315人阅读

摘要:在接口服务开发中,难免会校验传入方的参数校验,尤其在请求时,验证字符长度,字符类型是否满足数据库中字段的最大长度及类型,如果不符合条件应及时拦截并返回,避免后续的流程。

公司转java开发也有一段时间了,在实际开发过程中还是会遇到一些问题的,本篇主要记录下接口服务中参数验证相关的开发过程和一些知识点。

在接口服务开发中,难免会校验传入方的参数校验,尤其在post请求时,验证字符长度,字符类型是否满足数据库中字段的最大长度及类型,如果不符合条件应及时拦截并返回,避免后续的流程。

hibernate validator constraint 注解

先了解下提供的注解,基本上常用的都提供了,在代码编写时还是比较方便的,一个注解解决了验证逻辑。

/**Bean Validation 中内置的 constraint**/
@Null   //被注释的元素必须为 null    
@NotNull    //被注释的元素必须不为 null    
@AssertTrue     //被注释的元素必须为 true    
@AssertFalse    //被注释的元素必须为 false    
@Min(value)     //被注释的元素必须是一个数字,其值必须大于等于指定的最小值    
@Max(value)     //被注释的元素必须是一个数字,其值必须小于等于指定的最大值    
@DecimalMin(value)  //被注释的元素必须是一个数字,其值必须大于等于指定的最小值    
@DecimalMax(value)  //被注释的元素必须是一个数字,其值必须小于等于指定的最大值    
@Size(max=, min=)   //被注释的元素的大小必须在指定的范围内    
@Digits (integer, fraction)     //被注释的元素必须是一个数字,其值必须在可接受的范围内    
@Past   //被注释的元素必须是一个过去的日期    
@Future     //被注释的元素必须是一个将来的日期    
@Pattern(regex=,flag=)  //被注释的元素必须符合指定的正则表达式    
    
/**Hibernate Validator 附加的 constraint**//    
@NotBlank(message =)   //验证字符串非null,且长度必须大于0    
@Email  //被注释的元素必须是电子邮箱地址    
@Length(min=,max=)  //被注释的字符串的大小必须在指定的范围内    
@NotEmpty   //被注释的字符串的必须非空    
@Range(min=,max=,message=)  //被注释的元素必须在合适的范围内
简单使用 验证字段添加需要的注解
    /**
     * 订单号
     */
    @Range(min=1,message = "不是正确的订单号")
    private Long e_order_id;
    /**
     * 产品code
     */
    @NotBlank(message = "不是正确的产品code")
    private String product_code;
BindingResult接收

在controller中,我们通过BindingResult来接收对应的验证信息

    @ApiOperation(value = "修改订单状态", notes = "若找不到结果则返回 null。")
    @RequestMapping(value = "/status", method = RequestMethod.PUT)
    @ResponseBody
    public String PutOrderStatus(@RequestBody @Validated @NotNull OrderStatusReq req, BindingResult bindingResult) {
        String validResult = assertParameterValid(bindingResult);
        if (validResult != null) {
            return validResult;
        }
        return iOrderStatusService.putOrderStatus(req).toString();
    }
protected String assertParameterValid(BindingResult bindingResult) {
        if (bindingResult.hasErrors()) {
            FieldError error = bindingResult.getFieldError();
            return new Response<>(BusinessReturnCode.VALIDATION_FAILURE, String.format("[%s] %s.", error.getField(), error.getDefaultMessage()), null).toString();
        }
        return null;
    }
枚举Enum校验

可惜的是,Hibernate validation中没有提供枚举相关的校验,而实际业务场景中会有很多校验类型、状态等,这里我们只能自定义了。

首先我们需要自定义一个annotation来标记你的验证字段,因为Validator框架里面的基础annotation已经不够用。

然后自定义一个Validator(继承ConstraintValidator),并将annotation类型给到ConstraintValidator的泛型列表,相当于做了一个绑定。然后implement ConstraintValidator的两个方法,在isValid方法里面用要验证的枚举验证参数。

可以看下一个简单的demo:

@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = {EnumValidAnnotation.EnumValidtor.class})
@Documented
public @interface EnumValidAnnotation {
    String message() default "枚举不在范围内";

    Class[] groups() default {};

    Class[] payload() default {};

    Class[] target() default {};

    public class EnumValidtor implements ConstraintValidator {

        Class[] cls; //枚举类

        @Override
        public void initialize(EnumValidAnnotation constraintAnnotation) {
            cls = constraintAnnotation.target();
        }

        @Override
        public boolean isValid(Integer value, ConstraintValidatorContext context) {
            System.out.println("枚举值" + value);
            if (cls.length > 0) {
                for (Class cl : cls) {
                    try {
                        if (cl.isEnum()) {
                            //枚举类验证
                            Object[] objs = cl.getEnumConstants();
                            Method method = cl.getMethod("getCode");
                            for (Object obj : objs) {
                                Object code = method.invoke(obj);
                                if (value.equals(code)) {
                                    return true;
                                }
                            }
                        }
                    } catch (NoSuchMethodException e) {
                        e.printStackTrace();
                    } catch (IllegalAccessException e) {
                        e.printStackTrace();
                    } catch (InvocationTargetException e) {
                        e.printStackTrace();
                    }
                }
            }
            return false;
        }
    }

这样的话在你要验证的字段上加上对应的注解即可:

    /**
     * 更新类型 
     */
    @EnumValidAnnotation(target = OrderStatusEnum.class)
    private int stype;
总结

java中注解还是挺有意思的,类似c#中的attribute,但java中各种框架、方法的注解真的很多,不一直使用或做对应的笔记真的很容易忘记,还是需要多多积累和记录的。

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/73964.html

相关文章

  • Hibernate Validator入门及使用

    摘要:前言最近在开发某个模块的功能时,里面包含大量对请求参数判空和验证的步骤且参数繁多,存在大量的重复判断,验证影响代码的美观遂决定优化这部分代码。 前言 最近在开发某个模块的功能时,里面包含大量对请求参数判空和验证的步骤且参数繁多,存在大量的重复判断,验证影响代码的美观遂决定优化这部分代码。SpringBoot自带了参数验证框Hibernate Validator,下面是自己的学习笔记。 ...

    TANKING 评论0 收藏0
  • Hibernate Validator入门及使用

    摘要:前言最近在开发某个模块的功能时,里面包含大量对请求参数判空和验证的步骤且参数繁多,存在大量的重复判断,验证影响代码的美观遂决定优化这部分代码。 前言 最近在开发某个模块的功能时,里面包含大量对请求参数判空和验证的步骤且参数繁多,存在大量的重复判断,验证影响代码的美观遂决定优化这部分代码。SpringBoot自带了参数验证框Hibernate Validator,下面是自己的学习笔记。 ...

    kid143 评论0 收藏0
  • 深入了解数据校验:Bean Validation 2.0(JSR380)

    摘要:可能有人认为数据校验模块并不是那么的重要,因为硬编码都可以做。我以数据绑定为引子引出了数据校验这一块,是想表明它的重要性。关于数据校验这块,最新的是,也就是我们常说的。 每篇一句 吾皇一日不退役,尔等都是臣子 对Spring感兴趣可扫码加入wx群:Java高工、架构师3群(文末有二维码) 前言 前几篇文章在讲Spring的数据绑定的时候,多次提到过数据校验。可能有人认为数据校验模块...

    wangtdgoodluck 评论0 收藏0
  • Spring笔记1——极简入门教程

    摘要:创建工程将框架代码包解压后放到工作目录。方便起见,本教程使用为例。添加创建一个,负责响应相关的业务请求。添加标注在中,对输入参数进行校验通常使用标注。在本教程,我们将实现的增和查的工作。创建用户用户名重启并提交创建请求。 环境准备 系统:MacOS 开发:IntelliJ IDEA 语言:Java8 其它:Mysql、Redis 脚手架代码 Spring提供了一个创建项目脚手架的官...

    ChristmasBoy 评论0 收藏0
  • 利用注解对Bean进行校验

    摘要:所以就有今天的话题利用注解对进行校验。利用注解对进行校验,主要是利用框架,实现了的接口关于校验的接口,直接使用非常方便,省时省力。 最近写业务代码,因为页面复杂,导致对应的Bean属性非常多,而产品大佬又提出各种校验要求。 emmmmmm......如果写if条件来校验,那简直是又臭又长。 所以就有今天的话题——利用注解对Bean进行校验。 利用注解对Bean进行校验,主要是利用hib...

    dmlllll 评论0 收藏0

发表评论

0条评论

snowell

|高级讲师

TA的文章

阅读更多
最新活动
阅读需要支付1元查看
<