参数校验工具类

原创 已于 2022-09-06 20:33:24 修改 · 475 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#java #javascript #c++

于 2022-08-29 14:06:39 首次发布
public class CheckParamUtil {

    private static final List<Class<?>> DIGIT_CLASS         = Lists.newArrayList(new Class<?>[] {Integer.class, Long.class, Short.class});
    private static final String         DEFAULT_DATE_FORMAT = "yyyy-MM-dd";

    /**
     * 获取校验接口
     *
     * @param name
     * @param value
     * @return
     */
    public static Checker getChecker(String name, Object value) {
        return new Checker(name, value);
    }

    /**
     * 默认校验实现
     */
    public static class Checker {
        /**
         * 参数名称
         */
        private final String name;
        /**
         * 参数值
         */
        private final Object value;

        private Checker(String name, Object value) {
            this.name = name;
            this.value = value;
        }

        /**
         * 数字参数校验
         * <pre>
         * CheckParamUtil.getChecker("fieldName", null).digit() => success
         * CheckParamUtil.getChecker("fieldName", 1234).digit() => success
         * CheckParamUtil.getChecker("fieldName", "123").digit() => success
         * CheckParamUtil.getChecker("fieldName", 1.23).digit() => failure
         * CheckParamUtil.getChecker("fieldName", "1.23").digit() => failure
         * </pre>
         *
         * @return Checker
         */
        public Checker digit() {
            // NULL不做处理
            if (value == null) {
                return this;
            }
            // 数字
            if (DIGIT_CLASS.contains(value.getClass())) {
                return this;
            }
            // 字符串
            if (value instanceof String) {
                if (NumberUtils.isDigits((String) value)) {
                    return this;
                }
                throw new CCException(ErrorCodeEnum.PARAM_ERROR, name + " 必须是数字的字符串");
            }
            throw new CCException(ErrorCodeEnum.PARAM_ERROR, name + " 必须是数字");
        }

        /**
         * 参数非空
         * <pre>
         * CheckParamUtil.getChecker("fieldName", 1234).notNull() => success
         * CheckParamUtil.getChecker("fieldName", "1234").notNull() => success
         * CheckParamUtil.getChecker("fieldName", null).notNull() => failure
         * </pre>
         *
         * @return Checker
         */
        public Checker notNull() {
            if (value == null) {
                throw new CCException(ErrorCodeEnum.PARAM_ERROR, name + " 不能为空");
            }
            return this;
        }

        /**
         * 非空(用于集合)
         * <pre>
         * CheckParamUtil.getChecker("fieldName", {1,2,3,4}).notEmpty() => success
         * CheckParamUtil.getChecker("fieldName", {1:1, 2:2}).notEmpty() => success
         * CheckParamUtil.getChecker("fieldName", null).notEmpty() => failure
         * CheckParamUtil.getChecker("fieldName", {}).notEmpty() => failure
         * </pre>
         *
         * @return Checker
         */
        public Checker notEmpty() {
            notNull();

            if ((value instanceof Map) && CollectionUtils.isEmpty((Map<?, ?>) value)) {
                throw new CCException(ErrorCodeEnum.PARAM_ERROR, name + " 不能为空");
            }
            if ((value instanceof Collection) && CollectionUtils.isEmpty((Collection<?>) value)) {
                throw new CCException(ErrorCodeEnum.PARAM_ERROR, name + " 不能为空");
            }
            return this;
        }

        /**
         * 非空(用于字符串)
         * <pre>
         * CheckParamUtil.getChecker("fieldName", "string").notBlank() => success
         * CheckParamUtil.getChecker("fieldName", 12345678).notBlank() => failure
         * CheckParamUtil.getChecker("fieldName", " 1234 ").notBlank() => success
         * CheckParamUtil.getChecker("fieldName", null).notBlank() => failure
         * CheckParamUtil.getChecker("fieldName", "").notBlank() => failure
         * CheckParamUtil.getChecker("fieldName", "      ").notBlank() => failure
         * CheckParamUtil.getChecker("fieldName", "\r\t\n").notBlank() => failure
         * </pre>
         *
         * @return Checker
         */
        public Checker notBlank() {
            if (value == null || value instanceof String) {
                notNull();
                if (StringUtils.isBlank((String) value)) {
                    throw new CCException(ErrorCodeEnum.PARAM_ERROR, name + " 不能为空");
                }
            } else {
                throw new CCException(ErrorCodeEnum.PARAM_ERROR, name + " 必须是字符串");
            }
            return this;
        }

