高效编码之Lombok

最新推荐文章于 2024-09-02 11:41:23 发布
最新推荐文章于 2024-09-02 11:41:23 发布
阅读量1k 收藏
点赞数
分类专栏： 开发工具

Lombok简介

Lombok是一个可以通过简单的注解形式来帮助我们简化消除一些必须有但显得很臃肿的Java代码的工具，通过使用对应的注解，可以在编译源码的时候生成对应的方法。官方地址：https://projectlombok.org/，github地址：https://github.com/rzwitserloot/lombok。

IntelliJ IDEA 使用它的方法

  • 先安装插件

Paste_Image.png

  • 然后引入lombok的jar包
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.16.14</version>
</dependency>

注解的介绍

官方注解介绍

  • @Getter and @Setter

    你可以用@Getter / @Setter注释任何字段（当然也可以注释到类上的），让lombok自动生成默认的getter / setter方法。
    默认生成的方法是public的，如果要修改方法修饰符可以设置AccessLevel的值，例如：@Getter(access = AccessLevel.PROTECTED)

Paste_Image.png

import lombok.AccessLevel;
import lombok.Getter;
import lombok.Setter;
public class User {
    @Getter(AccessLevel.PROTECTED) @Setter private Integer id;
    @Getter @Setter private String name;
    @Getter @Setter private String phone;
}

  • @ToString

    生成toString()方法，默认情况下，它会按顺序（以逗号分隔）打印你的类名称以及每个字段。可以这样设置不包含哪些字段@ToString(exclude = "id") / @ToString(exclude = {"id","name"})
    如果继承的有父类的话，可以设置callSuper 让其调用父类的toString()方法，例如：@ToString(callSuper = true)

import lombok.ToString;
@ToString(exclude = {"id","name"})
public class User {
  private Integer id;
  private String name;
  private String phone;
}

生成toString方法如下：

public String toString(){
  return "User(phone=" + phone + ")";
}

  • @EqualsAndHashCode

    生成hashCode()和equals()方法，默认情况下，它将使用所有非静态，非transient字段。但可以通过在可选的exclude参数中来排除更多字段。或者，通过在parameter参数中命名它们来准确指定希望使用哪些字段。

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

对比代码如下：

import java.util.Arrays;
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 transient int id;

 public String getName() {
   return this.name;
 }
 
 @Override public boolean equals(Object o) {
   if (o == this) return true;
   if (!(o instanceof EqualsAndHashCodeExample)) return false;
   EqualsAndHashCodeExample other = (EqualsAndHashCodeExample) o;
   if (!other.canEqual((Object)this)) return false;
   if (this.getName() == null ? other.getName() != null : !this.getName().equals(other.getName())) return false;
   if (Double.compare(this.score, other.score) != 0) return false;
   if (!Arrays.deepEquals(this.tags, other.tags)) return false;
   return true;
 }
 
 @Override public int hashCode() {
   final int PRIME = 59;
   int result = 1;
   final long temp1 = Double.doubleToLongBits(this.score);
   result = (result*PRIME) + (this.name == null ? 43 : this.name.hashCode());
   result = (result*PRIME) + (int)(temp1 ^ (temp1 >>> 32));
   result = (result*PRIME) + Arrays.deepHashCode(this.tags);
   return result;
 }
 
 protected boolean canEqual(Object other) {
   return other instanceof EqualsAndHashCodeExample;
 }
 
 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 boolean equals(Object o) {
     if (o == this) return true;
     if (!(o instanceof Square)) return false;
     Square other = (Square) o;
     if (!other.canEqual((Object)this)) return false;
     if (!super.equals(o)) return false;
     if (this.width != other.width) return false;
     if (this.height != other.height) return false;
     return true;
   }
   
   @Override public int hashCode() {
     final int PRIME = 59;
     int result = 1;
     result = (result*PRIME) + super.hashCode();
     result = (result*PRIME) + this.width;
     result = (result*PRIME) + this.height;
     return result;
   }
   
   protected boolean canEqual(Object other) {
     return other instanceof Square;
   }
 }
}

  • @NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor

    @NoArgsConstructor生成一个无参构造方法。当类中有final字段没有被初始化时，编译器会报错，此时可用@NoArgsConstructor(force = true)，然后就会为没有初始化的final字段设置默认值 0 / false / null。对于具有约束的字段（例如@NonNull字段），不会生成检查或分配，因此请注意，正确初始化这些字段之前，这些约束无效。

