Lombok介绍、使用方法和安装

news2025/1/8 18:07:16

目录

1 Lombok背景介绍

2 Lombok使用方法

2.1 @Data

2.2 @Getter/@Setter

2.3 @NonNull

2.4 @Cleanup

2.5 @EqualsAndHashCode

2.6 @ToString

2.7 @NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor

3 Lombok工作原理分析

4. Lombok的优缺点

5. 总结


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/setterequalshashcodetoString方法。出现的神奇就是在源码中没有gettersetter方法,但是在编译生成的字节码文件中有gettersetter方法。这样就省去了手动重建这些代码的麻烦,使代码看起来更简洁些。

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

<dependency>

    <groupId>org.projectlombok</groupId>

    <artifactId>lombok</artifactId>

    <version>1.16.20</version>

<scope>provided</scope>

</dependency>

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

2.1 @Data

        @Data注解在类上,会为类的所有属性自动生成setter/getterequalscanEqualhashCodetoString方法,如为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<T> {

    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 = (result*PRIME) + (this.getName() == null ? 43 : this.getName().hashCode());

    result = (result*PRIME) + this.getAge();

    result = (result*PRIME) + (int)(temp1 ^ (temp1 >>> 32));

    result = (result*PRIME) + Arrays.deepHashCode(this.getTags());

    return result;

  }

 

  public static class Exercise<T> {

    private final String name;

    private final T value;

    private Exercise(String name, T value) {

      this.name = name;

      this.value = value;

    }

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

      return new Exercise<T>(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 = (result*PRIME) + (this.getName() == null ? 43 : this.getName().hashCode());

      result = (result*PRIME) + (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 (true) {

          int r = in.read(b);

          if (r == -1) break;

          out.write(b, 0, r);

        }

      } finally {

        if (out != null) {

          out.close();

        }

      }

    } finally {

      if (in != null) {

        in.close();

      }

    }

  }

}

2.5 @EqualsAndHashCode

        默认情况下,会使用所有非静态(non-static)和非瞬态(non-transient)属性来生成equalshasCode,也能通过exclude注解来排除一些属性。

示例如下:

import lombok.EqualsAndHashCode;

@EqualsAndHashCode(exclude={"id", "shape"})

public class EqualsAndHashCodeExample {

  private transient int transientVar = 10;

  private String name;

  private double score;

  private Shape shape = new Square(5, 10);

  private String[] tags;

  private int id;

  public String getName() {

    return this.name;

  }

  @EqualsAndHashCode(callSuper=true)

  public static class Square extends Shape {

    private final int width, height;

    public Square(int width, int height) {

      this.width = width;

      this.height = height;

    }

  }

}

2.6 @ToString

        类使用@ToString注解,Lombok会生成一个toString()方法,默认情况下,会输出类名、所有属性(会按照属性定义顺序),用逗号来分割。

        通过将includeFieldNames参数设为true,就能明确的输出toString()属性。这一点是不是有点绕口,通过代码来看会更清晰些。

使用Lombok的示例:

import lombok.ToString;

@ToString(exclude="id")

public class ToStringExample {

  private static final int STATIC_VAR = 10;

  private String name;

  private Shape shape = new Square(5, 10);

  private String[] tags;

  private int id;

  public String getName() {

    return this.getName();

  }

  @ToString(callSuper=true, includeFieldNames=true)

  public static class Square extends Shape {

    private final int width, height;

   

    public Square(int width, int height) {

      this.width = width;

      this.height = height;

    }

  }

}

不使用Lombok的示例如下:

import java.util.Arrays;

public class ToStringExample {

  private static final int STATIC_VAR = 10;

  private String name;

  private Shape shape = new Square(5, 10);

  private String[] tags;

  private int id;

  public String getName() {

    return this.getName();

  }

  public static class Square extends Shape {

    private final int width, height;

    public Square(int width, int height) {

      this.width = width;

      this.height = height;

    }

    @Override public String toString() {

      return "Square(super=" + super.toString() + ", width=" + this.width + ", height=" + this.height + ")";

    }

  }

  @Override public String toString() {

    return "ToStringExample(" + this.getName() + ", " + this.shape + ", " + Arrays.deepToString(this.tags) + ")";

  }

}

