第17篇-JAVA Annotation 注解

Posted 2020-10-02

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了第17篇-JAVA Annotation 注解相关的知识，希望对你有一定的参考价值。

第17篇-JAVA Annotation 注解

每篇一句 ：真的努力后你会发现自己要比想象的优秀很多
初学心得：怀着一颗奋斗不息的心，一切困苦艰辛自当迎刃而解
(笔者：JEEP/711)[JAVA笔记 | 时间:2017-05-17| JAVA Annotation注解 ]

1.什么是注解（Annotation）

Annotation 其实就是代码里的特殊标记, 它用于替代配置文件，也就是说，传统方式通过配置文件告诉类如何运行，有了注解技术后，开发人员可以通过注解告诉类如何运行。在Java技术里注解的典型应用是：可以通过反射技术去得到类里面的注解，以决定怎么去运行类
Annotation（注解）就是Java提供了一种元程序中的元素关联任何信息和着任何元数据（metadata）的途径和方法
Annotion(注解)是一个接口，程序可以通过反射来获取指定程序元素的Annotion对象，然后通过Annotion对象来获取注解里面的元数据
Annotation(注解)是JDK5.0及以后版本引入的。它可以用于创建文档，跟踪代码中的依赖性，甚至执行基本编译时检查。从某些方面看，annotation就像修饰符一样被使用，并应用于包、类型、构造方法、方法、成员变量、参数、本地变量的声明中

2.基本Annotation

[email protected]: 限定重写父类方法, 该注解只能用于方法
[email protected]: 用于表示某个程序元素(类, 方法等)已过时
[email protected]: 抑制编译器警告

3.自定义Annotation

使用@interface定义Annotation
使用Annotation修饰程序中的类、方法、变量、接口等定义，通常我们会把Annotation放在所有修饰符之前
定义带成员变量的Annotation
为Annotation的成员变量指定初始值

4.提取Annotation信息

Annotation接口来代表程序元素前面的注释，该接口是所有Annotation类型的父接口
AnnotatedElement接口代表程序中可以接受注释的程序元素
调用AnnotatedElement对象的如下三个方法来访问Annotation信息：
getAnnotation(Class annotationClass)：返回该程序元素上存在的、指定类型的注释,如果该类型的注释不存在,则返回null
Annotation[] getAnnotations()：返回该程序元素上存在的所有注释
boolean isAnnotationPresent(Class<? extends Annotation> annotationClass)：判断该程序元素上是否包含指定类型的注释，存在则返回true，否则返回false

5.Annotation 注解实例

自定义Annotation

1.import java.lang.annotation.Documented;  
2.import java.lang.annotation.ElementType;  
3.import java.lang.annotation.Retention;  
4.import java.lang.annotation.RetentionPolicy;  
5.import java.lang.annotation.Target;  
6./** 
7. * 定义一个注解 
8. */  
[email protected](ElementType.METHOD) // 这是一个对方法的注解，还可以是包、类、变量等很多东西  
[email protected](RetentionPolicy.RUNTIME) // 保留时间，一般注解就是为了框架开发时代替配置文件使用，JVM运行时用反射取参数处理，所以一般都为RUNTIME类型  
[email protected] // 用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化  
12.public @interface OneAnnotation {  
13.    // 定义注解的参数，类型可以为基本类型以及String、Class、enum、数组等，default为默认值  
14.    String parameter1() default "";  
15.    int parameter2() default -1;  
16.}

使用注解

1./** 
2. * 一个用到了自定义的注解的类 
3. */  
4.public class OClass {  
5.    @OneAnnotation(parameter1="YES", parameter2=10)  
6.    public void oneMethod () {  
7.    }  
8.}

获取注解参数

1.import java.lang.reflect.Method;  
2.public class TestDemo {  
3.    public static void main(String[] args) throws Exception {  
4.        // 提取到被注解的方法Method，这里用到了反射的知识  
5.        Method method = Class.forName("OneClass").getDeclaredMethod("oneMethod");  
6.        // 从Method方法中通过方法getAnnotation获得我们设置的注解  
7.        OneAnnotation oneAnnotation = method.getAnnotation(OneAnnotation.class);  
8.        // 得到注解的俩参数  
9.        System.out.println(oneAnnotation.parameter1());  
10.        System.out.println(oneAnnotation.parameter2());  
11.    }  
12.}