Java 注解

电玩女神 2021-06-22 15:37 434阅读 0赞

# 注解 #

## 一、什么是注解 ##

什么是注解呢？  
Java 注解（Annotation）又称 Java 标注，是 JDK5.0 引入的一种注释机制。例如我们以前用到的测试一个方法的时候，就使用了`@Test`注解。  
注解的语法就是：`@注解名称`  
注解的作用就是为了替代xml配置文件，在servlet3.0中，就可以不再使用web.xml，而是所有的配置都使用注解。  
注解是由框架来读取使用的。

**例如在web.xml里面，我们要写`<servlet>`和`<servlet-mapping>`，这些配置文件由Tomcat读取，我们来编写。  
在Servlet3.0中就可以使用使用注解来代替配置文件，开发者就不用再写配置文件了，而是写注解，然后Tomcat来读取注解。**

## 二、注解的使用 ##

注解的使用分为三个步骤：

1.  定义注解类。这一步往往是框架来实现的。
2.  使用注解。这一步是我们需要使用的。
3.  读取注解。这一步往往也是框架来实现的。

### 2.1、定义注解类 ###

定义注解类不能使用class、enum，也不能使用interface，而是使用`@interface`。  
例如：

/** * 定义注解类 * * @author Veeja.Liu * @emial veejaliu@gmail.com * */
    @interface MyAnno1 { 
    
    }

这样我们就完成了一个注解类**MyAnno1**的定义。

### 2.2 使用注解类 ###

怎么样来使用注解类呢？  
很简单，我们像以前一样，在类或者方法的上方加上`@MyAnno1`就可以使用我们刚才我们定义的注解类了。  
即：

@MyAnno1
    public class Demo3 { 
    	//上方使用注解类
    }

注解都可以使用在什么上面呢？  
我们在类、类成员变量、类构造函数、类成员方法、成员方法参数、局部变量上使用，发现都是可以的。  
例如：

@MyAnno1
    public class Demo3 { 
    	@MyAnno1
    	private String name;
    
    	@MyAnno1
    	public Demo3() { 
    
    	}
    
    	@MyAnno1
    	public void fun1() { 
    
    	}
    
    	public void fun2(@MyAnno1 String name) { 
    		@MyAnno1
    		String username = "hello";
    	}
    }

在以上这些地方使用注解，都是可以的。  
当然，注解也可以放在package上，但是没什么用。就不再赘述了。

## 三、注解的属性 ##

### 3.1 定义属性 ###

**定义属性的语法就是`变量类型 属性名()`。**  
虽然看起来这像是一个方法，因为有一对小括号，但是它就是一个属性， 注解的属性。  
例如：

/** * 定义注解类 */
    @interface MyAnno1 { 
    	//定义了两个属性，int类型的age，String类型的name
    	int age();
    	String name();
    }

### 3.2 使用注解时给属性赋值 ###

我们如果给注解类定义了属性，那么在使用注解的时候就必须给出属性的值。否则就会报错。  
例如：

@MyAnno1(age = 10, name = "username")
    public class Demo2 { 
    
    }

### 3.3 注解属性的默认值 ###

**注解的属性还可以有默认值**，在使用注解时就可以不给带有默认值的属性赋值了。但没有给出默认值的属性还是要赋值的。  
例如：

@MyAnno2(name = "veeja")
    public class Demo2 { 
    
    }
    /** * 定义注解类 */
    @interface MyAnno2 { 
    	// 定义了两个属性
    	// int类型的age，age的默认值为100
    	int age() default 100;
    
    	// String类型的name，name没有默认值
    	String name();
    }

### 3.4 名为value的属性的特权 ###

如果我们定义注解类的时候，给出了一个名为value的属性，那么**在使用注解的时候给value赋值**，可以不用指定属性名，直接给出属性的值就可以了。  
例如：

@MyAnno3(100)
    public class Demo2 { 
    
    }
    
    @interface MyAnno3 { 
    	int value();
    	String name() default "name";
    }

### 3.5 注解属性的类型 ###

注解的属性类型都可以是哪些呢？  
注解的属性类型可以是**8种基本的类型，以及String类型，Enum枚举类型，Class类型，甚至还可以是注解类型，当然还可以是以上类型的一维数组类型**。

