Java基础加强第四讲注解(上)——注解入门

刺骨的言语ヽ痛彻心扉 2022-03-25 07:46 246阅读 0赞

# Annotation(注解)的概述 #

从JDK1.5开始，Java增加了对元数据(MetaData)的支持，也就是Annotation(注解)。Annotation其实就是代码里的特殊标记，它用于替代配置文件，也就是说，传统方式通过配置文件告诉类如何运行，有了注解技术后，开发人员可以通过注解告诉类如何运行。在Java技术里注解的典型应用是可以通过反射技术去得到类里面的注解，以决定怎么去运行类。  
![在这里插入图片描述][20190119145553894.png]

# 了解注解及Java提供的几个基本注解 #

Java提供了三个基本注解，下面我会一一进行讲解。

1.  @SuppressWarnings：抑制编译器警告。  
    首先编写一个AnnotationTest类，先通过@SuppressWarnings的应用让大家认识和了解一下注解，通过`System.runFinalizersOnExit(true);`的编译警告引出@SuppressWarnings(“deprecation”)。  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70]
2.  @Deprecated：用于表示某个程序元素(类，方法等)已过时。  
    接着直接在刚才的类中增加一个方法，并加上@Deprecated标注，在另外一个类中调用这个方法。  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 1]  
    如果在另外一个类中调用这个方法，那么效果就是下面这样。  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 2]
3.  @Override：限定重写父类方法，该注解只能用于方法上。  
    表示一个方法声明打算重写超类中的另一个方法声明。如果方法利用此注释类型进行注解但没有重写超类方法，则编译器会生成一条错误消息。

总结：注解相当于一种标记，在程序中加了注解就等于为程序打上了某种标记，没加，则等于没有某种标记，以后，javac编译器，开发工具和其他程序可以用反射来了解你的类及各种元素上有无何种标记，看你有什么标记，就去干相应的事。标记可以加在包，类，字段，方法，方法的参数以及局部变量上。

# 注解的应用结构图 #

注解就相当于一个你的源程序中要调用的一个类，要在源程序中应用某个注解，得先准备好了这个注解类，就像你要调用某个类，得先要开发好这个类。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 3]

# 自定义注解及其应用 #

定义一个Annotation类型使用@interface关键字。如下，我定义了一个最简单的注解。

package cn.liayun.annotation;
    
    /* * * 注解也是一个特殊的类 */
    public @interface LiayunAnnotation { 
    	
    }

可把它加在某个类上，  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 4]  
最后，用反射进行测试AnnotationTest的定义上是否有@LiayunAnnotation：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 5]  
发现Eclipse控制台无任何输出，根据反射测试的问题，引出@Retention元注解的讲解。

## @Retention元注解 ##

只能用于修饰一个Annotation的定义，用于指定该Annotation可以保留的域，@Rentention包含一个RetentionPolicy类型的成员变量，通过这个变量指定域。其有三种取值：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 6]  
分别对应：java源文件→class文件→内存中的字节码。也即一个注解类的存在区域有3种状态：  
![在这里插入图片描述][20190119162557543.png]  
下面我会对@Retention元注解进行更加细致的解释：

*  当在java源程序上加入注解，此源程序接着要由javac去编译，javac把源文件编译成.class时，可能会把源程序上的一些注解给去掉，此时.class文件里面就没有注解了，这是一种可能；
 *  假设javac编译器把注解留在了.class文件里面，结果我们的程序在使用.class时，要由类加载器把.class文件给调到内存里来，只有把.class文件加载到内存里来之后，类加载器加载完了之后，类加载器会对.class文件进行处理，比如安全检查等，处理完了之后，在内存中最终的二进制文件才是字节码。类加载器在把.class文件调到内存的过程中，也有转换，转换的时候是否把.class文件里面的注解保留下来，这也是一种可能。

所以，一个注解的生命周期有3个阶段。现在我将定义的简单注解修改为如下，

