Java内功修炼系列:注解(Annotation)

·  阅读 432

小知识,大挑战!本文正在参与“程序员必备小知识”创作活动。

本文已参与「掘力星计划」,赢取创作大礼包,挑战创作激励金。

一 注解的定义

Java 注解是从 Java5 开始添加到 Java 的,它用于为 Java 代码提供元数据。作为元数据(见补充1),注解不直接影响你的代码执行,但也有一些类型的注解实际上可以用于这一目的。

注解即标签:如果把代码想象成一个具有生命的个体,注解就是给这些代码的某些个体打的标签。

注解API非常强大,被广泛应用于各种Java框架,如Spring,Hibernate,JUnit,还有Android中的Dagger2、ButterKnife、Retrofit等。

二 如何自定义注解

注解通过 @interface关键字进行定义。

public @interface Test {
}
复制代码

它的形式跟接口很类似,不过前面多了一个 @ 符号。上面的代码就创建了一个名字为 Test 的注解。 你可以简单理解为创建了一张名字为 Test的标签。

使用注解

@Test
public class TestAnnotation {
}
复制代码

你可以简单理解为将 Test 这张标签贴到 TestAnnotation这个类上面。

创建一个类 TestAnnotation,然后在类定义的地方加上 @Test就可以用 Test注解这个类了。

三 元注解

元注解是可以注解到注解上的注解,或者说元注解是一种基本注解,但是它能够应用到其它的注解上面。

难于理解的话可以这样说:元注解是一张特殊的标签,可以贴在其他的标签上,作用和目的就是给其他普通的标签进行解释说明。

元注解有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 种。

3.1 @Retention

Retention译为保留期。当 @Retention 应用到一个注解上的时候,它解释说明了这个注解的的存活时间。

它的取值如下:

RetentionPolicy.SOURCE注解只在源码阶段保留,在编译器进行编译时它将被丢弃忽视。
RetentionPolicy.CLASS注解只被保留到编译进行的时候,它并不会被加载到 JVM 中。
RetentionPolicy.RUNTIME注解可以保留到程序运行的时候,它会被加载进入到 JVM 中,所以在程序运行时可以获取到。

3.2 @Target

Target 是目标的意思,@Target 指定了注解运用的地方 你可以这样理解,当一个注解被 @Target 注解时,这个注解就被限定了运用的场景。 类比到标签,原本标签是你想张贴到哪个地方就到哪个地方,但是因为 @Target 的存在,它张贴的地方就非常具体了,比如只能张贴到方法上、类上、方法参数上等等。

@Target 有下面的取值:

ElementType.ANNOTATION_TYPE可以给一个注解进行注解
ElementType.CONSTRUCTOR可以给构造方法进行注解
ElementType.FIELD可以给属性进行注解
ElementType.LOCAL_VARIABLE可以给局部变量进行注解
ElementType.METHOD可以给方法进行注解
ElementType.PACKAGE可以给一个包进行注解
ElementType.PARAMETER可以给一个方法内的参数进行注解

3.3 @Documented

顾名思义,这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去。ElementType.TYPE 可以给一个类型进行注解,比如类、接口、枚举。

3.4 @Inherited

Inherited 是继承的意思,但是它并不是说注解本身可以继承,而是说如果一个超类被 @Inherited 注解过的注解进行注解的话,那么如果它的子类没有被任何注解应用的话,那么这个子类就继承了超类的注解。

3.5 @Repeatable

Repeatable 自然是可重复的意思。@Repeatable 是 Java 1.8 才加进来的,所以算是一个新的特性。

什么样的注解会多次应用呢?通常是注解的值可以同时取多个。

四 Java 预置的注解

上面的知识已经可以让我们自己定义一个注解了,但其实 Java 中本身就已经提供了一些现成的注解。

4.1 @Deprecated

这个元素是用来标记过时的元素。编译器在编译阶段遇到这个注解时会发出提醒警告,告诉开发者正在调用一个过时的元素比如过时的方法、过时的类、过时的成员变量。

