首页 > 编程语言 >Java开发Lombok使用详解

Java开发Lombok使用详解

时间:2023-05-23 10:46:51浏览次数:38  
标签:remark Java int Demo private id 详解 Lombok public

转:https://www.jb51.net/article/198920.htm

什么是Lombok

Lombok是一款Java开发插件,可以通过它定义的注解来精简冗长和繁琐的代码,主要针对简单的Java模型对象(POJO)。

好处就显而易见了,可以节省大量重复工作,特别是当POJO类的属性增减时,需要重复修改的Getter/Setter、构造器方法、equals方法和toString方法等。

引入pom中依赖。

<dependency>
  <groupId>org.projectlombok</groupId>
  <artifactId>lombok</artifactId>
  <version>1.18.10</version>
</dependency>

如果是通过Idea创建Spring Boot项目,可在创建项目时直接在“Developer Tool”中选择Lombok。

完成了以上两步,就可以在代码中使用该款神器了。

Lombok的使用

@Data

@Data最常用的注解之一。注解在类上,提供该类所有属性的getter/setter方法,还提供了equals、canEqual、hashCode、toString方法。

这里的提供什么意思?就是开发人员不用手写相应的方法,而Lombok会帮你生成。

使用@Data示例如下,最直观的就是不用写getter/setter方法。

@Data
public class Demo {
 private int id;
 private String remark;
}

我们看该类编译之后是什么样子。

public class Demo {
  private int id;
  private String remark;

  public Demo() {
  }

  public int getId() {
    return this.id;
  }

  public String getRemark() {
    return this.remark;
  }

  public void setId(final int id) {
    this.id = id;
  }

  public void setRemark(final String remark) {
    this.remark = remark;
  }

  public boolean equals(final Object o) {
    if (o == this) {
      return true;
    } else if (!(o instanceof Demo)) {
      return false;
    } else {
      Demo other = (Demo)o;
      if (!other.canEqual(this)) {
        return false;
      } else if (this.getId() != other.getId()) {
        return false;
      } else {
        Object this$remark = this.getRemark();
        Object other$remark = other.getRemark();
        if (this$remark == null) {
          if (other$remark != null) {
            return false;
          }
        } else if (!this$remark.equals(other$remark)) {
          return false;
        }

        return true;
      }
    }
  }

  protected boolean canEqual(final Object other) {
    return other instanceof Demo;
  }

  public int hashCode() {
    int PRIME = true;
    int result = 1;
    int result = result * 59  this.getId();
    Object $remark = this.getRemark();
    result = result * 59  ($remark == null ? 43 : $remark.hashCode());
    return result;
  }

  public String toString() {
    return "Demo(id="  this.getId()  ", remark="  this.getRemark()  ")";
  }
}

上面的反编译代码,我们可以看到提供了默认的构造方法、属性的getter/setter方法、equals、canEqual、hashCode、toString方法。

使用起来是不是很方便,最关键的是,当新增属性或减少属性时,直接删除属性定义即可,效率是否提升了很多?

为了节省篇幅,后面相关注解我们就不再看反编译的效果了,大家使用idea直接打开编译之后对应的.class文件即可看到。

@Setter

作用于属性上,为该属性提供setter方法; 作用与类上,为该类所有的属性提供setter方法, 都提供默认构造方法。

public class Demo {
 private int id;
 @Setter
 private String remark;
}
 
@Setter
public class Demo {
 private int id;
 private String remark;
}

@Getter

基本使用同@Setter方法,不过提供的是getter方法,不再赘述。

@Log4j

作用于类上,为该类提供一个属性名为log的log4j日志对象。

@Log4j
public class Demo {
}

该属性一般使用于Controller、Service等业务处理类上。与此注解相同的还有@Log4j2,顾名思义,针对Log4j2。

@AllArgsConstructor

作用于类上,为该类提供一个包含全部参的构造方法,注意此时默认构造方法不会提供。

@AllArgsConstructor
public class Demo {
 private int id;
 private String remark;
}
效果如下:

public class Demo {
private int id;
private String remark;


public Demo(final int id, final String remark) {
this.id = id;
this.remark = remark;
}
}

@NoArgsConstructor

作用于类上,提供一个无参的构造方法。可以和@AllArgsConstructor同时使用,此时会生成两个构造方法:无参构造方法和全参构造方法。