import lombok.NoArgsConstructor;
import lombok.NonNull;
@NoArgsConstructor(force = true)
public class User {
    @NonNull private Integer id;
    @NonNull private String name;
    private final String phone ;
}

@RequiredArgsConstructor会生成构造方法（可能带参数也可能不带参数），如果带参数，这参数只能是以final修饰的未经初始化的字段，或者是以@NonNull注解的未经初始化的字段
@RequiredArgsConstructor(staticName = "of")会生成一个of()的静态方法，并把构造方法设置为私有的

Paste_Image.png

 

Paste_Image.png

import lombok.NonNull;
import lombok.RequiredArgsConstructor;
@RequiredArgsConstructor
public class User {
  @NonNull private Integer id ;
  @NonNull private String name = "bbbb";
  private final String phone;
}
//另外一个
import lombok.NonNull;
import lombok.RequiredArgsConstructor;
@RequiredArgsConstructor(staticName = "of")
public class User {
  @NonNull private Integer id ;
  @NonNull private String name = "bbbb";
  private final String phone;
}

@AllArgsConstructor 生成一个全参数的构造方法

Paste_Image.png

import lombok.AllArgsConstructor;
import lombok.NonNull;
@AllArgsConstructor
public class User {
  @NonNull private Integer id ;
  @NonNull private String name = "bbbb";
  private final String phone;
}

  • @Data

    @Data 包含了 @ToString、@EqualsAndHashCode、@Getter / @Setter和@RequiredArgsConstructor的功能

  • @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方法时，会把此前缀去掉

    Paste_Image.png

  • @Synchronized

    给方法加上同步锁

import lombok.Synchronized;
public class SynchronizedExample {
   private final Object readLock = new Object();
   
  @Synchronized
  public static void hello() {
    System.out.println("world");
  }
   
  @Synchronized
  public int answerToLife() {
    return 42;
 }
  @Synchronized("readLock")
  public void foo() {
    System.out.println("bar");
   }
}

//等效代码
public class SynchronizedExample {
private static final Object $LOCK = new Object[0];
private final Object $lock = new Object[0];
private final Object readLock = new Object();
 
public static void hello() {
  synchronized($LOCK) {
    System.out.println("world");
  }
}
 
public int answerToLife() {
 synchronized($lock) {
    return 42;
  }
}

public void foo() {
  synchronized(readLock) {
    System.out.println("bar");
  }
}
}

  • @Wither

    提供了给final字段赋值的一种方法

//使用lombok注解的
import lombok.AccessLevel;
import lombok.NonNull;
import lombok.experimental.Wither;
public class WitherExample {
  @Wither private final int age;
  @Wither(AccessLevel.PROTECTED) @NonNull private final String name;
   
  public WitherExample(String name, int age) {
    if (name == null) throw new NullPointerException();
    this.name = name;
    this.age = age;
  }
}

//等效代码
import lombok.NonNull;
public class WitherExample {
private final int age;
private @NonNull final String name;

public WitherExample(String name, int age) {
 if (name == null) throw new NullPointerException();
 this.name = name;
 this.age = age;
}

public WitherExample withAge(int age) {
 return this.age == age ? this : new WitherExample(age, name);
}

protected WitherExample withName(@NonNull String name) {
 if (name == null) throw new java.lang.NullPointerException("name");
 return this.name == name ? this : new WitherExample(age, name);
}
}

  • @onX

    在注解里面添加注解的方式

直接看代码

public class SchoolDownloadLimit implements Serializable {
    private static final long serialVersionUID = -196412797757026250L;

