Java 注解 (Annotation)使用

830 阅读12分钟

文章目录

简介

Annotation 中文译过来就是注解、标释的意思,在 Java 中注解是一个很重要的知识点,初学者可以这样理解注解:想像代码具有生命,注解就是对于代码中某些鲜活个体的贴上去的一张标签。简化来讲,注解如同一张标签

因为平常开发少见,相信有不少的人员会认为注解的地位不高。其实同 class 和 interface 一样,注解也属于一种类型。它是在 Java SE 5.0 版本中开始引入的概念

注解的定义和使用

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

public @interface TestAnnotation {
}

它的形式跟接口很类似,不过前面多了一个 @ 符号。上面的代码就创建了一个名字为 TestAnnotaion 的注解

既然创建了一个注解,那么注解的的使用方法是什么呢

@TestAnnotation
public class Test {
}

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

不过,要想注解能够正常工作,还需要介绍一个新的概念那就是元注解

元注解

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

元标签有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 种

@Retention

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

它的取值如下:

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

@Retention 相当于给一张标签上面盖了一张时间戳,时间戳指明了标签张贴的时间周期

@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
}

上面的代码中,我们指定 TestAnnotation 可以在程序运行周期被获取到,因此它的生命周期非常的长

@Documented

顾名思义,这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去

@Target

Target 是目标的意思,@Target 指定了注解运用的地方

类比到标签,原本标签是你想张贴到哪个地方就到哪个地方,但是因为 @Target 的存在,它张贴的地方就非常具体了,比如只能张贴到方法上、类上、方法参数上等等。@Target 有下面的取值

  • ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
  • ElementType.CONSTRUCTOR 可以给构造方法进行注解
  • ElementType.FIELD 可以给属性进行注解
  • ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
  • ElementType.METHOD 可以给方法进行注解
  • ElementType.PACKAGE 可以给一个包进行注解
  • ElementType.PARAMETER 可以给一个方法内的参数进行注解
  • ElementType.TYPE 可以给一个类型进行注解,比如类、接口、枚举

@Inherited

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

@Inherited
@Retention(RetentionPolicy.RUNTIME)
@interface Test {}


@Test
public class A {}


public class B extends A {}

注解 Test 被 @Inherited 修饰,之后类 A 被 Test 注解,类 B 继承 A,类 B 也拥有 Test 这个注解

@Repeatable

Repeatable 自然是可重复的意思

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

举个例子,一个人他既是程序员又是产品经理,同时他还是个画家

@interface Persons {
	Person[]  value();
}


@Repeatable(Persons.class)
@interface Person{
	String role default "";
}


@Person(role="artist")
@Person(role="coder")
@Person(role="PM")
public class SuperMan{
	
}

注意上面的代码,@Repeatable 注解了 Person。而 @Repeatable 后面括号中的类相当于一个容器注解

什么是容器注解呢?就是用来存放其它注解的地方。它本身也是一个注解

我们再看看代码中的相关容器注解

@interface Persons {
	Person[]  value();
}

按照规定,它里面必须要有一个 value 的属性,属性类型是一个被 @Repeatable 注解过的注解数组,注意它是数组

如果不好理解的话,可以这样理解。Persons 是一张总的标签,上面贴满了 Person 这种同类型但内容不一样的标签。把 Persons 给一个 SuperMan 贴上,相当于同时给他贴了程序员、产品经理、画家的标签。

我们可能对于 @Person(role=“PM”) 括号里面的内容感兴趣,它其实就是给 Person 这个注解的 role 属性赋值为 PM ,大家不明白正常,马上就讲到注解的属性这一块

注解的属性

注解的属性也叫做成员变量。注解只有成员变量,没有方法。注解的成员变量在注解的定义中以“无形参的方法”形式来声明,其方法名定义了该成员变量的名字,其返回值定义了该成员变量的类型

  1. 以下代码定义了 TestAnnotation 这个注解中拥有 id 和 msg 两个属性。在使用的时候,我们应该给它们进行赋值
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
	
	int id();
	
	String msg();

}

