共计 4440 个字符,预计需要花费 12 分钟才能阅读完成。
还在编写无聊干燥又难以保护的 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 开发手册(嵩山版)》最新公布,速速下载!
感觉不错,别忘了顺手点赞 + 转发哦!