public class Stu {  

    @Deprecated
    public void getNameOld(){
        System.out.println("这个方法是不推荐的:Deprecated!");
    }

    public void getName(){
        System.out.println("My name is Lucas");
    }


复制代码

在 IDE 中调用上面类的getNmaeOld方法时,可以看到getNmaeOld() 方法上面被一条直线划掉,这其实就是编译器识别后的提醒效果。

4.2 @Override

这个在开发者很常见了,提示子类要复写父类中被 @Override 修饰的方法。

4.3 @SuppressWarnings

阻止警告的意思。之前说过调用被 @Deprecated 注解的方法后,编译器会警告提醒,而有时候开发者会忽略这种警告,他们可以在调用的地方通过 @SuppressWarnings 达到目的。

@SuppressWarnings("deprecation")
public void testSupressWarnings(){
    Stu stu = new Stu();
    stu.getNameOld();
    stu.getName();
}
复制代码

4.4 @SafeVarargs

参数安全类型注解。它的目的是提醒开发者不要用参数做一些不安全的操作,它的存在会阻止编译器产生 unchecked 这样的警告。它是在 Java 1.7 的版本中加入的。

@SafeVarargs // Not actually safe!
    static void m(List<String>... stringLists) {
    Object[] array = stringLists;
    List<Integer> tmpList = Arrays.asList(42);
    array[0] = tmpList; // Semantically invalid, but compiles without warnings
    String s = stringLists[0].get(0); // Oh no, ClassCastException at runtime!
}
复制代码

上面的代码中,编译阶段不会报错,但是运行时会抛出 ClassCastException 这个异常,所以它虽然告诉开发者要妥善处理,但是开发者自己还是搞砸了。

4.5 @FunctionalInterface

函数式接口注解,这个是 Java 1.8 版本引入的新特性。函数式编程很火,所以 Java 8 也及时添加了这个特性。函数式接口 (Functional Interface) 就是一个具有一个方法的普通接口。比如:

@FunctionalInterface
public interface Runnable {
    /**
     * When an object implementing interface <code>Runnable</code> is used
     * to create a thread, starting the thread causes the object's
     * <code>run</code> method to be called in that separately executing
     * thread.
     * <p>
     * The general contract of the method <code>run</code> is that it may
     * take any action whatsoever.
     *
     * @see     java.lang.Thread#run()
     */
    public abstract void run();
}
复制代码

我们进行线程开发中常用的 Runnable 就是一个典型的函数式接口,上面源码可以看到它就被 @FunctionalInterface 注解。

可能有人会疑惑,函数式接口标记有什么用,这个原因是函数式接口可以很容易转换为 Lambda 表达式。

五 注解的属性

5.1 属性的定义

注解的属性也叫做成员变量。注解只有成员变量,没有方法。 需要注意的是,在注解中定义属性时它的类型必须是 8 种基本数据类型外加 类、接口、注解及它们的数组 注解中属性可以有默认值,默认值需要用 default 关键值指定。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test{
    int id() default 1;
    String msg() default "hello world";
}
复制代码

上面代码定义了 TestAnnotation 这个注解中拥有 id 和 msg 两个属性。在使用的时候,我们应该给它们进行赋值。 赋值的方式是在注解的括号内以 value="" 形式,多个属性之前用 ,隔开

@Test(id=1, msg="hello annotation")
public class TestAnnotation {

}
复制代码

5.2 注解的提取

注解与反射密不可分。 注解通过反射获取。首先可以通过 Class 对象的 isAnnotationPresent() 方法判断它是否应用了某个注解:

public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}
复制代码

然后通过 getAnnotation() 或者是 getAnnotations() 方法来获取 Annotation 对象,前一种方法返回指定类型的注解,后一种方法返回注解到这个元素上的所有注解:

public <A extends Annotation> A getAnnotation(Class<A> annotationClass) {}

public Annotation[] getAnnotations() {}
复制代码

