公司項目終于用上了插入式注解，真香！-魔扣目錄

了解過lombok底層原理的都知道其使用的就是的插入式注解，那么今天筆者就以真實場景演示一下插入式注解的使用。

需求

我們為公司提供了一套通用的JAVA基礎組件包，組件包內有不同的模塊，比如熔斷模塊、負載均模塊、rpc模塊等等，這些模塊均會被打成jar包，然后發布到公司的內部代碼倉庫中，供其他人引入使用。

這份代碼會不斷的迭代，我們希望可以通過promethus來監控現在公司內使用各版本代碼庫的比例，希望達到的效果圖如下：

我們希望看到每一個版本的使用率，這有利于我們做版本兼容，必要的時候可以對古早版本使用者溯源。

問題

需求似乎很簡單，但真要獲取自身的jar版本號還是挺麻煩的，有個比較簡單但陰間的辦法，就是給每一個組件都加上當前的jar版本號，寫到配置文件里或者直接設置成常量，這樣上報promethus時就可以直接獲取到jar包版本號了，這個方法雖然可以解決問題，但每次迭代版本都要跟著改一遍所有組件包的版本號數據，過于麻煩。

有沒有更好的解決辦法呢？比如我們可不可以在gradle打包構建時拿到jar包的版本號，然后注入到每個組件中去呢？就像lombok那樣，不需要寫get、set方法，只需要加個注解標記就可以自動注入get、set方法。

比如我們可以給每個組件定義一個空常量，加上自定義的注解：

@TrisceliVersion public static final String version = "";

然后像lombok生成set/get方法那樣注入真正的版本號：

@TrisceliVersion public static final String version = "1.0.31-SNAPSHOT";

參考lombok的實現，這其實是可以做到的，下面來看解決方案。

解決

java中解析一個注解的方式主要有兩種：編譯期掃描、運行期反射，這是lombok @Setter的實現：

@Target({ElementType.FIELD, ElementType.TYPE}) @Retention(RetentionPolicy.SOURCE) public @interface Setter { // 略... }

可以看到@Setter的Retention是SOURCE類型的，也就是說這個注解只在編譯期有效，它甚至不會被編入class文件，所以lombok無疑是第一種解析方式，那用什么方式可以在編譯期就讓注解被解析到并執行我們的解析代碼呢？答案就是定義插入式注解處理器（通過JSR-269提案定義的Pluggable Annotation Processing API實現）

插入式注解處理器的觸發點如下圖所示：

也就是說插入式注解處理器可以幫助我們在編譯期修改抽象語法樹（AST）！所以現在我們只需要自定義一個這樣的處理器，然后其內部拿到jar版本信息（因為是編譯期，可以找到源碼的path，源碼里隨便搞個文件存放版本號，然后用java io讀取進來即可），再將注解對應語法樹上的常量值設置成jar包版本號，語法樹變了，最終生成的字節碼也會跟著變，這樣就實現了我們想在編譯期給常量version注入值的愿望。

自定義一個插入式注解處理器也很簡單，首先要將自己的注解定義出來：

@Documented @Retention(RetentionPolicy.SOURCE) //只在編譯期有效，最終不會打進class文件中 @Target({ElementType.FIELD}) //僅允許作用于類屬性之上 public @interface TrisceliVersion { }

然后定義一個繼承了AbstractProcessor的處理器：

/** * {@link AbstractProcessor} 就屬于 Pluggable Annotation Processing API */ public class TrisceliVersionProcessor extends AbstractProcessor { private JavacTrees javacTrees; private TreeMaker treeMaker; private ProcessingEnvironment processingEnv; /** * 初始化處理器 * * @param processingEnv 提供了一系列的實用工具 */ @SneakyThrows @Override public synchronized void init(ProcessingEnvironment processingEnv) { super.init(processingEnv); this.processingEnv = processingEnv; this.javacTrees = JavacTrees.instance(processingEnv); Context context = ((JavacProcessingEnvironment) processingEnv).getContext(); this.treeMaker = TreeMaker.instance(context); } @Override public SourceVersion getSupportedSourceVersion() { return SourceVersion.latest(); } @Override public Set getSupportedAnnotationTypes() { HashSet set = new HashSet<>(); set.add(TrisceliVersion.class.getName()); // 支持解析的注解 return set; } @Override public boolean process(Set annotations, RoundEnvironment roundEnv) { for (TypeElement t : annotations) { for (Element e : roundEnv.getElementsAnnotatedWith(t)) { // 獲取到給定注解的element（element可以是一個類、方法、包等） // JCVariableDecl為字段/變量定義語法樹節點 JCTree.JCVariableDecl jcv = (JCTree.JCVariableDecl) javacTrees.getTree(e); String varType = jcv.vartype.type.toString(); if (!"java.lang.String".equals(varType)) { // 限定變量類型必須是String類型，否則拋異常 printErrorMessage(e, "Type '" + varType + "'" + " is not support."); } jcv.init = treeMaker.Literal(getVersion()); // 給這個字段賦值，也就是getVersion的返回值 } } return true; } /** * 利用processingEnv內的Messager對象輸出一些日志 * * @param e element * @param m error message */ private void printErrorMessage(Element e, String m) { processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, m, e); } private String getVersion() { /** * 獲取version，這里省略掉復雜的代碼，直接返回固定值 */ return "v1.0.1"; }

定義好的處理器需要SPI機制被發現，所以需要定義META.services：