package cn.liayun.annotation;
    
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    
    /* * * 注解也是一个特殊的类 */
    @Retention(RetentionPolicy.RUNTIME)//注解的注解，称之为元注解，
    public @interface LiayunAnnotation {  //表示我们定义的注解一直保持到运行期间
    	
    }

就能正确打印了。  
所以，可以得出一个结论：我们写一个注解的目的，主要是用来替换配置文件，我们希望这个类在运行时获得注解配置的信息，来运行我这个类，想要注解配置的信息能够让类在运行时获取到，那就一定要把这个注解声明在运行时。  
介绍完@Retention元注解之后，可以思考这样一个问题，@Override、@SuppressWarnings和@Deprecated这三个注解的属性值分别是什么？  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 7]

## @Target元注解 ##

该元注解指定注解用于修饰类的哪个成员。@Target包含了一个名为value，类型为ElementType的成员变量。如若声明注解时，没指定@Target，默认该注解可以作用在类的所有成员上。  
Target的默认值为任何元素，设置Target等于ElementType.METHOD，原来加在类上的注解就报错了。如下，  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 8]  
改为用数组方式设置\{ElementType.METHOD, ElementType.TYPE\}就可以了，表示此注解既可以在方法上使用，也可在类上使用。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 9]

## @Documented元注解 ##

用于指定被该元Annotation修饰的Annotation类将被javadoc工具提取成文档。

## @Inherited元注解 ##

被它修饰的Annotation将具有继承性。如果某个类使用了被@Inherited修饰的Annotation，则其子类将自动具有该注解。  
注意，元注解以及其枚举属性值不用记，只要会看JDK提供那几个基本注解的API帮助文档的定义或其源代码，按图索骥即可查到，或者直接看java.lang.annotation包下面的类。

# 为注解增加基本属性 #

## 什么是注解的属性？ ##

一个注解相当于一个胸牌，如果你胸前贴了胸牌，就是某某公司的员工，否则，就不是。如果还想区分出是某某公司哪个部门的员工，这时候可以为胸牌再增加一个属性来进行区分。加了属性的标记效果为：@LiayunAnnotation(color=“red”)。  
注解属性的作用：原来写在配置文件中的信息，可以通过注解的属性进行描述。

## 定义基本类型的属性以及应用该属性 ##

在LiayunAnnotation注解类中增加String color()，如下：

package cn.liayun.annotation2;
    
    import java.lang.annotation.ElementType;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    
    /* * * 注解也是一个特殊的类 */
    @Retention(RetentionPolicy.RUNTIME)
    @Target({ ElementType.METHOD, ElementType.TYPE})
    public @interface LiayunAnnotation { 
    	String color();
    }

用反射方式获得注解对应的实例对象后，再通过该对象调用属性对应的方法。

package cn.liayun.annotation2;
                                                   
    @LiayunAnnotation(color = "red")//为注解设置属性
    public class AnnotationTest { 
    
    	@SuppressWarnings("deprecation")//压缩警告
    	public static void main(String[] args) { 
    		System.runFinalizersOnExit(true);
    		
    		/* * 检查一个类上是否有应用@LiayunAnnotation注解？ */
    		if (AnnotationTest.class.isAnnotationPresent(LiayunAnnotation.class)) { 
    			//得到类上应用的具体注解，即创建了一个类(注解)的实例对象
    			LiayunAnnotation annotation = AnnotationTest.class.getAnnotation(LiayunAnnotation.class);
    			System.out.println(annotation.color());
    		}
    	}
    	
    	@Deprecated//表示该方法已过时，即该方法已作废
    	public static void sayHello() { 
    		System.out.println("hi，我是李阿昀");
    	}
    	
    	//@Override注解：表示子类覆盖父类的方法
    
    }

可以认为上面这个@LiayunAnnotation(color = “red”)是LiayunAnnotation类的一个实例对象。

### 为属性指定缺省值 ###

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 10]

### value属性 ###

