用了那么久的 Lombok，你知道它的原理么？

作者：王再軍 2022-12-09 09:46:55

我們學(xué)會了如何自己寫一個屬于自己的簡易Lombok的插件。

序言

在寫Java代碼的時候，最煩寫setter/getter方法，自從有了Lombok插件不用再寫那些方法之后，感覺再也回不去了，那你們是否好奇過Lombok是怎么把setter/getter方法給你加上去的呢？有的同學(xué)說我們Java引入Lombok之后會污染依賴包，那我們可不可以自己寫一個工具來代替Lombok呢？

知識點

Java編譯過程
了解Lombok原理
了解插入式注解處理器

分析

序言提到的問題其實都是同一個問題，就是如何去獲取和修改Java源代碼？

要回答這個問題，我們需要回答這幾個問題：

Java編譯器是如何解析Java源代碼的？
編譯器編譯源代碼都有哪些步驟？
我們在編譯器工作的時候，怎么才能去增加內(nèi)容或者是進行代碼分析？

希望大家看完本文能夠自己寫一個簡易的Lombok工具。

回答

如何解析源代碼

其實從我們的代碼到被編譯，中間隔了一個數(shù)據(jù)結(jié)構(gòu)，叫做AST（抽象樹）。具體的形式，可以查看下面的圖片。右邊的便是AST的數(shù)據(jù)結(jié)構(gòu)了。

代碼編譯都有哪些步驟

整個編譯過程大致如下：

圖片來自 openjdk

1、初始化插入注解處理器

2、解析與填充符號表過程

a.詞法分析、語法分析。將源代碼的字符流轉(zhuǎn)變?yōu)闃?biāo)記集合，構(gòu)造出抽象語法樹。

b.填充符號表。產(chǎn)生符號地址和符號信息。

3、插入式注解處理器的注解處理過程：插入式注解處理器的執(zhí)行階段。后面我會給大家?guī)韮蓚€此方面的實用實戰(zhàn)例子。

4、分析與字節(jié)碼生成過程

a.標(biāo)注檢查。對語法的靜態(tài)信息檢查。

b.數(shù)據(jù)流及控制流分析。對程序動態(tài)運行過程進行檢查。

c.解語法糖。將簡化代碼編寫的語法糖還原為原有的形式。

d.字節(jié)碼生成。將前面各個步驟所生成的信息轉(zhuǎn)化成為字節(jié)碼。

?我們知道了上面的理論之后，接下來我們進行實戰(zhàn)。帶著大家一起去修改AST（抽象樹）。添加自己的代碼。

實戰(zhàn)

如何自己實現(xiàn)一個自動添加Setter/Getter的工具?

首先，我們創(chuàng)建一個自己的注解。

@Retention(RetentionPolicy.SOURCE) // 注解只在源碼中保留
@Target(ElementType.TYPE) // 用于修飾類
public @interface MySetterGetter {
}

創(chuàng)建一個需要生成setter/getter方法的實體類

@MySetterGetter  // 打上我們的注解
public class Test {
    private String wzj;
}

接下來就來看一看如何來生成我們想要的字符串。

整體代碼如下：

@SupportedAnnotationTypes("com.study.practice.nameChecker.MySetterGetter")
@SupportedSourceVersion(SourceVersion.RELEASE_8)
public class MySetterGetterProcessor extends AbstractProcessor {
    // 主要是輸出信息
    private Messager messager;
    private JavacTrees javacTrees;

