目錄
- 一、注解基礎
- 二、注解原理
- 三、常用注解
- 1、JDK注解
- 2、Lombok注解
- 四、自定義注解
- 1、同步控制
- 2、型別引擎
- 五、參考原始碼
使用的太多，被忽略的理所當然；
一、注解基礎
注解即標注與決議，在Java的代碼工程中，注解的使用幾乎是無處不在，甚至多到被忽視；
無論是在JDK原始碼或者框架組件，都在使用注解能力完成各種識別和決議動作；在對系統功能封裝時，也會依賴注解能力簡化各種邏輯的重復實作；
基礎介面
在Annotation的原始碼注釋中有說明：所有的注解型別都需要繼承該公共介面，本質上看注解是介面，但是代碼并沒有顯式宣告繼承關系，可以直接查看位元組碼檔案；
-- 1、宣告注解
public @interface SystemLog {}
-- 2、查看指令
javap -v SystemLog.class
-- 3、列印結果
Compiled from "SystemLog.java"
public interface com.base.test.SystemLog extends java.lang.annotation.Annotation
元注解
宣告注解時使用，用來定義注解的作用目標，保留策略等；
@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface SystemLog { String model () default "" ; }
- Documented：是否被javadoc或類似工具記錄在檔案中；
- Inherited：標識注解是否可以被子類繼承；
- Target：作用目標，在ElementType列舉中可以看到取值包括類、方法、屬性等；
- Retention：保留策略，比如編譯階段是否丟棄，運行時保留；
此處宣告一個SystemLog注解，作用范圍是在方法上，并且在運行時保留，該注解通常用在服務運行時，結合AOP切面編程實作方法的日志采集；
二、注解原理
先來看一個簡單的注解使用案例，再細致的分析其中原理，案例并不復雜，就是常見的標注與決議兩個關鍵動作；
public class LogInfo {
@SystemLog(model = "日志模塊")
public static void main(String[] args) {
// 生成代理檔案
System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");
// 反射機制
Method[] methods = LogInfo.class.getMethods();
for (Method method:methods){
SystemLog systemLog = method.getAnnotation(SystemLog.class) ;
if (systemLog != null){
// 動態代理：com.sun.proxy.$Proxy2
System.out.println(systemLog.getClass().getName());
System.out.println(systemLog.model());
}
}
}
}
這里涉及到兩個核心概念：反射機制、動態代理；反射機制可以在程式運行時獲取類的完整結構資訊，代理模式給目標物件提供一個代理物件，由代理物件持有目標物件的參考；
案例中通過反射機制，在程式運行時進行注解的獲取和決議，值得關注的是systemLog物件的類名，輸出的是代理類資訊；
案例執行完畢后，會在代碼工程的目錄下生成代理類，可以查看$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);
}
}
}
在對SystemLog決議的程序中，實際上是在使用注解的代理類，$Proxy2繼承了Proxy類并實作了SystemLog介面，并且重寫了相關方法；有關反射和代理的邏輯，在之前的內容中有詳說，此處不贅述；
值得一看是代理類中invoke方法呼叫，具體的處理邏輯在AnnotationInvocationHandler類的invoke方法中，會對注解原生方法和自定義方法做判斷，并對原生方法提供實作；
三、常用注解
1、JDK注解
在JDK中有多個注解是經常使用的，例如Override、Deprecated、SuppressWarnings等；
- Override：判斷方法是否為重寫方法；
- Deprecated：標記過時的API，繼續使用會警告；
- FunctionalInterface：檢驗是否為函式式介面；
- SuppressWarnings：代碼的警告會靜默處理；
這里注意FunctionalInterface注解，從1.8開始引入，檢驗是否為函式式介面，即介面只能有一個抽象方法，否則編譯報錯；
2、Lombok注解
在具體的看Lombok組件之前，需要先了解一個概念：代碼編譯；在open-jdk的描述檔案中大致分為三個核心階段；
第一步：讀取命令列上指定的所有源檔案，決議為語法樹，進行符號表填充；
第二步：呼叫注解處理器，如果處理器生成任何新的源檔案或類檔案，編譯會重新啟動；
第三步：分析器創建的語法樹被分析并轉換為類檔案；
更多細節說明可以參考openjdk檔案中Compiler模塊的內容，下面再回到Lombok組件上；
Lombok組件在代碼工程中的使用非常頻繁，通過注解的方式極大的簡化Java中Bean物件的撰寫，提高了效率并且讓原始碼顯得簡潔；
這里用一段簡單的代碼演示其效果，在IdKey的類中通過三個常用的Lombok注解，替代了類中很多基礎方法的顯式生成，查看編譯后的檔案實際是存在相關方法的；
@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中注解處理器的相關原始碼，AbstractProcessor作為超類，編譯器在編譯時會去檢查該類的子類，子類中最核心的是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抽象樹
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類從簡潔的原始碼編譯為復雜的位元組碼檔案，通過注解對結構處理時關聯一個核心概念，叫AST抽象樹，會涉及到很多語法、詞法的決議邏輯；
四、自定義注解
在系統開發中通過自定義注解可以處理各種麻煩的重復邏輯，其最明顯的好處就是可以大量的消除冗余的代碼塊；
1、同步控制
代碼中可能存在很多方法是限制重復請求的，加鎖處理是很常用的手段，此時完全可以通過注解結合AOP切面編程簡化代碼的復雜程度；
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface SyncLock {
String lockKey(); // 鎖的Key
int time () default 3000 ; // 有效時間
int retryNum () default 3 ; // 重試次數
}
通過注解標記在方法上，可以極大簡化同步鎖的編碼步驟，只是在讀取KEY的時候需要設計好決議規則，結合反射原理進行獲取即可；
基于相同的原理，也適應與日志采集、系統告警等功能，在之前的內容中都有詳細的總結；
2、型別引擎
在資料處理的邏輯中，經常有這樣一種場景，同一份資料要動態推送到多種資料源中存盤，比如常見的MySQL表和ES索引雙寫模式，這就需要對物體物件做不同的決議邏輯；
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface BizType {
EsIndexEnum esIndexEnum () ; // ES索引決議適配
MySqlTableEnum mySqlTableEnum () ; // MySQL表決議適配
ExcelEnum excelEnum () ; // Excel決議適配
}
首先宣告一個型別決議的注解，可以標記在物體物件的欄位屬性上，然后根據各種資料源的型別列舉，去適配不同決議工廠的執行邏輯，比如常用資料型別、格式、或者完全自定義，
五、參考原始碼
編程檔案：
https://gitee.com/cicadasmile/butte-java-note
應用倉庫：
https://gitee.com/cicadasmile/butte-flyer-parent
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/534066.html
標籤：Java
上一篇：Java反應式編程（2）