欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

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

程序员文章站 2022-07-11 08:37:27
注解属于比较高级的Java开发技术,前面介绍的内置注解专用于编译器检查代码,另外一些注解则由各大框架定义与调用,像Web开发常见的Spring框架、Mybatis框架,Android开发常见的ButterKnife框架等等,都使用了大量的注解。为了更好地弄清注解的应用原理,接下来不妨尝试自定义注解, ......

注解属于比较高级的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开发笔记(序)章节目录