详解Lombok中的Builder及SuperBuilder

　　本篇文章详细介绍了Java中lombok的Builder注解及SuperBuilder注解的解析和使用，希望对大家的学习或工作有一定的参考借鉴价值。废话不多说，直接上干货。Builder
　　Lombok的Builder提供了一种非常有用的机制，无需编写样板代码即可使用构建者模式。Builder可以放在类，构造函数或方法上。基础用法
　　先定义示例类Question，类声明中用Builder注解。定义Quesstion，使用Builder注解BuilderpublicclassQuestion｛privateLongid；privateStringquestion；｝
　　用Builder注解的类，Lombok会帮我们做以下几个事情（参考下面的示例代码）：定义一个名为XXXBuilder（XXX为目标类）的内部静态类，具有与静态方法（称为构建器）相同的类型参数。在构建器中：目标类的每个成员变量都有一个私有的非static非final字段。在构建器中：一个私有无参数构造函数。在构建器中：目标类的每个成员变量都有类似setter的方法：它与该成员变量具有相同的类型和相同的名称，返回构建器本身，以便可以链式调用。在构建器中：调用build（）方法，传入每个字段。它返回与目标类类型相同的实例对象。在构建器中：一个合理的toString（）实现。在目标类中：一个builder（）静态方法，它创建构建器的一个新实例。publicclassQuestion｛privateLongid；privateStringquestion；Question（Longid，Stringquestion）｛this。idid；this。questionquestion；｝publicstaticQuestionBuilderbuilder（）｛returnnewQuestionBuilder（）；｝publicstaticclassQuestionBuilder｛privateLongid；privateStringquestion；QuestionBuilder（）｛｝publicQuestionBuilderid（Longid）｛this。idid；returnthis；｝publicQuestionBuilderquestion（Stringquestion）｛this。questionquestion；returnthis；｝publicQuestionbuild（）｛returnnewQuestion（this。id，this。question）；｝publicStringtoString（）｛returnQuestion。QuestionBuilder（idthis。id，questionthis。question）；｝｝组合用法
　　Builder中使用Singular注释集合。定义Answer，使用Builder注解BuilderpublicclassAnswer｛privateLongid；privateStringanswer；｝定义Quesstion，使用Builder注解BuilderpublicclassQuestion｛privateLongid；privateStringquestion；SingularprivateListanswers；Singular（answer）privateListanswerList；｝
　　在使用Singular注释注释一个集合字段（使用Builder注释类），lombok会将该构建器节点视为一个集合，并生成两个adder方法，而不是setter方法。一个往集合添加单个元素；一个将另一个集合的所有元素添加到集合中；
　　除此之外，还生成了clear方法，用于清空集合。publicclassQuestion｛privateLongid；privateStringquestion；Listanswers；Question（Longid，Stringquestion，Listanswers）｛this。idid；this。questionquestion；this。answersanswers；｝publicstaticQuestionBuilderbuilder（）｛returnnewQuestionBuilder（）；｝publicstaticclassQuestionBuilder｛privateLongid；privateStringquestion；privateArrayListanswers；QuestionBuilder（）｛｝publicQuestionBuilderid（Longid）｛this。idid；returnthis；｝publicQuestionBuilderquestion（Stringquestion）｛this。questionquestion；returnthis；｝publicQuestionBuilderanswer（Answeranswer）｛if（this。answersnull）｛this。answersnewArrayList（）；｝this。answers。add（answer）；returnthis；｝publicQuestionBuilderanswers（Collectionlt；？extendsAnsweranswers）｛if（answersnull）｛thrownewNullPointerException（answerscannotbenull）；｝else｛if（this。answersnull）｛this。answersnewArrayList（）；｝this。answers。addAll（answers）；returnthis；｝｝publicQuestionBuilderclearAnswers（）｛if（this。answers！null）｛this。answers。clear（）；｝returnthis；｝publicQuestionbuild（）｛Listanswers；switch（this。answersnull？0：this。answers。size（））｛case0：answersCollections。emptyList（）；break；case1：answersCollections。singletonList（this。answers。get（0））；break；default：answersCollections。unmodifiableList（newArrayList（this。answers））；｝returnnewQuestion（this。id，this。question，answers）；｝publicStringtoString（）｛returnQuestion。QuestionBuilder（idthis。id，questionthis。question，answersthis。answers）；｝｝｝
　　从上面代码块，可以看到在集合字段增加了Singular注解后，构建器的build（）方法会更复杂一些，主要是为了保证以下两点：在调用build（）时，生成的集合将是不可变的。在调用build（）之后调用其中一个adder方法或clear方法不会修改任何已经生成的对象。如果对集合修改之后，再调用build（），则会创建一个基于上一个对象创建的对象实体。生成的集合将被压缩到最小的可行格式，同时保持高效。
　　如果您的标识符是用普通英语编写的，lombok会假定任何带有Singular的集合的名称是英语复数，并将尝试自动将该名称单数化。如果可能，addone方法将使用此名称。例如，如果这里我们定义的集合为answers，那么addone方法将自动称为answer（Answeranswer）。您还可以在Singular注解中显式指定标识符的单数形式，如上面代码块中被注释的部分：Singular（answer）privateListanswerList；
　　如果lombok无法将您的标识符单数化，或者它有歧义，lombok将生成错误并强制您明确指定单数名称。
　　Builder。Default的使用
　　如果在构建会话期间从未设置某个字段参数，则它始终为0nullfalse。如果您将Builder放在类上（而不是方法或构造函数），您可以直接在字段上指定默认值，并使用Builder。Default注释该字段：BuilderpublicclassAnswer｛Builder。DefaultprivatefinalStringidUUID。randomUUID（）。toString（）；privateStringanswer；｝
　　Builder（toBuildertrue）
　　如果我们想要创建对象的副本或近似副本，我们可以将属性toBuildertrue添加到Builder注释中：
　　Lombok会在目标类中新增一个toBuilder（）方法。当调用toBuilder（）方法时，它会返回一个新的构建器，该构建器使用调用它的实例的属性进行初始化：publicclassAnswer｛privatefinalStringid；privateStringanswer；privatestaticStringdefaultid（）｛returnUUID。randomUUID（）。toString（）；｝Answer（Stringid，Stringanswer）｛this。idid；this。answeranswer；｝publicstaticAnswerBuilderbuilder（）｛returnnewAnswerBuilder（）；｝publicAnswerBuildertoBuilder（）｛return（newAnswerBuilder（））。id（this。id）。answer（this。answer）；｝publicstaticclassAnswerBuilder｛privatebooleanidset；privateStringidvalue；privateStringanswer；AnswerBuilder（）｛｝publicAnswerBuilderid（Stringid）｛this。idvalueid；this。idsettrue；returnthis；｝publicAnswerBuilderanswer（Stringanswer）｛this。answeranswer；returnthis；｝publicAnswerbuild（）｛Stringidvaluethis。idvalue；if（！this。idset）｛idvalueAnswer。defaultid（）；｝returnnewAnswer（idvalue，this。answer）；｝publicStringtoString（）｛returnAnswer。AnswerBuilder（idvaluethis。idvalue，answerthis。answer）；｝｝｝SuperBuilder
　　Builder并不支持对父类成员属性的构造，为解决这个问题，SuperBuilder应运而生，算是Builder的升级版。SuperBuilder在lombokv1。18。2中作为实验性功能引入。
　　定义示例类Event和其子类QuestionEvent。SuperBuilderpublicclassEvent｛Stringmessage；｝SuperBuilderpublicclassQuestionEventextendsEvent｛｝
　　用SuperBuilder注解的类，Lombok会帮我们做以下几个事情（参考下面的示例代码）：SuperBuilder在以builder实例作为参数的类上生成一个protect类型的构造函数。此构造函数将新实例的字段设置为builder中的值。为了确保类型安全，SuperBuilder为每个注解类生成两个内部构建器类，一个抽象类和一个具体类，名为XXXBuilder和XXXBuilderImpl（其中XXX是注解类的名称）。publicclassEvent｛Stringmessage；protectedEvent（EventBuilderlt；？，？b）｛this。messageb。message；｝publicstaticEventBuilderlt；？，？builder（）｛returnnewEventBuilderImpl（）；｝privatestaticfinalclassEventBuilderImplextendsEventBuilderEvent，EventBuilderImpl｛privateEventBuilderImpl（）｛｝protectedEventBuilderImplself（）｛returnthis；｝publicEventbuild（）｛returnnewEvent（this）；｝｝publicabstractstaticclassEventBuilderCextendsEvent，BextendsEventBuilderC，B｛privateStringmessage；publicEventBuilder（）｛｝protectedabstractBself（）；publicabstractCbuild（）；publicBmessage（Stringmessage）｛this。messagemessage；returnthis。self（）；｝publicStringtoString（）｛returnEvent。EventBuilder（messagethis。message）；｝｝｝publicclassQuestionEventextendsEvent｛protectedQuestionEvent（QuestionEventBuilderlt；？，？b）｛super（b）；｝publicstaticQuestionEventBuilderlt；？，？builder（）｛returnnewQuestionEventBuilderImpl（）；｝privatestaticfinalclassQuestionEventBuilderImplextendsQuestionEventBuilderQuestionEvent，QuestionEventBuilderImpl｛privateQuestionEventBuilderImpl（）｛｝protectedQuestionEventBuilderImplself（）｛returnthis；｝publicQuestionEventbuild（）｛returnnewQuestionEvent（this）；｝｝publicabstractstaticclassQuestionEventBuilderCextendsQuestionEvent，BextendsQuestionEventBuilderC，BextendsEvent。EventBuilderC，B｛publicQuestionEventBuilder（）｛｝protectedabstractBself（）；publicabstractCbuild（）；publicStringtoString（）｛returnQuestionEvent。QuestionEventBuilder（supersuper。toString（））；｝｝｝为什么Builder不能处理父类的成员变量，而SuperBuilder可以？
　　原因在于，在Java的抽象语法树设计上，每个类只包含了显式声明的变量而不包括父类的成员变量。Lombok针对Builder注解的内部实现findAllFields方法是从当前类的抽象语法树出发去找所有的成员变量，所以就只能找到当前类的成员变量，而访问不到父类的成员变量。
　　SuperBuilder注解的内部实现，在查找所有成员变量之前，先拿到了继承的父类的抽象语法树。JCClassDecltd（JCClassDecl）parent。get（）；获取继承的父类的抽象语法树JCTreeextendsClauseJavac。getExtendsClause（td）；JCExpressionsuperclassBuilderClassnull；if（extendsClauseinstanceofJCTypeApply）｛Rememberthetypearguments，becauseweneedthemfortheextendsclauseofourabstractbuilderclass。superclassTypeParams（（JCTypeApply）extendsClause）。getTypeArguments（）；Aclassnamewithagenericstype，e。g。，Superclass。extendsClause（（JCTypeApply）extendsClause）。getType（）；｝if（extendsClauseinstanceofJCFieldAccess）｛NamesuperclassName（（JCFieldAccess）extendsClause）。getIdentifier（）；StringsuperclassBuilderClassNamesuperclassName。toString（）Builder；superclassBuilderClassparent。getTreeMaker（）。Select（（JCFieldAccess）extendsClause，parent。toName（superclassBuilderClassName））；｝elseif（extendsClause！null）｛StringsuperclassBuilderClassNameextendsClause。toString（）Builder；superclassBuilderClasschainDots（parent，extendsClause。toString（），superclassBuilderClassName）；｝注意点SuperBuilder与Builder不兼容，不能一起使用。被SuperBuilder注解的类，其父类也必须使用SuperBuilder注解。