    @Getter(onMethod = @_({@Id,@Column(name="id",nullable=false),@GeneratedValue(strategy= GenerationType.AUTO)}))
    @Setter
    private Integer id;

    @Getter(onMethod = @_(@Column(name="school_id")))
    @Setter
    private Integer schoolId;


    @Getter(onMethod = @_(@Column(name = "per_download_times")))
    @Setter
    private Integer perDownloadTimes;

    @Getter(onMethod = @_(@Column(name = "limit_time")))
    @Setter
    private Integer limitTime;

    @Getter(onMethod = @_(@Column(name = "download_to_limit_an_hour")))
    @Setter
    private Integer downloadToLimitInHour;

    @Getter(onMethod = @_(@Column(name = "available")))
    @Setter
    private Integer available = 1;
}

  • @Builder

    @Builder注释为你的类生成复杂的构建器API。
    lets you automatically produce the code required to have your class be instantiable with code such as:

Person.builder().name("Adam Savage").city("San Francisco").job("Mythbusters").job("Unchained Reaction").build();

直接看官方示例，对比一下就都明白了

//使用lombok注解的
import lombok.Builder;
import lombok.Singular;
import java.util.Set;
@Builder
public class BuilderExample {
 private String name;
 private int age;
 @Singular private Set<String> occupations;
}

//等效代码
import java.util.Set;
class BuilderExample {
  private String name;
  private int age;
  private Set<String> occupations;

  BuilderExample(String name, int age, Set<String> occupations) {
      this.name = name;
      this.age = age;
      this.occupations = occupations;
  }

  public static BuilderExampleBuilder builder() {
      return new BuilderExampleBuilder();
  }

  public static class BuilderExampleBuilder {
      private String name;
      private int age;
      private java.util.ArrayList<String> occupations;

      BuilderExampleBuilder() {
      }

      public BuilderExampleBuilder name(String name) {
          this.name = name;
          return this;
      }

      public BuilderExampleBuilder age(int age) {
          this.age = age;
          return this;
      }

      public BuilderExampleBuilder occupation(String occupation) {
          if (this.occupations == null) {
              this.occupations = new java.util.ArrayList<String>();
          }

          this.occupations.add(occupation);
          return this;
      }

      public BuilderExampleBuilder occupations(Collection<? extends String> occupations) {
          if (this.occupations == null) {
              this.occupations = new java.util.ArrayList<String>();
          }

          this.occupations.addAll(occupations);
          return this;
      }

      public BuilderExampleBuilder clearOccupations() {
          if (this.occupations != null) {
              this.occupations.clear();
          }

          return this;
      }

      public BuilderExample build() {
          // complicated switch statement to produce a compact properly sized immutable set omitted.
          // go to https://projectlombok.org/features/Singular-snippet.html to see it.
          Set<String> occupations = ...;
          return new BuilderExample(name, age, occupations);
      }

      @java.lang.Override
      public String toString() {
          return "BuilderExample.BuilderExampleBuilder(name = " + this.name + ", age = " + this.age + ", occupations = " + this.occupations + ")";
      }
  }
}

  • @Delegate

    这个注解也是相当的牛逼，看下面的截图，它会该类生成一些列的方法，这些方法都来自与List接口

    Paste_Image.png

附带一个我使用的例子

import lombok.Getter;
import lombok.RequiredArgsConstructor;
import lombok.Setter;
import lombok.ToString;
import lombok.experimental.Accessors;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;
import java.io.Serializable;
import java.util.Date;

@Entity
@Table(name= Constants.TABLE_SCHOOL_DOWNLOAD_LIMIT)
@RequiredArgsConstructor(staticName = "of")
@Accessors(chain = true)
@ToString
public class SchoolDownloadLimit implements Serializable {
    private static final long serialVersionUID = -196412797757026250L;

    @Getter(onMethod = @_({@Id,@Column(name="id",nullable=false),@GeneratedValue(strategy= GenerationType.AUTO)}))
    @Setter
    private Integer id;

