Java注解 个人学习笔记

注解：

• 概念:说明程序的。给计算机看的 （注解：用文字描述程序的。给程序员看的）
• 定义：注解（Annotation），也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类，接口，枚举是在同一层次。他可以声明在 包，类，字段，方法，局部变量，方法参数等的前面，用来对这些元素进行说明，注释。
• 概念描述：JDK1.5之后的新特性；说明程序的；使用注解：@注解名称
• 作用分类：

1.编写文档：通过代码里标识的注解生成文档（生成文档doc文档）
2.代码分析：通过代码里标识的注解对代码进行分析（使用反射）–主要使用
3.编译检查：通过代码里标识的注解让编译器能够实现基本的编译检查（Override）

• JDK中预定义的一些注解

@Override：检测被该注解标注的方法是否是继承自父类（接口）的
@Deprecated ：该注解标注的内容，表示已过时
@SuppressWarnings ：压制警告 一般传递参数all @SuppressWarnings("all") //传all 压制所有警告

package cn.cast.annotation;

import java.util.Date;

/**
 * @Override： 检测被该注解标注的方法是否是继承自父类（接口）的
 * @Deprecated ：该注解标注的内容，表示已过时
 * @SuppressWarnings ：压制警告
 */
@SuppressWarnings("all") //传all 压制所有警告
public class AnnoDemo2 {
    @Override  //可以选中，利用ctrl+B跳转到 @override的代码界面
    //会检测tostring方法声明是否跟Object类一样，如果不一样会失败，报错，安全检查
    public String toString() {
        return super.toString();
    }

    @Deprecated
    public void show1(){
        //有一定的缺陷
        //不能直接删除，代码就会不兼容低版本了
    }

    //show2在右边栏有警告：Method show2() is never used

    public void show2(){
        //替代show1方法
        //推荐用户使用show2方法，而不是show1方法
    }
    public void demo(){
        show1();
        Date date=new Date();
    }
}

• 自定义注解

