Java 效率工具之 Lombok

谁践踏了优雅 2021-08-19 21:56 354阅读 0赞

点击上方 [Java后端][Java]，选择 设为星标

优质文章，及时送达

![format_png][]

作者 |  LiWenD正在掘金

链接 | juejin.im/post/5b00517cf265da0ba0636d4b

还在编写无聊枯燥又难以维护的POJO吗？洁癖者的春天在哪里？请看Lombok！

在过往的Java项目中，充斥着太多不友好的代码：POJO的getter/setter/toString；异常处理；I/O流的关闭操作等等，这些样板代码既没有技术含量，又影响着代码的美观，Lombok应运而生。

首先说明一下：任何技术的出现都是为了解决某一类问题的，如果在此基础上再建立奇技淫巧，不如回归Java本身。应该保持合理使用而不滥用。

Lombok的使用非常简单，下面我们一起来看下：

**1）引入相应的maven包：**

<dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>1.16.18</version>
      <scope>provided</scope>
    </dependency>

Lombok的scope=provided，说明它只在编译阶段生效，不需要打入包中。事实正是如此，Lombok在编译期将带Lombok注解的Java文件正确编译为完整的Class文件。

**2）添加IDE工具对Lombok的支持：**

IDEA中引入Lombok支持如下：

*  点击File-- Settings设置界面，安装Lombok插件：

![format_png 1][]

*  点击File-- Settings设置界面，开启Annocation Processors：

![format_png 2][]

开启该项是为了让Lombok注解在编译阶段起到作用。

Eclipse的Lombok插件安装可以自行百度，也比较简单，值得一提的是，由于Eclipse内置的编译器不是Oracle javac，而是eclipse自己实现的Eclipse Compiler for Java (ECJ).要让ECJ支持Lombok，需要在eclipse.ini配置文件中添加如下两项内容：

\-Xbootclasspath/a:\[lombok.jar所在路径\]

\-javaagent:\[lombok.jar所在路径\]

**3）Lombok实现原理：**

自从Java 6起，javac就支持“JSR 269 Pluggable Annotation Processing API”规范，只要程序实现了该API，就能在javac运行的时候得到调用。

欢迎关注微信公众号：Java后端

Lombok就是一个实现了"JSR 269 API"的程序。在使用javac的过程中，它产生作用的具体流程如下：

*  javac对源代码进行分析，生成一棵抽象语法树(AST)
 *  javac编译过程中调用实现了JSR 269的Lombok程序
 *  此时Lombok就对第一步骤得到的AST进行处理，找到Lombok注解所在类对应的语法树(AST)，然后修改该语法树(AST)，增加Lombok注解定义的相应树节点
 *  javac使用修改后的抽象语法树(AST)生成字节码文件

**4) Lombok注解的使用：**

***POJO类常用注解：***

**@Getter/@Setter:** 作用类上，生成所有成员变量的getter/setter方法；作用于成员变量上，生成该成员变量的getter/setter方法。可以设定访问权限及是否懒加载等

package com.trace;
    
    import lombok.AccessLevel;
    import lombok.Getter;
    import lombok.Setter;
    
    /**
     * Created by Trace on 2018/5/19.<br/>
     * DESC: 测试类
     */
    @SuppressWarnings("unused")
    public class TestClass {
    
        public static void main(String[] args) {
    
        }
    
    
        @Getter(value = AccessLevel.PUBLIC)
        @Setter(value = AccessLevel.PUBLIC)
        public static class Person {
            private String name;
            private int age;
            private boolean friendly;
        }
    
    
        public static class Animal {
            private String name;
            private int age;
            @Getter @Setter private boolean funny;
        }
        
    }

在Structure视图中，可以看到已经生成了getter/setter等方法：

![format_png 3][]

编译后的代码如下：\[这也是传统Java编程需要编写的样板代码\]

//
    // Source code recreated from a .class file by IntelliJ IDEA
    // (powered by Fernflower decompiler)
    //
    
    package com.trace;
    
    public class TestClass {
        public TestClass() {
        }
    
        public static void main(String[] args) {
        }
    
        public static class Animal {
            private String name;
            private int age;
            private boolean funny;
    
            public Animal() {
            }
    
            public boolean isFunny() {
                return this.funny;
            }
    
            public void setFunny(boolean funny) {
                this.funny = funny;
            }
        }
    
        public static class Person {
            private String name;
            private int age;
            private boolean friendly;
    
            public Person() {
            }
    
            public String getName() {
                return this.name;
            }
    
            public int getAge() {
                return this.age;
            }
    
            public boolean isFriendly() {
                return this.friendly;
            }
    
            public void setName(String name) {
                this.name = name;
            }
    
            public void setAge(int age) {
                this.age = age;
            }
    
            public void setFriendly(boolean friendly) {
                this.friendly = friendly;
            }
        }
    }

