java注解:如何实现和使用一个自定义注解?

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/wangpengzhi19891223/article/details/78131137

java中注解在java中的应用非常广泛,如override、supperwarning等等注解,框架中的注解应用更为广泛,主流框架基本都有自己的注解体系,今天想总结和学习一下注解的相关知识,第一篇将介绍如何实现一个注解,第二篇将介绍如何应用一个注解。

1,注解有什么用? 注解的作用基本有三个:
.生成文档。这是最常见的,也是java 最早提供的注解。常用的有 @see @param @return 等
.跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。作用就是减少配置。现在的框架基本都使用了这种配置来减少配置文件的数量。也是
.在编译时进行格式检查。如@override 放在方法前,如果你这个方法并不是覆盖了超类方法,则编译时就能检查出。

2,实现一个最简单的注解:

@Retention(RetentionPolicy.RUNTIME)
public @interface MyTarget {
}

上面是一个最简单的注解实现,没有定义任何的属性,其中需要注意的是@Retention(RetentionPolicy.RUNTIME)是定义注解所必须的。
@Retention是注解的注解,称为注解的元注解。括号里有一个枚举类型的值,即为注解内部定义的值。打开Retention的实现:

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Retention {
    RetentionPolicy value();
}

可以看到这里定义了一个变量value并且没有缺省值,所以不写这个value就会报错。 继续打开RetentionPolicy:

public enum RetentionPolicy {
    SOURCE,
    CLASS,
    RUNTIME
}

可以发现这个枚举类定义了三个值,这三个值分别代表的是我们定义的MyTarget如何保持。
用@Retention(RetentionPolicy.CLASS)修饰的注解,表示注解的信息被保留在class文件(字节码文件)中当程序编译时,但不会被虚拟机读取在运行的时候;
用@Retention(RetentionPolicy.SOURCE )修饰的注解,表示注解的信息会被编译器抛弃,不会留在class文件中,注解的信息只会留在源文件中;
用@Retention(RetentionPolicy.RUNTIME )修饰的注解,表示注解的信息被保留在class文件(字节码文件)中当程序编译时,会被虚拟机保留在运行时,

还需要注意的是java的元注解一共有四个:
@Document
@Target
@Retention
@Inherited

各个的作用,读者自己查一下吧。无论如何我们实现了一个最简单的注解MyTarget,下面进行简单的测试:

    @MyTarget
    public void doSomething() { }

    @Resource
    public static void main(String[] args) throws Exception
    {
        Method method = MyTargetTest.class.getMethod("doSomething",null);
       if(method.isAnnotationPresent(MyTarget.class))
        {                              System.out.println(method.getAnnotation(MyTarget.class));
        }
    }

运行上面的测试会打出一句话:

@annotations.MyTarget()

其中

if(method.isAnnotationPresent(MyTarget.class))

可以判断出方法是是不是存在MyTarget的注解,能打印出这句话证明我们写的确实是一个注解。

二:注解中的属性定义

上面的内容我们实现了一个最简单的注解,但是这个注解基本是没有什么功能的,java注解的功能实现基本是通过定义属性实现的(真正实现功能有相关的处理类,处置这些属性,我们先来定义属性)。注解处理器类库(java.lang.reflect.AnnotatedElement):

AnnotatedElement 接口是所有程序元素(Class、Method和Constructor)的父接口,所以程序通过反射获取了某个类的AnnotatedElement对象之后,程序就可以调用该对象的如下四个个方法来访问Annotation信息:

  
注解处理的一个基础:

方法1:<T extends Annotation> T getAnnotation(Class<T> annotationClass): 返回改程序元素上存在的、指定类型的注解,如果该类型注解不存在,则返回null。
  方法2:Annotation[] getAnnotations():返回该程序元素上存在的所有注解。
  方法3:boolean is AnnotationPresent(Class<?extends Annotation> annotationClass):判断该程序元素上是否包含指定类型的注解,存在则返回true,否则返回false.
  方法4:Annotation[] getDeclaredAnnotations():返回直接存在于此元素上的所有注释。与此接口中的其他方法不同,该方法将忽略继承的注释。(如果没有注释直接存在于此元素上,则返回长度为零的一个数组。)该方法的调用者可以随意修改返回的数组;这不会对其他调用者返回的数组产生任何影响。

j

注解定义属性不同于java,看一下上面的Retention的定义属性方式:

 RetentionPolicy value();

这基本就是注解定义属性的方式,类似于java中定义方法,可以设置缺省值,即用注解的时候缺省值是可以不写的。

我们来看一下注解的功能之一: 为属性赋值,我们定义三个注解:

@Retention(RetentionPolicy.RUNTIME)
public @interface CarSalerTarget {
    public String salerName();
    public int age() default  1;
}
@Retention(RetentionPolicy.RUNTIME)
public @interface CarNameTarget {
    String name() default  "";
}
@Retention(RetentionPolicy.RUNTIME)
public @interface CarSalerTarget {
    public String salerName();
    public int age() default  1;
}

都是汽车相关的信息,中文名,英文名,销售员信息; 下面我们定义一个奔驰汽车的类,试着用注解进行赋值:

public class BnechCar {
    @CarNameTarget(name="奔驰")
    private String name;

    @CarTypeTarget(carType= CarTypeTarget.Type.benchi)
    private String type;

    @CarSalerTarget(salerName="wpz",age=22)
    private String salerInfo;
}

这样其实就定义和赋值完成了,我们搞一个中间类来打印一下信息:

/**
 * Created by wangpengzhi1 on 2017/9/29.
 */
public class CarInfoUtil {
    public static void getFruitInfo(Class<?> clazz){
        Field[] fields = clazz.getDeclaredFields();
        for(Field field :fields){
            if(field.isAnnotationPresent(CarNameTarget.class)){
                CarNameTarget name = (CarNameTarget) field.getAnnotation(CarNameTarget.class);
                String carColour ="汽车的中文名:"+name.name();
                System.out.println(carColour);
            }
            else if(field.isAnnotationPresent(CarTypeTarget.class)){
                CarTypeTarget type= (CarTypeTarget) field.getAnnotation(CarTypeTarget.class);
                String carType="汽车的类型:"+type.carType().toString();
                System.out.println(carType);
            }
            else if(field.isAnnotationPresent(CarSalerTarget.class)){
                CarSalerTarget saler= (CarSalerTarget) field.getAnnotation(CarSalerTarget.class);
                String salerInfo=" 销售员姓名:"+saler.salerName()+" 销售员年龄:"+ saler.age();
                System.out.println(salerInfo);
            }
        }
    }
}

这个类其实就是根据注解获取属性的值。

测试类:

 @Test
    public void testTarget(){
          CarInfoUtil.getFruitInfo(BnechCar.class);
    }

打印信息:

汽车的中文名:奔驰
汽车的类型:benchi
销售员姓名:wpz 销售员年龄:22

看的出注解为属性赋值是成功的。利用上面的处理方式基本就可以理解了框架中使用注解如何进行DI的操作了。

java 注解的知识网络:
这里写图片描述

java技术交流群:255453635 备注:CSDN

展开阅读全文

没有更多推荐了,返回首页