Java学习之注解

今天学习的内容是 注解，英文名为Annotaion

学习方式：参照博客+慕课网

注解的定义

public @interface TestAnnotation {
}

注解的定义

 @TestAnnotation
public class Test {
}

创建一个作用域在类的注解，在一个类上面用@注解名的方式就可以使用了
元注解
元注解又称为注解的注解，准确来说是用来规定注解的注解，下面依依介绍五种元注解

@Retention
Retention英文为保留期的意思，顾名思义它是用来定义这个注解的存活时间的
它的取值如下：

• RetentionPolicy.SOURCE 注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视。
• RetentionPolicy.CLASS 注解只被保留到编译进行的时候，它并不会被加载到 JVM 中。
• RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候，它会被加载进入到 JVM 中，所以在程序运行时可以获取到它们。
  @Document
  它的作用是能够将注解中的元素包含到 Javadoc 中去。
  @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
怎么说呢，这个意思是可重复的意思，那注解什么时候需要重复使用呢，举个例子,一个人他既是程序员又是产品经理,同时他还是个画家。

@interface Persons {
    Person[]  value();
}
@Repeatable(Persons.class)
@interface Person{
    String role default "";
}//上是注解定义，下是注解使用
@Person(role="artist")
@Person(role="coder")
@Person(role="PM")
public class SuperMan{
}

在这里需要提到的是，一个注解里面如果只有一个变量那这个变量一定命名为value，如

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

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

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
    int id();
    String msg();
}

上面代码定义了 TestAnnotation 这个注解中拥有 id 和 msg 两个属性。在使用的时候，我们应该给它们进行赋值。

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

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

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

注解中属性可以有默认值，默认值需要用 default 关键值指定。比如：

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

下面介绍一下Java中的预置注解

@Deprecated 这个类的作用是把过时的一些方法给标识出来。编译器在编译阶段遇到这个注解时会发出提醒警告，告诉开发者正在调用一个过时的元素比如过时的方法、过时的类、过时的成员变量。比如：

public class Hero {
    @Deprecated
    public void say(){
        System.out.println("Noting has to say!");
    }
    public void speak(){
        System.out.println("I have a dream!");
    }
}

当say函数过期是函数会变成 say（） 的形式来警示编程人员
@Override 如英文意思，重写的意思
@SuppressWarnings
阻止警告的意思。之前说过调用被 @Deprecated 注解的方法后，编译器会警告提醒，而有时候开发者会忽略这种警告，他们可以在调用的地方通过 @SuppressWarnings 达到目的。

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

注解与反射
如果能熟练掌握注解与反射，相信对后面的框架学习会更有帮助

注解通过反射获取。首先可以通过 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，则就可以调用它们的属性方法了。比如

@TestAnnotation()
public class Test {
    public static void main(String[] args) {
    Class a=Test.class;//创建一个Test类的类类型
        boolean hasAnnotation = a.isAnnotationPresent(TestAnnotation.class);
        if ( hasAnnotation ) {
            TestAnnotation testAnnotation = a.getAnnotation(TestAnnotation.class);
            System.out.println("id:"+testAnnotation.id());
            System.out.println("msg:"+testAnnotation.msg());
        }
    }
}

写这个的目的是作为学习笔记，所以照搬了很多优秀博主写的东西

本文大多数截取自：https://blog.csdn.net/qq1404510094/article/details/80577555