Java.Annotations

Annotation

 

0. Annotation Tricks

http://developer.android.com/reference/java/lang/annotation/Annotation.html

0.1 Annotation 接口

"Defines the interface implemented by all annotations. Note that the interface itself is not an annotation,

and neither is an interface that simply extends this one. Only the compiler is able to create proper annotation types."

只有编译器可以创建合适的annotation类型。

0.2 AnnotatedElement 接口

java.lang.reflect.AnnotatedElement

since 1.5

"Represents an annotated element of the program currently running in this VM.

This interface allows annotations to be read reflectively. All annotations returned

by methods in this interface are immutable and serializable." Ref[8]

实现该接口的有: 

Class<T> 实现了该接口。

该接口有方法：

abstract <T extends Annotation> T getAnnotation(Class<T> annotationType)

Q: 那么annotationType参数应该接受哪些参数呢？

A: 参考ACRA的ACRA.java中以下方法的实现，

    public static ACRAConfiguration getNewDefaultConfig(Application app) {
        if(app != null) {
            return new ACRAConfiguration(app.getClass().getAnnotation(ReportsCrashes.class));
        } else {
            return new ACRAConfiguration(null);
        }
    }

可以看出传给annotationType的值是KLAnnotation.class。

KLAnnotation的定义：

 @interface KLAnnotation {}

0.3 关于.class和getClass()的区别，以及关于Class

参见 http://www.cnblogs.com/cwgk/p/4103391.html

0.4  @interface Vs. class Vs. interface

"Annotation type declaration cannot have explicit superinterfaces.

Annotation type declaration cannot have an explicit superclass." Ref[6]

以上说法是否正确? 以及@interface 和class interface是同一级的关键字(或 组件)吗？

 

1. Annotations 基础

Ref[1,2,3,4,5] 

1.1 Annotation简介

"Java annotations are used to provide meta data for your Java code. 

Java annotations were added to Java from Java 5. This text covers Java annotations as they look in Java 6.

As far as I know, Java annotations have not changed in Java 7, so this text should be valid for

Java 7 programmers too." Ref[2]

Java注解 用来为Java代码添加元数据。

Java注解典型的被用于：
编译器指令，构建时指令，运行时指令

"Java has 3 built-in annotations that you can use to give instructions to the Java compiler. " Ref[2]

"Java annotations can be be used at build-time, when you build your software project.

The build process includes generating source code, compiling the source, generating

XML files (e.g. deployment descriptors), packaging the compiled code and files into a JAR file etc." Ref[2]

"Normally, Java annotations are not present in your Java code after compilation.

It is possible, however, to define your own annotations that are available at runtime. " Ref[2]

一般情况下，Java注解在编译后不存在于Java代码中。但是可以通过定义自己的注解，这样可以在运行时使用。

 

1.2 Java注解的写法

@Entity

"@" 告诉编译器这是一个注解。跟在"@"之后的字符串是注解的名字。

Java注解可以有元素(Elements), 你可以给这些元素进行赋值。元素和属性类似。

@Entity(tableName = "vehicles")

上例中的注解有个元素tableName，并给该元素赋值为vehicles。如果注解没有元素，不需要括号。

@Entity(tableName = "vehicles", primaryKey = "id") 

注解可以有多个元素。

@InsertNew(value = "yes")

如果注解只有一个元素，通常该元素被命名为value。当注解只有一个元素并且该元素的名字为value时，可以简写为：

@InsertNew("yes")

 

1.3 注解可以应用的位置

Java注解可以放在classse, interfaces, methods, method parameters, fields and local variables.

@Entity
public class Vehicle {
}

@Entity
public class Vehicle {

    @Persistent
    protected String vehicleName = null;


    @Getter
    public String getVehicleName() {
        return this.vehicleName;
    }

    public void setVehicleName(@Optional vehicleName) {
        this.vehicleName = vehicleName;
    }

    public List addVehicleNameToList(List names) {

        @Optional
        List localNames = names;

        if(localNames == null) {
            localNames = new ArrayList();
        }
        localNames.add(getVehicleName());

        return localNames;
    }

}

上例中，示例了注解的使用位置。

 

1.4 内建的Java注解 

Java comes with three built-in annotations which are used to give the Java compiler instructions:

@Deprecated

@Override

@SuppressWarnings

 

1.4.1  @Deprecated

"The @Deprecated annotation is used to mark a class, method or field as deprecated, meaning it should no longer be used.

If your code uses deprecated classes, methods or fields, the compiler will give you a warning. Here is @Deprecated Java

annotation example:" Ref[2]

@Deprecated
public class MyComponent {

}

 

1.4.2 @Override

"The @Override Java annotation is used above methods that override methods in a superclass.

If the method does not match a method in the superclass, the compiler will give you an error." Ref[2]

 

1.4.3 @SuppressWarnings

"The @SuppressWarnings annotation makes the compiler suppress warnings for a given method.

For instance, if a method calls a deprecated method, or makes an insecure type cast, the compiler may

generate a warning. You can suppress these warnings by annotating the method containing the code with

the@SuppressWarnings annotation." Ref[2]

 

1.5 创建自己的注解

和interface,class类似，Java注解定义在自己的文件中。

@interface MyAnnotation {

    String   value();

    String   name();
    int      age();
    String[] newNames();

}

@interface: "This signals to the Java compiler that this is a Java annotation definition."

"Notice that each element is defined similarly to a method definition in an interface.

It has a data type and a name. You can use all primitive data types as element data types.

You can also use arrays as data type. You cannot use complex objects as data type." Ref[2]

可以在自己的代码中使用上面定义的注解：

