[译] Java注解

原地址
注解允许我们在源码中添加一些元信息。它自JDK5 引入,对于代码中的操作并没有直接的影响。

注解用途

  1. 编译器指令:有三个内建注解(@Deprecated, @Override 和 @SuppressWarninigs)。它们被用来作为编译器指令。举例来说,@Override注解用来告诉编译器该方法是一个重写方法。
  2. 编译期指令:注解可以向编译器提供编译时期指令,用于产生代码、XML文件等。
  3. 运行时指令:我们可以定义一些运行时注解,用以通过Java反射访问。

注解基础概念

注解通常以 @ 符号开始,紧跟着是注解名。@ 符号告诉编译器,这是一个注解。
举例而言,@Override
这里 @ 符号代表这是一个注解,而 Override 就是注解的名字。

我们可以在哪里使用注解

注解可以被应用于类、接口、方法和属性。下面的注解就是被应用于方法当中。

@Override
void myMethod() { 
    //Do something 
}

Java内建注解

Java有三个内建注解:

  • @Override
  • @Deprecated
  • @SuppressWarnings
  1. @Override
    当我们在子类中重写方法,我们应该把这个注解标注在方法上。这样讲增强代码的可读性,同时可以避免一些误操作。比如说,当我们改变了父类中的方法签名,如果使用了注解,就必须同步更改子类中的方法签名,否则编译器将抛出编译期错误。如果你没有使用注解,可能很难跟踪这种错误。

  2. @Deprecated
    这个注解被用来标注在类、方法和属性上,表明其已经过时了,不再被使用。当程序中再使用该类、方法或者属性时,编译器将抛出警告。当一个元素被标记为过时,应该在JavaDoc中标记 @deprecated 。注意这里@Deprecated 和 @deprecated 的区别。@deprecated 被用来作为文档记录目的。

/**
 * @deprecated
 * reason for why it was deprecated
 */
@Deprecated
public void anyMethodHere(){
    // Do something
}
  1. @SuppressWarning
    这个注解用来告诉编译器忽略指定的警告。
@SuppressWarnings("deprecation")
    void myMethod() {
        myObject.deprecatedMethod();
}

如上所示,正在调用一个过时的方法,编译器将给出一个警告,然而当我们使用@SuppressWarnings 注解,这个警告将被忽略。

创建自定义注解

  • 使用 @interface 来创建注解,紧跟着时注解名。
  • 注解也可以拥有元素,他们看起来像方法一样。在下面的例子中,我们有四个元素,但是我们不应该提供这些元素的实现。
  • 所有的注解继承自 java.lang.annotation.Annotatoin 接口。
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
@Documented
@Target(ElementType.METHOD)
@Inherited
@Retention(RetentionPolicy.RUNTIME)
public @interface MyCustomAnnotation{
    int studentAge() default 18;
    String studentName();
    String stuAddress();
    String stuStream() default "CSE";
}

注意:所有的元素都有一个默认值设置。在创建或者使用注解的时候,可以被跳过。举例来说,我想在一个类中使用上面的注解,可以这样做:

@MyCustomAnnotation(
    studentName="Chaitanya",
    stuAddress="Agra, India"
)
public class MyClass {
...
}

我们并没有对studentAge和stuStream元素赋值,因为这并不是必要的(在注解被定义的时候已经设置了默认值)。但是,如果没有设置默认值,我们需要在使用注解的时候给这些元素提供值。
注意:我们可以在注解中使用数组元素。用例如下:

//定义部分
@interface MyCustomAnnotation {
    int      count();
    String[] books();
}
//使用部分  
@MyCustomAnnotation(
    count=3,
    books={"C++", "Java"}
)
public class MyClass {

}

现在重新回到话题:在自定义注解的例子中,我们使用了四个注解:@Documented, @Target, @Inherited, @Retention. 下面我们分别讨论他们。

@Documented

该注解表示,注解元素将被写入到 JavaDoc 中:

ava.lang.annotation.Documented
@Documented
public @interface MyCustomAnnotation {
  //Annotation body
}
.............................................................
@MyCustomAnnotation
public class MyClass { 
     //Class body
}

当为MyClass生成 javadoc文档的时候,文档中将包含 MyCustomAnnotation 注解。

Target

该注解指定我们可以在哪里使用它。如下面例子所示,我们定义了target 类型为 METHOD,这也意味着该注解只能应用于方法中。

import java.lang.annotation.ElementType;
import java.lang.annotation.Target;

@Target({ElementType.METHOD})
public @interface MyCustomAnnotation {

}
.......................................................................
public class MyClass {
   @MyCustomAnnotation
   public void myMethod()
   {
       //Doing something
   }
}

注意:
1) 如果你没有定义 Target 类型,默认可以应用于任何元素。
2) 除了ElementType.METHOD,注解中还可以有下面的 Target 值:
ElementType.METHOD
ElementType.PACKAGE 包
ElementType.PARAMETER 参数
ElementType.TYPE 类
ElementType.ANNOTATION_TYPE 注解
ElementType.CONSTRUCTOR 构造函数
ElementType.LOCAL_VARIABLE 局部变量
ElementType.FIELD 属性

@Inherited

该注解表明,被注解标注的类,它的所有子类将继承该注解:

java.lang.annotation.Inherited

@Inherited
public @interface MyCustomAnnotation {

}
................................................................
@MyCustomAnnotation
public class MyParentClass { 
  ... 
}
................................................................
public class MyChildClass extends MyParentClass { 
   ... 
}

这里,MyParentClass 使用了标注@inherited 的注解--- @MyCustomAnnotation。这意味着在MyChildClass中,将继承 @MyCustomAnnotation。

@Retention
表明注解保留的时间长度。

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME)
@interface MyCustomAnnotation {
    
}

在这里,我们使用了 RetentionPolicy.RUNTIME. 其实,这里还有两个选项。下面我们来分别说明:
RetentionPolicy.RUNTIME: 该注解在运行时可用,通过Java反射获取。
RetentionPolicy.CLASS: 该注解应用于 .class 文件中,但是在运行时不可用。
RetentionPolicy.SOURCE: 该注解在程序源码中可用,在 .class 文件中和 运行时均不可用。

用例

for(Class<?> c:clzz){
            if(c.isAnnotationPresent(HandlerType.class)){
                HandlerType handlerType=c.getAnnotation(HandlerType.class);
                ChannelType channelType=handlerType.channelType();
                MessageType messageType=handlerType.messageType();
                try {
                    Object obj= c.newInstance();
                    if(obj instanceof AbstractHandler){
                        handlers.put(getKey(channelType, messageType), (AbstractHandler)obj);
                    }
                }catch (Exception e) {
                    continue;
                }
            }
        }
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,491评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,856评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,745评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,196评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,073评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,112评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,531评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,215评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,485评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,578评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,356评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,215评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,583评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,898评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,497评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,697评论 2 335

推荐阅读更多精彩内容