前言

先解釋一下本人為什么會自定義注解，對成員屬性進行必填校驗的需求吧。因工作需要，目前一部分時間都在做App開發(fā)，其中一個app是Android原生開發(fā)。當中每一個頁面都包含大量的輸入項，并且這些信息均需要傳遞到服務端，均為必填項。起初輸入項較少時，在提交方法上可逐一進行非空校驗。隨著輸入項不斷增加，這種方式就顯得代碼十分冗余。
鑒于注解在Java開發(fā)中的大量運用，不僅簡化代碼并提高編碼的效率。所以我就想自己也可以寫一個注解，然后在數(shù)據(jù)提交時通過反射獲取實例對象上有標注自定義注解的Field，逐一進行非空校驗。

一、什么是注解（Annotation）

Java注解又稱Java標注，是Java語言5.0版本開始支持加入源代碼的特殊語法元數(shù)據(jù)
Java語言中的類、方法、變量、參數(shù)和包等都可以被標注。和Javadoc不同，Java標注可以通過反射獲取標注內(nèi)容。在編譯器生成類文件時，標注可以被嵌入到字節(jié)碼中。Java虛擬機可以保留標注內(nèi)容，在運行時可以獲取到標注內(nèi)容。當然它也支持自定義Java標注。

內(nèi)置的注解

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

作用在代碼中的注解

• @Override：檢查該方法是否是重寫方法，如果發(fā)現(xiàn)是其父類，或者是引用的接口中沒有該方法時，會報編譯錯誤。
• @Deprecated：標注過時方法，如果使用該方法，會報編譯警告。
• @SuppressWarnings：指示編譯器去忽略注解中聲明的警告。

常用的元注解（作用在其他注解的注解）

• Retention 標注這個注解的保留時間長短，是只在代碼中，還是編入class文件中，或者是在運行時怎么通過反射訪問。數(shù)值類型有

  • SOURCE：在源文件中有效，編譯過程中會被忽略
  • CLASS：隨源文件一起編譯在class文件中，運行時忽略
  • RUNTIME：在運行時有效

• Target：描述了注解修飾的對象范圍，常用的包括：

  • METHOD：用于描述方法
  • PACKAGE：用于描述包
  • PARAMETER：用于描述方法變量
  • TYPE：用于描述類、接口或enum類型

• @Document：標注這個注解是否包含在用戶文檔中

• @Inherited:標注這個注解是繼承于哪個注解類（默認 注解并沒有繼承于任何子類）

只有定義為RetentionPolicy.RUNTIME時，才可通過反射獲取到注解，并且還可以拿到Class,Method,Field類。

二、自定義注解

這里我們自定義一個注解，因為我們這里的應用場景是對有標注的Field進行非空判斷，所以還需要知道是哪些字段不能為空，所以這里給注解添加一個參數(shù)，用于字段描述。

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Required {
    // 注解的參數(shù) 參數(shù)類型+參數(shù)名+默認值
    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("區(qū)域類型")
    private int locationTypeID;
}

我這里封裝了一個工具類來校驗任意JavaBean實例對象,通過反射機制獲取Class、Field、調(diào)用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數(shù)組
            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();
    }
}

調(diào)用方只需傳遞實例對象即可

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所有的框架底層是通過注解和反射實現(xiàn)，所以反射機制(Reflection)對Java開發(fā)者來說是非常重要的，值得開發(fā)者深入學習。