Java 自定义注解

一. 注解的基本定义

概念：说明程序的，是给计算机看的
注释：用文字描述程序的，是给程序员看的

定义：
注解（Annotation），也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。

概念描述：

• JDK1.5之后的新特性
• 说明程序的
• 使用注解：@注解名称

二. 注解的作用

①编写文档：通过代码里标识的注解生成文档【生成文档doc文档】
②代码分析：通过代码里标识的注解对代码进行分析【使用反射】
③编译检查：通过代码里标识的注解让编译器能够实现基本的编译检查【Override】

三. 自定义注解

1.JDK中预定义的一些注解
@Override ：检测被该注解标注的方法是否是继承自父类(接口)的
@Deprecated：该注解标注的内容，表示已过时
@SuppressWarnings：压制警告

• 一般传递参数all @SuppressWarnings(“all”)

2. 自定义注解：
格式：

@元注解
public @interface 注解名称{
	属性列表;
}

本质：注解本质上就是一个接口，该接口默认继承Annotation接口
public interface MyAnno extends java.lang.annotation.Annotation {}

属性：接口中的抽象方法
要求：

1. 属性的返回值类型有下列取值

• 基本数据类型
• String
• 枚举
• 注解
• 以上类型的数组

package cn.jess.annotation;
public @interface MyAnno2 {
}

package cn.jess.annotation;

public enum Person {
    P1,P2;
}

package cn.jess.annotation;
import com.sun.corba.se.spi.orbutil.threadpool.Work;

public @interface MyAnno {
    int value();
    Person per();
    MyAnno2 anno2();
    String[] strs();
     /*String name() default "张三";*/
     /*String show2();
     Person per();
     MyAnno2 anno2();
     String[] strs();*/
}

2. 定义了属性，在使用时需要给属性赋值
   1. 如果定义属性时，使用default关键字给属性默认初始化值，则使用注解时，可以不进行属性的赋值。
   2. 如果只有一个属性需要赋值，并且属性的名称是value，则value可以省略，直接定义值即可。
   3. 数组赋值时，值使用{}包裹。如果数组中只有一个值，则{}可以省略

package cn.jess.annotation;

@MyAnno(value=12,per = Person.P1,anno2 = @MyAnno2,strs="bbb")
@MyAnno3
public class Worker {
    @MyAnno3
    public String name = "aaa";
    @MyAnno3
    public void show(){
    }
}

元注解：用于描述注解的注解
@Target：描述注解能够作用的位置

ElementType取值：

• TYPE：可以作用于类上
• METHOD：可以作用于方法上
• FIELD：可以作用于成员变量上

@Retention：描述注解被保留的阶段
@Retention(RetentionPolicy.RUNTIME)：当前被描述的注解，会保留到class字节码文件中，并被JVM读取到
@Documented：描述注解是否被抽取到api文档中
@Inherited：描述注解是否被子类继承

package cn.jess.annotation;

import java.lang.annotation.*;

@Target({ElementType.TYPE,ElementType.METHOD,ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface MyAnno3 {
}

四. 在程序中的使用

在程序使用(解析)注解：获取注解中定义的属性值

1. 获取注解定义的位置的对象 （Class，Method,Field）
2. 获取指定的注解

getAnnotation(Class)
//其实就是在内存中生成了一个该注解接口的子类实现对象
    
 public class ProImpl implements Pro{
	public String className(){
	    return "cn.jess.annotation.Demo1";
   }
	public String methodName(){
	    return "show";
   }
}

3. 调用注解中的抽象方法获取配置的属性值

举例：

package cn.jess.annotation;

public class Demo1 {
    public void show(){
        System.out.println("demo1...show...");
    }
}

package cn.jess.annotation;

public class Demo2 {
    public void show(){
        System.out.println("demo2...show...");
    }
}

package cn.jess.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 描述需要执行的类名，和方法名
 */
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Pro {
    String className();
    String methodName();
}

package cn.jess.annotation;

import java.io.InputStream;
import java.lang.reflect.Method;
import java.util.Properties;

@Pro(className = "cn.jess.annotation.Demo1",methodName = "show")
public class ReflectTest {
    public static void main(String[] args) throws Exception {

        /*
            前提：不能改变该类的任何代码。可以创建任意类的对象，可以执行任意方法
         */

        //1.解析注解
        //1.1获取该类的字节码文件对象
        Class<ReflectTest> reflectTestClass = ReflectTest.class;
        //2.获取上边的注解对象
        //其实就是在内存中生成了一个该注解接口的子类实现对象
        /*
           public class ProImpl implements Pro{
                public String className(){
                    return "cn.jess.annotation.Demo1";
                }
                public String methodName(){
                    return "show";
                }
            }
      */
        Pro an = reflectTestClass.getAnnotation(Pro.class);
        //3.调用注解对象中定义的抽象方法，获取返回值
        String className = an.className();
        String methodName = an.methodName();
        System.out.println(className);//cn.itcast.annotation.Demo1
        System.out.println(methodName);//show

        //3.加载该类进内存
        Class cls = Class.forName(className);
        //4.创建对象
        Object obj = cls.newInstance();
        //5.获取方法对象
        Method method = cls.getMethod(methodName);
        //6.执行方法
        method.invoke(obj);
    }
}

小结：
1. 以后大多数时候，我们会使用注解，而不是自定义注解
2. 注解给谁用？编译器，给解析程序用
3. 注解不是程序的一部分，可以理解为注解就是一个标签