代码洁癖的春天！Java 效率工具之 Lombok

柔情只为你懂 2024-04-18 14:28 46阅读 0赞

[点击上方“搜云库技术团队”，选择“设为星标”][Link 1]

[回复“1024”或][Link 1][“面试题”][Link 1]获取学习资料

还在编写无聊枯燥又难以维护的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插件：**

![640?wx\_fmt=other][640_wx_fmt_other]

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

![640?wx\_fmt=other][640_wx_fmt_other 1]

开启该项是为了让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运行的时候得到调用。Lombok就是一个实现了"JSR 269 API"的程序。在使用javac的过程中，它产生作用的具体流程如下：

**1、**javac对源代码进行分析，生成一棵抽象语法树(AST)

**2、**javac编译过程中调用实现了JSR 269的Lombok程序

**3、**此时Lombok就对第一步骤得到的AST进行处理，找到Lombok注解所在类对应的语法树(AST)，然后修改该语法树(AST)，增加Lombok注解定义的相应树节点

**5、**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等方法：

![640?wx\_fmt=other][640_wx_fmt_other 2]

编译后的代码如下：\[这也是传统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属性排除某些字段。

![640?wx\_fmt=other][640_wx_fmt_other 3]

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

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

![640?wx\_fmt=other][640_wx_fmt_other 4]

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

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

@NoArgsConstructor：生成无参构造器；

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

@AllArgsConstructor：生成全参构造器。

![640?wx\_fmt=other][640_wx_fmt_other 5]

编译后结果：

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：**作用于类上，生成日志变量。针对不同的日志实现产品，有不同的注解：

![640?wx\_fmt=other][640_wx_fmt_other 6]

**其他重要注解：**

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

![640?wx\_fmt=other][640_wx_fmt_other 7]

编译后结果如下：

![640?wx\_fmt=other][640_wx_fmt_other 8]

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

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

![640?wx\_fmt=other][640_wx_fmt_other 9]

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

**敬请关注「搜云库技术团队」微信公众号，获取最新文章**

来源：juejin.im/post/5b00517cf265da0ba0636d4b

整编：搜云库技术团队，欢迎广大技术人员投稿

如果对本文的内容有疑问，请在文章留言区留言，谢谢。

[》》》福利 + 程序员工作内推群《《《][Link 1]

**2000道 互联网Java工程师 ****面试题**** 共768页.pdf**

**关注公众号并回复：****“面试题”**** 无套路获取**

**更多技术干货**

推荐：[近300篇：历史技术文章，20大分类整理][300_20]

1、[懂点 Nginx 如何实现反向代理与负载均衡，是面试加分项][Nginx] 2、[面试官：SpringBoot jar 可执行原理，知道吗？][SpringBoot jar] 3、[很高兴！终于在生产上踩到了慢查询优化的坑][Link 2] 4、[精选 Dubbo RPC 面试题，比较全面，含答案][Dubbo RPC] 5、[Logback 这样配置，TPS提高10倍][Logback _TPS_10]

![640?wx\_fmt=png][640_wx_fmt_png]

[Link 1]: https://mp.weixin.qq.com/s?__biz=MzA3MTUzOTcxOQ==&mid=2452966575&idx=2&sn=65d240d020625f7018c697eba4642be1&scene=21#wechat_redirect
[640_wx_fmt_other]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/f408d4f134664683a1f92b65dae8be14.png
[640_wx_fmt_other 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/0a2888c86c50443cbb70cbedac5c64f6.png
[640_wx_fmt_other 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/3013c41016434618834a8db75f38fd96.png
[640_wx_fmt_other 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/9bc567ed6aa04f9fa2efff846225f435.png
[640_wx_fmt_other 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/79bfffd27f9448c3b50758048be97233.png
[640_wx_fmt_other 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/97bbc36f55fa42f5b547cbe8c05d612d.png
[640_wx_fmt_other 6]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/ce87ce43cd734642bf28a7aeb568f8e8.png
[640_wx_fmt_other 7]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/0c7e834896e84fb789da3634c77c9f01.png
[640_wx_fmt_other 8]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/cd1b87022e1c46d99e72c8fc062a8eb2.png
[640_wx_fmt_other 9]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/577b37620b4c419193622df8ff455080.png
[300_20]: https://mp.weixin.qq.com/s?__biz=MzA3MTUzOTcxOQ==&mid=2452967357&idx=1&sn=d718fe7c8f9766aacda36e98d6de654e&scene=21#wechat_redirect
[Nginx]: https://mp.weixin.qq.com/s?__biz=MzA3MTUzOTcxOQ==&mid=2452967630&idx=1&sn=93f8d5ff2c10daeff48c37064e2bf2c5&scene=21#wechat_redirect
[SpringBoot jar]: https://mp.weixin.qq.com/s?__biz=MzA3MTUzOTcxOQ==&mid=2452967612&idx=1&sn=da6ab8e35a28bfc507882c041661a9e2&scene=21#wechat_redirect
[Link 2]: https://mp.weixin.qq.com/s?__biz=MzA3MTUzOTcxOQ==&mid=2452967602&idx=1&sn=38f88513f78b113e6fdeab44f8ccd19b&scene=21#wechat_redirect
[Dubbo RPC]: https://mp.weixin.qq.com/s?__biz=MzA3MTUzOTcxOQ==&mid=2452967573&idx=1&sn=168fe89b158dbd7f5a64ee92ac0f6f50&scene=21#wechat_redirect
[Logback _TPS_10]: https://mp.weixin.qq.com/s?__biz=MzA3MTUzOTcxOQ==&mid=2452967573&idx=2&sn=104350825970a31e12b24972a28e2284&scene=21#wechat_redirect
[640_wx_fmt_png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/3a9f377690c247c9a11496dcf1ae75d8.png