**@ToString：**作用于类，覆盖默认的toString()方法，可以通过of属性限定显示某些字段，通过exclude属性排除某些字段。

![format_png 4][]

**@EqualsAndHashCode：**作用于类，覆盖默认的equals和hashCode

**@NonNull：**主要作用于成员变量和参数中，标识不能为空，否则抛出空指针异常。

![format_png 5][]

**@NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor：**作用于类上，用于生成构造函数。有staticName、access等属性。

staticName属性一旦设定，将采用静态方法的方式生成实例，access属性可以限定访问权限。

@NoArgsConstructor：生成无参构造器；

@RequiredArgsConstructor：生成包含final和@NonNull注解的成员变量的构造器；

@AllArgsConstructor：生成全参构造器。

![format_png 6][]

编译后结果：

public static class Person {
        @NonNull
        private String name;
        private int age;
        private boolean friendly;
    
        public String toString() {
            return "TestClass.Person(name=" + this.getName() + ", age=" + this.getAge() + ")";
        }
    
        @NonNull
        public String getName() {
            return this.name;
        }
    
        public int getAge() {
            return this.age;
        }
    
        public boolean isFriendly() {
            return this.friendly;
        }
    
        public void setName(@NonNull String name) {
            if(name == null) {
                throw new NullPointerException("name");
            } else {
                this.name = name;
            }
        }
    
        public void setAge(int age) {
            this.age = age;
        }
    
        public void setFriendly(boolean friendly) {
            this.friendly = friendly;
        }
    
        private Person() {
        }
    
        private static TestClass.Person of() {
            return new TestClass.Person();
        }
    
        @ConstructorProperties({"name"})
        Person(@NonNull String name) {
            if(name == null) {
                throw new NullPointerException("name");
            } else {
                this.name = name;
            }
        }
    
        @ConstructorProperties({"name", "age", "friendly"})
        public Person(@NonNull String name, int age, boolean friendly) {
            if(name == null) {
                throw new NullPointerException("name");
            } else {
                this.name = name;
                this.age = age;
                this.friendly = friendly;
            }
        }
    }

**@Data：**作用于类上，是以下注解的集合：@ToString @EqualsAndHashCode @Getter @Setter @RequiredArgsConstructor

**@Builder：**作用于类上，将类转变为建造者模式

**@Log：**作用于类上，生成日志变量。针对不同的日志实现产品，有不同的注解：

![format_png 7][]

***其他重要注解：***

**@Cleanup：**自动关闭资源，针对实现了java.io.Closeable接口的对象有效，如：典型的IO流对象

![format_png 8][]

编译后结果如下：

![format_png 9][]

**是不是简洁了太多。**

**@SneakyThrows：**可以对受检异常进行捕捉并抛出，可以改写上述的main方法如下：

![format_png 10][]

**@Synchronized：**作用于方法级别，可以替换synchronize关键字或lock锁，用处不大。

**- END -**

**推****荐****阅****读 **

***1.*** [60 个 Chrome 神器插件大收集][60 _ Chrome]

***2. ***[Spring 的 Bean 生命周期][Spring _ Bean]

***3.*** [发布没有答案的面试题，都是耍流氓][Link 1]

***4.*** [什么是一致性 Hash 算法？][Hash]

***5.***  [团队开发中 Git 最佳实践][Git]

![format_png 11][]

**喜****欢****文****章****，****点****个****在看 **![format_png 12][]