        /**
         * 长度
         * <pre>
         * CheckUtil.getChecker("fieldName", "12345").length(5) => success
         * CheckUtil.getChecker("fieldName", 12345).length(5) => success
         * CheckUtil.getChecker("fieldName", 0).length(0) => success
         * CheckUtil.getChecker("fieldName", "").length(0) => success
         * CheckUtil.getChecker("collectionName", emptyList).length(0) => true
         * CheckUtil.getChecker("collectionName", emptyList).length(3) => true
         * CheckUtil.getChecker("collectionName", oneElementList).length(3) => failure
         * CheckUtil.getChecker("collectionName", oneElementList).length(0) => failure
         * CheckUtil.getChecker("collectionName", 2).length(0) => failure
         * CheckUtil.getChecker("collectionName", "123456").length(0) => failure
         * CheckUtil.getChecker("fieldName", null).length(5) => failure
         * CheckUtil.getChecker("fieldName", "123456").length(5) => failure
         * CheckUtil.getChecker("collectionName", fiveElementList).length(3) => failure
         * </pre>
         *
         * @param length 长度
         * @return Checker
         */
        public Checker length(int length) {
            if (value == null || value instanceof String) {
                if (String.valueOf(value).length() != length) {
                    throw new CCException(ErrorCodeEnum.PARAM_ERROR, name + " 长度必须是" + length);
                }
                return this;
            } else if (value instanceof Collection) {
                if (((Collection<?>) value).size() != length) {
                    throw new CCException(ErrorCodeEnum.PARAM_ERROR, name + " 长度必须是" + length);
                }
                return this;
            } else if (value instanceof Integer) {
                if (String.valueOf(value).length() != length) {
                    throw new CCException(ErrorCodeEnum.PARAM_ERROR, name + " 长度必须是" + length);
                }
                return this;
            } else {
                throw new CCException(ErrorCodeEnum.PARAM_ERROR, name + " 必须是字符串、集合或数字");
            }
        }

        /**
         * 数字范围
         * <pre>
         * min == null && max != null => value <= max
         * min != null && max == null => value >= min
         * min != null && max != null => min <= value <= max
         * </pre>
         *
         * @param min
         * @param max
         * @return
         */
        public Checker range(Long min, Long max) {
            digit();

            Long val = Long.valueOf(value.toString());
            if (min != null && !(val >= min)) {
                throw new CCException(ErrorCodeEnum.PARAM_ERROR, name + " 必须大于" + min);
            }

            if (max != null && !(val <= max)) {
                throw new CCException(ErrorCodeEnum.PARAM_ERROR, name + " 必须小于等于" + max);
            }
            return this;
        }

        /**
         * 检查值是否等于或小于参数max
         *
         * @param max
         * @return
         */
        public Checker equalOrLessThan(Long max) {
            notNull();
            digit();
            Long val = null;
            if (value instanceof Long) {
                val = (Long) value;
            } else {
                val = Long.valueOf(value.toString());
            }
            if (max != null && (val > max)) {
                throw new CCException(ErrorCodeEnum.PARAM_ERROR, name + " 不能超过" + max);
            }
            return this;
        }

        /**
         * 检查字符串长度是否等于或小于参数max
         *
         * @param max
         * @return
         */
        public Checker lengthEqualOrLessThan(Integer max) {
            notNull();
            if (value instanceof String) {
                if (max != null && (((String) value).length() > max)) {
                    throw new CCException(ErrorCodeEnum.PARAM_ERROR, name + " 长度不能大于" + max);
                }
            } else {
                throw new CCException(ErrorCodeEnum.PARAM_ERROR, name + " 必须是字符串");
            }
            return this;
        }