    @Getter(onMethod = @_(@Column(name="school_id")))
    @Setter
    private Integer schoolId;

    @Getter(onMethod = @_(@Column(name = "per_download_times")))
    @Setter
    private Integer perDownloadTimes;

    @Getter(onMethod = @_(@Column(name = "limit_time")))
    @Setter
    private Integer limitTime;

    @Getter(onMethod = @_(@Column(name = "download_to_limit_an_hour")))
    @Setter
    private Integer downloadToLimitInHour;

    @Getter(onMethod = @_(@Column(name = "available")))
    @Setter
    private Integer available = 1;

    @Getter(onMethod = @_(@Column(name = "create_time")))
    @Setter
    private Date createTime;

    @Getter(onMethod = @_(@Column(name = "update_time")))
    @Setter
    private Date updateTime;
}

就介绍这么多了，更多的注解请看官方文档



作者：缓慢移动的蜗牛
链接：https://www.jianshu.com/p/365ea41b3573
來源：简书
简书著作权归作者所有，任何形式的转载都请联系作者获得授权并注明出处。

街角幸福
关注
专栏目录
解锁Lombok的6大级技巧：如何让Java代码瘦身提速？
java专栏
05-10 228
Lombok的@Builder注解可以为类生成Builder模式的构造方式，但如果想在构建过程中加入自定义逻辑怎么办？Java1@Data2@Builder67 @Builder.Default // 设置默认值910 // 自定义Builder方法// 强制设置active为true13 }14}1516// 使用示例。
详解SpringBoot优雅编码之Lombok加持
08-27
详解SpringBoot优雅编码之Lombok加持 Lombok是一款功能强大且广泛使用的Java库，旨在简化Java开发过程，提高代码质量和开发效率。下面我们将详细介绍Lombok的使用方法和优雅编码技巧。 Lombok的优点： 1. 简化...
lombok使用简介
程序员青戈
12-01 4763
原文地址：http://www.jianshu.com/p/365ea41b3573 Lombok简介 Lombok是一个可以通过简单的注解形式来帮助我们简化消除一些必须有但显得很臃肿的Java代码的工具，通过使用对应的注解，可以在编译源码的时候生成对应的方法。官方地址：https://projectlombok.org/，github地址：ht
六，Spring Boot 容器中 Lombok 插件的详细使用，简化配置，提高开发效率
最新发布
weixin_61635597的博客
09-02 1505
简化 Java Bean开发，可以使用 Lombok 的注解让代码更加简洁。Java项目中，很多没有技术含量但又必须存在的代码；比如：Pojo 的 getter/setter/toString；异常处理：I/O流的关闭操作等等。Java项目中，很多没有技术含量但又必须存在的代码：比如：这些代码既没有技术含量，又影响着代码的美观，Lombok 应运而生。Spring Boot 和 IDEA 官方支持IDEA 2020已经内置了 Lombok插件。
使用lombok提高编码效率
热门推荐
再见尼罗河的博客
06-18 4万+
Lombok简介 lombok项目通过增加处理程序使我们的java语言更加刺激（简洁和快速）。
Lombok
xxpxxpoo8的专栏
06-22 609
spring boot2 ,lombok,
Lombok的使用及spring boot对静态资源操作
weixin_44746654的博客
09-26 688
lombok的使用 引入依赖 <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <scope>provided</scope> </dependency> 安装插件 ideal安装lombok File->settings->plugins 直接搜索Lom
lombok-plugin-0.28-2018.3.zip
12-16
10. **学习和调试**：了解 Lombok 的工作原理对于高效使用和调试代码很有帮助。你可以通过查看生成的字节码或者启用 IDE 的“Show Generated Sources”功能来查看 Lombok 生成的代码。 总的来说，Lombok 和它的 IDE...
东Lombok：东Lombok项目
02-16
通过学习和使用"东Lombok"项目，开发者可以更好地理解和掌握Lombok库的使用，提升自己的Java编程技能，同时也能在项目中实现更高效、更简洁的代码编写。对于初学者，这是一个了解和实践代码生成库的绝佳案例。在日常...
lombok2018.1-2019.3.zip
08-25
Lombok是一款非常流行的Java开发工具，它通过注解的方式简化了JavaBean的编写工作，极大地提高了开发效率。...这个压缩包提供了2018.1到2019.3版本的Lombok插件，方便开发者在IDE中集成使用，享受更高效的编码体验。
lombok-plugin插件包
02-04
总的来说，Lombok-plugin 插件包是 IntelliJ IDEA 开发者使用 Lombok 进行高效开发的得力助手，它极大地提升了编码效率和代码整洁度，但同时也需要开发者理解其工作原理，以便在适当的时候做出正确的选择。
解决Maven打包(编译)慢的问题
qq_43023197的博客
09-08 946
解决Maven打包(编译)慢的问题
JAVA学习日记: 注解(3)
SIESTA030的博客
10-13 271
今天我学习的是注解的第三课(基础) 今天学习了的主要内容： 1.注解使用的一些小解析 2.标记注解 注解使用: 当注解中有且仅有一个元素且元素名称就叫做value 可以使用如下方法赋值: @注解名(要赋的值) 标记注解: 标记注解和标记接口类似，该注解不具有任何元素 标记接口，是没有任何抽象方法的接口；看似无用，即便实现这样的接口也没有需要实现的方法 但是标记接口有一个重要的作用，即可以将一些实现了该接口的类看似同一个类型；更便于实现多态。 标记注解也类似，虽然本身没有
lombok生成构造方法
weixin_44523741的博客
09-04 4305
lombok生成构造方法
代码优化lombok
正在减肥的java小菜鸟
08-27 296
lombok插件的安装 在开发中，对于一些类。常常需要写getter/setter方法。这些都是必须的而且是冗余的代码。先在介绍一个插件，可以让我们省去这些重复冗余方法。这个插件就是lombok。首先去下载合适的lombok的jar。 lombok的官方地址：https://projectlombok.org/ 然后将该jar放在eclipse目录与eclipse里面 .ini的目录同级。 ...
Java学习————————————注解
weixin_44501770的博客
10-04 316
一、Java常用注解： 1、@Override 检测被该注解标注的方法是否继承于父类（接口） 2、@Deprecated 表示被标注的方法已过时 3、@SuppressWarnings 压制警告 二、Java自定义注解 1、格式 （1）元注解：描述注解的注解 常见： @Target:描述注解作用的位置 ElementType.TYPE：作用于类 ElementType.METHOD：作用于方法 Element...
Lombok 之 Constructor
lvshuchangyin的专栏
03-29 3万+
在Lombok中，生成构造方法的annotation一共有三个，@NoArgsConstructor, @RequiredArgsConstructor, @AllArgsContructor。使用这三个annotation来完成项目中对于不同构造方法的需求。 @NoArgsConstructor ： 生成一个无参数的构造方法，这个annotation在与其他的annotation配合起来
Java中返回体去掉指定字段
Dyeln的博客
01-11 6010
在定义的返回体结构中需要忽略指定字段可以使用如下方法：例如 @Getter(onMethod = @__( @JsonIgnore)) private String salt;
SpringBoot（四）SpringBoot中lombok使用
a878787877的专栏
03-22 439
lombok概述 lombok简介 Lombok想要解决了的是在我们实体Bean中大量的Getter/Setter方法，以及toString, hashCode等可能不会用到，但是某些时候仍然需要复写，以期方便使用的方法；在使用Lombok之后，将由其来自动帮你实现代码生成，注意，其是 在运行过程中，帮你自动生成的 。就是说，将极大减少你的代码总量。 lombok作用 消除模板代码 g...
IntelliJ IDEA Lombok插件0.34版本更新
资源摘要信息:"Lombok 是一个 Java 库，它通过注解的方式，帮助开发者消除 Java 类中的样板代码。...因此，在使用 Lombok 时，团队内部应有相应的规范和约定，确保所有成员都能高效且正确地使用这一工具。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值