初识java Annotation

关于java Annotation
什么是注解(Annotation)

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

注解的组成

注解包含元注解和普通注解,所谓元注解是修饰注解的注解。
主要的元注解有@Retention、@Documented、@Target、@Inherited,下面逐一介绍。
(1)@Retention 表明的是注解的声明周期。注解的值是enum类型的
 RetentionPolicy。包括以下几种情况。
  ①SOURCE:注解只保留在源文件。当Java被解析成class文件的时
候, 注解被遗弃。Annotations are to be discarded by the compiler 
  ②CLASS:注解保留到class文件中,但是当class文件被JVM加载的
时候被遗弃。这是默认的声明周期
  ③RUNTIME:注解被保留到class文件中、class文件被JVM加载的时 候,能通过反射被获取
(2)@Documented:表示注解是否能被 javadoc 处理并保留在文档 中。
(3)@Taeget:表明该注解类型适用的程序元素。如果meta-annotation
Target没有出现在注解类型的声明中,则表示这个注解类型可以使用在
任何程序元素。但是,如果Target使用在特定的程序元素 中,则编译器
会执行指定的使用限制。主要的ElementType包括: 
  ①Type:包括Class,interface(包括注解类型),枚举声明
  ②FIELD:域(包括枚举常量)
  ③METHOD:方法
  ④PARAMETER:参数
  ⑤CONSTRUCTOR:构造器
  ⑥LOCAL_VARIABLE:本地变量
  ⑦ANNOTATION_TYPE:注解类型,用这个修饰的话,表明该注解是元注解
  ⑧PACKAGE:包
(4)@Inherited:表明该注解类型是可继承的。如果一个可继承的元注
解出现在一个注解类型的声明中,把该注解使用在class上,class没有
使用该注解类型,然后将在类的超类中查询是否使用该注解类型。程序
会一直进行,直到注解类型被找到或者已经达到了最顶层的类-
Object。如果没有包含该注解类型的超类,则会判定该类没有使用该注解类型。

自定义注解的语法以及定义形式

使用@Interface自定义注解时,自动继承了java.lang.annotation.Annotation接口,由编译程序自动完成其他细节。在定义注解时,不能继承其他的注解或接口,@Interface用来声明一个注解,其中的每一个方法实际上是声明了一个配置参数,方法的名称是参数的名称,返回值类型是参数的类型,返回值类型只能是基本类型、Class、String、enum。可以通过default来声明参数的默认值。
定义注解格式:
public @Interface 注解名{定义体}
(1)以@Interface方式定义
(2)注解包含成员,成员是以无参数的方法的形式被定义。例如:String value();
(3)成员的权限访问级别有两种,分别是public或默认。如果没有表示public,就是默认。
(4)返回值可以是以下值:
  ①基本数据类型:int,float,boolean,byte,double,char,long,short
  ②String类型
  ③enum枚举类型
  ④Clas类型
  ⑤Annotation类型
  ⑥以上所有类型的数组
(5)注解类型需要表明注解的生命周期、作用的程序元素、是否可继承
等等,这些信息都是通过元注解实现。
(6)成员赋值是通过@Annotation(name=value),如果成员方法的名字
为value,则可以直接通过@Annotation(value)赋值
具体可以看下面的实例,元注解Target的源码实现:
@Retention(value = RetentionPolicy.RUNTIME)
@Target(value = { ElementType.ANNOTATION_TYPE } )
public @interface Target
{
    ElementType[] value();
}

注解实例

食物名称注解:
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface FoodName {
    String value() default "";
}

食物颜色注解:
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface FoodColor {
    public enum foodColor {BLUE, RED, WHITE,BLACK};

    public foodColor color() default foodColor.RED;
}

供应商注解:
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Provider {
     int providerNO() default -1;
     String providerNmame() default "";
     String providerAddress() default "";
}
注解解析类:
public class foodUtils {
    public void getFruit(Class<?> clazz){

        Field[] fields=clazz.getFields();
        for(Field field:fields){
            if(field.isAnnotationPresent(FoodName.class)){
                FoodName fruitName=field.getAnnotation(FoodName.class);
                String FruitName=fruitName.value();
                System.out.println("食物名称:"+FruitName);
            }
            if(field.isAnnotationPresent(FoodColor.class)){
                FoodColor fruitColor=field.getAnnotation(FoodColor.class);
                String Color=fruitColor.color().toString();
                System.out.println("食物颜色:"+Color);
            }
            if (field.isAnnotationPresent(Provider.class)){
                Provider provider=field.getAnnotation(Provider.class);
                int providerNo=provider.providerNO();
                String providerName=provider.providerNmame();
                String providerAddress=provider.providerAddress();
                System.out.println("提供商编号:"+providerNo+",提供商名称:"+providerName+",提供商地址:"+providerAddress);
            }

        }

    }
}

测试类:
public class test {

    public static void main(String[] args){
        foodUtils fruitUtils=new foodUtils();
        fruitUtils.getFruit(Chocolate.class);
    }
}
结果输出:
食物名称:chocolate
食物颜色:BLACK
提供商编号:1,提供商名称:浙商集团,提供商地址:浙江杭州
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 135,246评论 19 139
  • 什么是注解(Annotation):Annotation(注解)就是Java提供了一种元程序中的元素关联任何信息和...
    九尾喵的薛定谔阅读 3,265评论 0 2
  • 本文章涉及代码已放到github上annotation-study 1.Annotation为何而来 What:A...
    zlcook阅读 29,373评论 15 116
  • 傍晚躺在床上等微波炉里的米饭,收到家父微信:在干嘛?我说准备吃饭,他说你先吃饭吧。 一个“先”字,暴露出有事找我的...
    捣蛋小鬼阅读 270评论 0 0
  • 在邂逅你之前 谁像一艘失舵的小船 在岁月的河里顺水漂流 任时光飞逝匆匆 而今 你点亮了谁人生暗夜的塔灯 灯光划破浓...
    蕙兰漱雪阅读 323评论 6 13