@EqualsAndHashCode

作用于类上,生成equals、canEqual、hashCode方法。具体效果参看最开始的@Data效果。

@NonNull

作用于属性上,提供关于此参数的非空检查,如果参数为空,则抛出空指针异常。

使用方法:

public class Demo {
 @NonNull
 private int id;
 private String remark;
}
效果如下:
public class Demo {
  @NonNull
  private int id;
  private String remark;
}

@RequiredArgsConstructor

作用于类上,由类中所有带有@NonNull注解或者带有final修饰的成员变量作为参数生成构造方法。

@Cleanup

作用于变量,保证该变量代表的资源会被自动关闭,默认调用资源的close()方法,如果该资源有其它关闭方法,可使用

@Cleanup(“methodName”)来指定。
public void jedisExample(String[] args) {
  try {
    @Cleanup Jedis jedis =  redisService.getJedis();
  } catch (Exception ex) {
    logger.error(“Jedis异常:”,ex)
  }
}

效果相当于:
public void jedisExample(String[] args) {

  Jedis jedis= null;
  try {
    jedis = redisService.getJedis();
  } catch (Exception e) {
    logger.error(“Jedis异常:”,ex)
  } finally {
    if (jedis != null) {
      try {
        jedis.close();
      } catch (Exception e) {
        e.printStackTrace();
      }
    }
  }
}

@ToString

作用于类上,生成包含所有参数的toString方法。见@Data中toString方法。

@Value

作用于类上,会生成全参数的构造方法、getter方法、equals、hashCode、toString方法。与@Data相比多了全参构造方法,少了默认构造方法、setter方法和canEqual方法。

该注解需要注意的是:会将字段添加上final修饰,个人感觉此处有些失控,不太建议使用。

@SneakyThrows

作用于方法上,相当于把方法内的代码添加了一个try-catch处理,捕获异常catch中用Lombok.sneakyThrow(e)抛出异常。使用@SneakyThrows(BizException.class)指定抛出具体异常。

@SneakyThrows
public int getValue(){
 int a = 1;
 int b = 0;
 return a/b;
}
效果如下:
public int getValue() {
  try {
    int a = 1;
    int b = 0;
    return a / b;
  } catch (Throwable var3) {
    throw var3;
  }
}

@Synchronized

作用于类方法或实例方法上,效果与synchronized相同。区别在于锁对象不同,对于类方法和实例方法,synchronized关键字的锁对象分别是类的class对象和this对象,而@Synchronized的锁对象分别是私有静态final对象lock和私有final对象lock。也可以指定锁对象。

public class FooExample { 

 private final Object readLock = new Object(); 

 @Synchronized 
 public static void hello() { 
   System.out.println("world");  
 } 

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

}

效果相当于如下:
public class FooExample { 

 private static final Object $LOCK = new Object[0]; 
 private final Object readLock = new Object(); 

 public static void hello() { 
  synchronized($LOCK) { 
   System.out.println("world"); 
  } 
 }  

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

}

val

使用val作为局部变量声明的类型,而不是实际写入类型。 执行此操作时,将从初始化表达式推断出类型。

public Map<String, String> getMap() {
 val map = new HashMap<String, String>();
 map.put("1", "a");
 return map;
}
效果如下:
public Map<String, String> getMap() {
  HashMap<String, String> map = new HashMap();
  map.put("1", "a");
  return map;
}

也就是说在局部变量中,Lombok帮你推断出具体的类型,但只能用于局部变量中。

@Builder

作用于类上,如果你喜欢使用Builder的流式操作,那么@Builder可能是你喜欢的注解了。

使用方法:

@Builder
public class Demo {
 private int id;
 private String remark;
}
效果如下:
public class Demo {
  private int id;
  private String remark;

  Demo(final int id, final String remark) {
    this.id = id;
    this.remark = remark;
  }

  public static Demo.DemoBuilder builder() {
    return new Demo.DemoBuilder();
  }

  public static class DemoBuilder {
    private int id;
    private String remark;

    DemoBuilder() {
    }

    public Demo.DemoBuilder id(final int id) {
      this.id = id;
      return this;
    }

    public Demo.DemoBuilder remark(final String remark) {
      this.remark = remark;
      return this;
    }