赋值的方式是在注解的括号内以 value="" 形式,多个属性之前用 ,隔开

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

}

需要注意的是,在注解中定义属性时它的类型必须是 8 种基本数据类型外加 类、接口、注解及它们的数组

  1. 注解中属性可以有默认值,默认值需要用 default 关键值指定。比如
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
	
	public int id() default -1;
	
	public String msg() default "Hi";

}

@TestAnnotation()
public class Test {}

TestAnnotation 中 id 属性默认值为 -1,msg 属性默认值为 Hi,因为有默认值,所以无需要再在 @TestAnnotation 后面的括号里面进行赋值了,这一步可以省略

  1. 如果一个注解内仅仅只有一个名字为 value 的属性时,应用这个注解时可以直接将属性值填写到括号内
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Check {
	String value();
}

Check 这个注解只有 value 这个属性。所以可以这样应用

@Check("hi")
int a;

这和下面的效果是一样的

@Check(value="hi")
int a;
  1. 还需要注意的一种情况是一个注解没有任何属性,那么在应用这个注解的时候,括号都可以省略
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Perform {

}

@Perform
public void testMethod(){}

Java 预置的注解

以上学习了自定义注解,其实Java 语言本身已经提供了几个现成的注解

@Deprecated

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

定义了一个 Hero 类,它有两个方法 say() 和 speak() ,其中 say() 被 @Deprecated 注解

public class Hero {
    @Deprecated
    public void say(){
        Log.d("Hero","I have nothing to say");
    }

    public void speak(){
        Log.d("Hero","I have a dream");
    }
}

然后我们在 IDE 中分别调用它们
在这里插入图片描述
say() 方法上面被一条直线划了一条,这其实就是编译器识别后的提醒效果

@Override

这个大家应该很熟悉了,提示子类要复写父类中被 @Override 修饰的方法

@SuppressWarnings

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

@SuppressWarnings("deprecation")
    public void test1(){
        Hero hero = new Hero();
        hero.say();
        hero.speak();
    }

@SafeVarargs

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

@FunctionalInterface

函数式接口注解。函数式接口 (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 表达式。这是另外的主题了,有兴趣的同学请自己搜索相关知识点学习

注解与反射

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

类上的注解

public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}

然后通过 getAnnotation() 方法来获取 Annotation 对象

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

或者是 getAnnotations() 方法

public Annotation[] getAnnotations() {}

前一种方法返回指定类型的注解,后一种方法返回注解到这个元素上的所有注解
如果获取到的 Annotation 如果不为 null,则就可以调用它们的属性方法了。比如

我们打开Eclipse,新建一个
在这里插入图片描述

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
	
	public int id() default -1;
	
	public String msg() default "Hi";

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

程序运行结果是
在这里插入图片描述
这个正是 TestAnnotation 中 id 和 msg 的默认值

属性、方法上的注解

上面的例子中,只是检阅出了注解在类上的注解,其实属性、方法上的注解照样是可以的

import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.lang.reflect.Method;

@TestAnnotation(msg="Hello")
public class HelloWorld {
	@Check(value="hi")
	int a;
	
	
	@Perform
	public void testMethod(){}
	
	
	@SuppressWarnings("deprecation")
	public void test1(){
		Hero hero = new Hero();
		hero.say();
		hero.speak();
	}


	public static void main(String[] args) {
		
		boolean hasAnnotation = HelloWorld.class.isAnnotationPresent(TestAnnotation.class);
		
		if ( hasAnnotation ) {
			TestAnnotation testAnnotation = HelloWorld.class.getAnnotation(TestAnnotation.class);
			//获取类的注解
			System.out.println("id:"+testAnnotation.id());
			System.out.println("msg:"+testAnnotation.msg());
		}
		
		
		try {
			//获取类本身的属性成员
			Field a = HelloWorld.class.getDeclaredField("a");
			//将此对象的 accessible 标志设置为指示的布尔值。值为 true 则指示反射的对象在使用时应该取消 Java 语言访问检查。值为 false 则指示反射的对象应该实施 Java 语言访问检查。 
			a.setAccessible(true);
			//获取一个成员变量上的注解
			Check check = a.getAnnotation(Check.class);
			
			if ( check != null ) {
				System.out.println("check value:"+check.value());
			} else {
				System.out.println("check is null");
			}
			
			Method testMethod = HelloWorld.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());
				}
			} else {
				System.out.println("testMethod is null");
			}
		} 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());
		}
		
	}
}