    private TreeMaker treeMaker;
    private Names names;
    @Override
    public synchronized void init(ProcessingEnvironment processingEnv){
        super.init(processingEnv);
        this.messager = processingEnv.getMessager();
        this.javacTrees = JavacTrees.instance(processingEnv);
        Context context = ((JavacProcessingEnvironment)processingEnv).getContext();
        this.treeMaker = TreeMaker.instance(context);
        this.names = Names.instance(context);
    }

    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv){
        // 拿到被注解標(biāo)注的所有的類
        Set<? extends Element> elementsAnnotatedWith = roundEnv.getElementsAnnotatedWith(MySetterGetter.class);
        elementsAnnotatedWith.forEach(element -> {
            // 得到類的抽象樹結(jié)構(gòu)
            JCTree tree = javacTrees.getTree(element);
            // 遍歷類，對類進行修改
            tree.accept(new TreeTranslator(){
                @Override
                public void visitClassDef(JCTree.JCClassDecl jcClassDecl){
                    List<JCTree.JCVariableDecl> jcVariableDeclList = List.nil();
                    // 在抽象樹中找出所有的變量
                    for(JCTree jcTree: jcClassDecl.defs){
                        if (jcTree.getKind().equals(Tree.Kind.VARIABLE)){
                            JCTree.JCVariableDecl jcVariableDecl = (JCTree.JCVariableDecl)jcTree;
                            jcVariableDeclList = jcVariableDeclList.append(jcVariableDecl);
                        }
                    }
                    
                    // 對于變量進行生成方法的操作
                    for (JCTree.JCVariableDecl jcVariableDecl : jcVariableDeclList) {
                        messager.printMessage(Diagnostic.Kind.NOTE, jcVariableDecl.getName() + " has been processed");
                        jcClassDecl.defs = jcClassDecl.defs.prepend(makeSetterMethodDecl(jcVariableDecl));

                        jcClassDecl.defs = jcClassDecl.defs.prepend(makeGetterMethodDecl(jcVariableDecl));
                    }


        // 生成返回對象
        JCTree.JCExpression methodType = treeMaker.Type(new Type.JCVoidType());

        return treeMaker.MethodDef(treeMaker.Modifiers(Flags.PUBLIC), getNewSetterMethodName(jcVariableDecl.getName()), methodType, List.nil(), parameters, List.nil(), block, null);
    }
    /**
     * 生成 getter 方法
     * @param jcVariableDecl
     * @return
    private JCTree.JCMethodDecl makeGetterMethodDecl(JCTree.JCVariableDecl jcVariableDecl){
        ListBuffer<JCTree.JCStatement> statements = new ListBuffer<>();
        // 生成表達式
        JCTree.JCReturn aReturn = treeMaker.Return(treeMaker.Ident(jcVariableDecl.getName()));
        statements.append(aReturn);
        JCTree.JCBlock block = treeMaker.Block(0, statements.toList());
        // 無入?yún)?/span>
        // 生成返回對象
        JCTree.JCExpression returnType = treeMaker.Type(jcVariableDecl.getType().type);
        return treeMaker.MethodDef(treeMaker.Modifiers(Flags.PUBLIC), getNewGetterMethodName(jcVariableDecl.getName()), returnType, List.nil(), List.nil(), List.nil(), block, null);
    }
    /**
     * 拼裝Setter方法名稱字符串
     * @param name
     * @return
    private Name getNewSetterMethodName(Name name){
        String s = name.toString();
        return names.fromString("set" + s.substring(0,1).toUpperCase() + s.substring(1, name.length()));
    }
    /**
     * 拼裝 Getter 方法名稱的字符串
     * @param name
     * @return
    private Name getNewGetterMethodName(Name name){
        String s = name.toString();
        return names.fromString("get" + s.substring(0,1).toUpperCase() + s.substring(1, name.length()));
    }
    /**
     * 生成表達式
     * @param lhs
     * @param rhs
     * @return
    private JCTree.JCExpressionStatement makeAssignment(JCTree.JCExpression lhs, JCTree.JCExpression rhs){
        return treeMaker.Exec(
                treeMaker.Assign(lhs, rhs)
        );
    }
}

代碼有點多，我們逐一拆解說明：

下面這是整個代碼結(jié)構(gòu)的腦圖，后面的講解會基于這個順序。

a. 注解

@SupportedAnnotationTypes 表示我們需要監(jiān)聽的注解，比如我們之前定義的 @MySetterGetter。

@SupportedSourceVersion 表示我們想要對什么版本的Java源代碼進行處理。?

b. 父類

AbstractProcessor是本次的核心類，編譯器在編譯的時候會掃描此類的子類。其中有一個子類必須實現(xiàn)的核心方法 public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)，此方法如果是返回為true就說明編譯的那個類抽象樹的結(jié)構(gòu)又變化，需要重新進行詞法分析和語法分析（可以查看上面提到的那個編譯流程圖）。如果返回的是false就說明沒有變化。

c. process方法

主要的操作邏輯是：

1、拿到所有被我們MySetterGetter標(biāo)注的類。

2、遍歷所有的類，生成類的抽象樹結(jié)構(gòu)。

3、對類進行操作：

a.找到類中所有的變量。

b.對變量進行生成Set和Get方法。

4、返回 true，說明類結(jié)構(gòu)變了，需要重新解析。如果是false說明沒有變，不用重新解析。?

d. 操作JCTree樹

主要是在操作抽象樹，可以查看文末附件中的文章進行學(xué)習(xí)。

?e. 方法名稱拼接

這一塊兒和字符串拼接沒啥區(qū)別，用過反射的同學(xué)應(yīng)該也都清楚這個操作了。?

到此為止，我們就已經(jīng)介紹完了Lombok的原理。怎么樣是不是很簡單。接下來，就讓我們把它運行起來，投入到實戰(zhàn)之中。?

f. 運行

最后來看一下如何正確的運行這個我們寫的工具。

1.環(huán)境

我的系統(tǒng)環(huán)境是 macOs Monterey；

java版本是

openjdk version "1.8.0_302"
OpenJDK Runtime Environment (Temurin)(build 1.8.0_302-b08)
OpenJDK 64-Bit Server VM (Temurin)(build 25.302-b08, mixed mode)

2.編譯processor

?在你存放 MySetterGetter 和 MySetterGetterProcessor 兩個類的目錄下進行編譯。

javac -cp $JAVA_HOME/lib/tools.jar MySetterGetter.java MySetterGetterProcessor.java

執(zhí)行成功后會出現(xiàn)這三個class文件。

3.聲明插入式注解處理器

在你的工程的resources下面創(chuàng)建一個包，名稱為：META-INFO.services
然后創(chuàng)建一個文件，名稱為：javax.annotation.processing.Processor
將你的注解處理器的地址填入，我的配置是這樣的：

com.study.practice.nameChecker.MySetterGetterProcessor

4.用我們的工具去編譯目標(biāo)類

比如我們本次是要編譯那個test.java。

它的內(nèi)容再回顧一下：

@MySetterGetter  // 打上我們的注解
public class Test {
    private String wzj;
}

然后我們就去編譯它（注意類前面的路徑。這個你們得換成自己的工程目錄。）

javac -processor com.study.practice.nameChecker.MySetterGetterProcessor com/study/practice/nameChecker/Test.java

執(zhí)行之后如果沒有修改我的代碼的話會打印這幾個字符串：

process 1
process 2
注: wzj has been processed
process 1

最后會生成Test.class文件。

5.成果

最后的class文件解析出來就是這個樣子的。如下圖所示：

看到Setter/Getter方法就說明我們已經(jīng)大功告成了！是不是很簡單。

到此為止，我們就學(xué)會了如何自己寫一個屬于自己的簡易Lombok的插件了。

附件

treemarker 的介紹:

http://www.docjar.com/docs/api/com/sun/tools/javac/tree/TreeMaker.html

責(zé)任編輯：張燕妮來源：阿里云云棲號

插件 Lombok

偷偷摘套内射激情视频,久久精品99国产国产精,中文字幕无线乱码人妻,中文在线中文a,性爽19p

用了那么久的 Lombok，你知道它的原理么？

序言

知識點

分析

回答

實戰(zhàn)

用了那么久的 Lombok，你知道它的原理么？