Lombok 是一个用于 Java 的库，能够显著减少样板代码（boilerplate code），使代码更加简洁和易于维护。以下是对 Lombok 的一些常见用法的介绍。
1. 安装 Lombok
要使用 Lombok，首先需要在项目中引入它。对于 Maven 项目，可以在 pom.xml 中添加以下依赖：
<dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>1.18.24</version><scope>provided</scope>
</dependency>
对于 Gradle 项目，可以在 build.gradle 中添加以下依赖：
dependencies {compileOnly 'org.projectlombok:lombok:1.18.24'annotationProcessor 'org.projectlombok:lombok:1.18.24'
}
2. 常见注解
@Getter 和 @Setter
@Getter 和 @Setter 注解可以自动生成 getter 和 setter 方法。
import lombok.Getter;
import lombok.Setter;public class User {@Getter @Setter private String name;@Getter @Setter private int age;
}
@ToString
@ToString 注解可以自动生成 toString() 方法。
import lombok.ToString;@ToString
public class User {private String name;private int age;
}
@EqualsAndHashCode
@EqualsAndHashCode 注解可以自动生成 equals() 和 hashCode() 方法。
import lombok.EqualsAndHashCode;@EqualsAndHashCode
public class User {private String name;private int age;
}
@NoArgsConstructor, @AllArgsConstructor 和 @RequiredArgsConstructor
这些注解可以自动生成无参构造函数、全参构造函数和带有必需参数的构造函数。
import lombok.NoArgsConstructor;
import lombok.AllArgsConstructor;
import lombok.RequiredArgsConstructor;@NoArgsConstructor
@AllArgsConstructor
@RequiredArgsConstructor
public class User {private final String name;private int age;
}
@Data
@Data 是一个组合注解，包括 @Getter、@Setter、@ToString、@EqualsAndHashCode 和 @RequiredArgsConstructor。
import lombok.Data;@Data
public class User {private final String name;private int age;
}
@Builder
@Builder 注解可以实现构建器模式，允许以流式 API 的方式创建对象。
import lombok.Builder;@Builder
public class User {private String name;private int age;
}// 使用方式
User user = User.builder().name("Alice").age(30).build();
3. 高级用法
@Value
@Value 注解是 @Data 的不可变版本，所有字段都是 private final 的，且类本身是 final 的。
import lombok.Value;@Value
public class User {String name;int age;
}
@SneakyThrows
@SneakyThrows 注解允许你在方法中抛出受检异常而无需显式地在方法签名中声明。
import lombok.SneakyThrows;public class Example {@SneakyThrowspublic void run() {throw new Exception("Exception");}
}
@Delegate
@Delegate 注解可以将接口的方法委托给一个字段，从而实现装饰器模式。
import lombok.Delegate;public class UserService {@Delegateprivate final UserRepository userRepository = new UserRepositoryImpl();
}
4. Lombok 与 IDE 集成
为了在 IDE 中获得更好的体验，需要安装 Lombok 插件。例如，在 IntelliJ IDEA 中，可以通过以下步骤安装插件：
- 打开 IntelliJ IDEA。
- 进入
File > Settings > Plugins。 - 搜索 “Lombok” 并安装。
- 重启 IDE。
结论
Lombok 是一个强大的工具，可以显著减少 Java 代码中的样板代码。通过使用 Lombok 的各种注解，你可以让代码更加简洁、可读，并且易于维护。在实际项目中，合理使用 Lombok 可以提高开发效率和代码质量。