        /**
         * 检查集合容量是否等于或小于参数max
         *
         * @param max
         * @return
         */
        public Checker sizeEqualOrLessThan(Integer max) {
            notNull();
            if (value instanceof Collection) {
                if (max != null && (((Collection<?>) value).size() > max)) {
                    throw new CCException(ErrorCodeEnum.PARAM_ERROR, name + " 不能大于" + max);
                }
            } else if ((value instanceof Map)) {
                if (max != null && (((Map<?, ?>) value).size() > max)) {
                    throw new CCException(ErrorCodeEnum.PARAM_ERROR, name + " 不能大于" + max);
                }
            } else {
                throw new CCException(ErrorCodeEnum.PARAM_ERROR, name + " 必须是集合");
            }
            return this;
        }

        /**
         * 检查参数是否是日期格式(例:yyyyMMdd)
         *
         * @return
         */
        public Checker isDateFormat() {
            notBlank();
            try {
                DateFormat dateFormat = new SimpleDateFormat((String) value);
                Date date = new Date();
                // 判断入参是否能当作模板来格式化时间
                String dateString = dateFormat.format(date);
                // 将格式化后的时间转换为Date
                Date parse = dateFormat.parse(dateString);
                // 判断时间格式化前后，年份是否一致
                if (date.getYear() != parse.getYear() || date.getMonth() != parse.getMonth() || date.getDay() != parse.getDay()) {
                    throw new CCException(ErrorCodeEnum.PARAM_ERROR, name + " 时间类型的默认值不正确，只允许日期格式模板，例如“yyyyMMdd或yyyy-MM-dd”");
                }
                return this;
            } catch (Throwable throwable) {
                // 捕获类型转换，空指针或非法参数异常
                throw new CCException(ErrorCodeEnum.PARAM_ERROR.getCode(), name
                        + " 时间类型的默认值不正确，只允许日期格式模板，例如“yyyyMMdd”", throwable);
            }
        }

        /**
         * 检查值是否是时间(例:2020-03-10)
         *
         * @return
         */
        public Checker isDateyyyyMMdd() {
            notBlank();
            try {
                DateFormat dateFormat = new SimpleDateFormat(DEFAULT_DATE_FORMAT);
                dateFormat.parse((String) value);
                return this;
            } catch (Throwable throwable) {
                throw new CCException(ErrorCodeEnum.PARAM_ERROR.getCode(), name + " 时间类型的值不能为空，且只允许yyyy-MM-dd格式", throwable);
            }
        }

        /**
         * 检查两个字符是否相等
         *
         * @param equalsParam  需要比较的参数
         * @param errorMessage 错误信息
         * @return
         */
        public Checker equals(String equalsParam, String errorMessage) {
            notBlank();
            if (StringUtils.equals((String) value, equalsParam)) {
                return this;
            } else {
                throw new CCException(ErrorCodeEnum.PARAM_ERROR.getCode(), errorMessage);
            }
        }