2.7 @NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor

        无参构造器、部分参数构造器、全参构造器。Lombok没法实现多种参数构造器的重载。

Lombok示例代码如下:

import lombok.AccessLevel;

import lombok.RequiredArgsConstructor;

import lombok.AllArgsConstructor;

mport lombok.NonNull;

@RequiredArgsConstructor(staticName = "of")

@AllArgsConstructor(access = AccessLevel.PROTECTED)public class ConstructorExample<T> {

  private int x, y;

  @NonNull private T description;

 

  @NoArgsConstructor

  public static class NoArgsExample {

    @NonNull private String field;

  }

}

不使用Lombok的示例如下:

public class ConstructorExample<T> {

  private int x, y;

  @NonNull private T description;

  private ConstructorExample(T description) {

    if (description == null) throw new NullPointerException("description");

    this.description = description;

  }

  public static <T> ConstructorExample<T> of(T description) {

    return new ConstructorExample<T>(description);

  }

  @java.beans.ConstructorProperties({"x", "y", "description"})

  protected ConstructorExample(int x, int y, T description) {

    if (description == null) throw new NullPointerException("description");

    this.x = x;

    this.y = y;

    this.description = description;

  }

  public static class NoArgsExample {

    @NonNull private String field;

    public NoArgsExample() {

    }

  }

}

3 Lombok工作原理分析

        会发现在Lombok使用的过程中,只需要添加相应的注解,无需再为此写任何代码。自动生成的代码到底是如何产生的呢?

        核心之处就是对于注解的解析上。JDK5引入了注解的同时,也提供了两种解析方式。

  • 运行时解析

        运行时能够解析的注解,必须将@Retention设置为RUNTIME,这样就可以通过反射拿到该注解。java.lang,reflect反射包中提供了一个接口AnnotatedElement,该接口定义了获取注解信息的几个方法,ClassConstructorFieldMethodPackage等都实现了该接口,对反射熟悉的朋友应该都会很熟悉这种解析方式。

  • 编译时解析

        编译时解析有两种机制,分别简单描述下:

1Annotation Processing Tool

        apt自JDK5产生,JDK7已标记为过期,不推荐使用,JDK8中已彻底删除,自JDK6开始,可以使用Pluggable Annotation Processing API来替换它,apt被替换主要有2点原因:

  • api都在com.sun.mirror非标准包下
  • 没有集成到javac中,需要额外运行

2Pluggable Annotation Processing API