格式:
	元注解
	public @interface 注解名称{
	属性列表;(本质成员方法）
	}
	
本质:注解本质上就是一个接口，该接口默认继承Annotation接口（接口能定义什么，注解也能定义什么）
	public interface MyAnno extends java.lang.annotation.Annotation {}
属性:接口中的抽象方法
	要求:	1.属性的返回值类型有下列取值：基本数据类型;String;枚举;注解;以上类型的数组
			2.定义了属性，在使用时需要给属性赋值eg:@MyAnno(age=1,name="roxanne")//赋值 方法名称等于对应的一个值，多个赋值用,隔开
				2.1 如果定义属性时，使用default关键字给属性默认初始化值，则使用注解时，可以不进行属性的赋值
				2.2如果仅有一个属性需要赋值，且属性的名称是value，则value可以省略，直接定义值即可@MyAnno(12)
				2.3数组赋值时，值使用{}包裹，如果数组只有一个元素，大括号可以省略不写
    元注解：用于描述注解的注解
			@Target:描述注解能够作用的位置（能够作用在类上还是在方法上等等）
				ElementType取值：
					TYPE：可以作用在类上
					METHOD：可以作用在方法上
					FIELD：可以作用与成员变量上
			@Retention:描述注解被保留的阶段（三个阶段 源码 class 还是runtime阶段）
				@Retention(RetentionPolicy.RUNTIME)：当前被描述的注解，会保留到class字节码文件，并被JVM读取到；设为CLASS，会保留，但不会被JVM读取到；设为SOURCE，连字节码文件中都不会存在这个注解
			@Documented:描述注解是否被抽取到api文档中 
			@Inherited:描述注解是否被子类继承

package cn.cast.annotation;

public @interface MyAnno {

    int value();
    Person per();
    MyAnno2 anno2();
    String[] strs();
    String name()default "s1mple";
    //加了默认default就可以不用赋值
    /*String show2();
    Person per();
    MyAnno2 anno2();

    String[] strs();*/

}

package cn.cast.annotation;

public @interface MyAnno2 {

}

package cn.cast.annotation;

public enum Person {
    P1,P2;
}

package cn.cast.annotation;

@MyAnno(value = 12, per = Person.P1, anno2 = @MyAnno2, strs = "abc")
@MyAnno3
public class Worker {
    @MyAnno3
    public void show() {

    }

    @MyAnno3
    public String name="ass";
}

package cn.cast.annotation;

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

/**
 *  元注解：用于描述注解的注解
 *            @Target:描述注解能够作用的位置（能够作用在类上还是在方法上等等）
 *            @Retention:描述注解被保留的阶段（三个阶段 源码 class 还是runtime阶段）
 *            @Documented:描述注解是否被抽取到api文档中
 *            @Inherited:描述注解是否被子类继承
 */
@Target(value= {ElementType.TYPE,ElementType.FIELD,ElementType.METHOD})//ElementType是一个数组，可以赋多个值 枚举类型
@Retention(RetentionPolicy.RUNTIME)
//@Retention(RetentionPolicy.RUNTIME)，表示当前定义的这个注解，如果这个MyAnno3用来描述worker类，运行这个worker类的时候，JVM会读取到这么一个注解
//我们自己定义的注解一般都取这个值RetentionPolicy.RUNTIME
public @interface MyAnno3 {
}

• 在程序中使用（解析）注解：获取注解中定义的属性值

 1.获取注解定义的位置的对象；(定义在类上，就获取类对象，定义在方法上，就获取方法对象 Class Method Field）
 2.获取指定的注解 
 	getAnnotation(Class)
 	//其实就是在内存中生成了一个该注解接口的子类实现对象
	//在内存中实现了一个类，继承了这个接口，并且复写了里面的方法
	//相当于
	/**
 	public class ProImpl implements Pro{
    	public String className(){
        	return "cn.itcast.annotation.Demo1";
        //返回的值根据当时这个接口被用的时候所配的属性值确定
    	}
    	public String methodName(){
        	return "show";
    	}
 	}
 	//Pro an=reflectTestClass.getAnnotation(Pro.class);//通过这一行代码，他就会把这个类对应的对象创建一个，并且返回给你
 */
 3.调用注解中的抽象方法来获取配置的属性值

package cn.cast.annotation;

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

package cn.cast.annotation;

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

package cn.cast.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)//期望他保留在Runtime阶段
public @interface Pro {
    String className();
    String methodName();
}

package cn.cast.annotation;

import java.io.InputStream;
import java.lang.reflect.Method;
import java.util.Properties;
//利用注解起到替代配置文件作用
@Pro(className ="cn.cast.annotation.Demo1",methodName = "show")
public class ReflectTest {
    public static void main(String[] args) throws Exception {

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

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


        //3.加载该类进内存
        Class cls=Class.forName(classname);
        //4.创建对象
        Object obj=cls.newInstance();
        //5.获取对象方法
        Method method=cls.getMethod(methodname);
        //6.执行方法
        method.invoke(obj);
        //通过改变注解不同的值，就能等同于实现修改配置文件的效果
    }
}
//其实就是在内存中生成了一个该注解接口的子类实现对象
//在内存中实现了一个类，继承了这个接口，并且复写了里面的方法
//相当于
/**
 public class ProImpl implements Pro{
    public String className(){
        return "cn.itcast.annotation.Demo1";
        //返回的值根据当时这个接口被用的时候所配的属性值确定
    }
    public String methodName(){
        return "show";
    }
 }
 Pro an=reflectTestClass.getAnnotation(Pro.class);//通过这一行代码，他就会把这个类对应的对象创建一个，并且返回给你
 */

• 小结：
  1.以后大多数时候，我们会使用注解，而不是自定义注解
  2.注解给谁用？ 编译器（识别注解，检测编译有没有问题）；解析程序（类似后面案例中的testcheck，如果没有解析程序的存在，注解加上毫无意义）
  3.注解不是我们程序的一部分（注解类似于一个标签，贴上之后将来就可以被测试了，不给他加标签，不影响这个方法的性质，他还能使用）