转:J2SE5中的最新注释功能SuppressWarnings
一、什么是注释
说起注释,得先提一提什么是元数据(metadata)。所谓元数据就是数据的数据。也就是说,元数据是描述数据的。就象数据表中的字段一样,每个字段描述了这个字段下的数据的含义。而J2SE5.0中提供的注释就是java源代码的元数据,也就是说注释是描述java源代码的。在J2SE5.0中可以自定义注释。使用时在@后面跟注释的名字。 在J2SE5.0的java.lang包中预定义了三个注释。它们是Override、Deprecated和SuppressWarnings。下面分别解释它们的含义。 Override 这个注释的作用是标识某一个方法是否覆盖了它的父类的方法。那么为什么要标识呢?让我们来看看如果不用Override标识会发生什么事情。 |
|
假设有两个类Class1和ParentClass1,用Class1中的myMethod1方法覆盖ParentClass1中的myMethod1方法。
class ParentClass1 ...{ public void myMethod1() ...{...} } class Class1 extends ParentClass1 ...{ public void myMethod2() ...{...} 建立Class1的实例,并且调用myMethod1方法
ParentClass1 c1 = new Class1(); c1.myMethod1();
以上的代码可以正常编译通过和运行。但是在写Class1的代码时,误将myMethod1写成了myMethod2,然而在调用时,myMethod1并未被覆盖。因此,c1.myMethod1()调用的还是ParentClass1的myMethod1方法。更不幸的是,程序员并未意识到这一点。因此,这可能会产生bug。 如果我们使用Override来修饰Class1中的myMethod1方法,当myMethod1被误写成别的方法时,编译器就会报错。因此,就可以避免这类错误。
class Class1 extends ParentClass1 ...{ @Override // 编译器产生一个错误 public void myMethod2() ...{...} } 以上代码编译不能通过,被Override注释的方法必须在父类中存在同样的方法程序才能编译通过。也就是说只有下面的代码才能正确编译。
class Class1 extends ParentClass1 ...{ @Override public void myMethod1() ...{...} } Deprecated 这个注释是一个标记注释。所谓标记注释,就是在源程序中加入这个标记后,并不影响程序的编译,但有时编译器会显示一些警告信息。 说到这,可能你已经猜出来了。Deprecated注释一定和这些类成员有关。说得对!使用Deprecated标注一个类成员后,这个类成员在显示上就会有一些变化。在eclipse中非常明显。让我们看看图1有哪些变化。 图1 加上@Deprecated后的类成员在eclipse中的变化 从上图可以看出,有三个地方发生的变化。红色框里面的是变化的部分。 发生这些变化并不会影响编译,只是提醒一下程序员,这个方法以后是要被删除的,最好别用。 Deprecated注释还有一个作用。就是如果一个类从另外一个类继承,并且override被继承类的Deprecated方法,在编译时将会出现一个警告。如test.java的内容如下:
class Class1 ...{ @Deprecated public void myMethod()...{} } class Class2 extends Class1 ...{ public void myMethod()...{}
1
1
运行javac test.java 出现如下警告:
注意:test.java 使用或覆盖了已过时的 API。 test.java:4: 警告:[deprecation] Class1 中的 myMethod() 已过时 public void myMethod() 这些警告并不会影响编译,只是提醒你一下尽量不要用myMethod方法。 SuppressWarnings 这个世界的事物总是成对出现。即然有使编译器产生警告信息的,那么就有抑制编译器产生警告信息的。
public void myMethod() ...{ List wordList = new ArrayList(); wordList.add("foo"); }
这是一个类中的方法。编译它,将会得到如下的警告。 注意:Testannotation.java 使用了未经检查或不安全的操作。 这两行警告信息表示List类必须使用范型才是安全的,才可以进行类型检查。如果想不显示这个警告信息有两种方法。一个是将这个方法进行如下改写:
1
public void myMethod() 另外一种方法就是使用@SuppressWarnings。 三、如何自定义注释
public @interface MyAnnotation ...{ }
上面的代码是一个最简单的注释。这个注释没有属性。也可以理解为是一个标记注释。就象Serializable接口一样是一个标记接口,里面未定义任何方法。 当然,也可以定义有属性的注释。
public @interface MyAnnotation ...{ String value(); }
可以按如下格式使用MyAnnotation
@MyAnnotation("abc") public void myMethod() ...{ }
看了上面的代码,大家可能有一个疑问。怎么没有使用value,而直接就写”abc”了。那么”abc”到底传给谁了。其实这里有一个约定。如果没有写属性名的值,而这个注释又有value属性,就将这个值赋给value属性,如果没有,就出现编译错误。 除了可以省略属性名,还可以省略属性值。这就是默认值。
public @interface MyAnnotation ...{ public String myMethod()...{} default “xyz”; }
可以直接使用MyAnnotation
@MyAnnotation // 使用默认值xyz public void myMethod() ...{ } 也可以这样使用
@MyAnnotation(myMethod=”abc”) public void myMethod() ...{ }
如果要使用多个属性的话。可以参考如下代码。
public @interface MyAnnotation ...{ public enum MyEnum...{A, B, C} public MyEnum.value1() ...{} public String value2() ...{} } @MyAnnotation(value1=MyAnnotation.MyEnum.A, value2 = “xyz”) public void myMethod() ...{ } 这一节讨论了如何自定义注释。那么定义注释有什么用呢?有什么方法对注释进行限制呢?我们能从程序中得到注释吗?这些疑问都可以从下面的内容找到答案。
1
四、如何对注释进行注释 这一节的题目读起来虽然有些绕口,但它所蕴涵的知识却对设计更强大的java程序有很大帮助。 Target
@Target(...ElementType.METHOD) @interface MyAnnotation ...{}
@MyAnnotation // 错误的使用 以上代码定义了一个注释MyAnnotation和一个类Class1,并且使用MyAnnotation分别对Class1和myMethod1进行注释。如果编译这段代码是无法通过的。也许有些人感到惊讶,没错啊!但问题就出在@Target(ElementType.METHOD)上,由于Target使用了一个枚举类型属性,它的值是ElementType.METHOD。这就表明MyAnnotation只能为方法注释。而不能为其它的任何语言元素进行注释。因此,MyAnnotation自然也不能为Class1进行注释了。
@Target(...{ElementType.METHOD, ElementType.CONSTRUCTOR}) @interface MyAnnotation ...{}
Retention
@Retention(RetentionPolicy.SOURCE) @interface MyAnnotation1 ...{ }
@Retention(RetentionPolicy.CLASS) @interface MyAnnotation2 ...{} @Retention(RetentionPolicy.RUNTIME) @interface MyAnnotation3 ...{} 其中第一段代码的作用是不将注释保存在class文件中,也就是说象“//”一样在编译时被过滤掉了。第二段代码的作用是只将注释保存在class文件中,而使用反射读取注释时忽略这些注释。第三段代码的作用是即将注释保存在class文件中,也可以通过反射读取注释。 Documented
@interface MyAnnotation...{ } @MyAnnotation class Class1 ...{ public void myMethod() ...{ } } 使用javadoc为这段代码生成文档时并不将@MyAnnotation包含进去。生成的文档对Class1的描述如下:
class Class1extends java.lang.Object 而如果这样定义MyAnnotation将会出现另一个结果。 @Documented @interface MyAnnotation ...{}
生成的文档: @MyAnnotation // 这行是在加上@Documented后被加上的 Inherited 继承是java主要的特性之一。在类中的protected和public成员都将会被子类继承,但是父类的注释会不会被子类继承呢?很遗憾的告诉大家,在默认的情况下,父类的注释并不会被子类继承。如果要继承,就必须加上Inherited注释。
@Inherited @interface MyAnnotation ...{ }
@MyAnnotation public class ParentClass ...{} 在以上代码中ChildClass和ParentClass一样都已被MyAnnotation注释了。 五、如何使用反射读取注释 前面讨论了如何自定义注释。但是自定义了注释又有什么用呢?这个问题才是J2SE5.0提供注释的关键。自定义注释当然是要用的。那么如何用呢?解决这个问题就需要使用java最令人兴奋的功能之一:反射(reflect)。 在使用反射之前必须使用import java.lang.reflect.* 来导入和反射相关的类。 Annotation annotation = TestAnnotation.class.getAnnotation(MyAnnotation.class); 如果要得到全部的注释信息可使用如下语句: getDeclaredAnnotations与getAnnotations类似,但它们不同的是getDeclaredAnnotations得到的是当前成员所有的注释,不包括继承的。而getAnnotations得到的是包括继承的所有注释。 如果要得到其它成员的注释,可先得到这个成员,然后再得到相应的注释。如得到myMethod的注释。
Method method = TestAnnotation.class.getMethod("myMethod", null); Annotation annotation = method.getAnnotation(MyAnnotation.class); 注:要想使用反射得到注释信息,这个注释必须使用 @Retention(RetentionPolicy.RUNTIME)进行注释。
总结 |
转载于:https://www.cnblogs.com/liubiqu/archive/2008/06/01/1211503.html
转:J2SE5中的最新注释功能SuppressWarnings相关推荐
- 解读SQL Server 2012中的最新BI功能
如果SQL Server 2008 R2的重点是让商务智能(BI)的使用者像使用自助服务一样便捷,那么SQL Server 2012则是让自助服务BI这一概念延伸至让IT人员更容易进行管理. 事实上, ...
- [AHK]为通达信画线工具中的文字注释功能增加热键
不想每次都用鼠标去寻找定位这个功能,想热键直达. 方法一:点击坐标法,问题是分辨率不同会导致失效. SendMessage,0x111,4104,0,,ahk_class TdxW_MainFrame ...
- 在PDF-XChange Editor中摘要注释功能如何确定注释的顺序?
PDF-XChange Editor能替代Adobe Reader功能,比任何其他免费的PDF阅读器.查看器和编辑器更小,但功能更加丰富,支持用户在评价模式尝试使用PDF-Xchange免费提供的扩展 ...
- 苹果马上又要更新系统,iOS 14.5 Beta中的所有新功能
苹果今天发布了即将发布的iOS 14.5和iPadOS 14.5更新的第一个beta版本,尽管新软件是应用程序开发人员必须遵守应用程序跟踪透明度规则的最后期限,但还有一些其他值得注意的变化. Appl ...
- Word中查找和替换功能详细介绍
在Word中查找和替换功能很多人都会使用,最通常是用它来查找和替换文字,但实际上还可用查找和替换格式.段落标记.分页符和其他项目,并且还可以使用通配符和代码来扩展搜索. 一.查找和替换文字 例如:将& ...
- 如何撤消Git中的最新本地提交?
我不小心将错误的文件提交给Git ,但是我还没有将提交推送到服务器. 如何撤消本地存储库中的那些提交? #1楼 我想撤消我们共享存储库中的最新五次提交. 我查找了要回滚的修订版ID. 然后我输入以下内 ...
- 代码中特殊的注释技术——TODO、FIXME和XXX的用处
为什么80%的码农都做不了架构师?>>> 在阅读一些开源代码时,我们常会碰到诸如:TODO.FIXME和XXX的单词,它们是有其特殊含义的. TODO: + 说明: 如果代码中 ...
- 使用.NET中的XML注释(一) -- XML注释标签讲解
使用.NET中的XML注释(一) -- XML注释标签讲解 作者:Xt Idt 来源:博客园 发布时间:2011-04-02 11:46 阅读:9 次 原文链接 [收藏] 一.摘要 . ...
- 计算机配件制作表格,CAD教程 中望CAD表格功能创建零件明细表
CAD教程分享:中望CAD表格功能创建零件明细表中望CAD的最新版本中望CAD2011新增加了很多实用的功能,表格功能就是其中之一.利用中望CAD2011的表格功能可以极大地提高工作效率,今天就和大家 ...
最新文章
- 微软这次发布会巨硬:安卓折叠手机、双屏电脑,还有无线耳机和超薄平板
- 架构师之路 — 分布式系统 — gRPC 的 4 种服务定义及调用方式
- 基于工程经验的『RESTful接口设计规范』
- 凄怆与悲凉(灾区现场最新照片)
- 程序员面试100题之三:不用+、-、×、÷数字运算符做加法
- OSGI嵌入jetty应用服务器
- android sdk更新代理设置
- Webpack 4进阶--从前的日色变得慢 ,一下午只够打一次包
- jq使用教程05_ 新手也能用的安装版本,30秒点选即可安装完成,不需配置Python环境
- 为什么你学了 N 遍 Spring Boot,至今还是学生项目?你的问题在这里 | 原力计划...
- Echarts 地图基本使用
- 关于城市照明的大局观
- access查找出生日期年份_Access时间日期比较查询的方法总结
- CGROUP CFS 调度中的 period,burst 概念
- easymock 图片_小程序——使用Easy Mock
- MySQL版本号后面包含“-log”代表什么意思?
- SSM上传用户头像。解决HTTP 400,保存到本地以及数据库保存路径,在页面显示的问题
- vux安装时报vux-loader配置问题
- Promise对象的resolve回调函数和reject回调函数使用
- office的加载项作用
热门文章
- 在EF4.0中获取ObjectContext的数据库连接字符串
- extjs--combox用法
- 在客户端为UltraWebGrid增加行
- 将一串随机数输入到二维坐标轴中,不断刷新JPanel,实现动态显示的效果微笑
- php 单例模式原理,PHP单例模式demo详解
- matlab 倒数第二个位置_MATLAB中运行以下程序后倒数第二部分画图程序要怎么改??、、、...
- 截图识字工具下载使用
- python条件语句函数_python sum 函数中可以使用条件语句吗
- kafka原理_P8架构师带你参透Kafka:设计原理、消息存储、消息消费原理等等
- 17年三月计算机二级,2017年3月计算机二级考试攻略