詳解Java編程中Annotation注解對象的使用方法
注解(也被稱為元數(shù)據)為我們在代碼中添加信息提供了一種形式化的方法，使我們可以在稍后某個時刻非常方便地使用這些數(shù)據。
1.基本語法
Java SE5內置三種標準注解
@Override:表示當前的方法定義將覆蓋超類中的方法.如果你不小心拼寫錯誤,或者方法簽名對不上被覆
蓋的方法,編譯器就會發(fā)出錯誤提示
@Deprecated:如果程序員使用了注解為它的元素,那么編譯器就會發(fā)出警告信息
@SupperessWarnings:關閉不當?shù)木幾g器警告信息.
Java SE5內置四種元注解
@Target:表示該注解可以用于什么地方.可能的ElementType參數(shù)包括:
1)CONSTRUCTOR:構造器的聲明
2)FIELD:域聲明(包括enum實例)
3)LOCAL_VARIABLE:局部變量聲明
4)METHOD:方法聲明
5)PACKAGE:包聲明
6)PARAMETER:參數(shù)聲明
7)TYPE:類、接口(包括注解類型)或enum聲明
@Retention:表示需要在什么級別保存該注解信息.可選的RetentionPolicy參數(shù)包括:
1)SOURCE:注解將被編譯器丟棄
2)CLASS:注解在class文件中可用,但會被VM丟棄
3)RUNTIME:VM將在運行期也保留注解,因此可以通過反射機制讀取注解的信息
@Documented:將此注解包含在Javadoc中
@Inherited:允許子類繼承父類中的注解
大多數(shù)時候,程序員主要是定義自己的注解，并編寫自己的處理器來處理它們.
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.編寫注解處理器
如果沒有用來讀取注解的工具,那注解也不會比注釋更有用.使用注解的過程中.很重要的一個部
分就是創(chuàng)建與使用注解處理器.Java SE5擴展了反射機制的API,以幫助程序員構造這類工具.同時,它還提供了一個外部工具apt幫助程序員解析帶有注解的Java源代碼.下面是一個非常簡單的注解處理器,我們將用它來讀取PasswordUtils類,并使用反射機制查找@UseCase標記.我們?yōu)槠涮峁┝艘唤Mid值得,然后它會列出在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等類都實現(xiàn)了該接口).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的數(shù)據就會消失,并不會保留在編譯好的.class文件里面。
ClASS的意思是這個Annotation類型的信息保留在程序源碼里,同時也會保留在編譯好的.class文件里面,在執(zhí)行的時候，并不會把這一些信息加載到虛擬機(JVM)中去.注意一下，當你沒有設定一個Annotation類型的Retention值時，系統(tǒng)默認值是CLASS.
第三個,是RUNTIME,表示在源碼、編譯好的.class文件中保留信息，在執(zhí)行的時候會把這一些信息加載到JVM中去的．
舉一個例子，如@Override里面的Retention設為SOURCE,編譯成功了就不要這一些檢查的信息;相反,@Deprecated里面的Retention設為RUNTIME,表示除了在編譯時會警告我們使用了哪個被Deprecated的方法,在執(zhí)行的時候也可以查出該方法是否被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(參數(shù)), CONSTRUCTOR(構造函數(shù)),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的數(shù)據繼承給子類，那么就會用到@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類型里面的參數(shù)該怎么設定:
第一,只能用public或默認(default)這兩個訪問權修飾.例如,String value();這里把方法設為defaul默認類型.
第二,參數(shù)成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數(shù)據類型和String,Enum,Class,annotations等數(shù)據類型,以及這一些類型的數(shù)組.例如,String value();這里的參數(shù)成員就為String.
第三,如果只有一個參數(shù)成員,最好把參數(shù)名稱設為"value",后加小括號.例:上面的例子就只有一個參數(shù)成員.
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里的不同,參數(shù)成員也不同
@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里的不同,參數(shù)成員也不同
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Name {
String originate();
String community();
}
JavaEyer.java
package lighter.javaeye.com;
@Description("javaeye,做最棒的軟件開發(fā)交流社區(qū)")
public class JavaEyer {
@Name(originate="創(chuàng)始人:robbin",community="javaEye")
public String getName()
{
return null;
}
@Name(originate="創(chuàng)始人:江南白衣",community="springside")
public String getName2()
{
return "借用兩位的id一用,寫這一個例子,請見諒!";
}
}
package lighter.javaeye.com;
@Description("javaeye,做最棒的軟件開發(fā)交流社區(qū)")
public class JavaEyer {
@Name(originate="創(chuàng)始人:robbin",community="javaEye")
public String getName()
{
return null;
}
@Name(originate="創(chuàng)始人:江南白衣",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("創(chuàng)建的社區(qū):"+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("創(chuàng)建的社區(qū):"+name.community());
}
}
}
運行結果：
描述:javaeye,做最棒的軟件開發(fā)交流社區(qū) 創(chuàng)始人:robbin 創(chuàng)建的社區(qū):javaEye 創(chuàng)始人:江南白衣 創(chuàng)建的社區(qū):springside
相關文章
springboot熱部署class XX cannot be cast&nbs
在使用DevTools進行熱加載時遇到的`classXXcannotbecasttoclassXX`錯誤,以及解決該問題的方法,通過在`resources`目錄下創(chuàng)建`META-INF/spring-devtools.properties`文件,并添加相應的配置,可以有效解決此問題,使DevTools熱加載功能得以正常工作2025-02-02
使用Spark?SQL實現(xiàn)讀取不帶表頭的txt文件
這篇文章主要為大家詳細介紹了如何使用Spark?SQL實現(xiàn)讀取不帶表頭的txt文件,文中的示例代碼講解詳細,感興趣的小伙伴可以跟隨小編一起學習一下2024-03-03
本篇文章是作為一個很適合新手閱讀的初級小項目，客戶管理，它主要實現(xiàn)數(shù)據庫的增刪查改操作，管理每位客戶的不同信息，如果你也是開始學Java不久，這篇文章將很適合你2021-11-11
這篇文章主要介紹了解決SpringBoot使用yaml作為配置文件遇到的坑，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-08-08
SpringBoot實現(xiàn)分布式驗證碼登錄方案小結
驗證碼登錄作為一種有效的防護手段,可以防止惡意gongji、暴力pojie等,本文主要介紹了SpringBoot實現(xiàn)分布式驗證碼登錄方案小結,具有一定的參考價值,感興趣的可以了解一下2024-12-12
這篇文章主要介紹了Java反射機制的相關內容，涉及了class類的動態(tài)加載，獲取成員變量、構造函數(shù)信息等信息，需要的朋友可以參考下，希望對你有所幫助2021-07-07
這篇文章主要為大家詳細介紹了Java如何通過時間獲取8位驗證碼（每兩個小時生成一個）,文中的示例代碼講解詳細,感興趣的小伙伴可以跟隨小編一起學習一下2023-11-11
解讀動態(tài)數(shù)據源dynamic-datasource-spring-boot-starter使用問題
這篇文章主要介紹了解讀動態(tài)數(shù)據源dynamic-datasource-spring-boot-starter使用問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-03-03
這篇文章主要介紹了Java隨機生成手機短信驗證碼的方法,涉及Java數(shù)學運算計算隨機數(shù)及字符串操作的相關技巧,具有一定參考借鑒價值,需要的朋友可以參考下2015-11-11
Spring Boot定時任務單線程多線程實現(xiàn)代碼解析
這篇文章主要介紹了Spring Boot定時任務單線程多線程實現(xiàn)代碼解析,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-08-08