注解

注解

注解的概念

注解是JDK1.5的特性。
注解相当一种标记，是类的组成部分，可以给类携带一些额外的信息。
标记(注解)可以加在包，类，字段，方法，方法参数以及局部变量上。
注解是给编译器或JVM看的，编译器或JVM可以根据注解来完成对应的功能。
注解可以完成某些功能

注解和注释的区别

注释是给程序员看的,不会影响程序的执行
注解是给程序看的,程序后根据注解完成一些功能,注解会影响到程序的执行

注解的作用

注解的作用就是给程序带入参数。

1. 生成帮助文档：@author和@version

@author：用来标识作者姓名。
@version：用于标识对象的版本号，适用范围：文件、类、方法。
使用@author和@version注解就是告诉Javadoc工具在生成帮助文档时把作者姓名和版本号也标 记在文档中

2.编译检查：@Override

@Override：用来修饰方法声明。
用来告诉编译器该方法是重写父类中的方法，如果父类不存在该方法，则编译失败

3. 框架的配置(框架 = 代码 + 配置)

具体使用请关注框架课程的内容的学习。
常见注解
1. @author：用来标识作者名，eclipse开发工具默认的是系统用户名。
2. @version：用于标识对象的版本号，适用范围：文件、类、方法。
3. @Override ：用来修饰方法声明，告诉编译器该方法是重写父类中的方法，如果父类不存在该方法，则编译 失败。
4. @Deprecated: –> 用来表示不赞成使用,标记已经过时
5. @SupperssWarnings –> 抑制警告

自定义注解

格式

public @interface 注解名{ }
如：定义一个名为Student的注解 public @interface Student { }

注解的属性

1.属性的作用

可以让用户在使用注解时传递参数，让注解的功能更加强大。

2. 属性的格式

格式1：数据类型 属性名();
格式2：数据类型 属性名() default 默认值;

3.定义示例

public @interface Student {
String name(); // 姓名
int age() default 18; // 年龄
String gender() default “男”; // 性别 }
// 该注解就有了三个属性：name，age，gender

4. 属性适用的数据类型

八种基本数据类型 –> (int,float,boolean,byte,double,char,long,short)
String类型，Class类型，枚举类型，注解类型
以上所有类型的一维数组

使用自定义注解

定义注解

1. 定义一个注解：Book

包含属性：String value() 书名
包含属性：double price() 价格，默认值为 100
包含属性：String[] authors() 多位作者

2. 代码实现

public @interface Book { // 书名
String value(); // 价格
double price() default 100; // 多位作者
String[] authors(); }

使用注解

1. 定义类在成员方法上使用Book注解

/* * @version 1.0 * @description 书架类 * @date 2018/1/26 */
public class BookShelf {
@Book(value = “西游记”,price = 998,authors = {“吴承恩”,”白求恩”}) public void showBook(){ } }

2.使用注意事项

如果属性有默认值，则使用注解的时候，这个属性可以不用赋值。
如果属性没有默认值，那么在使用注解时一定要给属性赋值。
如果属性是数组,赋值时可以使用{},若此数组只有一个元素,可以省略{}

特殊属性value
1. 当注解中只有一个属性且名称是value，在使用注解时给value属性赋值可以直接给属性值，无论value是单 值元素还是数组类型。
2. 如果注解中除了value属性还有其他属性，且至少有一个属性没有默认值，则在使用注解给属性赋值时， value属性名不能省略。

注解之元注解

元注解的概述

Java API提供的注解 专门用来定义注解的注解。
任何Java官方提供的非元注解的定义中都使用到了元注解。

常用元注解

@Target @Retention

元注解之@Target []

作用：指明此注解用在哪个位置，如果不写默认是任何地方都可以使用。
可选的参数值在枚举类ElemenetType中包括
ElemenetType.TYPE： 用在类,接口上
ElemenetType.FIELD：用在成员变量上
ElemenetType.METHOD： 用在方法上
ElemenetType.PARAMETER：用在参数上
ElemenetType.CONSTRUCTOR：用在构造方法上
ElemenetType.LOCAL_VARIABLE：用在局部变量上

元注解之@Retention

作用：定义该注解的生命周期(有效范围) –> 用于注解上。
可选的参数值在枚举类型RetentionPolicy.中包括
RetentionPolicy.SOURCE：注解只存在于Java源代码中，编译生成的字节码文件中就不存在了。
RetentionPolicy.CLASS：注解存在于Java源代码、编译以后的字节码文件中，运行的时候内存中没有，默认值。
RetentionPolicy.RUNTIME：注解存在于Java源代码中、编译以后的字节码文件中、运行时内存中，程序可以通过反射获取该注解.

注解解析

什么是注解解析

通过Java技术获取注解数据的过程则称为注解解析。

与注解解析相关的接口

Anontation：所有注解类型的公共接口，类似所有类的父类是Object。
AnnotatedElement：定义了与注解解析相关的方法，常用方法以下四个：
boolean isAnnotationPresent(Class annotationClass);
判断当前对象是否有指定的注解，有则返回 true，否则返回false。
T getAnnotation(Class annotationClass);
获得当前对象上指定的注解对象。
Annotation[] getAnnotations(); 获得当前对象及其从父类上继承的所有的注解对象。
Annotation[] getDeclaredAnnotations();获得当前对象上所有的注解对象，不包括父类的。

获取注解数据的原理

        注解作用在那个成员上，就通过反射获得该成员的对象来得到它的注解。        

如注解作用在方法上，就通过方法(Method)对象得到它的注解
// 得到方法对象
Method method = clazz.getDeclaredMethod(“方法名”);
// 根据注解名得到方法上的注解对象
Book book = method.getAnnotation(Book.class);
如注解作用在类上，就通过Class对象得到它的注解
// 获得Class对象 Class c = 类名.class;
// 根据注解的Class获得使用在类上的注解对象
Book book = c.getAnnotation(Book.class);