查看运行结果
在这里插入图片描述
需要注意的是,如果一个注解要在运行时被成功提取,那么 @Retention(RetentionPolicy.RUNTIME) 是必须的

注解的使用场景

注解到底有什么用?我们不妨将目光放到 Java 官方文档上来

注解是一系列元数据,它提供数据用来解释程序代码,但是注解并非是所解释的代码本身的一部分。注解对于代码的运行效果没有直接影响

注解的作用如下:

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

值得注意的是,注解不是代码本身的一部分

注解同样无法改变代码本身,注解只是某些工具的的工具,注解主要针对的是编译器和其它工具软件(SoftWare tool)

当开发者使用了Annotation 修饰了类、方法、Field 等成员之后,这些 Annotation 不会自己生效,必须由开发者提供相应的代码来提取并处理 Annotation 信息。这些处理提取和处理 Annotation 的代码统称为 APT(Annotation Processing Tool)

栗子

要写一个测试框架,测试程序员的代码有无明显的异常
—— 程序员 A : 我写了一个类,它的名字叫做 NoBug,因为它所有的方法都没有错误
—— 我:自信是好事,不过为了防止意外,让我测试一下如何?
—— 程序员 A: 怎么测试?
—— 我:把你写的代码的方法都加上 @Jiecha 这个注解就好了
—— 程序员 A: 好的

NoBug.class

public class NoBug {
	@CheckError
	public void suanShu() {
		System.out.println("1234567890");
	}

	@CheckError
	public void jiafa() {
		System.out.println("1+1=" + 1 + 1);
	}

	@CheckError
	public void jianfa() {
		System.out.println("1-1=" + (1 - 1));
	}

	@CheckError
	public void chengfa() {
		System.out.println("3 x 5=" + 3 * 5);
	}

	@CheckError
	public void chufa() {
		System.out.println("6 / 0=" + 6 / 0);
	}
}

上面的代码,有些方法上面运用了 @CheckError 注解

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

}

接下来就可以测试 NoBug 相应的方法了

public class HelloWorld {
	public static void main(String[] args) {
		NoBug testobj = new NoBug();

		Class clazz = testobj.getClass();

		Method[] method = clazz.getDeclaredMethods();
		// 用来记录测试产生的 log 信息
		StringBuilder log = new StringBuilder();
		// 记录异常的次数
		int errornum = 0;

		for (Method m : method) {
			// 只有被 @CheckError 标注过的方法才进行测试
			if (m.isAnnotationPresent(CheckError.class)) {
				try {
					m.setAccessible(true);
					//用来执行某个的对象的目标方法
					m.invoke(testobj, null);

				} catch (Exception e) {
					// TODO Auto-generated catch block
					// 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());
	}
}

查看运行结果
在这里插入图片描述
提示 NoBug 类中的 chufa() 这个方法有异常,这个异常名称叫做 ArithmeticException,原因是运算过程中进行了除 0 的操作

这样,通过注解我完成了我自己的目的,那就是对别人的代码进行测试

所以,注解什么时候用?我只能告诉你,这取决于你想利用它干什么用

注解应用实例

注解运用的地方太多了,Android开发过程中接触到的栗子有以下:

JUnit

JUnit 这个是一个测试框架,典型使用方法如下:

public class MyMathTest {

    @Test
    public void add() {
        ...
    }
}

@Test 标记了要进行测试的方法add()

之前关于JUnit的文章传送门

ButterKnife

经典用法

@BindView(R.id.tv_test)
TextView mTv;

之前关于ButterKnife的文章传送门

等等

frank909的博文 写的很详细,学到了很多 ( •̀ ω •́ )y