java注解

一、基本概念

1. 什么是注解

1）Annontation是Java5开始引入的新特征，中文名称叫注解。它提供了一种安全的类似注释的机制，用来将任何的信息或元数据（metadata）与程序元素（类、方法、成员变量等）进行关联

2）为程序的元素（类、方法、成员变量）加上更直观更明了的说明，这些说明信息是与程序的业务逻辑无关，并且供指定的工具或框架使用

3）Annontation像一种修饰符一样，应用于包、类型、构造方法、方法、成员变量、参数及本地变量的声明语句中

4）Java注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置的功能。注解不会也不能影响代码的实际逻辑，仅仅起到辅助性的作用。包含在 java.lang.annotation 包中 （@interface）

2. 注解的用处

1）生成文档。这是最常见的，也是java 最早提供的注解。常用的有@param @return 等	

2）跟踪代码依赖性，实现替代配置文件功能。比如Dagger 2 依赖注入，未来java 开发，将大量注解配置，具有很大用处

3）在编译时进行格式检查。如@override 放在方法前，如果你这个方法并不是覆盖了超类方法，则编译时就能检查出

3. 注解的原理

1）注解本质是一个继承了Annotation 的特殊接口，其具体实现类是Java 运行时生成的动态代理类	

2）而我们通过反射获取注解时，返回的是Java 运行时生成的动态代理对象$Proxy1。通过代理对象调用自定义注解（接口）的方法，会最终调用AnnotationInvocationHandler 的invoke 方法

3）该方法会从memberValues 这个Map 中索引出对应的值。而memberValues 的来源是Java 常量池

---

二、元注解

java.lang.annotation 提供了四种元注解，专门注解其他的注解（在自定义注解的时候，需要使用到元注解）：

1. @Documented —— 注解是否将包含在JavaDoc中

2. @Retention —— 注解的保留策略

1）RetentionPolicy.SOURCE 			注解仅存在于源码中，在class字节码文件中不包含

2）RetentionPolicy.CLASS            默认的保留策略，注解会在class字节码文件中存在，但运行时无法获得

3）RetentionPolicy.RUNTIME 			注解会在class字节码文件中存在，在运行时可以通过反射获取到

3. @Target —— 注解的作用目标

1）ElementType.TYPE            		接口、类、枚举、注解

2）ElementType.FIELD                字段、枚举的常量

3）ElementType.METHOD            	方法

4）ElementType.PARAMETER          	方法参数

5）ElementType.CONSTRUCTOR          构造函数

6）ElementType.LOCAL_VARIABLE       局部变量

7）ElementType.ANNOTATION_TYPE      注解

8）ElementType.PACKAGE              包

4. @Target —— 注解可以被继承

---

三、JDK内置的注解

1. Override

1）java.lang.Override 是一个标记类型注解，它被用作标注方法

2）它说明了被标注的方法重载了父类的方法，起到了断言的作用

3）如果我们使用了这种注解在一个没有覆盖父类方法的方法时，java 编译器将以一个编译错误来警示

2. Deprecated

1）Deprecated 也是一种标记类型注解。当一个类型或者类型成员使用@Deprecated 修饰的话，编译器将不鼓励使用这个被标注的程序元素	

2）所以使用这种修饰具有一定的“延续性”：如果我们在代码中通过继承或者覆盖的方式使用了这个过时的类型或者成员，虽然继承或者覆盖后的类型或者成员并不是被声明为@Deprecated，但编译器仍然要报警

3. SuppressWarnings

1）SuppressWarnings 不是一个标记类型注解。它有一个类型为String[] 的成员，这个成员的值为被禁止的警告名

2）对于javac 编译器来讲，被-Xlint 选项有效的警告名也同样对@SuppressWarings 有效，同时编译器忽略掉无法识别的警告名

3）示例：@SuppressWarnings("unchecked")

---

四、 自定义注解

1. 自定义注解的规则

1）Annotation 型定义为@interface, 所有的Annotation 会自动继承java.lang.Annotation这一接口,并且不能再去继承别的类或是接口

2）参数成员只能用public 或默认(default) 这两个访问权修饰

3）参数成员只能用基本类型byte、short、char、int、long、float、double、boolean八种基本数据类型和String、Enum、Class、annotations等数据类型，以及这一些类型的数组

4）要获取类方法和字段的注解信息，必须通过Java的反射技术来获取 Annotation 对象，因为你除此之外没有别的获取注解对象的方法

5）注解也可以没有定义成员,，不过这样注解就没啥用了

2. 注解使用的基本流程

1）定义注解 —— 相当于定义标记

2）配置注解 —— 把标记打在需要用到的程序代码中

3）解析注解 —— 在编译期或运行时检测到标记，并进行特殊操作

	（1）一般传入注解类，通过反射获取注解对象   （一般这个时候通过反射，注解上的值已经和特定注解对象连上了，因为注解就是该方法的一个属性）  

		ReadCache cacheable = method.getAnnotation(ReadCache.class);

	（2）通过注解中声明的方法获取某对象上的注解的值  

		String value = cacheable.value()
		String namespace = cacheable.namespace();

	（3）拿到注解上获取到的值，去做想做的操作，比如初始化，检验，用切面key值的拼接等（作用分类：一种是规则校验类，一种是值配置类）	

3. 代码示例

1）定义注解		

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

	    public String value() default "";
	}

2）配置注解	

	public class User {

	    private String name;
	    private String age;

	    public String getName()
	    {
	        return name;
	    }

	    @Init(value = "hello test")
	    public void setName(String name){
	        this.name = name;
	    }

	    public String getAge(){
	        return age;
	    }

	    @Init(value = "27")
	    public void setAge(String age){
	        this.age = age;
	    }
	}

3）解析注解

	public class UserFactory {

	    public static User create() throws InvocationTargetException, IllegalAccessException {

	        User user = new User();

	        // 获取User类中所有的方法
	        Method[] methods = User.class.getMethods();

	        for(Method method : methods){
	            // 如果方法有注解，就把注解里面的数据复制到user对象
	            if(method.isAnnotationPresent(Init.class)){
	                Init init = method.getAnnotation(Init.class);
	                method.invoke(user, init.value());
	            }
	        }
	        return user;
	    }
	    
	}

---

参考网址

Java自定义注解

注解Annotation实现原理与自定义注解例子

注：文章是经过参考其他的文章然后自己整理出来的，有可能是小部分参考，也有可能是大部分参考，但绝对不是直接转载，觉得侵权了我会删，我只是把这个用于自己的笔记，顺便整理下知识的同时，能帮到一部分人。
ps : 有错误的还望各位大佬指正,小弟不胜感激