Java開發筆記（八十三）利用注解技術檢查空指針

注解屬於比較高級的Java開發技術，前面介紹的內置注解專用於編譯器檢查代碼，另外一些注解則由各大框架定義與調用，像Web開發常見的Spring框架、Mybatis框架，Android開發常見的ButterKnife框架等等，都使用了大量的注解。為了更好地弄清注解的應用原理，接下來不妨嘗試自定義注解，並在實際開發中對自定義的注解加以運用。
之前介紹異常預防的時候，為了避免出現空指針異常，可謂是八仙過海各顯神通，一路試驗了多項新技術。其中校驗某個字段非空尤其是個難點，案例中的蘋果類共有四個字段，包括名稱、顏色、重量、價格等，倘若要求這些字段均非空值才算有效記錄的話，就得四個字段一一判斷過去。那么采取for循環進行非空檢查的常規代碼示例如下：

	// 常規的for循環校驗，對每個對象及其每個屬性都進行空指針判斷
	private static void getRedAppleByFor(List<Apple> list) {
		List<Apple> redAppleList = new ArrayList<Apple>();
		if (list != null) { // 判斷清單非空
			for (Apple item : list) {
				// 對每個字段依次進行空指針判斷
				if (item!=null && item.getName()!=null && item.getColor()!=null 
						&& item.getWeight()!=null && item.getPrice()!=null) {
					if (item.isRedApple()) { // 判斷是否為紅蘋果
						redAppleList.add(item);
					}
				}
			}
		}
		System.out.println("常規的For循環校驗之后的紅蘋果清單=" + redAppleList.toString());
	}

 

從以上代碼可見，對每個字段依次進行空指針判斷，這里的條件語句拖得老長。倘若給蘋果類新增一個字段，那么此處的條件語句還得補上新字段的非空校驗。即使采用Java8引入的可選器Optional，也沒有更好的辦法，如此窘境簡直叫人束手無策。
如今有了注解技術，號稱可以自動檢查代碼，總算出現解決問題的一縷曙光。具體的處理過程大致分為四個步驟：自定義新的非空注解、給非空字段添加非空注解、利用反射機制校驗被非空注解修飾了的所有字段、在業務需要的地方調用校驗方法，下面分別進行詳細描述。

1、自定義新的非空注解
首先定義一個名叫“NotNull”的注解，並規定它用於在程序運行過程中檢查字段是否為空。這里有兩點值得特別關注：第一點，該注解的生效期間位於程序運行過程當中，意味着需要將它保留至運行階段；第二點，該注解用於檢查字段是否為空，意味着它的作用目標正好是字段。據此可編寫如下所示的注解定義代碼：

import java.lang.annotation.*;

@Documented // 該注解納入到Java開發手冊
@Target({ ElementType.FIELD }) // 該注解的作用目標是字段（屬性）
@Retention(RetentionPolicy.RUNTIME) // 該注解保留至運行階段，這樣能夠通過反射機制調用
//定義了一個注解，在interface前面加上符號“@”，表示這是個注解
public @interface NotNull {}

　　

2、給非空字段添加非空注解
接着修改蘋果類的定義代碼，在每個不能為空的字段上方添加注解“@NotNull”，表示這是個特殊字段，它必須有值而不允許是空指針，簡而言之，該字段必須是非空字段。修改后的蘋果類代碼片段示例如下：

//定義一個蘋果類
public class Apple {
	@NotNull // 通過注解聲明該字段不可為空
	private String name; // 名稱
	@NotNull // 通過注解聲明該字段不可為空
	private String color; // 顏色
	@NotNull // 通過注解聲明該字段不可為空
	private Double weight; // 重量
	@NotNull // 通過注解聲明該字段不可為空
	private Double price; // 價格

	// 此處省略蘋果類的剩余代碼定義
}

　　

3、利用反射機制校驗被非空注解修飾了的所有字段
然后還要通過反射技術去檢查非空字段，這里才是整個流程的關鍵之處。在進行反射調用的時候，又可分為主要的三個步驟：首先調用Class對象的getDeclaredFields方法，獲得該類中聲明的所有字段；其次依次遍歷這些字段，並調用字段對象的isAnnotationPresent方法，判斷當前字段是否存在非空注解；再次，倘若存在非空注解，則調用字段對象的get方法，獲得對應的字段值並判斷該字段是否為空指針。如此一來，某個添加了非空注解的字段，要是它的字段值被檢查出為空指針，馬上就能斷定包含該字段的對象是個無效記錄。
按照如上所述的反射調用步驟，編寫而來的非空校驗代碼如下所示：

//演示如何利用注解進行字段為空的校驗
public class NullCheck {