如果注解中有一个名称为value的属性，且你只想设置value属性（即其他属性都采用默认值或者你只有一个value属性），那么可以省略value=部分，例如：@LiayunAnnotation(“liayun”)。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 11]

# 为注解增加高级属性 #

## 数组类型的属性 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 12]  
注意：如果数组属性中只有一个元素，这时候属性值部分可以省略大括号。

## 枚举类型的属性 ##

既然要为注解增加一个枚举类型的属性，那么就应该定义一个枚举，如TrafficLamp交通灯。

package cn.liayun.annotation2;
    
    public enum TrafficLamp { 
    	//每个元素分别是由枚举类(抽象类)的子类来生成的
    	RED(30) { //RED(30)表示调用哪个构造函数
    
    		@Override
    		public TrafficLamp nextLamp() { 
    			return GREEN;
    		}
    		
    	},
    	GREEN(45) { 
    
    		@Override
    		public TrafficLamp nextLamp() { 
    			return YELLOW;
    		}
    		
    	},
    	YELLOW(5) { 
    
    		@Override
    		public TrafficLamp nextLamp() { 
    			return RED;
    		}
    		
    	};
    	//定义一个抽象方法
    	public abstract TrafficLamp nextLamp();
    	private int time;//指定每个灯的时间
    	private TrafficLamp(int time) {  this.time = time; }
    }

接下来就要为注解增加一个TrafficLamp枚举类型的属性了。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 13]

## 注解类型的属性 ##

我们再定义一个注解MetaAnnotation：

package cn.liayun.annotation2;
    
    public @interface MetaAnnotation { 
    	String value();
    }

接下来就要为注解增加一个MetaAnnotation注解类型的属性了。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 14]  
枚举和注解都是特殊的类，不能用new创建它们的实例对象，创建枚举的实例对象就是在其中增加元素。在程序中如何创建出一个注解的实例对象啊？直接用@放上一个标记即可，例如：  
![在这里插入图片描述][20190119165927744.png]  
可以认为@@LiayunAnnotation是@LiayunAnnotation类的一个实例对象，同样的道理，可以认为@MetaAnnotation是MetaAnnotation类的一个实例对象。  
注解的详细语法可以通过看java语言规范了解，即看java的language specification，可知道**注解的属性类型包括：基本数据类型，String，Class，枚举，其他注解，以及这些类型的数组**。

[20190119145553894.png]: /images/20220325/28fccfe2580045858fdc1e432d81338f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70]: /images/20220325/dfa39f2baca74fa684a169d80fb84639.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 1]: /images/20220325/5b0291b7880447199a603c7f75988d7a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 2]: /images/20220325/f1afa89a82ab4045b28dd005f7b518bc.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 3]: /images/20220325/9cdf0499e4b2423f9529a02d415d9614.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 4]: /images/20220325/ed1bb9a8df2e4dd48b8f53021cdb7bb7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 5]: /images/20220325/bd20775401f94f2cac26d6547b72721f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 6]: /images/20220325/a96ee9e1749d4d4494a944923538f7d5.png
[20190119162557543.png]: /images/20220325/4f10eb389151429eb3044bf81199fa67.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 7]: /images/20220325/ee2b6071765e41e1a257c3eabdb111eb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 8]: /images/20220325/ea16c436391c45db8d3966c1fe446ab7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 9]: /images/20220325/8fb5522855e341cea29b8ad4c678df42.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 10]: /images/20220325/ad075c3fa62440a5bfa9f06466ed7bab.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 11]: /images/20220325/f1098921c8a0402d92183d6120525447.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 12]: /images/20220325/3f1648d285ea4463b6b58bce7933de4e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 13]: /images/20220325/93f15f0869264ad48450f3ea20238d2a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 14]: /images/20220325/650070d5b3214a66a47d763ca51adf58.png
[20190119165927744.png]: /images/20220325/5aa3477333ff46fabfa11a79c9a41dcd.png