Java——注解

一、注解

注释： 对代码的说明，给人看的， 方便阅读代码， 写注释的习惯， 类上，方法上， 复杂的逻辑代码，写注释。

注解(Annontation)：对代码的说明，在运行时候，对注解进行解析（特殊的接口）

​ 它提供了一种安全的类似注释的机制，用来将任何的信息或元数据（metadata）与程序元素（类、方法、成员变量等）进行关联。为程序的元素（类、方法、成员变量）加上更直观更明了的说明，这些说明信息是与程序的业务逻辑无关，并且供指定的工具或框架使用。

为了后期学习框架使用。 SpringBoot 基于注解开发

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

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

二、注解的作用

1. 生成文档， API 帮助文档， @param @return @exception
2. 使用注解，替换配置文件 后期框架 SpringBoot 大量使用
3. 用于编译期间。进行语法检查， @Override

java23设计模式： 专门为某一方面问题的一种解决方案， 设计模式与设计模式之间有冲突。

常用： 工厂模式， 单例模式， 动态代理模式

三、注解的原理

注解本质是一个继承了Annotation的特殊接口，其具体实现类是Java运行时生成的动态代理类。而我们通过反射获取注解时，返回的是Java运行时生成的动态代理对象$Proxy1。通过代理对象调用自定义注解（接口）的方法，会最终调用AnnotationInvocationHandler的invoke方法。该方法会从memberValues这个Map中索引出对应的值。而memberValues的来源是Java常量池

注解本质是一个特殊接口， jdk通过动态代理模式， 生成注解接口的对应的代理对象

四、注解的分类

//告诉编译器忽略 unchecked 警告信息，如使用List，ArrayList等未进行参数化产生的警告信息。
@SuppressWarnings(“unchecked”)

//如果编译器出现这样的警告信息：The serializable class WmailCalendar does not declare a //static final serialVersionUID field of type long，使用这个注释将警告信息去掉。
@SuppressWarnings(“serial”)

//如果使用了使用@Deprecated注释的方法，编译器将出现警告信息。使用这个注释将警告信息去掉。
@SuppressWarnings(“deprecation”)

//rawtypes是说传参时也要传递带泛型的参数
@SuppressWarnings(“rawtypes”)

//抑制所有类型的警告：
@SuppressWarnings(“all”)

4.2元注解

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

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

​ 一个简单的Annotations标记注解，表示是否将注解信息添加在javadoc文档中

2.@Retention –什么时候使用该注解

​ Retention 的英文意为保留期的意思。当 @Retention 应用到一个注解上的时候，它解释说明了这个注解的的存活时间

它的取值如下：

• RetentionPolicy.SOURCE 注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视。
• RetentionPolicy.CLASS 注解只被保留到编译进行的时候，它并不会被加载到 JVM 中。
• RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候，它会被加载进入到 JVM 中，所以在程序运行时可以获取到它们。

3.@Target–注解用于什么地方

​ 默认值为任何元素，表示该注解用于什么地方。可用的ElementType参数包括
● ElementType.CONSTRUCTOR:用于描述构造器
● ElementType.FIELD:成员变量、对象、属性（包括enum实例）
● ElementType.LOCAL_VARIABLE:用于描述局部变量
● ElementType.METHOD:用于描述方法
● ElementType.PACKAGE:用于描述包
● ElementType.PARAMETER:用于描述参数
● ElementType.TYPE:用于描述类、接口(包括注解类型) 或enum声明

4.@Inherited – 定义该注释和子类的关系

​ Inherited 是继承的意思，但是它并不是说注解本身可以继承，而是说如果一个超类被 @Inherited 注解过的注解进行注解的话，那么如果它的子类没有被任何注解应用的话，那么这个子类就继承了超类的注解

4.3 自定义注解

自定义注解类编写的一些规则:

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. 注解也可以没有定义成员, 不过这样注解就没啥用了

例子如下：

先创建第一个注解：

package cn.sz.gl.test07;

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

@Target(ElementType.FIELD)//可以用来修饰对象，属性
@Retention(RetentionPolicy.RUNTIME)//什么时候都不丢弃
@Documented//用于生成javadoc文档
public @interface FruitName {

	String value() default "";
}

再创建一个注解：

package cn.sz.gl.test07;

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

@Target(ElementType.FIELD)//可以用来修饰对象，属性
@Retention(RetentionPolicy.RUNTIME)//什么时候都不丢弃
@Documented//用于生成javadoc文档
public @interface FruitColor {
	
	public enum Color{RED,GREEN,BLUE};
	Color fc() default Color.GREEN;
}

创建一个工具类用来处理注解：

package cn.sz.gl.test07;

import java.lang.reflect.Field;

public class AnnotationUtil {

	public static Object findInfo(Class clazz) throws IllegalArgumentException, IllegalAccessException, InstantiationException{
		Object obj = clazz.newInstance();
		Field fs [] = clazz.getDeclaredFields();
		
		for (int i = 0; i < fs.length; i++) {
			//判断该属性上是否有FruitName类型的注解
			if(fs[i].isAnnotationPresent(FruitName.class)){
				FruitName fn = fs[i].getAnnotation(FruitName.class);
				//为属性赋值
				fs[i].setAccessible(true);
				fs[i].set(obj, fn.value());
			}
			if(fs[i].isAnnotationPresent(FruitColor.class)){
				FruitColor fc = fs[i].getAnnotation(FruitColor.class);
				fs[i].setAccessible(true);
				fs[i].set(obj, fc.fc().toString());
			}
		}
		return obj;
	}
}

然后创建一个类，在类中应用自定义的注解：

package cn.sz.gl.test07;

import cn.sz.gl.test07.FruitColor.Color;

public class Apple {

	@FruitName("MyApple")
	private String applename;
	@FruitColor(fc=Color.RED)
	private String color;

	public String getApplename() {
		return applename;
	}

	public void setApplename(String applename) {
		this.applename = applename;
	}

	public String getColor() {
		return color;
	}

	public void setColor(String color) {
		this.color = color;
	}
}

最后在main方法中测试：

package cn.sz.gl.test07;

public class Test {

	public static void main(String[] args) {
		
		try {
			Apple apple = (Apple) AnnotationUtil.findInfo(Apple.class);
			
			System.out.println(apple.getApplename());
			System.out.println(apple.getColor());
			
			
			
		} catch (IllegalArgumentException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (IllegalAccessException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		} catch (InstantiationException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
	}
}

​