如果获取到的 Annotation 如果不为 null,则就可以调用它们的属性方法了:

@Test()
public class TestDemo{
	
public static void main(String[] args) {
	boolean hasAnnotation = TestDemo.class.isAnnotationPresent(Test.class);
		if ( hasAnnotation ) {
			TestAnnotation testAnnotation = TestDemo.class.getAnnotation(Test.class);
			System.out.println("id:"+testAnnotation.id());
			System.out.println("msg:"+testAnnotation.msg());
		}
	}

}
复制代码

上面的例子中,只是检阅出了注解在类上的注解。**其实属性、方法上的注解照样是可以的。**同样还是要假手于反射。

@TestAnnotation(msg="hello world")
public class Test {
	
	@Check(value="this is local value")
	int tempValue;
	
	
	@Perform
	public void testMethod(){}
	
	
        //不提示这是过时方法的ide提示
	@SuppressWarnings("deprecation")
	public void testSuppressWarnings(){
	    Stu stu = new Stu();
            stu.getNameOld();
            stu.getName();
	}
 
 
	public static void main(String[] args) {
		
		boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class);
		// 获得注解中的属性信息
		if ( hasAnnotation ) {
			TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class);
			System.out.println("id:"+testAnnotation.id());
			System.out.println("msg:"+testAnnotation.msg());
		}
		
		//获取被注解的类的成员变量以及方法信息
		try {
			Field tempValue = Test.class.getDeclaredField("tempValue");
			tempValue.setAccessible(true);
			//获取一个成员变量上的注解
			Check check = tempValue.getAnnotation(Check.class);
			
			if ( check != null ) {
				System.out.println("check value:"+check.value());
			}
			
			Method testMethod = Test.class.getDeclaredMethod("testMethod");
			
			if ( testMethod != null ) {
				// 获取方法中的注解
				Annotation[] ans = testMethod.getAnnotations();
				for( int i = 0;i < ans.length;i++) {
					System.out.println("method testMethod annotation:"+ans[i].annotationType().getSimpleName());
				}
			}
		} catch (NoSuchFieldException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
			System.out.println(e.getMessage());
		} catch (SecurityException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
			System.out.println(e.getMessage());
		} catch (NoSuchMethodException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
			System.out.println(e.getMessage());
		}
 
	}
 
}
复制代码

运行结果:

id:1
msg:hello world
check value:hi
method testMethod annotation:Perform
复制代码

六 注解的使用场景

  • 提供信息给编译器: 编译器可以利用注解来探测错误和警告信息
  • 编译阶段时的处理: 软件工具可以用来利用注解信息来生成代码、Html文档或者做其它相应处理。
  • 运行时的处理: 某些注解可以在程序运行的时候接受代码的提取 值得注意的是,注解不是代码本身的一部分。

官方文档的解释上,注解主要针对的是编译器和其它工具软件(SoftWare tool)。当开发者使用了Annotation 修饰了类、方法、Field 等成员之后,这些 Annotation 不会自己生效,必须由开发者提供相应的代码来提取并处理 Annotation 信息。这些处理提取和处理 Annotation 的代码统称为 APT(Annotation Processing Tool)。

所以注解有什么用?给谁用?答:给编译器 or APT 或者 其他工具类型的软件用的。值得注意的是,注解的提取需要 Java 的反射,而反射比较慢,所以注解使用时需要考虑时间成本的消耗。

七 注解实战之简易测试框架

有了注解,我们就可以在我们的代码中,侵入性很小的进行简单测试框架的编写。首先定义一个需要被测试时添加的注解:

@Retention(RetentionPolicy.RUNTIME)
public @interface SimpleTest {

}
复制代码

接着,在我们需要被测试的代码段上,添加该注解,这里以方法测试为例:

public class BugCodeAutoTest {
	
	@SimpleTest
	public void divideZero(){
		System.out.println("1 / 0 = " + 1 / 0);
	}
	