    public Demo build() {
      return new Demo(this.id, this.remark);
    }

    public String toString() {
      return "Demo.DemoBuilder(id="  this.id  ", remark="  this.remark  ")";
    }
  }
}

我们可以看到,在该类内部提供了DemoBuilder类用来处理具体的流式操作。同时提供了全参的构造方法。

 

标签:remark,Java,int,Demo,private,id,详解,Lombok,public
From: https://www.cnblogs.com/qsds/p/17422587.html

相关文章

  • Java开发笔记之将一个List拷贝到另一个List的问题
    0x00概述在对List数据进行不同的数据操作的时候,例如分支1将List按照A来排序,分支2将List按照B来排序,需要将List进行数据层面的拷贝; 0x01错误的操作仅仅是List的引用,并没拷贝List内的数据进行处理List<String>list1=newArrayList<>();List<String>list2=newArrayL......
  • 用chatGPT快速开发java后端功能
     接到一个紧急需求如图常规无非是建表,写接口,写测试类,最后造数据进行自测。突发奇想,要不用GPT4试一下快速写业务代码? 写句子1分钟,建表和得到代码1分钟第一步:建表,直接复制excel中内容到GPT中 第二步:要求转为下划线:  第三步:给出条件和想要的结果(下面第一幅图是自己写......
  • java.lang.IndexOutOfBoundsException: Invalid range
    报文:ERROR:17:38:36,099-TcLogger$IC_PrintStream.logButCheckForException:?java.lang.IndexOutOfBoundsExceptionjava.lang.IndexOutOfBoundsException:Invalidrange atjavax.swing.DefaultRowSorter.rowsUpdated(UnknownSource) atjavax.swing.DefaultRowSor......
  • 一篇文章告诉你什么是Java内存模型
    在上篇并发编程Bug起源:可见性、有序性和原子性问题,介绍了操作系统为了提示运行速度,做了各种优化,同时也带来数据的并发问题,定义在单线程系统中,代码按照顺序从上往下顺序执行,执行不会出现问题。比如一下代码:inta=1;intb=2;intc=a+b;程序从上往下执行,最终c的结果......
  • 【linux进阶】shell 命令之 awk | sed命令详解,带实例
    WK和Sed是常用的文本处理工具,可以用来处理文本文件、日志文件等数据。下面将分别介绍AWK和Sed命令,并提供一些实例。AWK命令AWK是一种文本处理工具,其名字取自它的三位创始人的姓名:AlfredAho,PeterWeinberger和BrianKernighan。AWK命令通常用于从文件或其他输入流中......
  • 【linux进阶】shell之数组字典参数处理详解
    在Shell脚本中,使用数组和字典(关联数组)可以方便地处理参数。以下是它们的介绍:数组Shell中的数组类似于其他编程语言中的数组,它是一个用于存储多个值的变量。在Bash和其他类Unixshell中,可以使用以下语法来创建和操作数组:1.定义数组定义数组需要使用array_name=(value1......
  • java学习日记20230522-TreeSet
    有序键值对集合publicclassTreeSetExercise{publicstaticvoidmain(String[]args){Integerinteger=newInteger(10);TreeSettreeSet=newTreeSet(newComparator(){@Overridepublicintcompare(Objecto1,Obj......
  • java学习日记20230522-集合选择原则
    1.判断存储的类型,一组对象【单列】或者一组键值对【双列】2.一组对象【单列】:collection的子类:允许重复:List的某个实现类:增删多LinkedList(底层维护的是双向链表)                                改查多ArrayList(底层维护的是object类型的可......
  • JavaScript函数
    1函数定义使用function关键字来定义,即functionfName(para,...){statment;...;},可使用在函数声明语句与函数定义表达式这两种形式中函数名称标识符fName。是函数声明语句必需的部分。它的用途就像变量的名字,新定义的函数对象会赋值给这个变量但对函数定义表达式来说......
  • Java设计模式-组合模式
    简介在软件设计中,设计模式是一种被广泛接受和应用的经验总结,旨在解决常见问题并提供可复用的解决方案。组合模式是一种结构型设计模式,它允许将对象组合成树形结构以表示“部分-整体”的层次结构。这种模式能够使客户端以一致的方式处理单个对象和对象集合,将对象的组合与对象的使......