还在编写无聊干燥又难以保护的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插件:

点击File-- Settings设置界面,开启Annocation Processors:

开启该项是为了让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的过程中,它产生作用的具体流程如下:

  • 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等办法:

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

@EqualsAndHashCode: 作用于类,笼罩默认的equals和hashCode

@NonNull: 次要作用于成员变量和参数中,标识不能为空,否则抛出空指针异样。

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

staticName属性一旦设定,将采纳静态方法的形式生成实例,access属性能够限定拜访权限。

@NoArgsConstructor:生成无参结构器;

@RequiredArgsConstructor:生成蕴含final和@NonNull注解的成员变量的结构器;

@AllArgsConstructor:生成全参结构器。

编译后后果:

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

其余重要注解:

@Cleanup: 主动敞开资源,针对实现了java.io.Closeable接口的对象无效,如:典型的IO流对象

编译后后果如下:

是不是简洁了太多。

@SneakyThrows: 能够对受检异样进行捕获并抛出,能够改写上述的main办法如下:

@Synchronized: 作用于办法级别,能够替换synchronize关键字或lock锁,用途不大。

作者:LiWenD正在掘金\
链接:https://juejin.cn/post/684490...

近期热文举荐:

1.1,000+ 道 Java面试题及答案整顿(2021最新版)

2.别在再满屏的 if/ else 了,试试策略模式,真香!!

3.卧槽!Java 中的 xx ≠ null 是什么新语法?

4.Spring Boot 2.5 重磅公布,光明模式太炸了!

5.《Java开发手册(嵩山版)》最新公布,速速下载!

感觉不错,别忘了顺手点赞+转发哦!