        @SimpleTest
	public void normalFun(){
		System.out.println("1 + 1 = " + (1 +1) );
	}
 
}
复制代码

此时就可以进行测试工具类的编写了:

public class TestTool {
 
	public static void main(String[] args) {
 
		BugCodeAutoTest bugCodeAutoTest = new BugCodeAutoTest();
		Class clazz = bugCodeAutoTest.getClass();
		
		Method[] method = clazz.getDeclaredMethods();
		//用来记录测试产生的 log 信息
		StringBuilder log = new StringBuilder();
		// 记录异常的次数
		int errornum = 0;
		
		for ( Method m: method ) {
			// 对被 @SimlpeTest 标注过的方法进行测试
			if ( m.isAnnotationPresent( SimlpeTest.class )) {
				try {
					m.setAccessible(true);
					m.invoke(bugCodeAutoTest, null);
				
				} catch (Exception e) {
					
					//e.printStackTrace();
					errornum++;
					log.append(m.getName());
					log.append(" ");
					log.append("has error:");
					log.append("\n\r  caused by ");
					//记录测试过程中,发生的异常的名称
					log.append(e.getCause().getClass().getSimpleName());
					log.append("\n\r");
					//记录测试过程中,发生的异常的具体信息
					log.append(e.getCause().getMessage());
					log.append("\n\r");
				} 
			}
		}
		
		
		log.append(clazz.getSimpleName());
		log.append(" has  ");
		log.append(errornum);
		log.append(" error.");
		
		// 生成测试报告
		System.out.println(log.toString());
 
	}
 
}
复制代码

运行结果:

 divideZero has error:

  caused by ArithmeticException

  by zero

BugCodeAutoTest has  1 error.
复制代码

上述代码中有个invoke方法,Method中invoke(Object obj,Object...args)第一个参数为类的实例,第二个参数为相应函数中的参数。如果函数是一个多参数的函数,可以这样调用:method.invoke(object, new Object[][]{new Object[]{obj1, obj2}}),这样相当于object.method(obj1, obj2):

method2.invoke(test, new String[][]{new String[]{"a", "b"}});
复制代码

补充1 :元数据

术语定义
元数据关于数据的数据。JSR-175 的目标是在 Java 语言中提供元数据工具。
批注一种特殊的 Java 结构,用来修饰类、方法、字段、参数、变量、构造器或包。它是 JSR-175 选择用来提供元数据的工具。
批注类型具有特殊实施的各种命名批注
属性由批注指定的一个特殊的元数据项目。有时可以和批注交替使用

例如:富士苹果有一个属性:它是红色的。假定有一个 FujiApple 类,您可以使用 @Color 批注类型的一个批注来指定它的颜色。通过这么做,您就提供了关于苹果的元数据。

元数据从metadata一词译来,就是“关于数据的数据”的意思,即描述数据的结构信息。元数据的功能作用有很多,比如:你可能用过Javadoc的注释自动生成文档。这就是元数据功能的一种。总的来说,元数据可以用来创建文档,跟踪代码的依赖性,执行编译时格式检查,代替已有的配置文件。

在Java中元数据以标签的形式存在于Java代码中,元数据标签的存在并不影响程序代码的编译和执行,被用来生成其它的文件或只在运行时知道被运行代码的描述信息。

其作用如下:

①生成文档:这是最常见的,也是java 最早提供的注解。常用的有@param @return 等;

② 跟踪代码依赖性,实现替代配置文件功能。常见的是spring 2.5 开始的基于注解配置。作用就是减少配置。现在的框架基本都使用了这种配置来减少配置文件的数量。;

③在编译时进行格式检查。如@override 放在方法前,如果你这个方法并不是覆盖了超类方法,则编译时就能检查出。

参考文章:

充分利用 Java 的元数据

我觉得最好的一篇注解文章:秒懂,Java 注解 (Annotation)你可以这样学:

Java注解-元数据、注解分类、内置注解和自定义注解:

分类:
后端