java--自定义注解（注解在运行时生效）
转：https://www.cnblogs.com/acm-bingzi/p/javaAnnotation.html
什么是注解？
Annontation是 Java5 开始引入的新特征，中文名称叫注解。它提供了一种安全的类似注释的机制，用来将任何的信息或元数据（metadata）与程序元素（类、方法、成员变量等）进行关联。为程序的元素（类、方法、成员变量）加上更直观更明了的说明，这些说明信息是与程序的业务逻辑无关，并且供指定的工具或框架使用。Annontation 像一种修饰符一样，应用于包、类型、构造方法、方法、成员变量、参数及本地变量的声明语句中。
Java 注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置的功能。注解不会也不能影响代码的实际逻辑，仅仅起到辅助性的作用。包含在 java.lang.annotation 包中。
注解的用处：
1、生成文档。这是最常见的，也是 java 最早提供的注解。常用的有 @param @return 等
2、跟踪代码依赖性，实现替代配置文件功能。比如 Dagger 2 依赖注入，未来 java 开发，将大量注解配置，具有很大用处;
3、在编译时进行格式检查。如 @override 放在方法前，如果你这个方法并不是覆盖了超类方法，则编译时就能检查出。
注解的原理：
注解本质是一个继承了 Annotation 的特殊接口，其具体实现类是 Java 运行时生成的动态代理类。而我们通过反射获取注解时，返回的是 Java 运行时生成的动态代理对象 $Proxy1。通过代理对象调用自定义注解（接口）的方法，会最终调用 AnnotationInvocationHandler 的 invoke 方法。该方法会从 memberValues 这个 Map 中索引出对应的值。而 memberValues 的来源是 Java 常量池。
元注解：
java.lang.annotation 提供了四种元注解，专门注解其他的注解（在自定义注解的时候，需要使用到元注解）：
@Documented – 注解是否将包含在 JavaDoc 中
@Retention – 什么时候使用该注解
@Target – 注解用于什么地方
@Inherited – 是否允许子类继承该注解
1.）@Retention – 定义该注解的生命周期
● RetentionPolicy.SOURCE : 在编译阶段丢弃。这些注解在编译结束之后就不再有任何意义，所以它们不会写入字节码。@Override, @SuppressWarnings 都属于这类注解。
● RetentionPolicy.CLASS : 在类加载的时候丢弃。在字节码文件的处理中有用。注解默认使用这种方式
● RetentionPolicy.RUNTIME : 始终不会丢弃，运行期也保留该注解，因此可以使用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式。
2.）Target – 表示该注解用于什么地方。默认值为任何元素，表示该注解用于什么地方。可用的 ElementType 参数包括
● ElementType.CONSTRUCTOR: 用于描述构造器
● ElementType.FIELD: 成员变量、对象、属性（包括 enum 实例）
● ElementType.LOCAL_VARIABLE: 用于描述局部变量
● ElementType.METHOD: 用于描述方法
● ElementType.PACKAGE: 用于描述包
● ElementType.PARAMETER: 用于描述参数
● ElementType.TYPE: 用于描述类、接口 (包括注解类型) 或 enum 声明
3.)@Documented – 一个简单的 Annotations 标记注解，表示是否将注解信息添加在 java 文档中。
4.)@Inherited – 定义该注释和子类的关系
@Inherited 元注解是一个标记注解，@Inherited 阐述了某个被标注的类型是被继承的。如果一个使用了 @Inherited 修饰的 annotation 类型被用于一个 class，则这个 annotation 将被用于该 class 的子类。
自定义注解：
自定义注解类编写的一些规则:
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. 注解也可以没有定义成员,，不过这样注解就没啥用了
PS: 自定义注解需要使用到元注解
自定义注解 demo：
水果名称注解：
1 import java.lang.annotation.Documented; 2 import java.lang.annotation.Retention; 3 import java.lang.annotation.Target; 4 import static java.lang.annotation.ElementType.FIELD; 5 import static java.lang.annotation.RetentionPolicy.RUNTIME; 6 7 /** 8 * 水果名称注解 9 */ 10 @Target(FIELD) 11 @Retention(RUNTIME) 12 @Documented 13 public @interface FruitName { 14 String value() default ""; 15 }
水果颜色注解：
1 import java.lang.annotation.Documented; 2 import java.lang.annotation.Retention; 3 import java.lang.annotation.Target; 4 import static java.lang.annotation.ElementType.FIELD; 5 import static java.lang.annotation.RetentionPolicy.RUNTIME; 6 7 /** 8 * 水果颜色注解 9 */ 10 @Target(FIELD) 11 @Retention(RUNTIME) 12 @Documented 13 public @interface FruitColor { 14 /** 15 * 颜色枚举 16 */ 17 public enum Color{BLUE,RED,GREEN}; 18 19 /** 20 * 颜色属性 21 */ 22 Color fruitColor() default Color.GREEN; 23 24 }
注解元素的默认值：
注解元素必须有确定的值，要么在定义注解的默认值中指定，要么在使用注解时指定，非基本类型的注解元素的值不可为 null。因此, 使用空字符串或 0 作为默认值是一种常用的做法。这个约束使得处理器很难表现一个元素的存在或缺失的状态，因为每个注解的声明中，所有元素都存在，并且都具有相应的值，为了绕开这个约束，我们只能定义一些特殊的值，例如空字符串或者负数，一次表示某个元素不存在，在定义注解时，这已经成为一个习惯用法。
水果供应商注解：
1 import java.lang.annotation.Documented; 2 import java.lang.annotation.Retention; 3 import java.lang.annotation.Target; 4 import static java.lang.annotation.ElementType.FIELD; 5 import static java.lang.annotation.RetentionPolicy.RUNTIME; 6 7 8 /** 9 * 水果供应者注解 10 */ 11 @Target(FIELD) 12 @Retention(RUNTIME) 13 @Documented 14 public @interface FruitProvider { 15 /** 16 * 供应商编号 17 */ 18 public int id() default -1; 19 20 /** 21 * 供应商名称 22 */ 23 public String name() default ""; 24 25 /** 26 * 供应商地址 27 */ 28 public String address() default ""; 29 }
注解处理器：基于反射机制获取注解信息
1 import java.lang.reflect.Field; 2 3 /** 4 * 注解处理器 5 */ 6 public class FruitInfoUtil { 7 public static void getFruitInfo(Class<?> clazz){ 8 9 String strFruitName="水果名称："; 10 String strFruitColor="水果颜色："; 11 String strFruitProvicer="供应商信息："; 12 13 Field[] fields = clazz.getDeclaredFields(); 14 15 for(Field field :fields){ 16 if(field.isAnnotationPresent(FruitName.class)){ 17 FruitName fruitName = (FruitName) field.getAnnotation(FruitName.class); 18 strFruitName=strFruitName+fruitName.value(); 19 System.out.println(strFruitName); 20 } 21 else if(field.isAnnotationPresent(FruitColor.class)){ 22 FruitColor fruitColor= (FruitColor) field.getAnnotation(FruitColor.class); 23 strFruitColor=strFruitColor+fruitColor.fruitColor().toString(); 24 System.out.println(strFruitColor); 25 } 26 else if(field.isAnnotationPresent(FruitProvider.class)){ 27 FruitProvider fruitProvider= (FruitProvider) field.getAnnotation(FruitProvider.class); 28 strFruitProvicer="供应商编号："+fruitProvider.id()+"供应商名称："+fruitProvider.name()+"供应商地址："+fruitProvider.address(); 29 System.out.println(strFruitProvicer); 30 } 31 } 32 } 33 }
注解使用：
1 import test.FruitColor.Color; 2 3 /** 4 * 注解使用 5 */ 6 public class Apple { 7 8 @FruitName("Apple") 9 private String appleName; 10 11 @FruitColor(fruitColor=Color.RED) 12 private String appleColor; 13 14 @FruitProvider(id=1,name="陕西红富士集团",address="陕西省西安市延安路 89 号红富士大厦") 15 private String appleProvider; 16 17 public void setAppleColor(String appleColor) { 18 this.appleColor = appleColor; 19 } 20 public String getAppleColor() { 21 return appleColor; 22 } 23 24 public void setAppleName(String appleName) { 25 this.appleName = appleName; 26 } 27 public String getAppleName() { 28 return appleName; 29 } 30 31 public void setAppleProvider(String appleProvider) { 32 this.appleProvider = appleProvider; 33 } 34 public String getAppleProvider() { 35 return appleProvider; 36 } 37 38 public void displayName(){ 39 System.out.println("水果的名字是：苹果"); 40 } 41 }
1 /** 2 * 输出结果 3 */ 4 public class FruitRun { 5 public static void main(String[] args) { 6 FruitInfoUtil.getFruitInfo(Apple.class); 7 } 8 }
运行结果：
水果名称：Apple
水果颜色：RED
供应商编号：1 供应商名称：陕西红富士集团 供应商地址：陕西省西安市延安路 89 号红富士大厦