annotation之于程序代码的作用大致可以归结为以下三点:
1) 给编译器(compiler)提供辅助信息,加强纠错和错误处理。比如注解override的函数是否符合override标准,某些warning是否抑制不抛等等。
2) 给某些软件提供信息,以生成相应的代码、xml文件或其它文档等相关内容。比如 Javadoc-generated。
3) 监控程序运行。比如对not null状态的监控。
二) annotation的基本语法
annotation的语法很简单。以@开头,括号内依次写入元素及其值。一般来说annotation在声明classes, fields, methods时使用。
@Author( name = "Benjamin Franklin", date = "3/27/2003" ) class MyClass() { ... }
而在Java SE 8中,annotation的使用场景做了进一步的扩展:
//Class instance creation expresson: new @Interned MyObject(); //Type cast: myString = (@NonNull String) str; //implements clause: class UnmodifiableListimplements @Readonly List<@Readonly T> { ... } //Thrown exception declaration: void monitorTemperature() throws @Critical TemperatureException { ... }
三) annotation的分类
annotation的分类其实也很简单。就分为两类:自定义注解和预定义注解。
1)自定义注解:
我们可以像这样声明一个叫ClassPreamble的注解
@interface ClassPreamble { String author(); String date(); int currentRevision() default 1; String lastModified() default "N/A"; String lastModifiedBy() default "N/A"; // Note use of array String[] reviewers(); }
声明完以后我们可以这样来使用它:
@ClassPreamble ( author = "John Doe", date = "3/17/2002", currentRevision = 6, lastModified = "4/12/2004", lastModifiedBy = "Jane Doe", // Note array notation reviewers = {"Alice", "Bob", "Cindy"} ) public class Generation3List extends Generation2List { // class code goes here }
但是光这样使用ClassPreamble并没有什么特别之处,就像一段普通的注释一般。但与普通注释不同的是,我们可以使编译器根据ClassPremble注解,在生成说明文档时自动加入ClassPremble内声明的相关元素的信息(author、date等)。为此我们在声明时需要加上一个“@Document”:
@Documented @interface ClassPreamble { // Annotation element definitions }
当然,如果我们需要在工程中广泛使用此类注解时,我们也可以考虑使用一下第三方提供的注解架包( Checker Framework就是其中之一)。它会提供给你很多有用的注解噢~~
2) 预定义注解
顾名思义。JDK在发布时除了支持注解功能,也已经预先定义好了一部分非常常用的注解。具体有:
@Deprecated:表明此类、方法或变量不建议使用。如果使用,将会抛出一个warning
@override: 表明此方法是重载.如果不是,抛出error
@SuppressWarnings: 忽略warning。也可以忽略指定类型的warning,比如:@SuppressWarnings("deprecation")
@SafeVarargs: 忽略方法或构造函数入参的不安全操作问题。
@FunctionalInterface:表明此是功能接口。
此外还有供注解使用的注解:
@Retention、@Documented、@Target、@Inherited、@Repeatable。这些注解也都不难理解,这里就不一一解释了。感觉需要注意的是@Repeatable,使用它时注解的声明步骤会多一步,即需要包含一个元素数组。