技术笔记:Lombok介绍、使用方法和总结

简介: 技术笔记:Lombok介绍、使用方法和总结

同步首发:


1 Lombok背景介绍


官方介绍如下:


Project Lombok makes java a spicier language by adding 'handlers' that know how to build and compile simple, boilerplate-free, not-quite-java code.


大致意思是Lombok通过增加一些“处理程序”,可以让java变得简洁、快速。


2 Lombok使用方法


Lombok能以简单的注解形式来简化java代码,提高开发人员的开发效率。例如开发中经常需要写的javabean,都需要花时间去添加相应的getter/setter,也许还要去写构造器、equals等方法,而且需要维护,当属性多时会出现大量的getter/setter方法,这些显得很冗长也没有太多技术含量,一旦修改属性,就容易出现忘记修改对应方法的失误。


Lombok能通过注解的方式,在编译时自动为属性生成构造器、getter/setter、equals、hashcode、toString方法。出现的神奇就是在源码中没有getter和setter方法,但是在编译生成的字节码文件中有getter和setter方法。这样就省去了手动重建这些代码的麻烦,使代码看起来更简洁些。


Lombok的使用跟引用jar包一样,可以在官网(下载jar包,也可以使用maven添加依赖:


[/span>dependency

[/span>groupId

[/span>artifactId

[/span>version

[/span>scope


接下来我们来分析Lombok中注解的具体用法。


2.1 @Data


@Data注解在类上,会为类的所有属性自动生成setter/getter、equals、canEqual、hashCode、toString方法,如为final属性,则不会为该属性生成setter方法。


官方实例如下:


import lombok.AccessLevel;


import lombok.Setter;


import lombok.Data;


import lombok.ToString;


@Data public class DataExample {


private final String name;


@Setter(AccessLevel.PACKAGE) private int age;


private double score;


private String【】 tags;


@ToString(includeFieldNames=true)


@Data(staticConstructor="of")


public static class Exercise {


private final String name;


private final T value;


}


}


如不使用Lombok,则实现如下:


import java.util.Arrays;


public class DataExample {


private final String name;


private int age;


private double score;


private String【】 tags;


public DataExample(String name) {


this.name = name;


}


public String getName() {


return this.name;


}


void setAge(int age) {


this.age = age;


}


public int getAge() {


return this.age;


}


public void setScore(double score) {


this.score = score;


}


public double getScore() {


return this.score;


}


public String【】 getTags() {


return this.tags;


}


public void setTags(String【】 tags) {


this.tags = tags;


}


@Override public String toString() {


return "DataExample(" + this.getName() + ", " + this.getAge() + ", " + this.getScore() + ", " + Arrays.deepToString(this.getTags()) + ")";


}


protected boolean canEqual(Object other) {


return other instanceof DataExample;


}


@Override public boolean equals(Object o) {


if (o == this) return true;


if (!(o instanceof DataExample)) return false;


DataExample other = (DataExample) o;


if (!other.canEqual((Object)this)) return false;


if (this.getName() == null ? other.getName() != null : !this.getName().equals(other.getName())) return false;


if (this.getAge() != other.getAge()) return false;


if (Double.compare(this.getScore(), other.getScore()) != 0) return false;


if (!Arrays.deepEquals(this.getTags(), other.getTags())) return false;


return true;


}


@Override public int hashCode() {


final int PRIME = 59;


int result = 1;


final long temp1 = Double.doubleToLongBits(this.getScore());


result = (resultPRIME) + (this.getName() == null ? 43 : this.getName().hashCode());


result = (resultPRIME) + this.getAge();


result = (resultPRIME) + (int)(temp1 ^ (temp1 ]> 32));


result = (resultPRIME) + Arrays.deepHashCode(this.getTags());


return result;


}


public static class Exercise {


private final String name;


private final T value;


private Exercise(String name, T value) {


this.name = name;


this.value = value;


}


public static Exercise of(String name, T value) {


return new Exercise(name, value);


}


public String getName() {


return this.name;


}


public T getValue() {


return this.value;


}


@Override public String toString() {


return "Exercise(name=" + this.getName() + ", value=" + this.getValue() + ")";


}


protected boolean canEqual(Object other) {


return other instanceof Exercise;


}


@Override public boolean equals(Object o) {


if (o == this) return true;


if (!(o instanceof Exercise)) return false;


Exercise other = (Exercise) o;


if (!other.canEqual((Object)this)) return false;


if (this.getName() == null ? other.getValue() != null : !this.getName().equals(other.getName())) return false;


if (this.getValue() == null ? other.getValue() != null : !this.getValue().equals(other.getValue())) return false;


return true;


}


@Override public int hashCode() {


final int PRIME = 59;


int result = 1;


result = (resultPRIME) + (this.getName() == null ? 43 : this.getName().hashCode());


result = (resultPRIME) + (this.getValue() == null ? 43 : this.getValue().hashCode());


return result;


}


}


}


2.2 @Getter/@Setter


如果觉得@Data太过残暴(因为@Data集合了@ToString、@EqualsAndHashCode、@Getter/@Setter、@RequiredArgsConstructor的所有特性)不够精细,可以使用@Getter/@Setter注解,此注解在属性上,可以为相应的属性自动生成Getter/Setter方法,示例如下:


import lombok.AccessLevel;


import lombok.Getter;


import lombok.Setter;


public class GetterSetterExample {


@Getter @Setter private int age = 10;


@Setter(AccessLevel.PROTECTED) private String name;


@Override public String toString() {


return String.format("%s (age: %d)", name, age);


}


}


如果不使用Lombok:


public class GetterSetterExample {


private int age = 10;


private String name;


@Override public String toString() {


return String.format("%s (age: %d)", name, age);


}


public int getAge() {


return age;


}


public void setAge(int age) {


this.age = age;


}


protected void setName(String name) {


this.name = name;


}


}


2.3 @NonNull


该注解用在属性或构造器上,Lombok会生成一个非空的声明,可用于校验参数,能帮助避免空指针。


示例如下:


import lombok.NonNull;


public class NonNullExample extends Something {


private String name;


public NonNullExample(@NonNull Person person) {


super("Hello");


this.name = person.getName();


}


}


不使用Lombok:


import lombok.NonNull;


public class NonNullExample extends Something {


private String name;


public NonNullExample(@NonNull Person person) {


super("Hello");


if (person == null) {


throw new NullPointerException("person");


}


this.name = person.getName();


}


}


2.4 @Cleanup


该注解能帮助我们自动调用close()方法,很大的简化了代码。


示例如下:


import lombok.Cleanup;


import java.io.;


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);


}


}


}


如不使用Lombok,则需如下:


import java.io.;


public class CleanupExample {


public static void main(String【】 args) throws IOException {


InputStream in = new FileInputStream(args【0】);


try {


OutputStream out = new FileOutputStream(args【1】);


try {


byte【】 b = new byte【10000】;


while //代码效果参考:http://www.jhylw.com.cn/303634411.html

(true) {

int r = in.read(b);


相关文章
|
2月前
|
监控 Cloud Native Java
Quarkus 云原生Java框架技术详解与实践指南
本文档全面介绍 Quarkus 框架的核心概念、架构特性和实践应用。作为新一代的云原生 Java 框架,Quarkus 旨在为 OpenJDK HotSpot 和 GraalVM 量身定制,显著提升 Java 在容器化环境中的运行效率。本文将深入探讨其响应式编程模型、原生编译能力、扩展机制以及与微服务架构的深度集成,帮助开发者构建高效、轻量的云原生应用。
285 44
|
2月前
|
安全 Java API
Java Web 在线商城项目最新技术实操指南帮助开发者高效完成商城项目开发
本项目基于Spring Boot 3.2与Vue 3构建现代化在线商城,涵盖技术选型、核心功能实现、安全控制与容器化部署,助开发者掌握最新Java Web全栈开发实践。
327 1
|
3月前
|
安全 Java 编译器
new出来的对象,不一定在堆上?聊聊Java虚拟机的优化技术:逃逸分析
逃逸分析是一种静态程序分析技术,用于判断对象的可见性与生命周期。它帮助即时编译器优化内存使用、降低同步开销。根据对象是否逃逸出方法或线程,分析结果分为未逃逸、方法逃逸和线程逃逸三种。基于分析结果,编译器可进行同步锁消除、标量替换和栈上分配等优化,从而提升程序性能。尽管逃逸分析计算复杂度较高,但其在热点代码中的应用为Java虚拟机带来了显著的优化效果。
112 4
|
3月前
|
Java API Maven
2025 Java 零基础到实战最新技术实操全攻略与学习指南
本教程涵盖Java从零基础到实战的全流程,基于2025年最新技术栈,包括JDK 21、IntelliJ IDEA 2025.1、Spring Boot 3.x、Maven 4及Docker容器化部署,帮助开发者快速掌握现代Java开发技能。
733 1
|
4月前
|
人工智能 Java
Java多任务编排技术
JDK 5引入Future接口实现异步任务处理,但获取结果不够灵活。Java 8新增CompletableFuture,实现异步任务编排,支持流式处理、多任务组合及异常处理,提升执行效率与代码可读性,简化并发编程复杂度。
105 0
|
2月前
|
IDE 安全 Java
Lombok 在企业级 Java 项目中的隐性成本:便利背后的取舍之道
Lombok虽能简化Java代码,但其“魔法”特性易破坏封装、影响可维护性,隐藏调试难题,且与JPA等框架存在兼容风险。企业级项目应优先考虑IDE生成、Java Records或MapStruct等更透明、稳健的替代方案,平衡开发效率与系统长期稳定性。
163 1
|
3月前
|
Java 测试技术 API
2025 年 Java 开发者必知的最新技术实操指南全览
本指南涵盖Java 21+核心实操,详解虚拟线程、Spring Boot 3.3+GraalVM、Jakarta EE 10+MicroProfile 6微服务开发,并提供现代Java开发最佳实践,助力开发者高效构建高性能应用。
543 4
|
2月前
|
安全 Cloud Native Java
Java 模块化系统(JPMS)技术详解与实践指南
本文档全面介绍 Java 平台模块系统(JPMS)的核心概念、架构设计和实践应用。作为 Java 9 引入的最重要特性之一,JPMS 为 Java 应用程序提供了强大的模块化支持,解决了长期存在的 JAR 地狱问题,并改善了应用的安全性和可维护性。本文将深入探讨模块声明、模块路径、访问控制、服务绑定等核心机制,帮助开发者构建更加健壮和可维护的 Java 应用。
231 0
|
3月前
|
JavaScript 安全 前端开发
Java开发:最新技术驱动的病人挂号系统实操指南与全流程操作技巧汇总
本文介绍基于Spring Boot 3.x、Vue 3等最新技术构建现代化病人挂号系统,涵盖技术选型、核心功能实现与部署方案,助力开发者快速搭建高效、安全的医疗挂号平台。
202 3
|
4月前
|
存储 Java Linux
操作系统层面视角下 Java IO 的演进路径及核心技术变革解析
本文从操作系统层面深入解析Java IO的演进历程,涵盖BIO、NIO、多路复用器及Netty等核心技术。分析各阶段IO模型的原理、优缺点及系统调用机制,探讨Java如何通过底层优化提升并发性能与数据处理效率,全面呈现IO技术的变革路径与发展趋势。
97 2