Java开发笔记（八十三）利用注解技术检查空指针

	// 常规的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());
	}

import java.lang.annotation.*;

@Documented // 该注解纳入到Java开发手册
@Target({ ElementType.FIELD }) // 该注解的作用目标是字段（属性）
@Retention(RetentionPolicy.RUNTIME) // 该注解保留至运行阶段，这样能够通过反射机制调用
//定义了一个注解，在interface前面加上符号“@”，表示这是个注解
public @interface NotNull {}

//定义一个苹果类
public class Apple {
	@NotNull // 通过注解声明该字段不可为空
	private String name; // 名称
	@NotNull // 通过注解声明该字段不可为空
	private String color; // 颜色
	@NotNull // 通过注解声明该字段不可为空
	private Double weight; // 重量
	@NotNull // 通过注解声明该字段不可为空
	private Double price; // 价格

	// 此处省略苹果类的剩余代码定义
}

//演示如何利用注解进行字段为空的校验
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;
		}
	}
}

	// 通过注解检查某个对象内部字段的空指针
	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]

	// 把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());
	}

	// 联合运用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());
	}