JSR 269      JSR 269自JDK6加入,作为apt的替代方案,它解决了apt的两个问题,javac在执行的时候会调用实现了该API的程序,这样我们就可以对编译器做一些增强,这时javac执行的过程如下:

        Lombok本质上就是一个实现了JSR 269 API的程序。在使用javac的过程中,它产生作用的具体流程如下:

  1. javac对源代码进行分析,生成了一棵抽象语法树(AST
  2. 运行过程中调用实现了“JSR 269 API”Lombok程序
  3. 此时Lombok就对第一步骤得到的AST进行处理,找到@Data注解所在类对应的语法树(AST),然后修改该语法树(AST),增加gettersetter方法定义的相应树节点
  4. javac使用修改后的抽象语法树(AST)生成字节码文件,即给class增加新的节点(代码块)

        拜读了Lombok源码,对应注解的实现都在HandleXXX中,比如@Getter注解的实现时HandleGetter.handle()。还有一些其它类库使用这种方式实现,比如Google AutoDagger等等。

4. Lombok的优缺点

优点:

  1. 能通过注解的形式自动生成构造器、getter/setterequalshashcodetoString等方法,提高了一定的开发效率
  2. 让代码变得简洁,不用过多的去关注相应的方法
  3. 属性做修改时,也简化了维护为这些属性所生成的getter/setter方法等

缺点:

  1. 不支持多种参数构造器的重载
  2. 虽然省去了手动创建getter/setter方法的麻烦,但大大降低了源代码的可读性和完整性,降低了阅读源代码的舒适度

5. 总结

        Lombok虽然有很多优点,但Lombok更类似于一种IDE插件,项目也需要依赖相应的jar包。Lombok依赖jar包是因为编译时要用它的注解,为什么说它又类似插件?因为在使用时,eclipseIntelliJ IDEA都需要安装相应的插件,在编译器编译时通过操作AST(抽象语法树)改变字节码生成,变向的就是说它在改变java语法。它不像spring的依赖注入或者mybatisORM一样是运行时的特性,而是编译时的特性。这里我个人最感觉不爽的地方就是对插件的依赖!因为Lombok只是省去了一些人工生成代码的麻烦,但IDE都有快捷键来协助生成getter/setter等方法,也非常方便。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/1664484.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

网络匿名--不只是TOR

今天&#xff0c;我们将讨论互联网匿名和隐私&#xff1a; 如何隐藏你的真实身份。 什么是 TOR 。 如何以完全匿名的方式执行黑客任务。 如何使用proxy chain。 如何让我们的匿名性领先一步。 如何使用特定的操作系统保持匿名。 结论&#xff0c;如何实现互联网匿名和隐…

Nginx或Tengine服务器配置SSL证书

目录 前提条件 步骤一&#xff1a;下载SSL证书 步骤二&#xff1a;在Nginx服务器安装证书 步骤三&#xff1a;验证SSL证书是否配置成功 前提条件 已通过数字证书管理服务控制台签发证书SSL证书绑定的域名已完成DNS解析&#xff0c;即您的域名与主机IP地址相互映射已在Web服…

python自动化办公的代码

以下是一个简单的Python自动化办公代码示例&#xff0c;用于实现一些基本的自动化任务&#xff0c;例如打开文件、读取数据、写入数据和保存文件等。 python import os # 打开文件 def open_file(filename): try: file open(filename, r) data file.read() file.close() ret…

【SpringBoot记录】自动配置原理(3):自动配置注解

前言 如果对注解有不太了解的&#xff0c;先行了解注解。这里做个简单的说明&#xff0c;个人理解注解就是对类、接口、方法、属性等添加一个标识&#xff0c;这些标识可以被编译器、开发工具或运行时环境识别&#xff0c;识别后即可在不改变原业务逻辑的情况下进行一些特定的…

记录一次接口优化的过程。接口响应时间从500s下降到5s。

记录一次接口优化的过程。接口响应时间从500s下降到5s。 接口说明&#xff1a; 该接口通过用户导入的一年内每天的厂区用电功率数据来计算用户安装储能设备后的收益情况。 用电功率数据具体为每15分钟一条&#xff0c;一年约有 12*30*24*4 34560 条。 代码循环情况为&…

python实现pip一键切换国内镜像源脚本分享

本文主要分享一个自己写的pip一键切换国内镜像源python脚本 import subprocess# pip 国内镜像源加速 source_urls [{"name": "默认镜像源", "url": ""},{"name": "清华大学镜像源(推荐使用)", "url": …

CLIP 浅析

CLIP 浅析 文章目录 CLIP 浅析概述如何训练CLIP如何使用Clip进行图像分类优缺点分析优点缺点 概述 CLIP的英文全称是Contrastive Language-Image Pre-training&#xff0c;即一种基于对比文本-图像对的预训练方法或者模型。 如何训练CLIP CLIP包括两个模型&#xff1a;Text …

用友畅捷通T+ keyEdit sql注入漏洞

产品介绍 畅捷通 T 是一款灵动&#xff0c;智慧&#xff0c;时尚的基于互联网时代开发的管理软件&#xff0c;主要针对中小型工贸与商贸企业&#xff0c;尤其适合有异地多组织机构&#xff08;多工厂&#xff0c;多仓库&#xff0c;多办事处&#xff0c;多经销商&#xff09;的…

java--io流(二)

一、打印流&#xff08;PrintStream[字节]、PrintWriter[字符]&#xff09; &#xff08;基本上可以代替前面所学的字节、字符输出流&#xff09;&#xff0c;二者关于打印数据功能相同&#xff08;都方便且高效&#xff09;&#xff0c;但是关于数据写出不同&#xff0c;前者…

数字孪生引擎国产信创环境适配靠谱么?

近期我们组织了一次国产化环境适配以及产品国产化产品替换的交流&#xff0c;虽然从属于不同的业务条线&#xff0c;但是在过去一段时间多多少少都承受不同程度的信创压力&#xff0c;尤其是自然资源业务方面&#xff0c;由于自然资源大多数的业务是属于强GIS的范畴&#xff0c…

未来娱乐新地标?气膜球幕影院的多维体验—轻空间

在中国&#xff0c;一座独特的娱乐场所正在崭露头角&#xff1a;气膜球幕影院。这个融合了气膜建筑与激光投影技术的创新场所&#xff0c;不仅令人惊叹&#xff0c;更带来了前所未有的科幻娱乐体验。让我们一起探索这个未来的娱乐空间&#xff0c;感受其中的多维魅力。 现场演出…

电脑复制和粘贴的时候会出现Hello!

电脑不管是Microsoft Excel还是Microsoft Word复制之后粘贴过来就出现HELLO&#xff0c;当复制粘贴文件的时候就会出现WINFILE&#xff1b; 具体现象看下面两个图片&#xff1a; 这是因为winfile 文件病毒&#xff08;幽灵蠕虫病毒&#xff09;,每月的28号发作&#xff1b; 症状…

基础I/O:文件系统调用接口

文章目录 文件系统调用接口open系统调用接口和C语言封装文件描述符fd重定向 文件系统调用接口 open NAME//打开、创建 - 打开并可能创建文件或设备open, creat - open and possibly create a file or deviceSYNOPSIS#include <sys/types.h>#include <sys/stat.h>…

【数据结构】顺序表与链表的差异

顺序表和链表都是线性表&#xff0c;它们有着相似的部分&#xff0c;但是同时也有着很大的差异。 存储空间上的差异&#xff1a; 对于插入上的不同点&#xff0c;顺序表在空间不够时需要扩容&#xff0c;而如果在使用realloc函数去扩容&#xff0c;会有原地扩容和异地扩容两种情…

DDS块集是如何工作的?

DDS块集使你能够在Simulink中创建DDS应用程序。如果你有一个在Simulink中建模的应用程序&#xff0c;希望能够使用DDS&#xff0c;则可以使用DDS块集轻松连接到DDS中间件平台。 DDS块集将DDS概念引入Simulink环境&#xff0c;在Simulink应用程序中对这些概念进行建模&#xff0…

Failed to parse source map (@toast-ui/editor/dist/purify.js.map)

使用 toast-ui-editor 时出现报错&#xff1a;Failed to parse source map (toast-ui/editor/dist/purify.js.map) 解决方法很简单&#xff1a; "start": "set "GENERATE_SOURCEMAPfalse" && react-scripts start ",在启动脚本时添加执…

PTP 对时协议 IEEE1588 网络对时 计算原理

前言 本文将阐述 PTP 对时协议的原理&#xff0c;slave 节点如何根据获取的时间来纠正和更新自己的时间。 协议概述 整个通讯过程中会发送 4 种类型的数据包&#xff0c;用来支撑对时。下面是 4 个包的解释 Sync message: 由 master 发送&#xff0c;发起对时事务, slave 接…

用于视频识别的快慢网络

提示&#xff1a;文章写完后&#xff0c;目录可以自动生成&#xff0c;如何生成可参考右边的帮助文档 文章目录 摘要Abstract文献阅读&#xff1a;用于视频识别的快慢网络1、文献摘要2、提出方法2.1、SlowFast模型2.2、SlowFast 提出思想 3、相关方法3.1、时空间卷积3.2、基于光…

交通数据三维可视化呈现与可视化分析系统开发(附程序源码)

目录 01 系统介绍 02 功能介绍 文件管理功能 模型研究 可视化分析功能 今天分享一套“交通数据三维可视化呈现与可视化分析系统”&#xff0c;并开放程序源代码下载&#xff0c;内容涉及开源空间数据库的使用、三维引擎的二次开发、矢量和栅格数据管理、交通流量分析模型框…

C语言----斐波那契数列

各位看官们好&#xff0c;当我写了上一篇博客杨辉三角后&#xff0c;有一些看官叫我讲一下斐波那契数列。对于这个大家应该是有了解的。最简单的规律就是f(n)f(n-2)f(n-1)。就是当前是前两项之和&#xff0c;然后下标1和0都是1.从第三项开始计算的。那么我们知道规律&#xff0…