技术笔记: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);


相关文章
|
10天前
|
存储 监控 安全
单位网络监控软件:Java 技术驱动的高效网络监管体系构建
在数字化办公时代,构建基于Java技术的单位网络监控软件至关重要。该软件能精准监管单位网络活动,保障信息安全,提升工作效率。通过网络流量监测、访问控制及连接状态监控等模块,实现高效网络监管,确保网络稳定、安全、高效运行。
38 11
|
19天前
|
XML Java 编译器
Java注解的底层源码剖析与技术认识
Java注解(Annotation)是Java 5引入的一种新特性,它提供了一种在代码中添加元数据(Metadata)的方式。注解本身并不是代码的一部分,它们不会直接影响代码的执行,但可以在编译、类加载和运行时被读取和处理。注解为开发者提供了一种以非侵入性的方式为代码提供额外信息的手段,这些信息可以用于生成文档、编译时检查、运行时处理等。
56 7
|
1天前
|
移动开发 前端开发 Java
Java最新图形化界面开发技术——JavaFx教程(含UI控件用法介绍、属性绑定、事件监听、FXML)
JavaFX是Java的下一代图形用户界面工具包。JavaFX是一组图形和媒体API,我们可以用它们来创建和部署富客户端应用程序。 JavaFX允许开发人员快速构建丰富的跨平台应用程序,允许开发人员在单个编程接口中组合图形,动画和UI控件。本文详细介绍了JavaFx的常见用法,相信读完本教程你一定有所收获!
Java最新图形化界面开发技术——JavaFx教程(含UI控件用法介绍、属性绑定、事件监听、FXML)
|
22天前
|
安全 Java 编译器
Kotlin教程笔记(27) -Kotlin 与 Java 共存(二)
Kotlin教程笔记(27) -Kotlin 与 Java 共存(二)
|
22天前
|
Java 开发工具 Android开发
Kotlin教程笔记(26) -Kotlin 与 Java 共存(一)
Kotlin教程笔记(26) -Kotlin 与 Java 共存(一)
|
19天前
|
JavaScript 安全 Java
java版药品不良反应智能监测系统源码,采用SpringBoot、Vue、MySQL技术开发
基于B/S架构,采用Java、SpringBoot、Vue、MySQL等技术自主研发的ADR智能监测系统,适用于三甲医院,支持二次开发。该系统能自动监测全院患者药物不良反应,通过移动端和PC端实时反馈,提升用药安全。系统涵盖规则管理、监测报告、系统管理三大模块,确保精准、高效地处理ADR事件。
|
29天前
|
Java 编译器 Android开发
Kotlin教程笔记(28) -Kotlin 与 Java 混编
Kotlin教程笔记(28) -Kotlin 与 Java 混编
32 2
|
1月前
|
监控 前端开发 Java
【技术开发】接口管理平台要用什么技术栈?推荐:Java+Vue3+Docker+MySQL
该文档介绍了基于Java后端和Vue3前端构建的管理系统的技术栈及功能模块,涵盖管理后台的访问、登录、首页概览、API接口管理、接口权限设置、接口监控、计费管理、账号管理、应用管理、数据库配置、站点配置及管理员个人设置等内容,并提供了访问地址及操作指南。
|
1月前
|
存储 Java 开发者
Java 中 Set 类型的使用方法
【10月更文挑战第30天】Java中的`Set`类型提供了丰富的操作方法来处理不重复的元素集合,开发者可以根据具体的需求选择合适的`Set`实现类,并灵活运用各种方法来实现对集合的操作和处理。
|
21天前
|
Java 数据库连接 编译器
Kotlin教程笔记(29) -Kotlin 兼容 Java 遇到的最大的“坑”
Kotlin教程笔记(29) -Kotlin 兼容 Java 遇到的最大的“坑”
37 0