[Java]: https://blog.csdn.net/qq_37217713/article/details/101445094
[format_png]: /images/20210731/9b37112a5c2b451d9c7ab7cf46f4bda6.png
[format_png 1]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy9vVEtIYzZGOHRzZ21Cd2x6bDFnbWlhbzQ1OVNETHJidWpGTE0wWGlheTN2aWFjaWFOV2tXSWFxeVFBRnNld1R4aWE4aWF3alg1cFM0ZWdmQVQ0czlWOG5YUlNPdy82NDA?x-oss-process=image/format,png
[format_png 2]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy9vVEtIYzZGOHRzZ21Cd2x6bDFnbWlhbzQ1OVNETHJidWo2RVhVMmljNWxTRUJ6Q1dtNFl5aWM1UTlnU2lhcnFjaWFWQW12VUxJdXh1a3lneTlrN0ZTUXZTcFp3LzY0MA?x-oss-process=image/format,png
[format_png 3]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy9vVEtIYzZGOHRzZ21Cd2x6bDFnbWlhbzQ1OVNETHJidWpPdnQ1NlZRVzVsYjlzWVJpYmRkWHNvNEpDVmFkSFA1RnFWajVYN201V0sxY2xjMGZLMDV4WmZnLzY0MA?x-oss-process=image/format,png
[format_png 4]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy9vVEtIYzZGOHRzZ21Cd2x6bDFnbWlhbzQ1OVNETHJidWpwMkE3VnFZQU9oQm4zMnlFYmVnbzZBRGpMM2N2bE1COHllSFY0QnlDdDNIWmF3UFA5M3JZZUEvNjQw?x-oss-process=image/format,png
[format_png 5]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy9vVEtIYzZGOHRzZ21Cd2x6bDFnbWlhbzQ1OVNETHJidWpNVHpsYndyWnFzS09TdlI2b2ljZE4zaHBEWERLeXVPQXBkOE02ZnBYOUFuV1BaWmNmQjFEU09nLzY0MA?x-oss-process=image/format,png
[format_png 6]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy9vVEtIYzZGOHRzZ21Cd2x6bDFnbWlhbzQ1OVNETHJidWpDQ21nSmVOUmljUTU1c0VkdUlpYlpOcVFUNWtyVnNqQndBTEZmMHg4ZWZEQTlZb3JOSDBpYnExQUEvNjQw?x-oss-process=image/format,png
[format_png 7]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy9vVEtIYzZGOHRzZ21Cd2x6bDFnbWlhbzQ1OVNETHJidWppY0JSdDhZVDF6aE91RklVQXBVdmpYaWNDOE5pYURpYnpXUmJuS3ZIQ0xmS2t6b3ZBb3l2STl0NlN3LzY0MA?x-oss-process=image/format,png
[format_png 8]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy9vVEtIYzZGOHRzZ21Cd2x6bDFnbWlhbzQ1OVNETHJidWpMUXl5dk5GOVlNTU9vR3RhRng5M3Z4VlFLSnVwdVR3UEp5VmFuN2xBUXR1RkVOYTM4aWF4Zm5nLzY0MA?x-oss-process=image/format,png
[format_png 9]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy9vVEtIYzZGOHRzZ21Cd2x6bDFnbWlhbzQ1OVNETHJidWpUYkxnQ3RMYzlob2MyM3Y0eFBTaWEyT2FmN0ZsQURSc21QcU5mUXZpYUdJdEtYa1NwdjYwVmM3US82NDA?x-oss-process=image/format,png
[format_png 10]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy9vVEtIYzZGOHRzZ21Cd2x6bDFnbWlhbzQ1OVNETHJidWpXb1dibUJqMDBnQkJrZDdKSmo5N01HTkRHNEFNNWFHRGRtcXBGa2F5YVZpY3J1UURIZkJUbVJBLzY0MA?x-oss-process=image/format,png
[60 _ Chrome]: http://mp.weixin.qq.com/s?__biz=Mzg2MjEwMjI1Mg%3D%3D&chksm=ce0da9d4f97a20c22960bd38a935897e563d9a0062a11cae550325d542c1ef8fbc7c56c21129&idx=1&mid=2247491159&scene=21&sn=2dfa13092681511e5013c4172696a171#wechat_redirect
[Spring _ Bean]: http://mp.weixin.qq.com/s?__biz=Mzg2MjEwMjI1Mg%3D%3D&chksm=ce0da9c6f97a20d089b5785768ec7be2a8a9269ef7403a3c61b1670a653db4dc5edb7465c12a&idx=1&mid=2247491141&scene=21&sn=c08829d17958445fbd753a9c00b10713#wechat_redirect
[Link 1]: http://mp.weixin.qq.com/s?__biz=Mzg2MjEwMjI1Mg%3D%3D&chksm=ce0da9aef97a20b895da6050e31a53328154ecd8932008b147227d8bede434fb87899be23b4c&idx=1&mid=2247491117&scene=21&sn=b1050e3674c5259cae4f3fe79aca0c70#wechat_redirect
[Hash]: https://blog.csdn.net/qq_37217713/article/details/103535328
[Git]: https://blog.csdn.net/qq_37217713/article/details/102481709
[format_png 11]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2pwZy9vVEtIYzZGOHRzaGlhRVQyZVMwU2NnRXM5ejl6dTdpYU9EWjRiYkxmRUkwNmQ3ZE5RaWNTalR4YjFGWWNaUVVWcm9saWJXRE41WWliMWliUXZ6NnFCaWNEOGJJeXcvNjQw?x-oss-process=image/format,png
[format_png 12]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2pwZy9DMXVETURxam4xOXd0dVFwSzNqbUpXM2JGR1dJOFl6NkZSMTd0bDFNRjhWZnFZeFB4OTkwa3YySjc0THZxd2liMjZLYXlIZE9YZDZlYnpycVlpYmJUand3LzY0MA?x-oss-process=image/format,png