Java中注解與原理分析詳解
一、注解基礎(chǔ)
注解即標(biāo)注與解析,在Java的代碼工程中,注解的使用幾乎是無(wú)處不在,甚至多到被忽視;
無(wú)論是在JDK源碼或者框架組件,都在使用注解能力完成各種識(shí)別和解析動(dòng)作;在對(duì)系統(tǒng)功能封裝時(shí),也會(huì)依賴(lài)注解能力簡(jiǎn)化各種邏輯的重復(fù)實(shí)現(xiàn);
基礎(chǔ)接口
在A(yíng)nnotation的源碼注釋中有說(shuō)明:所有的注解類(lèi)型都需要繼承該公共接口,本質(zhì)上看注解是接口,但是代碼并沒(méi)有顯式聲明繼承關(guān)系,可以直接查看字節(jié)碼文件;
//1、聲明注解 public @interface SystemLog {} //2、查看指令 javap -v SystemLog.class //3、打印結(jié)果 Compiled from "SystemLog.java" public interface com.base.test.SystemLog extends java.lang.annotation.Annotation
元注解
聲明注解時(shí)使用,用來(lái)定義注解的作用目標(biāo),保留策略等;
@Documented @Inherited @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface SystemLog { String model () default "" ; }
- Documented:是否被javadoc或類(lèi)似工具記錄在文檔中;
- Inherited:標(biāo)識(shí)注解是否可以被子類(lèi)繼承;
- Target:作用目標(biāo),在ElementType枚舉中可以看到取值包括類(lèi)、方法、屬性等;
- Retention:保留策略,比如編譯階段是否丟棄,運(yùn)行時(shí)保留;
此處聲明一個(gè)SystemLog注解,作用范圍是在方法上,并且在運(yùn)行時(shí)保留,該注解通常用在服務(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í)獲取類(lèi)的完整結(jié)構(gòu)信息,代理模式給目標(biāo)對(duì)象提供一個(gè)代理對(duì)象,由代理對(duì)象持有目標(biāo)對(duì)象的引用;
案例中通過(guò)反射機(jī)制,在程序運(yùn)行時(shí)進(jìn)行注解的獲取和解析,值得關(guān)注的是systemLog對(duì)象的類(lèi)名,輸出的是代理類(lèi)信息;
案例執(zhí)行完畢后,會(huì)在代碼工程的目錄下生成代理類(lèi),可以查看$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í)際上是在使用注解的代理類(lèi),$Proxy2
繼承了Proxy類(lèi)并實(shí)現(xiàn)了SystemLog接口,并且重寫(xiě)了相關(guān)方法;有關(guān)反射和代理的邏輯,在之前的內(nèi)容中有詳說(shuō),此處不贅述;
值得一看是代理類(lèi)中invoke方法調(diào)用,具體的處理邏輯在A(yíng)nnotationInvocationHandler類(lèi)的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)用注解處理器,如果處理器生成任何新的源文件或類(lèi)文件,編譯會(huì)重新啟動(dòng);
第三步:分析器創(chuàng)建的語(yǔ)法樹(shù)被分析并轉(zhuǎn)換為類(lèi)文件;
更多細(xì)節(jié)說(shuō)明可以參考o(jì)penjdk文檔中Compiler模塊的內(nèi)容,下面再回到Lombok組件上;
Lombok組件在代碼工程中的使用非常頻繁,通過(guò)注解的方式極大的簡(jiǎn)化Java中Bean對(duì)象的編寫(xiě),提高了效率并且讓源碼顯得簡(jiǎn)潔;
這里用一段簡(jiǎn)單的代碼演示其效果,在IdKey的類(lèi)中通過(guò)三個(gè)常用的Lombok注解,替代了類(lèi)中很多基礎(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作為超類(lèi),編譯器在編譯時(shí)會(huì)去檢查該類(lèi)的子類(lèi),子類(lèi)中最核心的是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、注解處理抽象類(lèi) 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類(lèi)從簡(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、類(lèi)型引擎
在數(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è)類(lèi)型解析的注解,可以標(biāo)記在實(shí)體對(duì)象的字段屬性上,然后根據(jù)各種數(shù)據(jù)源的類(lèi)型枚舉,去適配不同解析工廠(chǎng)的執(zhí)行邏輯,比如常用數(shù)據(jù)類(lèi)型、格式、或者完全自定義。
到此這篇關(guān)于Java中注解與原理分析詳解的文章就介紹到這了,更多相關(guān)Java注解內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Java使用Scanner類(lèi)進(jìn)行控制臺(tái)輸入實(shí)現(xiàn)方法
這篇文章主要介紹了Java使用Scanner類(lèi)進(jìn)行控制臺(tái)輸入實(shí)現(xiàn)方法,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2019-12-12Spring Security無(wú)法調(diào)用接口錯(cuò)誤的問(wèn)題解決
記錄一下之前在寫(xiě)程序的時(shí)候遇到的問(wèn)題,Spring Security無(wú)法調(diào)用接口錯(cuò)誤的問(wèn)題,本文就來(lái)介紹一下解決方法,感興趣的可以了解一下2023-08-08Java事務(wù)管理學(xué)習(xí)之Spring和Hibernate詳解
這篇文章主要給大家介紹了Java事務(wù)管理學(xué)習(xí)之Spring和Hibernate的相關(guān)資料,文中通過(guò)示例代碼介紹的非常詳細(xì),需要的朋友們可以參考借鑒,下面來(lái)一起看看吧。2017-03-03劍指Offer之Java算法習(xí)題精講字符串操作與數(shù)組及二叉搜索樹(shù)
跟著思路走,之后從簡(jiǎn)單題入手,反復(fù)去看,做過(guò)之后可能會(huì)忘記,之后再做一次,記不住就反復(fù)做,反復(fù)尋求思路和規(guī)律,慢慢積累就會(huì)發(fā)現(xiàn)質(zhì)的變化2022-03-03SpringBoot?Security從入門(mén)到實(shí)戰(zhàn)示例教程
Spring?Security是一個(gè)功能強(qiáng)大且高度可定制的身份驗(yàn)證和訪(fǎng)問(wèn)控制框架,接下來(lái)通過(guò)本文給大家介紹SpringBoot?Security從入門(mén)到實(shí)戰(zhàn)示例教程,感興趣的朋友一起看看吧2022-05-05Java實(shí)現(xiàn)File轉(zhuǎn)換MultipartFile格式的例子
本文主要介紹了Java實(shí)現(xiàn)File轉(zhuǎn)換MultipartFile格式的例子,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-07-07spring4新特性之web開(kāi)發(fā)增強(qiáng)
這篇文章主要介紹了spring4新特性之web開(kāi)發(fā)增強(qiáng)的相關(guān)資料,需要的朋友可以參考下2017-09-09jenkins中如何集成commander應(yīng)用的完整步驟
jenkins是一個(gè)用java編寫(xiě)的開(kāi)源的持續(xù)集成工具,在與oracle發(fā)生爭(zhēng)執(zhí)后,項(xiàng)目從hudson項(xiàng)目獨(dú)立出來(lái),下面這篇文章主要給大家介紹了關(guān)于jenkins中如何集成commander應(yīng)用的相關(guān)資料,文中通過(guò)示例代碼介紹的非常詳細(xì),需要的朋友可以參考下2018-05-05java?web項(xiàng)目Session獲取不到問(wèn)題及解決
這篇文章主要介紹了java?web項(xiàng)目Session獲取不到問(wèn)題及解決方案,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-01-01