java 注解的几大作用及使用方法详解(完) - 点滴记忆*记忆点滴
收藏本站

java 注解的几大作用及使用方法详解(完)

java 注解,从名字上看是注释,解释。但功能却不仅仅是注释那么简单。注解(Annotation) 为我们在代码中添加信息提供了一种形式化的方法,是我们可以在稍后 某个时刻方便地使用这些数据(通过 解析注解 来使用这些数据),常见的作用有以下几种:
  • 生成文档。这是最常见的,也是java 最早提供的注解。常用的有@see @param @return 等
  • 跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。作用就是减少配置。现在的框架基本都使用了这种配置来减少配置文件的数量。也是
  • 在编译时进行格式检查。如@Override 放在方法前,如果你这个方法并不是覆盖了超类方法,则编译时就能检查出。

java.lang.annotation 中包含所有定义自定义注解所需用到的原注解和接口。如接口 java.lang.annotation.Annotation 是所有注解继承的接口,并且是自动继承,不需要定义时指定,类似于所有类都自动继承Object。

该包同时定义了四个元注解,Documented,Inherited,Target(作用范围,方法,属性,构造方法等),Retention(生命范围,源代码,class,runtime)。下面将在实例中逐个讲解他们的作用,及使用方法。

Inherited : 在您定义注解后并使用于程序代码上时,预设上父类别中的注解并不会被继承至子类别中,您可以在定义注解时加上java.lang.annotation.Inherited 限定的Annotation,这让您定义的Annotation型别被继承下来。注意注解继承只针对class 级别注解有效(这段建议看完全文后在来回顾)。 多说无益,下面就一步步从零开始建一个我们自己的注解。

   建第一个注解

package com.tmser.annotation;
/**
 *
 *@interface用来声明一个注解,其中的每一个方法实际上是声明了一个配置参数。
 *方法的名称就是参数的名称,返回值类型就是参数的类型。
 *可以通过default来声明参数的默认值。
 *在这里可以看到@Retention和@Target这样的元注解,用来声明注解本身的行为。
 *@Retention用来声明注解的保留策略,有CLASS、RUNTIME和SOURCE这三种,
 *分别表示注解保存在类文件、JVM运行时刻和源代码中。
 *只有当声明为RUNTIME的时候,才能够在运行时刻通过反射API来获取到注解的信息。
 *@Target用来声明注解可以被添加在哪些类型的元素上,如类型、方法和域等。
 *就可以定义一个注解了,它将自动继承Annotation
 */
public @interface TestA {
//这里定义了一个空的注解,它能干什么呢。我也不知道,但他能用。
}

在下面这个程序中使用它:

package com.tmser.annotation;

import java.util.HashMap;
import java.util.Map;

/**
 * 这个类专门用来测试注解使用
 * @author tmser
 */
@TestA    //使用了类注解
public class UserAnnotation {
    
    @TestA //使用了类成员注解
    private Integer age;
    
    @TestA //使用了构造方法注解
    public UserAnnotation(){
        
    }
    @TestA //使用了类方法注解
    public void a(){
        @TestA //使用了局部变量注解
        Map m = new HashMap(0);
    }
    
    public void b(@TestA Integer a){ //使用了方法参数注解
        
    }
}

编译没有报错,ok,一个注解实验完成。这个注解也太简单了吧,好像什么信息也不能传递。别急下面就来一步步完善它,也该四位元注解依次开始上场了。

  1. 果然 说道:

    package-info.java创建了,但是创建出来后还是错误

  2. zzm 说道:

    写的非常详细,但是不够仔细,@Override首字母没大写,注释和Annotation终究是不同的你这样会误导新手的

    • tmser 说道:

      @zzm: 谢谢指正,自己备忘,这篇算仔细的了。

  3. uzi 说道:

    革命还需努力,菜鸟还需学习啊。。。

  4. uzi 说道:

    大神的杰作。。。。

  5. java 说道:

    看完,懂了不少。

  6. uuz 说道:

    写的非常详细啊。

  7. 点滴 说道:

    点击这里给我发消息学习

  8. 留下足迹