我们在自定义的注解上要添加几个元注解
@Target
@Retention
@Inherited
@Documented
@Target
用来声明当前注解可以使用的地方
value | 描述 |
---|---|
ElementType.TYPE | 应用于类、接口(包括注解类型)、枚举 |
ElementType.FIELD | 应用于属性(包括枚举中的常量) |
ElementType.METHOD | 应用于方法 |
ElementType.PARAMETER | 应用于方法的形参 |
ElementType.CONSTRUCTOR | 应用于构造函数 |
ElementType.LOCAL_VARIABLE | 应用于局部变量 |
ElementType.ANNOTATION_TYPE | 应用于注解类型 |
ElementType.PACKAGE | 应用于包 |
ElementType.TYPE_PARAMETER | 应用于类型变量 |
ElementType.TYPE_USE | 应用于任何使用类型的语句中(例如声明语句、泛型和强制转换语句中的类型) |
@Retention
表明该注解的生命周期
生命周期类型 | 描述 |
---|---|
RetentionPolicy.SOURCE | 编译时被丢弃,不包含在类文件中 |
RetentionPolicy.CLASS | JVM加载时被丢弃,包含在类文件中,默认值 |
RetentionPolicy.RUNTIME | 由JVM 加载,包含在类文件中,在运行时可以被获取到 |
@Inherited
表明使用了@Inherited注解的注解,所标记的类的子类也会拥有这个注解。
@Document
表明该注解标记的元素可以被Javadoc 或类似的工具文档化。
一般声明自定义注解的时候 使用前三个就够了
// {} 中可以声明多个Target类型, 这个注解我们只用在类的属性上, 只注明这一个值即可
@Target({ElementType.FIELD})
// 在运行时使用
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface ExcelValid {
// 注解的属性
// 属性声明格式 : 数据类型 属性名() default 默认值;
// 在调用获取属性值的时候 直接通过 ' 注解对象.属性名()' 的形式int length() default 0;DataTypeEnum type() default DataTypeEnum.String;boolean notNull() default true;String lengthMessage() default "";String typeMessage() default "";String notNullMessage() default "";
}
这样注解就声明好了
编写校验工具类
/*** 导入excel参数校验*/
public class ExcelValidUtil {/*** Excel导入字段校验** @param object 校验的JavaBean 其属性须有自定义注解*/public static void Excelvalid(Object object) throws RuntimeException {valid(object,0);}public static void Excelvalid(Object object, int size) throws RuntimeException {valid(object,size);}private static void valid(Object object,int size) throws RuntimeException {String prefix = "";if (size > 0) {prefix = "第" + size + "条数据";}// 通过反射获取类的所有属性字段Field[] fields = object.getClass().getDeclaredFields();for (Field field : fields) {//设置可访问field.setAccessible(true);// 进行判断 如果属性上有 @ExcelIgnore 注解或者没有 @ExcelProperty则表示该字段不参数映射, 跳过if (field.isAnnotationPresent(ExcelIgnore.class) || !field.isAnnotationPresent(ExcelProperty.class)) {continue;}//属性的值Object fieldValue = null;try {fieldValue = field.get(object);} catch (IllegalAccessException e) {throw new RuntimeException("导入参数检查失败");}//是否包含自定义校验注解boolean hasValid = field.isAnnotationPresent(ExcelValid.class);if (hasValid ) {// 获取自定义注解ExcelValid annotation = field.getAnnotation(ExcelValid.class);// 非空校验boolean notNull = annotation.notNull(); // 获取注解notNull属性的值if (notNull && Objects.isNull(fieldValue)) {throw new RuntimeException(prefix + " " +annotation.notNullMessage());}// 类型校验DataTypeEnum type = annotation.type(); // 获取注解type属性的值if (!validType(type,fieldValue)) {throw new RuntimeException(prefix + " " +annotation.typeMessage());}// 长度校验int length = annotation.length(); // 获取注解length属性的值if (length > 0) {if (length < String.valueOf(fieldValue).length()) {throw new RuntimeException(prefix + " " +annotation.lengthMessage());}}}}}// 类型转换校验private static Boolean validType(DataTypeEnum type,Object fieldValue) {try {switch (type){case Byte: Byte.valueOf(String.valueOf(fieldValue)); break;case Short: Short.valueOf(String.valueOf(fieldValue)); break;case Integer: Integer.valueOf(String.valueOf(fieldValue)); break;case Long: Long.valueOf(String.valueOf(fieldValue)); break;case Float: Float.valueOf(String.valueOf(fieldValue)); break;case Double: Double.valueOf(String.valueOf(fieldValue)); break;case String: String.valueOf(fieldValue); break;case BigDecimal: new BigDecimal(String.valueOf(fieldValue)); break;case Boolean: Boolean.valueOf(String.valueOf(fieldValue)); break;default: break;}}catch (Exception e){// 转换失败返回falsereturn false;}return true;}
}