关闭

java中的内置注解Annotation

711人阅读 评论(0) 收藏 举报

背景知识:
       从JDK5开始提供名为Annotation(注释)的功能,它被定义为JSR-175规范。注释是以“@注释名”在代码中存在的,还可以添加一些参数值,例如:@SuppressWarnings(value="unchecked")。注释可以附加在package, class, method, field等上面,相当于给它们添加了额外的辅助信息,我们可以通过反射机制编程实现对这些元数据的访问。如果没有外部解析工具等对其加以解析和处理的情况,本身不会对Java的源代码或class文件等产生任何影响,也不会对它们的执行产生任何影响。
     元数据的作用,大致可分为三种:编写文档,通过代码里标识的元数据生成文档;代码分析,通过代码里标识的元数据对代码进行分析;编译检查,通过代码里标识的元数据让编译器能实现基本的编译检查。

JDK5内置的基本注释
    JDK5内置了一些常用的注释,可以在编译时帮我们捕获部分编译错误,及提示信息,下面介绍下这些注释的用法:

1、@Override定义在java.lang.Override中,此注释只适用于修辞方法,表示一个方法声明打算重写超类中的另一个方法声明。如果方法利用此注释类型进行注解但没有重写超类方法,则编译器会生成一条错误消息。例如我们为某类重写toString()方法却写成了tostring(),并且我们为该方法添加了@Override注释;代码如下:

public class OverrideDemo {
    @Override
    public String tostring() {
        return super.toString();
    }
}

 

在编译时,会提示以下错误信息:

OverrideTest.java:4: 方法未覆盖其父类的方法 
          @Override
         ^1 错误
 
 
 
2、@Deprecated定义在java.lang.Deprecated中,此注释可用于修辞方法、属性、类,表示不鼓励程序员使用这样的元素,通常是因为它很危险或存在更好的选择。在使用不被赞成的程序元素或在不被赞成的代码中执行重写时,编译器会发出警告。使用@Deprecated的示例代码如下:
public class DeprecatedDemo {
    public static void main(String[] args) {
         DeprecatedClass.DeprecatedMethod();
    }
}
class DeprecatedClass {
    @Deprecated
    public static void DeprecatedMethod() {
    }
}
 
在编译时,会得到以下提示信息:

注意:DeprecatedDemo.java 使用或覆盖了已过时的 API。
注意:要了解详细信息,请使用 -Xlint:deprecation 重新编译。

要注意@Deprecated与@deprecated的区别,@deprecated是为了生成文档的需要,例如:
class DeprecatedClass {

@Deprecated
    public static void DeprecatedMethod() {
    }
}
 
 

 
3、@SuppressWarnings定义在java.lang.SuppressWarnings中,用来抑制编译时的警告信息。与前两个注释有所不同,你需要添加一个参数才能正确使用,这些参数值都是已经定义好了的,我们选择性的使用就好了,参数如下:


通过上面的表格,你应该了解到每个参数的用意了,下面我就以一个常用的参数unchecked为例,为你展示如何使用@SuppressWarnings注释,示例代码如下:

import java.util.List;
import java.util.ArrayList;
public class SuppressWarningsDemo {
        public static List cache = new ArrayList();
        //@SuppressWarnings(value = "unchecked")
        public void add(String data) {
            cache.add(data);
        }
}

 

当我们不使用@SuppressWarnings注释时,编译器就会有如下提示:

引用
注意:SuppressWarningsDemo.java 使用了未经检查或不安全的操作。
注意:要了解详细信息,请使用 -Xlint:unchecked 重新编译。

 

另外,由于@SuppressWarnings注释只有一个参数,并且参数名为value,所以我们可以将上面一句注释简写为
@SuppressWarnings("unchecked")。


同时参数value可以取多个值如:
@SuppressWarnings(value={"unchecked", "deprecation"})
或@SuppressWarnings({"unchecked", "deprecation"})。


原帖地址:http://www.iteye.com/topic/165316

0
0

查看评论
* 以上用户言论只代表其个人观点,不代表CSDN网站的观点或立场
    个人资料
    • 访问:3441000次
    • 积分:31808
    • 等级:
    • 排名:第159名
    • 原创:539篇
    • 转载:389篇
    • 译文:1篇
    • 评论:325条
    求打赏啊
      感觉有帮助请赏一杯茶钱,金额随意。您的鼓励是我写作的动力!
    博客专栏
    求关注啊
      我的微信公众号,敬请关注
    博客寄语
    本人小技术员一枚,踏踏实实做人,认认真真做技术,无其他不切实际的想法。本博客文章与本人的工作单位没有任何关系,只是大学时期或平时看书对IT常用技术的小总结,不能保证全部博文正确或最优,需要读者自己判断。本博客所有文章仅供学习交流,绝不能用作商业用途,绝对不可作为除学习之外的任何用途。本博客的所有内容仅供学习和测试,对任何法律问题及风险不承担任何责任。若无说明,文章为本人原创,对于本人的原创文章,转载必须注明出处和原文链接。本博主上传的学习资源同样只能作为学习用途,绝不能作为除学习之外的任何用途。对于未遵守本博主声明的情形,本博主保留诉诸法律的权利。十分欢迎和期待与IT技术以及生活的爱好者交流学习。
    最新评论