例如，我们在一个注解类中添加上以上所有的注解属性类型。

@interface MyAnno1 { 
    
    	int a(); // 基本类型
    
    	String b();// String类型
    
    	MyEnum1 c();// 枚举类型
    
    	Class d();// Class类型
    
    	MyAnno2 e();// 注解类型
    
    	String[] f();// String类型的一位数组类型
    	int[] g();// int类型的一维数组类型
    }
    
    @interface MyAnno2 { 
    	int aa();
    	String bb();
    }
    
    enum MyEnum1 { 
    	A, B, C
    }

那么我们既然定义了以上的注解类型，我们应该怎么使用它呢？  
我们来演示一下：

@MyAnno1(
    	a = 18, 
    	b = "hello", 
    	c = MyEnum1.A, 
    	d = String.class, 
    	e = @MyAnno2(aa = 18, bb = "HELLO"), 
    	f = {  "a", "b", "c" }, 
    	g = {  0, 1, 2 }
    )
    public class Demo3 { 
    
    }

而且要注意一点，再给数组类型的属性赋值的时候，不可以使用`g = new int[]{0,1,2}`，而是直接使用大括号加元素来赋值`g = { 0, 1, 2 }`，例如。而且，当数组里面只有一个元素的时候，我们可以省略大括号，只写一个值就可以了，例如`g = 0`。

## 四、注解的作用目标限定以及保留策略限定 ##

### 4.1 作用目标限定 ###

什么是作用目标限定呢？顾名思义，就是限制注解的使用目标，我们知道注解可以使用在很多地方上，我们可以通过某种方式来限制注解的使用范围，例如只让注解使用在类上，而不能使用在方法上。  
我们应该怎么做呢，就是在定义注解类的时候，给注解类加上`@Taeget`注解，**这个注解有一个属性为value，类型是ElementType\[\]，它是枚举类型。**

我们可以打开它的源码，看一看：

/* * @(#)ElementType.java 1.8 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */
    
    package java.lang.annotation;
    
    /** * A program element type. The constants of this enumerated type * provide a simple classification of the declared elements in a * Java program. * * <p>These constants are used with the {@link Target} meta-annotation type * to specify where it is legal to use an annotation type. * * @author Joshua Bloch * @since 1.5 */
    public enum ElementType { 
        /** Class, interface (including annotation type), or enum declaration */
        TYPE,
    
        /** Field declaration (includes enum constants) */
        FIELD,
    
        /** Method declaration */
        METHOD,
    
        /** Parameter declaration */
        PARAMETER,
    
        /** Constructor declaration */
        CONSTRUCTOR,
    
        /** Local variable declaration */
        LOCAL_VARIABLE,
    
        /** Annotation type declaration */
        ANNOTATION_TYPE,
    
        /** Package declaration */
        PACKAGE
    }

我们看到，它支持的值分别是：

*  TYPE：
 *  FIELD
 *  METHOD
 *  PARAMETER
 *  CONSTRUCTOR
 *  LOCAL\_VARIABLE
 *  ANNOTATION\_TYPE
 *  PACKAGE

源码的注释中，也说明了每一种值所代表可以支持的类型。

我们做一个演示，比如我们给注解加上target注解，指定类型为TYPE。  
即：

@Target(value = {  ElementType.TYPE })
    @interface MyAnno1 { 
    
    }

这个时候我们再把注解加到类或者方法上试一试：  
![在这里插入图片描述][20200305115031117.png]  
我们可以看到，这个时候就会报错了。

### 4.2 保留策略限定 ###

注解的保留策略，也就是在程序的编译执行过程中，注解的保留时间。分为三种，

*  源代码文件（SOURCE）：注解只存在在源代码中，当编译的时候注解就背忽略了。
 *  字节码文件（CLASS）：注解在源代码中存在，在编译的时候会把注解信息放到了class文件中，但是在JVM加载类的时候，会忽略掉注解。
 *  JVM中（RUNTIME）：注解在源代码、字节码文件中存在，并且JVM加载类的时候，会把注解加载到JVM内存中（这也是唯一可以反射的注解）。

我们怎么设置注解的保留策略呢。也是通过给注解添加注解，也就是在注解的上方添加`@Retention`注解。  
这个注解也有一个属性为value，其值也是RetentionPolicy类型的，是枚举类型，我们打开源码可以看到：