	// 對指定對象進行空指針校驗。返回true表示該對象跟它的每個字段都非空，返回false表示對象為空或者至少一個字段為空
	public static boolean isValid(Object obj) {
		if (obj == null) {
			System.out.println("校驗對象為空");
			return false;
		}
		Class cls = obj.getClass(); // 獲得對象實例的基因類型
		// 聲明一個字符串清單，用來保存非空校驗失敗的無效字段名稱
		List<String> invalidList = new ArrayList<String>();
		try {
			// 獲取對象的所有屬性（如果使用getFields，就無法獲取到private的屬性）
			Field[] fields = cls.getDeclaredFields();

			for (Field field : fields) { // 依次遍歷每個對象屬性
				// 如果該屬性聲明了NotNull注解，就進行字段非空的校驗
				if (field.isAnnotationPresent(NotNull.class)) {
					if (field != null) {
						field.setAccessible(true); // 將該字段設置為允許訪問
						Object value = field.get(obj); // 獲取某實例的字段值
						if (value == null) { // 如果發現該字段為空
							// 就把該字段的名稱添加到無效清單中
							invalidList.add(field.getName());
						}
					}
				}
			}
		} catch (Exception e) { // 捕捉到了任何一種異常（錯誤除外）
			e.printStackTrace();
		}
		if (invalidList.size() > 0) { // 無效清單非空，表示至少有一個字段沒通過非空校驗
			String desc = String.format("%s類非空校驗不通過的字段有：%s",
					cls.getName(), invalidList.toString());
			System.out.println(desc);
			return false;
		} else {
			return true;
		}
	}
}

為了方便程序員尋找非法字段，上面的代碼特意將未通過非空校驗的所有字段都打印出來，比起普通的空指針判斷要智能許多。

下面來個簡單的例子，驗證一下加了注解的非空校驗是否正常運行。實驗用的蘋果對象除了名稱字段有值，其余三個字段均為null，完整的實驗代碼見下：

	// 通過注解檢查某個對象內部字段的空指針
	private static void testSingle() {
		Apple apple = new Apple("蘋果", null, null, null);
		// NullCheck的isValid方法通過注解與反射技術來校驗空指針
		boolean isValid = NullCheck.isValid(apple);
		System.out.println("apple isValid="+isValid);
	}

 

運行以上的實驗代碼，觀察到以下的日志信息，果然找到了三個空指針字段：

com.addition.annotation.Apple類非空校驗不通過的字段有：[color, weight, price]

　　

4、在業務需要的地方調用校驗方法
最后把原來for循環那條冗長的空指針判斷語句改為調用新的校驗方法，改寫后的紅蘋果挑選代碼變成了這樣：

	// 把for循環內部的空指針校驗改為通過注解校驗
	private static void getRedAppleByForWithNullCheck(List<Apple> list) {
		List<Apple> redAppleList = new ArrayList<Apple>();
		if (list != null) { // 判斷清單非空
			for (Apple item : list) {
				// NullCheck的isValid方法通過注解與反射技術來校驗空指針
				if (NullCheck.isValid(item)) {
					if (item.isRedApple()) { // 判斷是否為紅蘋果
						redAppleList.add(item);
					}
				}
			}
		}
		System.out.println("For循環，非空校驗之后的紅蘋果清單=" + redAppleList.toString());
	}

 

瞧瞧，原本長長的一條if語句，現在縮短為“if (NullCheck.isValid(item))”，看上去真是清爽宜人。更加重要的是，假如以后蘋果類增加了新的非空字段，那也只需修改蘋果類的代碼，不必修改此處的校驗代碼了。
不但采取for循環的處理代碼得以優化，而且采取流式處理的新式代碼派上用場，不過是挑選非空校驗通過的正常蘋果么，只要在原代碼中補充形如“.filter(NullCheck::isValid)”的過濾方法就行了，補充過濾之后的流式代碼示例如下：

	// 聯合運用Optional校驗、流式處理，以及注解校驗
	private static void getRedAppleByStreamWithNullCheck(List<Apple> list) {
		List<Apple> redAppleList = new ArrayList<Apple>();
		// ifPresent表示list非空時候的處理
		Optional.ofNullable(list).ifPresent(apples -> {
			// 從原始清單中篩選出紅蘋果清單。注意“NullCheck::isValid”為靜態方法引用的寫法
			redAppleList.addAll(apples.stream().filter(NullCheck::isValid).filter(Apple::isRedApple).collect(Collectors.toList()));
		});
		System.out.println("流式處理，非空校驗之后的紅蘋果清單=" + redAppleList.toString());
	}

 

乖乖，改進之后的流式代碼不得了了，短短幾行代碼竟然同時運用了多項黑科技，包括但不限於：可選器、Lambda表達式、流式處理、方法引用、反射技術、注解技術。要是能熟練掌握這些開發技能，想必你的Java編碼水准已經達到了相當的高度。

更多Java技術文章參見《Java開發筆記（序）章節目錄》