少年意气强不羁，虎胁插翼白日飞。这篇文章主要讲述Java技术探索「开发实战专题」Lombok插件开发实践必知必会操作！相关的知识，希望能为你提供帮助。
前言首先我们还是看下 Lombok 官方的描述：
本文主要内容涉及如下：
- Lombok 插件安装
- Lombok 常用注解使用
正文 安装 Lombok
使用 Lombok 之前我们先要在所使用的 IDE 中进行集成安装，这里以 IDEA 为例，安装步骤十分简单：
- 前往
File -& gt; Settings -& gt; Plugin -& gt; Marketplace，搜索 Lombok
- 选择搜索结果 Lombok ，点击 Install 安装。
- 安装完成后重启即可。
pom.xml 文件中添加 Lombok 的依赖进行使用了。<
dependency>
<
groupId>
org.projectlombok<
/groupId>
<
artifactId>
lombok<
/artifactId>
<
version>
1.18.8<
/version>
<
scope>
provided<
/scope>
<
/dependency>
@Getter/@Setter
- 通常我们编写实体类无论多少个字段，都要为其提供
getter和setter方法，如下面的示例类User.java
- 我们常会遇到这种情况：某个实体类新增和修改某个字段，我们都需要单独处理调整，十分麻烦并且重复。这时候如果我们使用 Lombok 提供
@Getter/@Setter注解就能帮我们省去getter 和setter方法的维护，由 Lombok 对User类自动生成getter和setter方法,两者最终的字节码时一样的，而我们现在在User.java上编写的代码仅仅7 行即可：
@Getter
@Setter
public class User {
private Integer id;
private String username;
private String password;
}然后用测试类
UserTests.java 测试结果如下：public class UserTests {
@Test
public void test() {
User user = new User();
user.setUsername("one");
user.setPassword("zxc123");
Assert.assertEquals(user.getUsername(), "one");
Assert.assertEquals(user.getPassword(), "zxc123");
}
}【Java技术探索「开发实战专题」Lombok插件开发实践必知必会操作！】
@Getter/@Setter 注解不仅可以使用在类上，还可以使用在字段上，这样就是表示针对该字段自动生成 getter /setter 方法。@Getter
@Setter
private String password;
这里该注解使用在类上，还是在字段上的区别就是，如果注解使用在类上，只针对这个类的非静态字段有效。
需要注意的一点是：如果
@Getter 注解修饰了 boolean 类型的变量，其生成的 getter 方法签名是 isXXX 形式，而不是 getXXX形式。除此之外，
@Getter/@Setter 还提供访问权限控制的属性 lombok.AccessLevel value(), 默认为 PUBLIC，而其他选值都是枚举类型：MODULE, PROTECTED, PACKAGE, PRIVATE@NonNull
顾名思义，
@NonNull 用于标记类中不能允许为 null 的字段或者参数上，任何使用该字段的地方都生成空指针判断代码，若@NonNull 标记的变量为 null，抛出 NullPointException （NPE） 异常。比如下面示例代码：public class User {
private Integer id;
private String username;
private String password;
public User(Integer id, @NonNull String username, @NonNull String password) {
this.id = id;
this.username = username;
this.password = password;
}
}使用了
@NonNull 注解之后我们可以获取到反编译之后的字节码信息如下，这就是 Lombok 给我们生成的最终的代码：public class User {
private Integer id;
private String username;
private String password;
public User(Integer id, @NonNull String username, @NonNull String password) {
if (username == null) {
throw new NullPointerException("username is marked non-null but is null");
} else if (password == null) {
throw new NullPointerException("password is marked non-null but is null");
} else {
this.id = id;
this.username = username;
this.password = password;
}
}
}构造器注解
再来看下平时经常会遇见的场景，为实体类编写构造器方法，Lombok 提供了三个不同构造器注解
@NoArgsConstructor / @AllArgsConstructor / @RequiredArgsConstructor 分别对用不同构造器方法处理方式，接下来就一一描述。@NoArgsConstructor为实体类生成无参的构造器方法
@AllArgsConstructor为实体类生成除了static修饰的字段之外带有各参数的构造器方法。
@RequiredArgsConstructor为实体类生成指定字段的构造器方法，而这些字段需要被final，或者@NonNull修饰。
@RequiredArgsConstructor public class User3 { private Integer id; private final String username; @NonNull private String password; }
编译成功后使用构造器方法时就是这样的效果：User3 user3 = new User3("user3", "zxc123");
@ToString 会给类自动生成易阅读的 toString 方法，带上有所非静态字段的属性名称和值，这样就十分便于我们日常开发时进行的打印操作。@Getter
@Setter
@AllArgsConstructor
@ToString
public class User2 {
private Integer id;
private String username;
private String password;
}最终编译成字节码，反编译结果如下：
public class User2 {
private Integer id;
private String username;
private String password;
// 省去 setter/getter
public String toString() {
return "User2(id=" + this.getId() + ", username=" + this.getUsername() + ", password=" + this.getPassword() + ")";
}
}另外，注解
@ToString 还支持设置指定哪些字段的日志化输出，哪些不需要出现在 toString 方法中。使用属性 @ToString.Exclude排除不需要在 toString 中出现的字段，使用 @ToString.Include标记需要出现在 toString 中的字段，具体用法可参见示例：@Getter
@Setter
@AllArgsConstructor
@ToString
public class User2 {
@ToString.Exclude
private Integer id;
@ToString.Include
private String username;
@ToString.Include
private String password;
}打印
User2 对象的日志效果就是：User2(username=user2, password=zcx123)。@EqualsAndHashCode
@EqualsAndHashCode注解就是用于根据类所拥有的非静态字段自动重写 equals 方法和 hashCode 方法,方便我们用于对象间的比较。类似 @ToString，@EqualsAndHashCode还可以使用需要作为比较的字段和排除不需要比较的字段，具体用法可以看如下示例：@Getter
@Setter
@AllArgsConstructor
@ToString
@EqualsAndHashCode
public class User4 {
@EqualsAndHashCode.Exclude
private Integer id;
@EqualsAndHashCode.Include
private String username;
@EqualsAndHashCode.Exclude
private String password;
}写完实体类代码，我们编写测试方法试下效果：
@Test
public void testEqual() {
User4 user4 = new User4(1, "user4", "zxc");
User4 user4_2 = new User4(1, "user4", "123");
Assert.assertEquals(user4, user4_2);
// ture
}@Data/@Value
@Data/@Value 注解，提供了更综合的生成代码功能，等价于下面几个注解@Getter
@Setter
@AllArgsConstructor
@ToString
@EqualsAndHashCode两个注解都只能使用在类上，与
@Data 不同， @Value 用来修饰不可变的类上。一般实体类没有特别的限制的话，通常可以直接使用 @Data 注解修饰。@Builder
@Builder 是一个非常强大的注解，提供了一种基于建造者模式的构建对象的 API。使用 @Builder 注解为给我们的实体类自动生成 builder() 方法，并且直接根据字段名称方法进行字段赋值，最后使用 build()方法构建出一个实体对象。@Data
@Builder
public class User6 {
private Integer id;
private String username;
private String password;
}@Test
public void testBuilder() {
User6 user6 = User6.builder().id(1).username("user6").password("zxc123").build();
log.warn("testLog: {}", user6);
// User6(id=1, username=user6, password=zxc123)
}需要注意的是
@Builder 不支持父类字段的生成，当一个实体类存在父类时，@Builder只能生成当前类的字段构建方法。若需要用到父类的字段方法时， Lombok 提供了新的注解 @SuperBuilder 来应对这种情况，下面是 @SuperBuilder 注解的使用方式:@SuperBuilder
@Getter
@Setter
public class Parent {
private int id;
private String name;
}@SuperBuilder
@Data
public class Child extends Parent {
private String childName;
}调用示例:
Child child = Child.builder().id(1).name("父类名称").childName("子类名称").build();
System.out.println(child.getId());
也可以参考此文方式去处理继承的情况：https://reinhard.codes/2015/09/16/lomboks-builder-annotation-and-inheritance/
日志注解
正对程序类中常见不同框架 Logger 对象，Lombok 也提供了注解，来自动生成 Logger对象，实现优雅地输出日志,只需要在类上使用日志注解如
@Log。当然 Lombok 支持了多个日志框架，并且提供对应的注解如下：@CommonsLog等价效果：private static final org.apache.commons.logging.Log log = org.apache.commons.logging.LogFactory.getLog(LogExample.class);
@Flogger等价效果：private static final com.google.common.flogger.FluentLogger log = com.google.common.flogger.FluentLogger.forEnclosingClass();
@JBosLog等价效果：private static final org.jboss.logging.Logger log = org.jboss.logging.Logger.getLogger(LogExample.class);
@Log等价效果：private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(LogExample.class.getName());
@Log4j等价效果：private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(LogExample.class);
@Log4j2等价效果：private static final org.apache.logging.log4j.Logger log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class);
@Slf4j等价效果：private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExample.class);
@XSlf4j等价效果:private static final org.slf4j.ext.XLogger log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);
@Slf4j 注解进行日志输出：@Slf4j
public class UserTests {
// ....
@Test
public void testLog() {
User5 user5 = new User5();
user5.setId(1);
user5.setUsername("user5");
user5.setPassword("zxc123");
log.warn("testLog: {}", user5);
// 21:57:15.488 [main] WARN com.one.learn.lombok.UserTests - testLog: User5(id=1, username=user5, password=zxc123)
}
}@Cleanup
@Cleanup 用于标记需要释放清理操作的资源对象变量，如 FileInputStream, FileOutputStream 等，标记之后资源对象使用完毕后，就会被自动关闭和清理，实际上这里 Lombok 实现效果与 Java7 特性try with resource 一样, 为我们屏蔽了关闭资源的模板代码，下面给出 @Cleanup 的使用示例：public class CleanupExample {
public static void main(String[] args) throws IOException {
@Cleanup InputStream in = new FileInputStream(args[0]);
@Cleanup OutputStream out = new FileOutputStream(args[1]);
byte[] b = new byte[10000];
while (true) {
int r = in.read(b);
if (r == -1) {
break;
}
out.write(b, 0, r);
}
}
}将
CleanupExample.java 编译生成的字节码反编译可以得到如下结果：public class CleanupExample {
//...
public static void main(String[] args) throws IOException {
FileInputStream in = new FileInputStream(args[0]);
try {
FileOutputStream out = new FileOutputStream(args[1]);
try {
byte[] b = new byte[10000];
while(true) {
int r = in.read(b);
if (r == -1) {
return;
}
out.write(b, 0, r);
}
} finally {
if (Collections.singletonList(out).get(0) != null) {
out.close();
}
}
} finally {
if (Collections.singletonList(in).get(0) != null) {
in.close();
}
}
}
}@SneakyThrows
@SneakyThrows 主要用于在没有 throws 关键字的情况下，隐蔽地抛出受检查异常，为我们平常开发中需要异常抛出时省去的 throw 操作,下面为使用 @SneakyThrows 的示例代码：public class SneakyThrowsExample implements Runnable {
@SneakyThrows(UnsupportedEncodingException.class)
public String utf8ToString(byte[] bytes) {
return new String(bytes, "UTF-8");
}@SneakyThrows
public void run() {
throw new Throwable();
}
}最终编译成字节码，反编译结果如下：
public class SneakyThrowsExample implements Runnable {
public SneakyThrowsExample() {
}public String utf8ToString(byte[] bytes) {
try {
return new String(bytes, "UTF-8");
} catch (UnsupportedEncodingException var3) {
throw var3;
}
}public void run() {
try {
throw new Throwable();
} catch (Throwable var2) {
throw var2;
}
}
}val/var
val/var 用于局部变量的修饰，有了这注解修饰后，变量的类型就会自动通过等号右边的表达式推断出来，这个功能借鉴于许多编程语言的自动类型推断的特性。 而val 与 var 的区别在于， val 用于修饰不可变变量，var 修饰可变变量。当 val 修饰的变量被重新赋值时，编译器就会提示异常：Error: java: 无法为最终变量 X 分配值。实际用法也比较简单，可参考下面代码：@Slf4j
public class VarValExample {
public static void main(String[] args) {
val text = "abc";
// text = "1";
// Error: java: 无法为最终变量 text 分配值`。
var num = 1;
num = 2;
log.info("text:{},num:{}", text, num);
// text:abc,num:2
}
}结语到这里我们学习了 Lombok 的近乎 80% 常用的注解，应用在我们的日常开发中已经是绰绰有余了，开始尝试 使用 Lombok 吧，慢慢地就会感受下效率的提升以及代码的优雅。
参考
- Project Lombok: https://projectlombok.org/
- https://stackabuse.com/project-lombok-reducing-java-boilerplate-code/
- Project Lombok: Reducing Java Boilerplate Code：https://stackabuse.com/project-lombok-reducing-java-boilerplate-code/
- Lombok常用注解的使用总结：https://segmentfault.com/a/1190000017459838
- Lombok @Builder with Inheritance: https://www.baeldung.com/lombok-builder
- http://blog.didispace.com/java-lombok-1/
- Lombok’s @Builder annotation and inheritance： https://reinhard.codes/2015/09/16/lomboks-builder-annotation-and-inheritance/
- Lombok：让JAVA代码更优雅：http://blog.didispace.com/java-lombok-1/
- Lombok 简介：https://mp.weixin.qq.com/s?__biz=MzIzNzYxNDYzNw==&mid=2247483823&idx=1&sn=ff10d5050e4c95d6724520a14a4f9528&chksm=e8c4a2eddfb32bfb8c9a11bca96461cfeb695914156c4ca1a06b52c99d80b9e6b7fe57eb817c&mpshare=1&scene=1&srcid=0601m7OKSdsR9JlWGGJPm3dX%23rd
推荐阅读
- Java技术指南「并发原理专题」AQS的技术体系之CLHMCS锁的原理及实现
- Java ASM系列（（056）opcode: method）
- 作为有经验的程序员如果不懂Lambda表达式就说不过去了吧，建议收藏！！！
- Java技术指南[Guava Collections]实战使用相关Guava不一般的集合框
- 面试java开发被问最多的“cookiesessiontoken”问题，安排！
- python通过Matplotlib绘制常见的几种图形
- java操作sql server数据库
- #导入MD文档图片#教你解决禁止F12调试Debugger丑化JS等反爬
- 在java程序中使用protobuf