java自定義註解    

1.幾個常用的註解解釋

              @Target說明了Annotation所修飾的物件範圍：Annotation可被用於 packages、types（類、介面、列舉、Annotation型別）、型別成員（方法、構造方法、成員變數、列舉值）、方法引數和本地變數（如迴圈變數、catch引數）。在Annotation型別的宣告中使用了target可更加明晰其修飾的目標。

         作用：用於描述註解的使用範圍（即：被描述的註解可以用在什麼地方）

  取值(ElementType)有：

　　　　1.CONSTRUCTOR:用於描述構造器
　　　　2.FIELD:用於描述域
　　　　3.LOCAL_VARIABLE:用於描述區域性變數
　　　　4.METHOD:用於描述方法
　　　　5.PACKAGE:用於描述包
　　　　6.PARAMETER:用於描述引數
　　　　7.TYPE:用於描述類、介面(包括註解型別) 或enum宣告

       @Retention定義了該Annotation被保留的時間長短：某些Annotation僅出現在原始碼中，而被編譯器丟棄；而另一些卻被編譯在class檔案中；編譯在class檔案中的Annotation可能會被虛擬機器忽略，而另一些在class被裝載時將被讀取（請注意並不影響class的執行，因為Annotation與class在使用上是被分離的）。使用這個meta-Annotation可以對 Annotation的“生命週期”限制。

　　作用：表示需要在什麼級別儲存該註釋資訊，用於描述註解的生命週期（即：被描述的註解在什麼範圍內有效）

　　取值（RetentionPoicy）有：

　　　　1.SOURCE:在原始檔中有效（即原始檔保留）
　　　　2.CLASS:在class檔案中有效（即class保留）
　　　　3.RUNTIME:在執行時有效（即執行時保留）

　　 @Documented用於描述其它型別的annotation應該被作為被標註的程式成員的公共API，因此可以被例如javadoc此類的工具文件化。Documented       是一個標記註解，沒有成員。

@Inherited 元註解是一個標記註解，@Inherited闡述了某個被標註的型別是被繼承的。如果一個使用了@Inherited修飾的annotation型別被用於一個class，則這個annotation將被用於該class的子類。

　　注意：@Inherited annotation型別是被標註過的class的子類所繼承。類並不從它所實現的介面繼承annotation，方法並不從它所過載的方法繼承annotation。

　　當@Inherited annotation型別標註的annotation的Retention是RetentionPolicy.RUNTIME，則反射API增強了這種繼承性。如果我們使用java.lang.reflect去查詢一個@Inherited annotation型別的annotation時，反射程式碼檢查將展開工作：檢查class和其父類，直到發現指定的annotation型別被發現，或者到達類繼承結構的頂層。

 2.宣告自定義註解方式

使用@interface自定義註解時，自動繼承了java.lang.annotation.Annotation介面，由編譯程式自動完成其他細節。在定義註解時，不能繼承其他的註解或介面。@interface用來宣告一個註解，其中的每一個方法實際上是聲明瞭一個配置引數。方法的名稱就是引數的名稱，返回值型別就是引數的型別（返回值型別只能是基本型別、Class、String、enum）。可以通過default來宣告引數的預設值。

　　定義註解格式：
　　public @interface 註解名 {定義體}

註解引數的可支援資料型別：

　　　　1.所有基本資料型別（int,float,boolean,byte,double,char,long,short)
　　　　2.String型別
　　　　3.Class型別
　　　　4.enum型別
　　　　5.Annotation型別
　　　　6.以上所有型別的陣列

　　Annotation型別裡面的引數該怎麼設定: 
　　第一,只能用public或預設(default)這兩個訪問權修飾.例如,String value();這裡把方法設為defaul預設型別；　 　
　　第二,引數成員只能用基本型別byte,short,char,int,long,float,double,boolean八種基本資料型別和 String,Enum,Class,annotations等資料型別,以        及這一些型別的陣列.例如,String value();這裡的引數成員就為String;　　

簡單demo驗證一下：

註解類：

package xhsoft.yxd.admin.controller;

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

/**
 * @author WangMeng
 * @date 2017年1月11日
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
public @interface PersonAnnotation
{
	String name();
	int age();
}

package xhsoft.yxd.admin.controller;

/**
 * @author WangMeng
 * @date 2017年1月11日
 */
@PersonAnnotation(name = "11", age = 22)
public class TestAnnotation
{

	public static void print(Class c)
	{
		System.out.println(c.getName());

		// java.lang.Class的getAnnotation方法，如果有註解，則返回註解。否則返回null
		PersonAnnotation person = (PersonAnnotation) c.getAnnotation(PersonAnnotation.class);

		if (person != null)
		{
			System.out.println("name:" + person.name() + " age:" + person.age());
		}
		else
		{
			System.out.println("person unknown!");
		}
	}
	public static void main(String[] args)
	{
		TestAnnotation.print(TestAnnotation.class);
	}

}

專案中用到了登入的驗證 邏輯是:加上我們自定義註解的方法，需要進行驗證，是否登入過，登入過的通過，沒登入過的跳轉到登入頁面

註解類：

package xhsoft.web.tools.logined;

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;

/**
 * 
 * @author Corpse-work
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Logined
{
	/**
	 * 其它附加資訊
	 * @return
	 * @author Corpse-work 
	 * @Date 2016年10月21日
	 */
	String[] others() default {};
}

package xhsoft.web.tools.logined;

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

/**
 * 用於登入校驗
 * 
 * @author Corpse-work
 */
@Aspect// 這個註解表明 使用spring 的aop，需要開啟aop <!--開啟AOP自動代理 --><aop:aspectj-autoproxy />
@Component
public class LoginedAspect
{
	@Autowired
	private AbsLoginHelper loginHelper;

	@Around(value = "@annotation(logined)")// 標示遇到logined這個註解的方法進行攔截 @Around 等註解可檢視 spring aop相關知識
	public Object checkLogin(ProceedingJoinPoint join, Logined logined) throws Throwable
	{

		// 獲取到使用了註解的方法的引數 這裡面根據測試類 是 request,response
		Object[] args = join.getArgs();
                //獲取使用了註解的方法的 註解的引數  這裡面根據測試類 是 username,password
                String[] orherString=logined.others();
		// 執行使用註解方法並返回資訊   
		Object ret = join.proceed();
		// 下面是驗證登入身份的邏輯程式碼 省略。。。。。。。
		return null;
	}

}

package xhsoft.yxd.admin.controller;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

import xhsoft.web.tools.logined.Logined;

/**
 * @author WangMeng
 * @date 2017年1月13日
 */
@Controller
@RequestMapping("/admin")
public class Test
{

	@RequestMapping("/logintest")
	@Logined(others="username,password")
	public void loginTest(HttpServletRequest request, HttpServletResponse response)
	{
		System.out.println("logintest......");
	}
}