資訊專欄INFORMATION COLUMN
摘要：知識(shí)點(diǎn)自定義注解的使用首先我們先介紹自定義注解。元注解的作用就是負(fù)責(zé)注解其他注解。元注解是一個(gè)標(biāo)記注解，闡述了某個(gè)被標(biāo)注的類型是被繼承的。在定義注解時(shí)，不能繼承其他的注解或接口。
知識(shí)點(diǎn)： Java自定義注解、spring aop @aspect的使用首先我們先介紹Java自定義注解。
在開發(fā)過程中，我們實(shí)現(xiàn)接口的時(shí)候，會(huì)出現(xiàn)@Override，有時(shí)還會(huì)提示寫@SuppressWarnings。其實(shí)這個(gè)就是Java特有的特性，注解。
注解就是某種注解類型的一種實(shí)例，我們可以把它用在某個(gè)類上進(jìn)行標(biāo)注。下面這張圖解釋注解都是什么？
上圖可以看出注解大體分為三種：元注解，標(biāo)記注解，一般注解；
這一塊其他的我就不多做介紹，我們這里主要說一下如何定義自己的注解，在這之前我們必須了解標(biāo)準(zhǔn)元注解和相關(guān)定義注解的語法。
元注解的作用就是負(fù)責(zé)注解其他注解。Java5.0定義了4個(gè)標(biāo)準(zhǔn)的meta-annotation類型，它們被用來提供對(duì)其它 annotation類型作說明。Java5.0定義的元注解：
@Target說明了Annotation所修飾的對(duì)象范圍：Annotation可被用于 packages、types（類、接口、枚舉、Annotation類型）、類型成員（方法、構(gòu)造方法、成員變量、枚舉值）、方法參數(shù)和本地變量（如循環(huán)變量、catch參數(shù)）。在Annotation類型的聲明中使用了target可更加明晰其修飾的目標(biāo)。
CONSTRUCTOR:用于描述構(gòu)造器
FIELD:用于描述符
LOCAL_VARIABLE:用于描述局部變量
METHOD:用于描述方法
PACKAGE:用于描述包
PARAMETER: 用于描述參數(shù)
TYPE: 用于描述類、接口（包括注解類型）或者enum聲明
@Retention定義了該Annotation被保留的時(shí)間長(zhǎng)短：某些Annotation僅出現(xiàn)在源代碼中，而被編譯器丟棄；而另一些卻被編譯在class文件中；編譯在class文件中的Annotation可能會(huì)被虛擬機(jī)忽略，而另一些在class被裝載時(shí)將被讀取（請(qǐng)注意并不影響class的執(zhí)行，因?yàn)锳nnotation與class在使用上是被分離的）。使用這個(gè)meta-Annotation可以對(duì) Annotation的“生命周期”限制。
SOURCE:在源文件中有效（即源文件保留）
CLASS:在class文件中有效（即class保留）
RUNTIME:在運(yùn)行時(shí)有效（即運(yùn)行時(shí)保留）
@Documented用于描述其它類型的annotation應(yīng)該被作為被標(biāo)注的程序成員的公共API，因此可以被例如javadoc此類的工具文檔化。Documented是一個(gè)標(biāo)記注解，沒有成員。
@Inherited 元注解是一個(gè)標(biāo)記注解，@Inherited闡述了某個(gè)被標(biāo)注的類型是被繼承的。如果一個(gè)使用了@Inherited修飾的annotation類型被用于一個(gè)class，則這個(gè)annotation將被用于該class的子類。自定義注解
注意：@Inherited annotation類型是被標(biāo)注過的class的子類所繼承。類并不從它所實(shí)現(xiàn)的接口繼承annotation，方法并不從它所重載的方法繼承annotation。
當(dāng)@Inherited annotation類型標(biāo)注的annotation的Retention是RetentionPolicy.RUNTIME，則反射API增強(qiáng)了這種繼承性。如果我們使用java.lang.reflect去查詢一個(gè)@Inherited annotation類型的annotation時(shí)，反射代碼檢查將展開工作：檢查class和其父類，直到發(fā)現(xiàn)指定的annotation類型被發(fā)現(xiàn)，或者到達(dá)類繼承結(jié)構(gòu)的頂層。
使用@interface自定義注解時(shí)，自動(dòng)繼承了java.lang.annotation.Annotation接口，由編譯程序自動(dòng)完成其他細(xì)節(jié)。在定義注解時(shí)，不能繼承其他的注解或接口。@interface用來聲明一個(gè)注解，其中的每一個(gè)方法實(shí)際上是聲明了一個(gè)配置參數(shù)。方法的名稱就是參數(shù)的名稱，返回值類型就是參數(shù)的類型（返回值類型只能是基本類型、Class、String、enum）。可以通過default來聲明參數(shù)的默認(rèn)值。
注解參數(shù)的可支持?jǐn)?shù)據(jù)類型:
1. 所有基本數(shù)據(jù)類型（int,float,boolean,byte,double,char,long,short)
2. String類型
3. Class類型
4. enum類型
5. Annotation類型
6. 以上所有類型的數(shù)組
Annotation類型里面的參數(shù)該怎么設(shè)定:
第一,只能用public或默認(rèn)(default)這兩個(gè)訪問權(quán)修飾.例如,String value();這里把方法設(shè)為defaul默認(rèn)類型；
第二,參數(shù)成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數(shù)據(jù)類型和 String,Enum,Class,annotations等數(shù)據(jù)類型,以及這一些類型的數(shù)組.例如,String value();這里的參數(shù)成員就為String;
第三,如果只有一個(gè)參數(shù)成員,最好把參數(shù)名稱設(shè)為"value",后加小括號(hào).例:下面的例子FruitName注解就只有一個(gè)參數(shù)成員。
使用示例：
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) {
// //獲取參數(shù)的類型
// 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;
//}
}
測(cè)試接口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文件中導(dǎo)入以下依賴：
aopalliance aopalliance 1.0 org.aspectj aspectjweaver 1.8.13 org.aspectj aspectjrt 1.8.13 cglib cglib 2.2.2
這一塊要注意：aspectjweaver包的版本和JDK版本有關(guān)聯(lián)。如果是JDK 1.7及以上的用戶，需要aspectjweaver包的版本不能過低（JDK1.7 —— aspectJ1.7.3+）。否則會(huì)報(bào)錯(cuò)：報(bào)錯(cuò)error at ::0 can"t find referenced pointcut。
接下來，在Spring配置文件里進(jìn)行以下配置