        /**
         * 判断表达式是否成立，如不成立则抛出异常，异常为errorMessage
         *
         * @param errorMessage 表达式不成立
         * @return
         */
        public Checker isTrue(String errorMessage) {
            if (!(value instanceof Boolean)) {
                throw new CCException(ErrorCodeEnum.PARAM_ERROR.getCode(), errorMessage);
            }
            if (!(Boolean) value) {
                throw new CCException(ErrorCodeEnum.PARAM_ERROR.getCode(), errorMessage);
            }
            return this;
        }
    }
}
一个通用的参数校验的工具类
weixin_38399962的博客
10-14 1191
对于请求入参的校验常用方法都是一堆if...else...来进行判空，长度校验。不仅代码又多又长，阅读性极差。本文由博主自己结合hibernate-validate框架，封装的小工具，进行优雅的参数校验。
写一个必传参数校验工具类
啊谋的博客
11-04 384
需要依赖： 1.（使用alibab的fastjson 把对象转成json的时候会自动去掉值为null的字段，所以用下面这个jackson依赖） 2.apache工具包 <dependency> <groupId>com.fasterxml.jackson.datatype</groupId> <artifactId>jackson-datatype-guava</artifactId
Java校验参数工具类
06-02
这是自己开发的一个参数校验的工具类，可用于对实例的属性进行非空校验。包括全部校验和任一校验两种校验方式。 举例：CheckParamsUtils.checkParamsAll(requestBean, "name", "age","gender");
java后台注解校验工具类
04-23
后台通过注解的方式对model 的值进行校验。判断值是否符合类型要求或长度要求。
参数验证工具类
sinat_36891648的博客
11-16 269
package net.newcapec.cloudpay.commonutil.utils; import java.util.HashMap; import java.util.Map; /** * @title 参数工具类 * @desc * @author W.jw * @date 2017年12月20日 下午5:02:59 */ public class ParamUtil { private Map<String, String> map = new HashM
精选资源
参数校验工具类（包含异常工具类）
07-27
标题提到的"参数校验工具类（包含异常工具类）"是一个专门用于验证输入数据有效性的工具集，它可以帮助开发者快速、有效地检查传入参数，防止因无效数据导致的程序错误。描述中指出，该工具类不仅支持对单个对象进行...
Utils-防SQL注入参数校验工具类
scdncby的博客
05-14 2430
package com.utils; import javafx.beans.binding.When; import org.apache.commons.lang3.StringUtils; import org.apache.ibatis.annotations.Case; import org.slf4j.Logger; import org.slf4j.LoggerFactory; ...
Spring Boot 参数校验、校验工具类
这有一片海的博客
11-28 4008
Spring Boot实现参数校验 参数校验的目的 不做参数校验带来的问题： 入库异常（数据库字段长度为50，实际数据长度为100） NPE异常（未接收到参数就进行调用） 被同事嫌弃（500行代码，250行都在用if…esle做参数校验） …… 做参数校验的好处： 规避了不必要的异常 减少代码量 …… 如何进行参数校验 if-else进行参数校验 写的代码可能是这个样子的？？？？？当校验的参数个数变多，校验代码会惨不忍睹… 阅读代码的人的心情是这样的…… 硬编码校验的缺点: 代码行数会随着校
参数验证工具
05-23 457
参数校验始终不会少，但是如何让代码更加简洁？令人深思 接下来介绍一个参数验证工具定义一个自定义注解 判断工具 使用 DTO定义
校验工具类
11-27
正则工具类 提供验证邮箱、手机号、电话号码、身份证号码、数字等方法
参数校验工具类BeanValidator
qingcyb的博客
07-27 554
参数校验工具类
各种输入校验工具类
Android藏宝阁
11-05 1306
public class CommonUtil { /** * 电话号码验证 * * @param phoneNum * @return */ public static boolean isPhoneNum(String phoneNum) { Pattern p = Pattern.compile("^((1[0-9
【建议使用】告别if，Java超好用参数校验工具类
weixin_51393513的博客
12-19 813
一、前言 今天和小伙伴们分享一个常用的工具类，共计四个方法，使用场景比较广泛，有用于校验某个对象或对象中指定属性为空值时，直接返回异常，常用语校验前端请求参数；也有当值不为空时，执行指定动作，可减少大量的if条件，如：mybatis请求参数设置；还有用于判断当值不为空时，替代为新值，完成后续动作。 这样描述可能不够清晰，这里花哥列举了几个使用场景，更多的场景需要小伙伴们根据自己业务需求合理使用。 //场景一，点击登录时，后端校验用户名 if(StringUtils.isEmpty(name)){
接口参数校验工具类ValidationParamUtils，让参数校验从“繁琐、重复”变得“省事、简单”！
最新发布
qq_43600166的博客
08-17 815
本文介绍了一个参数校验工具类ValidationParamUtils，旨在简化Java开发中繁琐的数据校验工作。相比传统的javax.validation注解校验，该工具类具有以下优势：1)适用于业务层、持久层等全场景校验；2)支持自定义异常抛出；3)完美结合国际化需求。工具类提供了空值校验、范围校验、集合校验等常用方法，并通过BusinessException实现国际化错误信息。开发者可根据业务需求灵活扩展校验规则，替代重复的if判断，提高开发效率。
参数、业务 校验工具类
weixin_50029329的博客
09-28 202
package com.cy.pj.common.util; import com.cy.pj.common.exception.ServiceException; /** * 通过此工具类封装对参数，执行过程，结果等业务的校验。 * @author qilei * */ public class AssertUtil { /**验证参数的有效性*/ public static void isArgumentValid(boolean statement,String msg) {
校验参数个数工具类
jike11231的博客
06-07 756
项目中有个需求：前后端参数一致性校验，在某业务场景下后端代码需要校验参数个数，因此设计了1个工具类方便大伙使用，特此简单记录下。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值