服務(wù)運(yùn)行時(shí)，結(jié)合AOP切面編程實(shí)現(xiàn)方法的日志采集；
二、注解原理
先來(lái)看一個(gè)簡(jiǎn)單的注解使用案例，再細(xì)致地分析其中原理，案例并不復(fù)雜，就是常見(jiàn)的標(biāo)注與解析兩個(gè)關(guān)鍵動(dòng)作；
public class LogInfo {
@SystemLog(model = "日志模塊")
public static void main(String[] args) {
// 生成代理文件
System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");
// 反射機(jī)制
Method[] methods = LogInfo.class.getMethods();
for (Method method:methods){
SystemLog systemLog = method.getAnnotation(SystemLog.class) ;
if (systemLog != null){
// 動(dòng)態(tài)代理：com.sun.proxy.$Proxy2
System.out.println(systemLog.getClass().getName());
System.out.println(systemLog.model());
}
}
}
}這里涉及到兩個(gè)核心概念：反射機(jī)制、動(dòng)態(tài)代理；反射機(jī)制可以在程序運(yùn)行時(shí)獲取類的完整結(jié)構(gòu)信息，代理模式給目標(biāo)對(duì)象提供一個(gè)代理對(duì)象，由代理對(duì)象持有目標(biāo)對(duì)象的引用；
案例中通過(guò)反射機(jī)制，在程序運(yùn)行時(shí)進(jìn)行注解的獲取和解析，值得關(guān)注的是systemLog對(duì)象的類名，輸出的是代理類信息；
案例執(zhí)行完畢后，會(huì)在代碼工程的目錄下生成代理類，可以查看$Proxy2文件；
public final class $Proxy2 extends Proxy implements SystemLog {
public final String model() throws {
try {
return (String)super.h.invoke(this, m3, (Object[])null);
} catch (RuntimeException | Error var2) {
throw var2;
} catch (Throwable var3) {
throw new UndeclaredThrowableException(var3);
}
}
}在對(duì)SystemLog解析的過(guò)程中，實(shí)際上是在使用注解的代理類，$Proxy2繼承了Proxy類并實(shí)現(xiàn)了SystemLog接口，并且重寫(xiě)了相關(guān)方法；有關(guān)反射和代理的邏輯，在之前的內(nèi)容中有詳說(shuō)，此處不贅述；
值得一看是代理類中invoke方法調(diào)用，具體的處理邏輯在AnnotationInvocationHandler類的invoke方法中，會(huì)對(duì)注解原生方法和自定義方法做判斷，并對(duì)原生方法提供實(shí)現(xiàn)；
三、常用注解
1、JDK注解
在JDK中有多個(gè)注解是經(jīng)常使用的，例如Override、Deprecated、SuppressWarnings等；
- Override：判斷方法是否為重寫(xiě)方法；
- Deprecated：標(biāo)記過(guò)時(shí)的API，繼續(xù)使用會(huì)警告；
- FunctionalInterface：檢驗(yàn)是否為函數(shù)式接口；
- SuppressWarnings：代碼的警告會(huì)靜默處理；
這里注意FunctionalInterface注解，從1.8開(kāi)始引入，檢驗(yàn)是否為函數(shù)式接口，即接口只能有一個(gè)抽象方法，否則編譯報(bào)錯(cuò)；
2、Lombok注解
在具體的看Lombok組件之前，需要先了解一個(gè)概念：代碼編譯；在open-jdk的描述文檔中大致分為三個(gè)核心階段；
第一步：讀取命令行上指定的所有源文件，解析為語(yǔ)法樹(shù)，進(jìn)行符號(hào)表填充；
第二步：調(diào)用注解處理器，如果處理器生成任何新的源文件或類文件，編譯會(huì)重新啟動(dòng)；
第三步：分析器創(chuàng)建的語(yǔ)法樹(shù)被分析并轉(zhuǎn)換為類文件；
更多細(xì)節(jié)說(shuō)明可以參考o(jì)penjdk文檔中Compiler模塊的內(nèi)容，下面再回到Lombok組件上；
Lombok組件在代碼工程中的使用非常頻繁，通過(guò)注解的方式極大的簡(jiǎn)化Java中Bean對(duì)象的編寫(xiě)，提高了效率并且讓源碼顯得簡(jiǎn)潔；
這里用一段簡(jiǎn)單的代碼演示其效果，在IdKey的類中通過(guò)三個(gè)常用的Lombok注解，替代了類中很多基礎(chǔ)方法的顯式生成，查看編譯后的文件實(shí)際是存在相關(guān)方法的；
@Data
@AllArgsConstructor
@NoArgsConstructor
public class IdKey {
private Integer id ;
private String key ;
public static void main(String[] args) {
IdKey idKey01 = new IdKey(1,"cicada") ;
System.out.println(idKey01);
idKey01.setId(2);
idKey01.setKey("smile");
System.out.println(idKey01);
}
}
這里需要了解JDK中注解處理器的相關(guān)源碼，AbstractProcessor作為超類，編譯器在編譯時(shí)會(huì)去檢查該類的子類，子類中最核心的是process方法；
-- 1、Lombok處理器
@SupportedAnnotationTypes("*")
public class LombokProcessor extends AbstractProcessor {
private JavacTransformer transformer;
@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
transformer.transform(prio, javacProcessingEnv.getContext(), cusForThisRound, cleanup);
}
}
-- 2、AST抽象樹(shù)
public class JavacTransformer {
public void transform(long priority, Context context, List<JCTree.JCCompilationUnit> compilationUnits,
CleanupRegistry cleanup) {
JavacAST ast = new JavacAST(messager, context, unit, cleanup);
ast.traverse(new AnnotationVisitor(priority));
handlers.callASTVisitors(ast, priority);
}
}
-- 3、注解處理抽象類
public abstract class JavacAnnotationHandler<T extends Annotation> {
public abstract void handle(AnnotationValues<T> annotation, JCAnnotation ast, JavacNode annotationNode);
}
-- 4、Getter注解處理
public class HandleGetter extends JavacAnnotationHandler<Getter> {
@Override
public void handle(AnnotationValues<Getter> annotation, JCTree.JCAnnotation ast, JavacNode annotationNode) {
JavacNode node = annotationNode.up();
List<JCTree.JCAnnotation> onMethod = unboxAndRemoveAnnotationParameter(ast, "onMethod", "@Getter(onMethod", annotationNode);
switch (node.getKind()) {
case FIELD:
createGetterForFields(level, fields, annotationNode, true, lazy, onMethod);
break;
}
}
}
IdKey類從簡(jiǎn)潔的源碼編譯為復(fù)雜的字節(jié)碼文件，通過(guò)注解對(duì)結(jié)構(gòu)處理時(shí)關(guān)聯(lián)一個(gè)核心概念，叫AST抽象樹(shù)，會(huì)涉及到很多語(yǔ)法、詞法的解析邏輯；
四、自定義注解
在系統(tǒng)開(kāi)發(fā)中通過(guò)自定義注解可以處理各種麻煩的重復(fù)邏輯，其最明顯的好處就是可以大量地消除冗余的代碼塊；
1、同步控制
代碼中可能存在很多方法是限制重復(fù)請(qǐng)求的，加鎖處理是很常用的手段，此時(shí)完全可以通過(guò)注解結(jié)合AOP切面編程簡(jiǎn)化代碼的復(fù)雜程度；
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface SyncLock {
String lockKey(); // 鎖的Key
int time () default 3000 ; // 有效時(shí)間
int retryNum () default 3 ; // 重試次數(shù)
}
通過(guò)注解標(biāo)記在方法上，可以極大簡(jiǎn)化同步鎖的編碼步驟，只是在讀取KEY的時(shí)候需要設(shè)計(jì)好解析規(guī)則，結(jié)合反射原理進(jìn)行獲取即可；
基于相同的原理，也適應(yīng)與日志采集、系統(tǒng)告警等功能，在之前的內(nèi)容中都有詳細(xì)的總結(jié)；
2、類型引擎
在數(shù)據(jù)處理的邏輯中，經(jīng)常有這樣一種場(chǎng)景，同一份數(shù)據(jù)要?jiǎng)討B(tài)推送到多種數(shù)據(jù)源中存儲(chǔ)，比如常見(jiàn)的MySQL表和ES索引雙寫(xiě)模式，這就需要對(duì)實(shí)體對(duì)象做不同的解析邏輯；
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface BizType {
EsIndexEnum esIndexEnum () ; // ES索引解析適配
MySqlTableEnum mySqlTableEnum () ; // MySQL表解析適配
ExcelEnum excelEnum () ; // Excel解析適配
}
首先聲明一個(gè)類型解析的注解，可以標(biāo)記在實(shí)體對(duì)象的字段屬性上，然后根據(jù)各種數(shù)據(jù)源的類型枚舉，去適配不同解析工廠的執(zhí)行邏輯，比如常用數(shù)據(jù)類型、格式、或者完全自定義。
