spring 自定義註解（annotation）與 aop獲取註解

知識點： Java自定義註解、spring aop @aspect的使用

---

首先咱們先介紹Java自定義註解。

在開發過程當中，咱們實現接口的時候，會出現@Override，有時還會提示寫@SuppressWarnings。其實這個就是Java特有的特性，註解。

註解就是某種註解類型的一種實例，咱們能夠把它用在某個類上進行標註。下面這張圖解釋註解都是什麼？

上圖能夠看出註解大致分爲三種：元註解，標記註解，通常註解；

這一塊其餘的我就很少作介紹，咱們這裏主要說一下如何定義本身的註解，在這以前咱們必須瞭解標準元註解和相關定義註解的語法。
元註解的做用就是負責註解其餘註解。Java5.0定義了4個標準的meta-annotation類型，它們被用來提供對其它 annotation類型做說明。Java5.0定義的元註解：

1.@Target,

2.@Retention,

3.@Documented,

4.@Inherited

---

@Target

@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

@Retention定義了該Annotation被保留的時間長短：某些Annotation僅出如今源代碼中，而被編譯器丟棄；而另外一些卻被編譯在class文件中；編譯在class文件中的Annotation可能會被虛擬機忽略，而另外一些在class被裝載時將被讀取（請注意並不影響class的執行，由於Annotation與class在使用上是被分離的）。使用這個meta-Annotation能夠對 Annotation的「生命週期」限制。

做用：表示須要在什麼級別保存該註釋信息，用於描述註解的生命週期（即：被描述的註解在什麼範圍內有效）

取值（RetentionPoicy）有：

1. SOURCE:在源文件中有效（即源文件保留）
2. CLASS:在class文件中有效（即class保留）
3. RUNTIME:在運行時有效（即運行時保留）

 @Documented

@Documented用於描述其它類型的annotation應該被做爲被標註的程序成員的公共API，所以能夠被例如javadoc此類的工具文檔化。Documented是一個標記註解，沒有成員。

 @Inherited

@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類型被發現，或者到達類繼承結構的頂層。

---

自定義註解

使用@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;
　　第三,若是隻有一個參數成員,最好把參數名稱設爲"value",後加小括號.例:下面的例子FruitName註解就只有一個參數成員。

---

使用示例：

CacheRedis.java

import java.lang.annotation.*;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface CacheRedis {
    String key();

    int expireTime() default 600;
}

CacheService.java

import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class CacheService {

    Logger logger = LoggerFactory.getLogger(CacheService.class);

    @Pointcut(value = "@annotation(com.meizu.bro.service.test.CacheRedis)")
    public void pointCut(){}

    @Before(value = "pointCut() && @annotation(cacheRedis)")
    public void before(CacheRedis cacheRedis) {
        logger.info("the result of this method will be cached.");
    }

    @AfterReturning(value = "pointCut() && @annotation(cacheRedis)",returning = "result")
    public void after(CacheRedis cacheRedis,Object result) {
        String key = cacheRedis.key();
        int expireTime = cacheRedis.expireTime();
        //do something...
        logger.info("-----redis-----[key = " + key + "]"+"[expireTime = " + expireTime + "]");
        logger.info("the result of this method is" + result + ",and has been cached.");
    }

    //@Around("pointCut() && @annotation(cacheRedis)")
    //public Object setCache(ProceedingJoinPoint joinPoint,CacheRedis cacheRedis) {
    //    Object result = 1;
    //
    //    Method method = getMethod(joinPoint);//自定義註解類
    //    //CacheRedis cacheRedis = method.getAnnotation(CacheRedis.class);//獲取key值
    //    String key = cacheRedis.key();
    //    int expireTime = cacheRedis.expireTime();
    //    //獲取方法的返回類型,讓緩存能夠返回正確的類型
    //    Class returnType =((MethodSignature)joinPoint.getSignature()).getReturnType();
    //
    //    logger.info("[key = " + key + "]"+"[expireTime = " + expireTime + "]");
    //
    //    return result;
    //}
    //
    //private Method getMethod(ProceedingJoinPoint joinPoint) {
    //    //獲取參數的類型
    //    Method method = null;
    //    try {
    //        Signature signature = joinPoint.getSignature();
    //        MethodSignature msig = null;
    //        if (!(signature instanceof MethodSignature)) {
    //            throw new IllegalArgumentException("該註解只能用於方法");
    //        }
    //        msig = (MethodSignature) signature;
    //        method = joinPoint.getTarget().getClass().getMethod(msig.getName(), msig.getParameterTypes());
    //    } catch (NoSuchMethodException e) {
    //        logger.error("annotation no sucheMehtod", e);
    //    } catch (SecurityException e) {
    //        logger.error("annotation SecurityException", e);
    //    }
    //    return method;
    //}
}

測試接口TestController.java

@Controller
public class TestController {
    
    @Autowired
    private TestService testService;

    @RequestMapping(value = "/test")
    public ModelAndView myTest() {
        int test = testService.test(10);
        return ViewUtil.buildStandardJsonViewByObj(test);
    }

    @RequestMapping(value = "/test1")
    public ModelAndView myTest1() {
        String yanyi = testService.test1("yanyi");
        return ViewUtil.buildStandardJsonViewByObj(yanyi);
    }
}

TestService.java

public interface TestYanyiService {
    int test(int i);

    String test1(String i1);
}

TestServiceImpl.java

import org.springframework.stereotype.Service;

@Service
public class TestYanyiServiceImpl implements TestYanyiService {
    @Override
    @CacheRedis(key = "test",expireTime = 10)
    public int test(int i) {
        return 0;
    }

    @Override
    @CacheRedis(key = "test1")
    public String test1(String i1) {
        return i1;
    }
}

代碼完成後，須要在pom文件中導入如下依賴：

<dependency>
                <groupId>aopalliance</groupId>
                <artifactId>aopalliance</artifactId>
                <version>1.0</version>
            </dependency>
            <dependency>
                <groupId>org.aspectj</groupId>
                <artifactId>aspectjweaver</artifactId>
                <version>1.8.13</version>
            </dependency>
            <dependency>
                <groupId>org.aspectj</groupId>
                <artifactId>aspectjrt</artifactId>
                <version>1.8.13</version>
            </dependency>       
            <dependency>
                <groupId>cglib</groupId>
                <artifactId>cglib</artifactId>
                <version>2.2.2</version>
            </dependency>

這一塊要注意：aspectjweaver包的版本和JDK版本有關聯。若是是JDK 1.7及以上的用戶，須要aspectjweaver包的版本不能太低（JDK1.7 —— aspectJ1.7.3+）。不然會報錯：報錯error at ::0 can't find referenced pointcut。

接下來，在Spring配置文件裏進行如下配置

<!-- 啓動對@AspectJ註解的支持 -->  
<aop:aspectj-autoproxy/> 

<!--通知spring使用cglib而不是jdk的來生成代理方法 AOP能夠攔截到Controller->  
<aop:aspectj-autoproxy proxy-target-class="true" />

ok! 完成後，調用測試接口，能夠看到在控制窗口打印切面類前置和後置的相關log。這時候，咱們就能夠在裏邊實現本身的功能咯。（我這裏準備實現redis緩存功能。）