@MyAnnotation(
    value="123",
    name="Jakob",
    age=37,
    newNames={"Jenkov", "Peterson"}
)
public class MyClass {


}

 

1.5.1 元素的默认值

可以为元素指定默认值。"That way the element becomes optional and can be left out. "

@interface MyAnnotation {

    String   value() default "";

    String   name();
    int      age();
    String[] newNames();

}

 

"The value element can now be left out when using the annotation. If you leave it out,

it will be considered as if you had used the default value for the value element."

@MyAnnotation(
    name="Jakob",
    age=37,
    newNames={"Jenkov", "Peterson"}
)
public class MyClass {


}

 

在上例中value元素没有被指明值，所以value元素采用默认值。

1.5.2 元注解

元注解：修饰注解的注解。有@Retention @Target @Inherited

1.5.2.1 @Retention

"You can specify for your custom annotation if it should be available at runtime,

for inspection via reflection. You do so by annotating your annotation definition

with the @Retention annotation."

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME)

@interface MyAnnotation {

    String   value() default "";

}

 

"@Retention(RetentionPolicy.RUNTIME) This is what signals to the Java compiler and JVM that the annotation

should be available via reflection at runtime." Ref[2].  

在运行时访问annotation可以参考 Ref[11].

另外：RetetionPolicy 类提供了另外的两个值：

RetentionPolicy.CLASS: "means that the annotation is stored in the .class file, but not available at runtime.

This is the default retention policy, if you do not specify any retention policy at all." 

RetentionPolicy.SOURCE: "means that the annotation is only available in the source code, and not in the .class

files and not a runtime. If you create your own annotations for use with build tools that scan the code, you

can use this retention policy. That way the .class files are not polluted unnecessarily." Ref[2]

1.5.2.2 @Target

"You can specify which Java elements your custom annotation can be used to annotate. You do so by

annotating your annotation definition with the @Target annotation." Ref[2]

import java.lang.annotation.ElementType;
import java.lang.annotation.Target;

@Target({ElementType.METHOD})
public @interface MyAnnotation {

    String   value();
}

 

ElementType包含一下的targets：

ElementType.ANNOTATION_TYPE

ElementType.CONSTRUCTOR

ElementType.FIELD

ElementType.LOCAL_VARIABLE

ElementType.METHOD

ElementType.PACKAGE

ElementType.PARAMETER

ElementType.TYPE

"The ANNOTATION_TYPE target means Java annotation definitions. Thus, the annotation can only be used to annotate other annotations. Like the @Target and @Retention annotations.

The TYPE target means any type. A type is either a class, interface, enum or annotation." Ref[2]

1.5.2.3 @Inherited

"The @Inherited annotation signals that a custom Java annotation used in a class should be

inherited by subclasses inheriting from that class." Ref[2]

java.lang.annotation.Inherited

@Inherited
public @interface MyAnnotation {

}

@MyAnnotation
public class MySuperClass { ... }

public class MySubClass extends MySuperClass { ... }

"In this example the class MySubClass inherits the annotation @MyAnnotation 

because MySubClassinherits from MySuperClass, and MySuperClass has a @MyAnnotation annotation." Ref[2] 

1.5.2.4 @Documented

java.lang.annotation.Documented

@Documented
public @interface MyAnnotation {

}

@MyAnnotation
public class MySuperClass { ... }

 

"When generating JavaDoc for the MySuperClass class, the @MyAnnotation is now included in the JavaDoc." Ref[2]

 

2. Demo

Ref[9]

 

3. Annotations 的使用案例 

3.1 ACRA的实现 

3.2 PerferenceInjector的实现

Ref[9]

 

4. Annotation Processor

A：如何编写Annotation Processor? 以及调试Processor?

B: 如何没有和Annotation相对应的Processor，那么Annotation会有什么效果?

 

---

Items

Java Annotations : Java 注解 

RetentionPolicy: 保留策略

---

Reference

1. Java Annotations and Java Reflection - Tutorial  (AAAA) [Read]

http://www.vogella.com/tutorials/JavaAnnotations/article.html 

2. Java Annotations  (AAAAA) [Read]

http://tutorials.jenkov.com/java/annotations.html

3. Java Annotations By Example (AAAA) [ToRead]

http://whyjavasucks.com/Blog/5/Java_By_Example/93/Java_Annotations

4. Complete Java Annotations Tutorial (AAAA) [ToRead] 

http://howtodoinjava.com/2014/06/09/complete-java-annotations-tutorial/

5. Type Annotations in Java 8: Tools and Opportunities (AAA [ToRead]

http://www.infoq.com/articles/Type-Annotations-in-Java-8

6. 

http://stackoverflow.com/questions/4722354/can-annotation-implement-interfaces

7. CODE GENERATION USING ANNOTATION PROCESSORS IN THE JAVA LANGUAGE  (AAAAA)

https://deors.wordpress.com/2011/09/26/annotation-types/

https://github.com/deors/deors.demos.annotations 

8. Interface AnnotatedElement Java doc

http://docs.oracle.com/javase/7/docs/api/javax/annotation/processing/package-summary.html

9. Using Java 6 Processors in Eclipse

http://java.dzone.com/news/using-java-6-processors 

10. Getting Started with the Annotation Processing Tool, apt

http://docs.oracle.com/javase/7/docs/technotes/guides/apt/GettingStarted.html

11. Java Reflection and Annotations tutorial

http://tutorials.jenkov.com/java-reflection/annotations.html

12. APT in Eclipse

http://help.eclipse.org/luna/index.jsp?topic=%2Forg.eclipse.jdt.doc.isv%2Fguide%2Fjdt_apt_getting_started.htm

13. Explore Annotations in Java 8 [To Read]

https://dzone.com/articles/explore-annotations-in-java-8