詳解Java編程中Annotation注解對象的應用辦法。本站提示廣大學習愛好者：（詳解Java編程中Annotation注解對象的應用辦法）文章只能為提供參考，不一定能成為您想要的結果。以下是詳解Java編程中Annotation注解對象的應用辦法正文
注解(也被稱為元數據)為我們在代碼中添加信息供給了一種情勢化的辦法，使我們可以在稍後某個時辰異常便利地應用這些數據。
1.根本語法
Java SE5內置三種尺度注解
@Override:表現以後的辦法界說將籠罩超類中的辦法.假如你不當心拼寫毛病,或許辦法簽名對不上被覆
蓋的辦法,編譯器就會收回毛病提醒
@Deprecated:假如法式員應用了注解為它的元素,那末編譯器就會收回正告信息
@SupperessWarnings:封閉欠妥的編譯器正告信息.
Java SE5內置四種元注解
@Target:表現該注解可以用於甚麼處所.能夠的ElementType參數包含:
1)CONSTRUCTOR:結構器的聲明
2)FIELD:域聲明(包含enum實例)
3)LOCAL_VARIABLE:部分變量聲明
4)METHOD:辦法聲明
5)PACKAGE:包聲明
6)PARAMETER:參數聲明
7)TYPE:類、接口(包含注解類型)或enum聲明
@Retention:表現須要在甚麼級別保留該注解信息.可選的RetentionPolicy參數包含:
1)SOURCE:注解將被編譯器拋棄
2)CLASS:注解在class文件中可用,但會被VM拋棄
3)RUNTIME:VM將在運轉期也保存注解,是以可以經由過程反射機制讀取注解的信息
@Documented:將此注解包括在Javadoc中
@Inherited:許可子類繼續父類中的注解
年夜多半時刻,法式員重要是界說本身的注解，並編寫本身的處置器來處置它們.
UseCase.java
package com;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.METHOD)//用來界說你的注解將運用在甚麼處所,本處運用為辦法
//用來界說該注解在哪個級別可用,在源代碼中(source)類文件中(class)或許運轉時(runtime)
@Retention(RetentionPolicy.RUNTIME)
public @interface UseCase {
public int id();
public String description()default "no description";
}
PasswordUtils .java
package com;
public class PasswordUtils {
@UseCase(id=47,description="Passwords must contain at least one numeric")
public boolean validatePassword(){
return true;
}
@UseCase(id=48)
public String encryptPassword(String password){
return password;
}
@UseCase(id=49,description="Jong_Cai")
public void showName(){
System.out.println("Jong_Cai");
}
}
2.編寫注解處置器
假如沒有效來讀取注解的對象,那注解也不會比正文更有效.應用注解的進程中.很主要的一個部
分就是創立與應用注解處置器.Java SE5擴大了反射機制的API,以贊助法式員結構這類對象.同時,它還供給了一個內部對象apt贊助法式員解析帶有注解的Java源代碼.上面是一個異常簡略的注解處置器,我們將用它來讀取PasswordUtils類,並應用反射機制查找@UseCase標志.我們為其供給了一組id值得,然後它會列出在PasswordUtils中找到的用例,和缺掉的用例.
UseCaseTracker.java
package com;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
public class UseCaseTracker {
public static void trackUseCases(List<Integer> list, Class<?> cl) {
for (Method m : cl.getDeclaredMethods()) {
UseCase us = m.getAnnotation(UseCase.class);
if (us != null) {
System.out.println("Found Use Case:" + us.id() + " "
+ us.description());
list.remove(new Integer(us.id()));
}
}
for (int i : list) {
System.out.println("Warning:Missing use case-" + i);
}
}
public static void main(String[] args) {
List<Integer> list = new ArrayList<Integer>();
Collections.addAll(list, 47,48,49,50,51);
trackUseCases(list, PasswordUtils.class);
}
}
這個法式用到了兩個反射的辦法:getDeclaredMethods()和getAnnotation(),它們都屬於AnnotatedElement接口(class,Method與Field等類都完成了該接口).getAnnotation()辦法前往指定類型的注解對象,在這裡就是UseCase,假如被注解的辦法上沒有該類型的注解,則前往null值.然後我們經由過程挪用id()和description()辦法從前往的UseCase對象中提取元素的值.個中encryptPassword()辦法在注解的時刻沒有指定description的值,是以處置器在處置它對應的注解時,經由過程description()辦法獲得的是默許值no description.
Annotation在java的世界正漫山遍野睜開,有空寫這一篇簡略的annotations的文章,算是關於Annotation入門的文章吧,願望能列位們能拋磚,配合進修......
不講空話了,理論才是硬事理.
3.實例
上面講一下annotation的概念先，再來說一下如何設計本身的annotation.
起首在jdk自帶的java.lang.annotation包裡,翻開以下幾個源文件:
源文件Target.java
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target {
ElementType[] value();
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target {
ElementType[] value();
}
個中的@interface是一個症結字，在設計annotations的時刻必需把一個類型界說為@interface，而不克不及用class或interface症結字(會不會認為sun有點小氣,恰恰弄得與interface這麼像).
源文件Retention.java
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Retention {
RetentionPolicy value();
}
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Retention {
RetentionPolicy value();
}
看到這裡，年夜家能夠都隱約了,都不曉得在說甚麼，別急，往下看一下. 在下面的文件都用到了RetentionPolicy，ElementType這兩個字段,你能夠就會猜到這是兩個java文件.切實其實，這兩個文件的源代碼以下：
源文件RetentionPolicy.java
public enum RetentionPolicy {
SOURCE,
CLASS,
RUNTIME
}
public enum RetentionPolicy {
SOURCE,
CLASS,
RUNTIME
}
這是一個enum類型,共有三個值，分離是SOURCE,CLASS 和 RUNTIME.
SOURCE代表的是這個Annotation類型的信息只會保存在法式源碼裡，源碼假如經由了編譯以後，Annotation的數據就會消逝,其實不會保存在編譯好的.class文件外面。
ClASS的意思是這個Annotation類型的信息保存在法式源碼裡,同時也會保存在編譯好的.class文件外面,在履行的時刻，其實不會把這一些信息加載到虛擬機(JVM)中去.留意一下，當你沒有設定一個Annotation類型的Retention值時，體系默許值是CLASS.
第三個,是RUNTIME,表現在源碼、編譯好的.class文件中保存信息，在履行的時刻會把這一些信息加載到JVM中去的．
舉一個例子，如@Override外面的Retention設為SOURCE,編譯勝利了就不要這一些檢討的信息;相反,@Deprecated外面的Retention設為RUNTIME,表現除在編譯時會正告我們應用了哪一個被Deprecated的辦法,在履行的時刻也能夠查出該辦法能否被Deprecated.
源文件ElementType.java
public enum ElementType {
TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR,
LOCAL_VARIABLE, ANNOTATION_TYPE,PACKAGE
}
public enum ElementType {
TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR,
LOCAL_VARIABLE, ANNOTATION_TYPE,PACKAGE
}
＠Target外面的ElementType是用來指定Annotation類型可以用在哪一些元素上的.解釋一下：TYPE(類型), FIELD(屬性), METHOD(辦法), PARAMETER(參數), CONSTRUCTOR(結構函數),LOCAL_VARIABLE(部分變量), ANNOTATION_TYPE,PACKAGE(包),個中的TYPE(類型)是指可以用在Class,Interface,Enum和Annotation類型上.
別的,從1的源代碼可以看出,@Target本身也用了本身來聲明本身,只能用在ANNOTATION_TYPE之上.
假如一個Annotation類型沒有指明@Target應用在哪些元素上,那末它可使用在任何元素之上,這裡的元素指的是下面的八品種型.
舉幾個准確的例子:
@Target(ElementType.METHOD)
@Target(value=ElementType.METHOD)
@Target(ElementType.METHOD,ElementType.CONSTRUCTOR)
詳細參考一下javadoc文檔
源文件它們都應用了@Documented,@Documented的目標就是讓這一個Annotation類型的信息可以或許顯示在javaAPI解釋文檔上;沒有添加的話，應用javadoc生成API文檔的時刻就會找不到這一個類型生成的信息.
別的一點，假如須要把Annotation的數據繼續給子類，那末就會用到@Inherited這一個Annotation類型.
上面講的設計一個最簡略的Annotation例子,這一例子共用四個文件;
Description.java
package lighter.javaeye.com;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Description {
String value();
}
package lighter.javaeye.com;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Description {
String value();
}
解釋:一切的Annotation會主動繼續java.lang.annotation這一個接口,所以不克不及再去繼續其余類或是接口.
最主要的一點,Annotation類型外面的參數該怎樣設定:
第一,只能用public或默許(default)這兩個拜訪權潤飾.例如,String value();這裡把辦法設為defaul默許類型.
第二,參數成員只能用根本類型byte,short,char,int,long,float,double,boolean八種根本數據類型和String,Enum,Class,annotations等數據類型,和這一些類型的數組.例如,String value();這裡的參數成員就為String.
第三,假如只要一個參數成員,最好把參數稱號設為"value",後加小括號.例:下面的例子就只要一個參數成員.
Name.java
package lighter.javaeye.com;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
//留意這裡的@Target與@Description裡的分歧,參數成員也分歧
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Name {
String originate();
String community();
}
package lighter.javaeye.com;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
//留意這裡的@Target與@Description裡的分歧,參數成員也分歧
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Name {
String originate();
String community();
}
JavaEyer.java
package lighter.javaeye.com;
@Description("javaeye,做最棒的軟件開辟交換社區")
public class JavaEyer {
@Name(originate="開創人:robbin",community="javaEye")
public String getName()
{
return null;
}
@Name(originate="開創人:江南白衣",community="springside")
public String getName2()
{
return "借用兩位的id一用,寫這一個例子,請見諒!";
}
}
package lighter.javaeye.com;
@Description("javaeye,做最棒的軟件開辟交換社區")
public class JavaEyer {
@Name(originate="開創人:robbin",community="javaEye")
public String getName()
{
return null;
}
@Name(originate="開創人:江南白衣",community="springside")
public String getName2()
{
return "借用兩位的id一用,寫這一個例子,請見諒!";
}
}
寫一個可以運轉提取JavaEyer信息的類TestAnnotation
package lighter.javaeye.com;
import java.lang.reflect.Method;
import java.util.HashSet;
import java.util.Set;
public class TestAnnotation {
/**
* author lighter
* 解釋:詳細關天Annotation的API的用法請拜見javaDoc文檔
*/
public static void main(String[] args) throws Exception {
String CLASS_NAME = "lighter.javaeye.com.JavaEyer";
Class test = Class.forName(CLASS_NAME);
Method[] method = test.getMethods();
boolean flag = test.isAnnotationPresent(Description.class);
if(flag)
{
Description des = (Description)test.getAnnotation(Description.class);
System.out.println("描寫:"+des.value());
System.out.println("-----------------");
}
//把JavaEyer這一類有益用到@Name的全體辦法保留到Set中去
Set<Method> set = new HashSet<Method>();
for(int i=0;i<method.length;i++)
{
boolean otherFlag = method[i].isAnnotationPresent(Name.class);
if(otherFlag) set.add(method[i]);
}
for(Method m: set)
{
Name name = m.getAnnotation(Name.class);
System.out.println(name.originate());
System.out.println("創立的社區:"+name.community());
}
}
}
package lighter.javaeye.com;
import java.lang.reflect.Method;
import java.util.HashSet;
import java.util.Set;
public class TestAnnotation {
/**
* author lighter
* 解釋:詳細關天Annotation的API的用法請拜見javaDoc文檔
*/
public static void main(String[] args) throws Exception {
String CLASS_NAME = "lighter.javaeye.com.JavaEyer";
Class test = Class.forName(CLASS_NAME);
Method[] method = test.getMethods();
boolean flag = test.isAnnotationPresent(Description.class);
if(flag)
{
Description des = (Description)test.getAnnotation(Description.class);
System.out.println("描寫:"+des.value());
System.out.println("-----------------");
}
//把JavaEyer這一類有益用到@Name的全體辦法保留到Set中去
Set<Method> set = new HashSet<Method>();
for(int i=0;i<method.length;i++)
{
boolean otherFlag = method[i].isAnnotationPresent(Name.class);
if(otherFlag) set.add(method[i]);
}
for(Method m: set)
{
Name name = m.getAnnotation(Name.class);
System.out.println(name.originate());
System.out.println("創立的社區:"+name.community());
}
}
}
運轉成果：
描寫:javaeye,做最棒的軟件開辟交換社區 開創人:robbin 創立的社區:javaEye 開創人:江南白衣 創立的社區:springside
