一) annotation的作用
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 UnmodifiableList<T> implements
@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,使用它时注解的声明步骤会多一步,即需要包含一个元素数组。
分享到:
相关推荐
JDK5.0 - Java Annotation 介绍 (ppt格式)
JAVA Annotation学习示例 的一个简单示例 有源码 也有相关博客说明
java annotation 手册.doc,java annotation 手册.doc,java annotation 手册.doc
Java Annotation注解技术
Java Annotation的讲解和例子~~~
本文针对java初学者或者annotation初次使用者全面地说明了annotation的使用方法、定义方式、分类。初学者可以通过以上的说明制作简单的annotation程序,但是对于一些高级的annotation应用(例如使用自定义annotation...
Java Annotation详解 Java Annotation详解 Java Annotation详解
struts 拦截器,扩展,以及java annotation 这个是我学习所用,放在此处,作为中转。
JavaAnnotation必须掌握的特性Java开发Java经验技巧共6页.pdf.zip
java annotation手册 关于annotation是什么东西,百度一下会有很多关于它的描述,在这里就不用再copy了,我们还是以一个示例开始吧,在开始示例之前,我们先来一个小故事。
Java Annotation入门,本文初步告诉你怎么使用java anotatin
NULL 博文链接:https://xing-kenny.iteye.com/blog/1338865
如果你想知道java annotation是什么?你可以看看
java annotation 从JDK5.0后提供的功能。里面包含的实例,我是为了学习这个,所以放到这个上面作为中转。从别人博客里面摘取,博客地址里面附有。
javaAnnotation.pdf
Java Annotation学习整理
JavaAnnotation实例.docx