title: Java注解
date: February 1, 2016 3:12 PM
categories: java
tags: [注解,java]
[TOC]
我的博客
注解
注解目的
- 生成文檔 烙样，如 @see @param @return 等
- 跟蹤代碼依賴性，實(shí)現(xiàn)替代配置文件功能
- 在編譯時進(jìn)行格式檢查蕊肥。如@override
注解基礎(chǔ)
最基礎(chǔ)的注解如下
@Entity
@ 表示這是一個注解谒获，之后的字母表示這個注解的名字蛤肌，以上例子的注解名字為 Entity
注解元素
Java 注解中有一些元素批狱，并且可以設(shè)置他們的值赔硫，舉個??
@Entity(tableName = "vehicles")
注解Entity中含有一個tableName元素，并且把這個元素賦值為vehicles。
一個注解也可以同時含有多個元素
@Entity(tableName = "vehicles", primaryKey = "id")
當(dāng)一個注解只含有一個元素時，賦值可以寫成以下形式
@InsertNew("yes")
注解的種類
注解可以修飾 類、接口茧彤、方法、參數(shù)、域、本地變量。
@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;
}
}
Java 內(nèi)置的注解
Java 內(nèi)置了三種指導(dǎo)編譯的注解趋箩，分別為
- @Deprecated
- @Override
- @SuppressWarnings
@Deprecated
Annotation type used to mark program elements that should no longer be used by programmers. Compilers produce a warning if a deprecated program element is used.
可以修飾 類、方法、域车胡。表示之后不會被使用了。如果代碼中使用到了注解為@Deprecated 的代碼，編譯器會產(chǎn)生警告
@Override
Annotation type used to mark methods that override a method declaration in a superclass. Compilers produce an error if a method annotated with @Override does not actually override a method in a superclass.
修飾方法，表示此方法復(fù)現(xiàn)了父類的方法，如果在父類中沒有相應(yīng)的方法編譯器會報(bào)錯
@Override 并不是必須的，但是在子類中復(fù)寫父類的方法中最好使用，以防復(fù)寫的時候名字和父類的方法名不一致而產(chǎn)生一些問題
public class MySuperClass {
public void doTheThing() {
System.out.println("Do the thing");
}
}
public class MySubClass extends MySuperClass{
@Override
public void doTheThing() {
System.out.println("Do it differently");
}
}
@SuppressWarnings
Annotation type used to indicate that the compiler should not issue the specified warnings for the marked program element. Warnings are not only suppressed for the annotated element but also for all program elements contained in that element.
It is recommended that programmers always use this annotation on the most deeply nested element where it is actually needed.
使編譯器不產(chǎn)生對此方法的警告信息提佣。
自定義注解
注解的定義和類、接口的定義類似荤崇。舉個??
@interface MyAnnotation {
String value();
String name();
int age();
String[] newNames();
}
使用 @interface 關(guān)鍵字表示定義的是一個注解镐依。其中的每一個方法實(shí)際上是聲明了一個配置參數(shù)。方法的名稱就是參數(shù)的名稱天试，返回值類型就是參數(shù)的類型。然低，元素只支持原始的數(shù)據(jù)類型务唐。
使用上述的注解
@MyAnnotation(
value="123",
name="Jakob",
age=37,
newNames={"Jenkov", "Peterson"}
)
public class MyClass {
}
元素默認(rèn)值
在定義注解時可以設(shè)置默認(rèn)值，舉個??
@interface MyAnnotation {
String value() default "";
String name();
int age();
String[] newNames();
}
元素value在使用時可以不賦值带兜，當(dāng)不賦值時枫笛，默認(rèn)采用定義時的默認(rèn)值
@MyAnnotation(
name="Jakob",
age=37,
newNames={"Jenkov", "Peterson"}
)
public class MyClass {
}
@Retention
- 用來聲明注解的保留策略，有CLASS刚照、RUNTIME和SOURCE這三種，分別表示注解保存在類文件、JVM運(yùn)行時刻和源代碼中。
- 只有當(dāng)聲明為RUNTIME的時候郭变，才能夠在運(yùn)行時刻通過反射API來獲取到注解的信息。
- RetentionPolicy.SOURCE 注解將被編譯器丟棄
- RetentionPolicy.CLASS 注解在class文件中可用未荒，但會被VM丟棄
- RetentionPolicy.RUNTIME VM將在運(yùn)行期也保留注釋，因此可以通過反射機(jī)制讀取注解的信息脆侮。
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation {
String value() default "";
}
使用時可以使用反射的方法得到注解中的信息
反射得到注解信息
類注解
@MyAnnotation(name="someName", value = "Hello World")
public class TheClass {
}
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface MyAnnotation {
public String name();
public String value();
}
//法1：可以直接得到所有的注解，在里面尋找MyAnnotation
Class aClass = TheClass.class;
Annotation[] annotations = aClass.getAnnotations();
for(Annotation annotation : annotations){
if(annotation instanceof MyAnnotation){
MyAnnotation myAnnotation = (MyAnnotation) annotation;
System.out.println("name: " + myAnnotation.name());
System.out.println("value: " + myAnnotation.value());
}
}
//法2：可以直接得到MyAnnotation注解
Class aClass = TheClass.class;
Annotation annotation = aClass.getAnnotation(MyAnnotation.class);
if(annotation instanceof MyAnnotation){
MyAnnotation myAnnotation = (MyAnnotation) annotation;
System.out.println("name: " + myAnnotation.name());
System.out.println("value: " + myAnnotation.value());
}
方法注解
public class TheClass {
@MyAnnotation(name="someName", value = "Hello World")
public void doSomething(){}
}
Method method = ... //obtain method object
Annotation[] annotations = method.getDeclaredAnnotations();
for(Annotation annotation : annotations){
if(annotation instanceof MyAnnotation){
MyAnnotation myAnnotation = (MyAnnotation) annotation;
System.out.println("name: " + myAnnotation.name());
System.out.println("value: " + myAnnotation.value());
}
}
//同樣
Method method = ... // obtain method object
Annotation annotation = method.getAnnotation(MyAnnotation.class);
if(annotation instanceof MyAnnotation){
MyAnnotation myAnnotation = (MyAnnotation) annotation;
System.out.println("name: " + myAnnotation.name());
System.out.println("value: " + myAnnotation.value());
}
域比默、參數(shù)注解同理
@Target
用來聲明注解可以被添加在哪些類型的元素上幻捏，如類型、方法和域等命咐。
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
@Target({ElementType.METHOD})
public @interface MyAnnotation {
String value();
}
??表示這個注解只能修飾方法
表示該注解用于什么地方篡九，可能的值在枚舉類 ElemenetType 中，包括：
- ElemenetType.CONSTRUCTOR 構(gòu)造器聲明
- ElemenetType.FIELD 域聲明（包括 enum 實(shí)例）
- ElemenetType.LOCAL_VARIABLE 局部變量聲明
- ElemenetType.METHOD 方法聲明
- ElemenetType.PACKAGE 包聲明
- ElemenetType.PARAMETER 參數(shù)聲明
- ElemenetType.TYPE 類醋奠，接口（包括注解類型）或enum聲明
@Inherited
允許子類繼承父類中的注解榛臼，舉個??
java.lang.annotation.Inherited
@Inherited
public @interface MyAnnotation {
}
@MyAnnotation
public class MySuperClass { ... }
public class MySubClass extends MySuperClass {... }
在這個例子中伊佃，因?yàn)?code>MySubClass繼承了MySuperClass，并且MySuperClass被注解@MyAnnotation修飾了沛善，所以類MySubClass繼承了@MyAnnotation注解
@Documented
@Documented 將此注解包含在 javadoc 中 航揉，它代表著此注解會被javadoc工具提取成文檔。在doc文檔中的內(nèi)容會因?yàn)榇俗⒔獾男畔?nèi)容不同而不同金刁。相當(dāng)與@see,@param 等帅涂。
舉個??
import java.lang.annotation.Documented;
@Documented
public @interface MyAnnotation {
}
@MyAnnotation
public class MySuperClass { ... }
參考
http://blog.csdn.net/tigerdsh/article/details/8848890
http://tutorials.jenkov.com/java/annotations.html