/* * @(#)RetentionPolicy.java 1.5 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */
    
    package java.lang.annotation;
    
    /** * Annotation retention policy. The constants of this enumerated type * describe the various policies for retaining annotations. They are used * in conjunction with the {@link Retention} meta-annotation type to specify * how long annotations are to be retained. * * @author Joshua Bloch * @since 1.5 */
    public enum RetentionPolicy { 
        /** * Annotations are to be discarded by the compiler. */
        SOURCE,
    
        /** * Annotations are to be recorded in the class file by the compiler * but need not be retained by the VM at run time. This is the default * behavior. */
        CLASS,
    
        /** * Annotations are to be recorded in the class file by the compiler and * retained by the VM at run time, so they may be read reflectively. * * @see java.lang.reflect.AnnotatedElement */
        RUNTIME
    }

共有三种属性可选值：`SOURCE` 、`CLASS` 、`RUNTIME` 。就是对应我们上面描述的三种情况。  
例如我们在某个注解上面添加：

@Retention(value = RetentionPolicy.RUNTIME)
    @interface MyAnno5 { 
    
    }

这样，它就变成了一个可以保留在JVM内存中的注解，这也是唯一可以反射得到的注解。

## 五、反射注解 ##

首先，要想反射注解，首先要求注解的保留策略必须是`RUNTIME`。  
其次，反射注解需要从作用目标上返回，也就是

*  类上的注解，需要使用Class来获取
 *  方法上的注解，需要使用Method来获取
 *  构造器上的注解，需要使用Construcator来获取
 *  成员上的，需要使用Filed来获取

**上面的四种作用目标，我们可以分为两大类，**

*  第一类是`Class`，
 *  第二类是`Method`、`Construcator`、`Filed`，因为这三个类都有一个共同的父类，就是`AccessibleObject`。

**所以我们就只学习获取Class注解的方法和获取Method注解的方法就可以了。**  
而上面的类，他们都有一个方法，就是`Annotation getAnnotation(Class)`，可以返回目标上指定类型的注解。还有一个方法`Annotation[] getAnnotations()`，可以返回目标上所有的注解。

我们来操作一下，先创建一个注解类：

@Retention(value = RetentionPolicy.RUNTIME)
    @interface MyAnno1 { 
    	String name();
    	int age();
    	String sex();
    }

我们在一个类以及类内的方法上使用这个注解：

@MyAnno1(age = 1, name = "A类", sex = "男")
    class A { 
    	@MyAnno1(age = 2, name = "fun1方法", sex = "女")
    	public void fun1() { 
    	}
    }

**那么我们怎么样在运行的时候来得到这些注解呢？**

### 1. 得到类的注解： ###

首先是，先要得到作用目标：

/* * 1.得到作用目标 */
    Class<A> c = A.class;

然后要获取指定类型的注解：

/* * 2. 获取指定类型的注解，因为一个目标上可能会有多个注解 */
    MyAnno1 myAnno1 = c.getAnnotation(MyAnno1.class);

最后我们查看一下注解的属性就可以了：

/* * 3. 打印注解的属性即可。 */
    System.out.println(myAnno1.name() + "," + myAnno1.age() + ","	+ myAnno1.sex());

输出的结果就是：

A类,1,男

### 2. 得到方法的注解： ###

得到方法的注解也是上面的三步走，只不过我们得到的目标是一个方法而不是类，代码稍微有一点点区别：如下：

@Test
    public void fun2() throws SecurityException, NoSuchMethodException { 
    	/* * 1. 得到作用目标 */
    	Class<A> c = A.class;
    	Method method = c.getMethod("fun1");
    	/* * 2. 获取指定类型的注解，因为一个目标上可能会有多个注解 */
    	MyAnno1 myAnno1 = method.getAnnotation(MyAnno1.class);
    	/* * 3. 打印注解的属性即可。 */
    	System.out.println(myAnno1.name() + "," + myAnno1.age() + ","
    			+ myAnno1.sex());
    }

输出的结果就是：

fun1方法,2,女

--------------------

END.

[20200305115031117.png]: /images/20210615/7de380a757064e039ca796fe78c9a87e.png