Java注解介绍

基于注解(Annotation-based)的Java开发无疑是最新的开发趋势.[译者注: 这是05年的文章,在2014年,毫无疑问,多人合作的开发,使用注解变成很好的合作方式,相互之间的影响和耦合可以很低]. 

public @interface MyAnnotation {
   String doSomething();
}

@MyAnnotation (doSomething="What to do")
public void mymethod() {
   ....
}

// 这种注解,就像一种标签, 没有状态
// 有点像没有方法定义的接口Serializable一样
public @interface AMarkerAnnotation {
}

@AMarkerAnnotation
public void mymethod() {
   ....
}

public @interface SingleElementAnnotation
{
    String doSomething();
}

@SingleElementAnnotation ("可以只传对应类型的值")
public void mymethod() {
   ....
}

public @interface FullValueAnnotation {
   String doSomething();
   int count; 
   String date();
}

@FullValueAnnotation (doSomething="参数值", count=1,
               date="09-09-2005")
public void mymethod() {
   ....
}

1. 注解声明应该以一个at符号开始(@),后跟一个interface 关键字,以及注解的名字.
2. 注解里面的方法声明,不接受任何参数(只是看起来像是方法而已,本质是属性域).
3. 注解里面的方法声明不能有throws 子句.
4. 注解里面的方法返回类型只能是下面这几种:

• primitives(6种原始数据类型,int,byte等)
• String(字符串)
• Class(类, 如 String.class 这种)
• enum(枚举)
• array of the above types(数组,数组元素只能是上面的一种类型)

• Simple annotations(简单注解类型): 这些是 Tiger(Tiger是JDK1.5的代号?)提供的基本类型,只能用来注解普通代码;不能用来创建另一个自定义注解类型.
• Meta annotations(元注解): 专门设计用来注解其他注解类型(annotation-type)声明的. 简单地说,他们被称为注解的注解(annotations-of-annotations).

• Override
• Deprecated
• Suppresswarnings

public class Test_Override {
	@Override
	public String toString() {
	   return super.toString() + "测试使用 ‘Override‘ 注解";
	}
}

Compiling 1 source file to D:tempNew Folder (2)
                              TestJavaApplication1buildclasses
D:tempNew Folder (2)TestJavaApplication1srctest
   myannotationTest_Override.java:24: method does not override
                a method from its superclass
@Override
1 error
BUILD FAILED (total time: 0 seconds)

public class Test_Deprecated {
   @Deprecated
   public void doSomething() {
      System.out.println("测试使用 弃用 注解: ‘Deprecated‘");
   }
}

public class TestAnnotations {
   public static void main(String arg[]) throws Exception {
      new TestAnnotations(); 
   }
   public TestAnnotations() {
   Test_Deprecated t2=new Test_Deprecated();
   t2.doSomething();
}

Compiling 1 source file to D:tempNew Folder
(2)TestJavaApplication1buildclasses
D:tempNew Folder
(2)TestJavaApplication1srctestmyannotation
    TestAnnotations.java:27:
warning: [deprecation] doSomething() in
test.myannotation.Test_Deprecated has been deprecated
t2.doSomething();
1 warning

public class TestAnnotations {
   public static void main(String arg[]) throws Exception {
      new TestAnnotations().doSomeTestNow();
   }
   @SuppressWarnings({"deprecation"})
   public void doSomeTestNow() {
      Test_Deprecated t2 = new Test_Deprecated();
      t2.doSomething();
   }
}

• Target
• Retention
• Documented
• Inherited

• @Target(ElementType.TYPE) —— 可以适用于任何类的元素
• @Target(ElementType.FIELD) —— 只适用于字段或属性
• @Target(ElementType.METHOD) —— 只适用于方法的注解
• @Target(ElementType.PARAMETER) —— 只适用于方法的参数
• @Target(ElementType.CONSTRUCTOR) —— 只适用于构造函数
• @Target(ElementType.LOCAL_VARIABLE) —— 只适用于局部变量
• @Target(ElementType.ANNOTATION_TYPE) —— 指明声明类型本身是一个注解类型

@Target(ElementType.METHOD)
public @interface Test_Target {
   public String doTestTarget();
}

public class TestAnnotations {
   public static void main(String arg[]) {
      new TestAnnotations().doTestTarget();
   }
   // 在方法上使用注解,OK.
   // 中间也可以不换行,换2行之类,Java忽略多余的换行
   @Test_Target(doTestTarget="Hello World !")
   public void doTestTarget() {
      System.out.printf("Testing Target annotation");
   }
}

public class TestAnnotations {
   // 这是错误的做法,编译不会通过,因为注解的Level不对.
   // 元注解指明了只能注解方法,就不能用来注解属性
   @Test_Target(doTestTarget="Hello World !")
   private String str;
   public static void main(String arg[]) {
      new TestAnnotations().doTestTarget();
   }
   public void doTestTarget() {
      System.out.printf("Testing Target annotation");
   }
}

"TestAnnotations.java": 
D:R_AND_DTestAnnotationsrctestmyannotation
   TestAnnotations.java:16: 
annotation type not applicable to this kind of declaration at line
16, column 0
@Test_Target(doTestTarget="Hello World !")
^
Error in javac compilation

• RetentionPolicy.SOURCE —— 这种类型的Annotations只在源代码级别保留,编译时就会被忽略
• RetentionPolicy.CLASS —— 这种类型的Annotations编译时被保留,在class文件中存在,但JVM将会忽略
• RetentionPolicy.RUNTIME —— 这种类型的Annotations将被JVM保留,所以他们能在运行时被JVM或其他使用反射机制的代码所读取和使用.

@Retention(RetentionPolicy.RUNTIME)
public @interface Test_Retention {
   String doTestRetention();
}

@Documented
public @interface Test_Documented {
   String doTestDocument();
}

public class TestAnnotations {
   public static void main(String arg[]) {
      new TestAnnotations().doSomeTestRetention();
      new TestAnnotations().doSomeTestDocumented();
   }
   @Test_Retention (doTestRetention="保留注解信息测试")
   public void doSomeTestRetention() {
      System.out.printf("测试注解类型 ‘Retention‘");
   }
   @Test_Documented(doTestDocument="Hello document")
   public void doSomeTestDocumented() {
      System.out.printf("测试注解类型 ‘Documented‘");
   }
}

@Inherited
public @interface MyParentObject { 
      boolean isInherited() default true;
      String doSomething() default "Do what?";
}

@MyParentObject
public Class MyChildObject {
}

public class MyChildObject implements MyParentObject {
   public boolean isInherited() {
      return false;
   }
   public String doSomething() {
      return "";
   }
   public boolean equals(Object obj) {
      return false;
   }
   public int hashCode() {
      return 0;
   }
   public String toString() {
      return "";
   }
   public Class annotationType() {
      return null;
   }
}

1. J2SE 5.0新特性和增强功能 
2. J2SE 5.0简介
3. Tiger的注解,第1部分:元数据添加到Java代码中  
4. Java 1.5中有什么新特性? 
5. NetBeans4中的老虎 
6. 驯服老虎.pdf 

Java注解介绍