注解是java.lang.annotation包提供的功能(我一度以为是Spring的特性?),Spring利用注解做了非常多的事情,注解也让很多集成工作变得非常轻松和简单,同时太过完美的封装也会带来弊端,那就是代码藏得太深了。。
注解本身做的事情非常少,大部分是提供识别的功能。
注解的使用场景
注解一般在声明时使用,比如类、字段、方法和其他程序元素的声明,将注解写在声明时,通常是单独一行写在声明的前面,比如:
@Description(name="name",descrip ="descript")
public String className;
Java8以后,注解可以添加在任意的类型之前,比如
1. 创建对象实例时
new @Interned MyObject();
2. 类型转换时
myString = (@NonNull String) str;
3. 接口实现
class UnmodifiableList<T> implements
@Readonly List<@Readonly T> { ... }
4. 抛异常声明
void monitorTemperature() throws
@Critical TemperatureException { ... }
预定义的注解
Java SE API中预定义了一组注解类型。有些注解类型由Java编译器使用,有些则应用于其他注解。
@Deprecated 注解表示标记的元素已被弃用,不应该再使用。每当程序使用带有@Deprecated注释的方法、类或字段时,编译器都会生成警告。当一个元素被弃用时,还应该使用Javadoc @deprecated标记记录它,如下面的示例所示。在Javadoc注解和注释中使用@并非巧合:它们在概念上是相关的。另外,注意Javadoc标记以小写d开头,注释以大写D开头。
// Javadoc comment follows
/**
* @deprecated
* explanation of why it was deprecated
*/
@Deprecated
static void deprecatedMethod() { }
}
@Override 注释通知编译器,该元素意味着重写父类中声明的元素。
// mark method as a superclass method
// that has been overridden
@Override
int overriddenMethod() { }
@SuppressWarnings 注解告诉编译器忽略它将会产生的特定警告。在下面的例子中,使用了一个已弃用的方法,编译器通常会生成一个警告。但是,在这种情况下,注解会导致警告被忽略。
// use a deprecated method and tell
// compiler not to generate a warning
@SuppressWarnings("deprecation")
void useDeprecatedMethod() {
// deprecation warning
// - suppressed
objectOne.deprecatedMethod();
}
每个编译器警告都属于一个类别。Java语言规范列出了两类:deprecated和unchecked。当与泛型出现之前编写的遗留代码交互时,可能会出现unchecked的警告。要忽略多个类别的警告,请使用以下语法:
@SuppressWarnings({“unchecked”、“deprecated”})
@SafeVarargs 当应用于方法或构造函数时,@SafeVarargs 注解断言代码不会对其varargs参数执行潜在的不安全操作。
@FunctionalInterface Java SE 8中引入的@FunctionalInterface 表示被注解的类型声明为功能接口(functional Interface)。
注解的注解
应用于其他注解的注解称为元注解(meta-annotations)。在java.lang.annotation中定义了几种元注解类型。
1. @Retention
@Retention注解指定标记的注解是如何保存的:
RetentionPolicy.SOURCE——标记的注解只保留在源代码级别,并被编译器忽略。
RetentionPolicy.CLASS——标记的注解在编译时由编译器保留,但是被Java虚拟机(JVM)忽略。
RetentionPolicy.RUNTIME——标记的注释由JVM保留,以便运行时环境可以使用它。
2.@Documentation
@Documentation注解指出,无论何时使用指定的注解,这些元素都应该使用Javadoc工具进行文档化。(默认情况下,Javadoc中不包含注解。)
3.@Target
使用@Target注解来限制被标记的注解可以应用于哪种Java元素。目标注解指定以下元素类型之一作为其值:
-
ElementType.ANNOTATION_TYPE
注解 -
ElementType.CONSTRUCTOR
构造函数 -
ElementType.FIELD
属性 -
ElementType.LOCAL_VARIABLE
局部变量 -
ElementType.METHOD
方法 -
ElementType.PACKAGE
包声明 -
ElementType.PARAMETER
参数 -
ElementType.TYPE
类声明
4. @inheritance
@inheritance注解表示可以从父类继承注解类型(默认情况下并非如此。),这个注解只适用于类声明。
5. Repeatable
Java SE 8中引入的@Repeatable注解表明,标记的注解可以不止一次应用于相同的声明或类型使用。
使用注解
举例,我自定义了一个注解
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Description {
String name() default "";
String descrip() default "";
}
这个注解被应用于ElementType.FIELD也就是类的属性上,同时RetentionPolicy.RUNTIME表明其可以被JVM识别。
示例注解有两个可以赋值的属性name()和descript();
下面声明一个类,使用我们自定义的注解来标注。
public class AnnotationDemo {
@Description(name="fieldName",descrip ="descript")
public String className;
public String getClassName(){
return this.className;
}
public void setClassName(String className){
this.className = className;
}
}
在使用中获取注解的值:
AnnotationDemo ad = new AnnotationDemo();
Description an = null;;
try {
an = ad.getClass().getField("className").getAnnotation(Description.class);
} catch (NoSuchFieldException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (SecurityException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
if(null!=an){
System.out.println("getAnnotation:"+an.name()+an.descrip());
}
输出结果:
getAnnotation:fieldNamedescript
以上是java注解的基础内容。就是这么一个小小的功能,可以支撑起很多强大的框架。