java 自定义 编译校验_自定义注解，通过Java反射机制校验数据

前言

先解释一下本人为什么会自定义注解，对成员属性进行必填校验的需求吧。因工作需要，目前一部分时间都在做App开发，其中一个app是Android原生开发。当中每一个页面都包含大量的输入项，并且这些信息均需要传递到服务端，均为必填项。起初输入项较少时，在提交方法上可逐一进行非空校验。随着输入项不断增加，这种方式就显得代码十分冗余。

鉴于注解在Java开发中的大量运用，不仅简化代码并提高编码的效率。所以我就想自己也可以写一个注解，然后在数据提交时通过反射获取实例对象上有标注自定义注解的Field，逐一进行非空校验。

一、什么是注解(Annotation)

Java注解又称Java标注，是Java语言5.0版本开始支持加入源代码的特殊语法元数据

Java语言中的类、方法、变量、参数和包等都可以被标注。和Javadoc不同，Java标注可以通过反射获取标注内容。在编译器生成类文件时，标注可以被嵌入到字节码中。Java虚拟机可以保留标注内容，在运行时可以获取到标注内容。当然它也支持自定义Java标注。

内置的注解

Java自定义了一套注解，共有七个，3个在java.lang中，剩下4个在java.lang.annnotation中。

作用在代码中的注解

@Override：检查该方法是否是重写方法，如果发现是其父类，或者是引用的接口中没有该方法时，会报编译错误。

@Deprecated：标注过时方法，如果使用该方法，会报编译警告。

@SuppressWarnings：指示编译器去忽略注解中声明的警告。

常用的元注解(作用在其他注解的注解)

Retention 标注这个注解的保留时间长短，是只在代码中，还是编入class文件中，或者是在运行时怎么通过反射访问。数值类型有

SOURCE：在源文件中有效，编译过程中会被忽略

CLASS：随源文件一起编译在class文件中，运行时忽略

RUNTIME：在运行时有效

Target：描述了注解修饰的对象范围，常用的包括：

METHOD：用于描述方法

PACKAGE：用于描述包

PARAMETER：用于描述方法变量

TYPE：用于描述类、接口或enum类型

@Document：标注这个注解是否包含在用户文档中

@Inherited:标注这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)

只有定义为RetentionPolicy.RUNTIME时，才可通过反射获取到注解，并且还可以拿到Class,Method,Field类。

二、自定义注解

这里我们自定义一个注解，因为我们这里的应用场景是对有标注的Field进行非空判断，所以还需要知道是哪些字段不能为空，所以这里给注解添加一个参数，用于字段描述。

@Target(ElementType.FIELD)

@Retention(RetentionPolicy.RUNTIME)

@Documented

public @interface Required {

// 注解的参数 参数类型+参数名+默认值

String value() default "";

}

@Data

@EqualsAndHashCode(callSuper = false)

@Entity(generateConstructors = false, generateGettersSetters = false)

public class SysInspectedCorp extends BaseObservable implements Serializable {

protected static final long serialVersionUID = 3L;

@Id(autoincrement = true)

@Property(nameInDb = "_id")

private Long corpId;

@Required("单位名称")

private String corpName;

@Required("店面照")

private String corpPhoto;

@Required("区域类型")

private int locationTypeID;

}

我这里封装了一个工具类来校验任意JavaBean实例对象,通过反射机制获取Class、Field、调用getter方法获取属性的值进行非空判断，满足逻辑判断则将Field描述返回

public class RequiredUtils {

/**

*

* @param object

* @return

* @description Invalid entity required field

* @throws Exception

*/

public static String requiredValidator(Object object) throws Exception {

String fieldDesc = null;

if (ObjectUtil.isNotNull(object)) {

// 拿到类

Class> clz = object.getClass();

// 拿到类的所有属性,返回field数组

Field[] fields = clz.getDeclaredFields();

for (Field field : fields) {

// 判断字段是否有@Required注解

if (field.isAnnotationPresent(Required.class)) {

// 拿到属性的getter方法

Method method = object.getClass().getMethod("get" + getMethodName(field.getName()));

if (field.getGenericType().toString().equals("class java.lang.String")) {// 如果type是类类型或包装类型，则前面包含"class "，后面跟类名

String val = (String) method.invoke(object);

if (StrUtil.hasEmpty(val)) {

fieldDesc = getFieldDesc(field);

break;

}

} else if (field.getGenericType().toString().equals("class java.lang.Long")) {// 类型是Long

Long val = (Long) method.invoke(object);

if (val == null || val == 0) {

fieldDesc = getFieldDesc(field);

break;

}

} else if (field.getGenericType().toString().equals("double")) {// 类型是double>0

double val = (double) method.invoke(object);

if (Double.compare(val, Double.valueOf(0.0)) <= 0) {

fieldDesc = getFieldDesc(field);

break;

}

} else if (field.getGenericType().toString().equals("class java.util.Date")) {// 类型是Date

Date val = (Date) method.invoke(object);

if (val == null) {

fieldDesc = getFieldDesc(field);

break;

}

} 其他类型自行扩展

}

}

}

return fieldDesc;

}

/**

* @param fieldName

* @return

* @throws Exception

* @description 把一个字符串的第一个字母大写、效率最高

*/

public static String getMethodName(String fieldName) {

byte[] items = fieldName.getBytes();

items[0] = (byte) ((char) items[0] - 'a' + 'A');

return new String(items);

}

/**

*

* @param field

* @return

* @description 返回字段描述

*/

private static String getFieldDesc(Field field) {

Required annotation = field.getAnnotation(Required.class);

return annotation.value();

}

}

调用方只需传递实例对象即可

public void btnSubmit_OnClick(View view) {

String res;

try {

res = RequiredUtils.requiredValidator(inspectedCorpViewModel.getInspectedCorp().getValue());

if (StrUtil.isNotEmpty(res))

ToastUtils.ShowMessage(this, mResult, mTextToSpeech, res + "不能为空！");

} catch (Exception e) {

e.printStackTrace();

}

}

通过此方式，省去大量if-else语句，减少无意义的重复工作。本文主要讲解了自定义注解以及Java反射机制的相关知识点。Java所有的框架底层是通过注解和反射实现，所以反射机制(Reflection)对Java开发者来说是非常重要的，值得开发者深入学习。