Lombok

最新推荐文章于 2022-02-23 10:30:54 发布
最新推荐文章于 2022-02-23 10:30:54 发布
阅读量84 收藏
点赞数
分类专栏： Lombok
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_37054816/article/details/104389336
版权

Lombok能通过注解的方式，在编译时自动为属性生成构造器、getter/setter、equals、hashcode、toString方法。在源码中没有getter和setter方法，但是在编译生成的字节码文件中有getter和setter方法。

Lombok的使用跟引用jar包一样，可以在官网（https://projectlombok.org/download）下载jar包，也可以使用maven添加依赖：



<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.16.20</version>
    <scope>provided</scope>
</dependency>

具体

@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<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;
    }
  }
}

@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;
  }
}

@EqualsAndHashCode

默认情况下，会使用所有非静态（non-static）和非瞬态（non-transient）属性来生成equals和hasCode，也能通过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;
    }
  }
}

@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) + ")";
  }
}

@NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor

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

Lombok示例代码如下：

import lombok.AccessLevel;
import lombok.RequiredArgsConstructor;
import lombok.AllArgsConstructor;
import 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() {
    }
  }
}

 

风在咆哮
关注
专栏目录
lombok 1.18.24
05-26
Lombok 是一个 Java 开发工具，它通过注解处理器在编译时自动插入代码，以减少样板代码。Lombok 的最新版本是 1.18.24，这个版本修复了一些已知问题，并可能引入了新的特性或改进。在 Java 开发中，Lombok 提供的...
lombok-jar包.zip
09-03
Lombok是一款非常流行的Java库，它通过提供一系列的注解，极大地简化了Java代码的编写，尤其是减少了getter、setter、equals、hashCode、toString等方法的编写。这个"lombok-jar包.zip"文件包含了Lombok的jar包，是...
Lombok链式调用，子类对象set父类属性，返回父类对象
ql_7256的博客
09-13 8645
前言 lombok相信大家都用过，没用过肯定也不会点进来，一直用着都很舒服。今但是天在码代码时，碰到了一个问题，卡了半天。问题是这样的：Lombok链式调用父类中的set属性时，返回的居然是一个父类对象，紧靠文字描述，可能比较抽象，代码如下： 子类实体 父类实体 其实就是实体间的继承，把公共的字段抽取出来，具体的实体继承。我这里的JcZyyhzh继承了BaseCompanyIdEntity，BaseCompanyIdEntity其实还继承了BaseIdEntity，因为和我们今天主题扯不上关系，就没贴出
lombok使用
Significance的博客
08-10 701
一、@Accessors @Accessors,主要用于控制生成的getter和setter,主要参数介绍 fluent boolean值，默认为false。此字段主要为控制生成的getter和setter方法前面是否带get/set chain boolean值，默认false。如果设置为true，setter返回的是此对象，方便链式调用方法 prefix 设置前缀 例如：@Accessors(prefix = "abc") private String abcAge 当生成get/set方法时，会把此
IDEA使用lombok
qq_53121751的博客
02-23 5127
一、lombok插件介绍 说明：常规开发中POJO类必须手写get/set/toString 方法，这类操作写起来还是比较麻烦的，但是又不得不写，开发效率低，索引引用了lombok插件，简化上述过程 二、插件安装 maven引入jar包 <!--添加lombok的包--> <dependency> <groupId>org.projectlombok</groupId> <art
Lombok常用注解总结
ACGkaka的博客
12-22 1834
Lombok常用注解总结
史上最全 Lombok Features 注解详解
riemann_的博客
04-08 4172
文章目录一、@Getter and @Setter二、@ToString三、@EqualsAndHashCode四、@AllArgsConstructor, @RequiredArgsConstructor and @NoArgsConstructor五、@Data六、@Value七、@Builder八、@Accessors九、@Slf4j and @Log4j十、@NonNull十一、@Sync...
lombok_lombok_源码.zip
09-30
Lombok 是一个 Java 开发工具库，它通过注解处理器自动为 Java 类生成常见的 getter、setter、构造器、equals、hashCode 和 toString 方法，极大地减少了样板代码。本压缩包"Lombok_lombok_源码.zip"包含了 Lombok ...
Lombok-开源
07-01
**Lombok 深度解析：提升 Java 代码效率与简洁性的开源利器** Lombok 是一个流行的 Java 库，由 Rangka 开发并维护，它通过注解处理器技术为 Java 开发者提供了极大的便利。Lombok 的核心目标是减少 Java 代码中的...
lombok-1.16.10-API文档-中文版.zip
06-20
赠送jar包：lombok-1.16.10.jar； 赠送原API文档：lombok-1.16.10-javadoc.jar； 赠送源代码：lombok-1.16.10-sources.jar； 赠送Maven依赖信息文件：lombok-1.16.10.pom； 包含翻译后的API文档：lombok-1.16.10-...
使用lombok提高编码效率
热门推荐
再见尼罗河的博客
06-18 4万+
Lombok简介 lombok项目通过增加处理程序使我们的java语言更加刺激（简洁和快速）。
Lombok使用示例详情
人不风流枉少年
03-09 2万+
简介 Lombok是一个可以通过注解来帮助我们简化消除一些必须有但显得很臃肿的Java代码的一种工具，通过使用对应的注解，可以在编译源码的时候动态添加源码。 例如在实体中经常见到一堆Getter和Setter方法，这些方法是必要的不可缺少的，但是这些代码感觉却像是“垃圾”，看起来重复而臃肿，看起来也不美观，也不简洁清爽，可以使用lombok，在类上直接使用@Getter @Setter 这两...
lombok使用详解
Grace
04-23 2696
官网地址： https://www.projectlombok.org/  Project Lombok是一个java库，它可以自动插入到编辑器中，并构建工具，使java更加丰富。再也不要写另一个getter或equals方法了。尽早访问未来的java特性，比如val，等等。  不仅仅只有get/set/tostring方法的自动生成哦，还有exception/log/资源自动释放（如文件流的输入...
Lombok介绍、使用方法和总结
weixin_34235371的博客
03-26 826
同步首发：http://www.yuanrengu.com/index.php/20180324.html 1 Lombok背景介绍 官方介绍如下： Project Lombok makes java a spicier language by adding 'handlers' that know how to build and compile simple, boilerplate-fre...
减少你的重复代码-lombok使用教程-idea集成插件
KimZing的博客
04-14 4926
简介 大部分项目中都必不可少的包含数据库实体(Entity)、数据载体(dto,dataObject),而这两部分都包含着大量的没有业务逻辑的setter、getter、空参构造，同时我们一般要复写类的toString(),equals(),hashCode()方法(贫血模型)。这些工作都是重复性的工作，作为程序员，懒是必备素质之一，这些工作肯定已经有大牛封装好了处理方法,这就是lombok。
lombok 介绍及基本使用方法
左小轩的博客
07-27 2265
Lombok是一个基于LGPL的开源J2EE综合开发环境的Eclipse插件，对编码，发布，测试，以及debug等各个软件开发的生命周期提供支持，支持JSP,EJB等。Lomboz是Eclipse的一个J2EE的插件，它将很多Java应用服务器、J2EE组件和Web应用开发集成到Eclipse中，可以帮助Java开发者使用Eclipse建立、测试、部署J2EE应用。 lombok 的官方网址：h
lombok使用简介
程序员青戈
12-01 4746
原文地址：http://www.jianshu.com/p/365ea41b3573 Lombok简介 Lombok是一个可以通过简单的注解形式来帮助我们简化消除一些必须有但显得很臃肿的Java代码的工具，通过使用对应的注解，可以在编译源码的时候生成对应的方法。官方地址：https://projectlombok.org/，github地址：ht
Lombok常用注解
dxx707099957的博客
07-22 918
加入 maven 依赖 <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.12</version> </dependency> 1. @Getter/@Setter 自动产生 getter/setter ...
黑马程序员_基础测试题详解
webdev
12-19 684
----------------------ASP.Net+Android+IOS开发.Net培训、期待与您交流！---------------------- 1.编写一个函数，函数内输出一个字符串，并在主函数内调用它。 package com.itheima; /* * 题目： 编写一个函数，函数内输出一个字符串，并在主函数内调用它。 * 分析：1.首先写一个静态的 void类型...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值