java注解方式参数校验

1、注解类NotEmpty.java空值校验

package com.cmbc.umm.core.common.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;


@Documented
@Inherited
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface NotEmpty {
    //String value() default "";
}

2、注解类CheckValue.java正则表达式校验和空值校验

package com.cmbc.umm.core.common.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Documented
@Inherited
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface CheckValue {
    String value() default "";
}

3、解析工具类AnnotationUtil.java

package com.cmbc.umm.core.common.util;

import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.apache.commons.lang3.ArrayUtils;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.cmbc.umm.core.common.annotation.CheckValue;
import com.cmbc.umm.core.common.annotation.NotEmpty;


public class AnnotationUtil {
    private static final Logger logger = LoggerFactory.getLogger(AnnotationUtil.class);

    /**
     * 校验格式是否正确,如果@CheckValue() 没有参数,则校验是否为空
     * 例子:@CheckValue("^[A-Za-z0-9_-]{1,32}$") 校验数字、字母、下划线1到32位 : @CheckValue()
     * 校验字段是否为空
     * 
     * @param obj
     * @return 如果返回null表示:校验通过
     */
    public static String checkValue(Object obj) {
        return parseAnnotation(CheckValue.class, obj, true);
    }

    /**
     * 校验是否为空
     * 
     * @param obj
     * @return 如果返回null表示:校验通过
     */
    public static String checkEmpty(Object obj) {
        return parseAnnotation(NotEmpty.class, obj, true);
    }

    private static String parseAnnotation(Class<? extends Annotation> aClazz, Object obj, boolean hasParent) {
        StringBuilder sb = new StringBuilder();
        boolean flag = false;

        Class<?> clazz = obj.getClass();
        Field[] fields = clazz.getDeclaredFields();

        Field[] bothField = fields;
        if (hasParent) {
            Class<?> superClazz = clazz.getSuperclass();
            Field[] superFields = superClazz.getDeclaredFields();
            bothField = (Field[]) ArrayUtils.addAll(fields, superFields);
        }

        for (Field field : bothField) {
            Annotation annotation = field.getAnnotation(aClazz);
            if (annotation == null)
                continue;
            field.setAccessible(true);

            try {
                if (annotation instanceof CheckValue) {
                    CheckValue cv = (CheckValue) annotation;
                    String regex = cv.value();
                    if (StringUtils.isEmpty(regex)) {
                        // 输入的正则表达式为空,所以不做校验
                        // continue;
                        // NotEmpty ne = (NotEmpty)annotation;
                        Object oValue = field.get(obj);
                        if (oValue == null) {
                            sb.append("字段" + field.getName() + "不能为null|");
                            flag = true;
                        } else {
                            if (oValue instanceof String) {
                                String value = (String) oValue;
                                if (StringUtils.isBlank(value)) {
                                    sb.append("字段" + field.getName() + "不能为空|");
                                    flag = true;
                                }
                            } else {
                                logger.info("字段" + field.getName() + "不是字符串,不能判断是否为空");
                            }
                        }
                    } else {
                        Pattern pattern = Pattern.compile(regex);
                        String value = (String) field.get(obj);
                        Matcher m = pattern.matcher(value);
                        if (!m.matches()) {
                            sb.append("字段" + field.getName() + "格式错误|");
                            flag = true;
                        }
                    }

                } else if (annotation instanceof NotEmpty) {
                    Object oValue = field.get(obj);
                    if (oValue == null) {
                        sb.append("字段" + field.getName() + "不能为null|");
                        flag = true;
                    } else {
                        if (oValue instanceof String) {
                            String value = (String) oValue;
                            if (StringUtils.isBlank(value)) {
                                sb.append("字段" + field.getName() + "不能为空|");
                                flag = true;
                            }
                        } else {
                            logger.info("字段" + field.getName() + "不是字符串,不能判断是否为空");
                        }
                    }

                }
            } catch (Exception e) {
                sb.append(e.getMessage());
                flag = true;
                logger.error("解析注解出错:", e);
                // e.printStackTrace();
            }

        }

        if (flag) {
            return sb.toString();
        } else {
            return null;
        }
    }

}

4、测试
1)People.java

package test;

import com.cmbc.commons.annotation.CheckValue;
import com.cmbc.commons.annotation.NotEmpty;

public class People {
    @CheckValue("^[A-Za-z0-9_-]{13,32}$")
    private String id;
    @NotEmpty
    private String name;
    @CheckValue
    private int age;

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "People [id=" + id + ", name=" + name + ", age=" + age + "]";
    }


}

2)Student.java

package test;

import com.cmbc.commons.annotation.CheckValue;

public class Student extends People{
    @CheckValue
    private String clazzNo;

    public String getClazzNo() {
        return clazzNo;
    }

    public void setClazzNo(String clazzNo) {
        this.clazzNo = clazzNo;
    }

}

3)测试代码

package test;

import java.util.Map;

import com.cmbc.commons.utils.AnnotationUtil;
import com.cmbc.epay.umm.utils.EfficentDevUtil;

public class Test {
    private String name;
    public static void main(String[] args) {
        Student p = new Student();
        p.setId("1111");
        p.setName("");
        p.setClazzNo(" ");
        String s = AnnotationUtil.checkValue(p);
        System.out.println(s);
    }
}
  • 3
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Java中的自定义注解是一种给代码提供额外信息的方式,可以在运行时通过反射机制获取注解的信息。通过自定义注解,我们可以实现参数校验,提高代码的健壮性和可维护性。 首先,我们需要定义一个注解类,用于定义参数校验的规则。比如,我们可以定义一个注解叫做@ParamCheck,用于对方法的参数进行校验。 ```java @Target(ElementType.PARAMETER) @Retention(RetentionPolicy.RUNTIME) public @interface ParamCheck { String value(); } ``` 接着,在需要进行参数校验的方法上使用@ParamCheck注解,并给注解传入校验规则的表达式。比如,我们可以给一个名为checkNumber的方法的参数添加校验注解。 ```java public void checkNumber(@ParamCheck("number > 0") int number) { // ... } ``` 然后,在方法内部,通过反射机制获取参数注解信息,并根据注解中定义的校验规则对参数进行校验。 ```java public void checkNumber(int number) { Parameter parameter = ...; // 获取方法的参数信息 ParamCheck paramCheckAnnotation = parameter.getAnnotation(ParamCheck.class); if (paramCheckAnnotation != null) { String expression = paramCheckAnnotation.value(); // 根据expression对number进行校验 // ... } } ``` 最后,我们可以在调用checkNumber方法时传入一个不满足校验规则的参数,比如-10,当方法内部进行参数校验时,可以捕获到校验失败的情况,并进行相应处理。 ```java checkNumber(-10); // 参数校验失败,抛出异常或者进行其他处理 ``` 通过自定义注解实现参数校验可以方便地对代码进行统一的校验规则管理,提高代码的可维护性和可读性。同时,由于注解是在运行时通过反射获取,可以对代码进行动态改变和扩展,使得我们可以更加灵活地进行参数校验

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值