Java关于Lombok的介绍和用法

  前言

  what?你的 Java 代码中还充斥着大量的 set/get 方法?

  我们在刚开始学习 Java 语言的时候讲过,面向对象的三大特征就是封装,继承,和多态。在 Java 中,要保证封装性,需要将成员变量私有化,对外提供 set/get 方法来访问,虽然现在的 IDE,像 eclipse,IDEA都提供了快捷键,来生成 set/get 方法,但是在做项目的时候,一个 JavaBean 往往会有很多的成员变量,一个变量对应两个方法,如果有10几个成员变量,那么会对应20多个方法,也许还要去写构造器、equals 等方法,而且需要维护。这样一来,会使代码变得非常冗余,这些显得很冗长也没有太多技术含量,一旦修改属性,就容易出现忘记修改对应方法的失误。

  我在看大佬的项目的源码的时候,看到他们的代码中都没有 set/get 方法,取而代之的是在 JavaBean 上标注的注解,我感到非常的好奇,原来他们是用了一种叫做 Lombok 的插件,便去详细了解了这个插件。

  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 变得简洁、快速。

  Lombok使用方法

  Lombok 能通过注解的方式,在编译时自动为属性生成构造器、getter/setter、equals、hashcode、toString 方法。出现的神奇就是在源码中没有 getter 和 setter 方法,但是在编译生成的字节码文件中有 getter 和 setter 方法。这样就省去了手动重建这些代码的麻烦,使代码看起来更简洁些。

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

  org.projectlombok

  lombok

  1.18.10

  provided

  注意:

  第一次使用 Lombok 插件需要做如下几步配置

  1.将 Lombok 插件安装到 IDEA

  file -> setting

  选中 Plugins,搜索 Lombok,点击 Install

  2.选择默认的编译方式为 javac,因为 eclipse 是不支持 Lombok 的编译方式的,javac 支持 Lombok 的编译方式。

  3.打开注解生成器 Enable annotation processing

  再次注意:

  IntelliJ IDEA 2019.2(也就是我用的版本)默认是不支持 Lombok 插件的,需要去

  https://plugins.jetbrains.com/plugin/6317-lombok/versions

  下载对应版本的插件,然后手动引入,在 IDEA 中选择 File -> Setting -> plugins 找到 Install Plugin from Disk…(注意版本不同位置可能有所差异)

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

  @Data

  @Data 注解在类上,会为类的所有属性自动生成 setter/getter、equals、canEqual、hashCode、toString 方法,如为 final 属性,则不会为该属性生成 setter 方法。

  比如我们写一个学生类

  @Data

  public class Student {

  private String name;

  private Integer age;

  private Integer id;

  private String major;

  }

  这样就可以调用 set/get 方法了。

  @Getter/@Setter

  如果觉得@Data 太过残暴(因为@Data 集合了@ToString、@EqualsAndHashCode、@Getter/@Setter、@RequiredArgsConstructor 的所有特性)不够精细,可以使用@Getter/@Setter 注解,此注解在属性上,可以为相应的属性自动生成 set/get 方法。

  public class Student {

  @Setter private String name;

  private Integer age;

  private Integer id;

  private String major;

  public static void main(String[] args) {

  Student stu = new Student();

  stu.setName("Mr.ml");

  }

  }

  @NonNull

  该注解用在属性或构造器上,Lombok 会生成一个非空的声明,可用于校验参数,能帮助避免空指针。

  public class Student {

  @Setter private String name;

  private Integer age;

  private Integer id;

  private String major;

  public Student(@NonNull String name) {

  this.name = name;

  }

  }

  @Cleanup

  该注解能帮助我们自动调用 close() 方法,很大的简化了代码。

  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);

  }

  }

  }

  @EqualsAndHashCode郑州妇科医院 http://www.120zzkd.com/

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

  @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() 属性。这一点是不是有点绕口,通过代码来看会更清晰些。

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

  }

  }

  }

  @NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor

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

  @RequiredArgsConstructor(staticName = "of")

  @AllArgsConstructor(access = AccessLevel.PROTECTED)

  public class ConstructorExample {

  private int x, y;

  @NonNull private T description;

  @NoArgsConstructor

  public static class NoArgsExample {

  @NonNull private String field;

  }

  }

原文地址:https://www.cnblogs.com/gnz49/p/12090473.html

时间: 2024-11-09 19:50:00

Java关于Lombok的介绍和用法的相关文章

关于Java中this和super的用法介绍和区别

1.this&super 什么是this,this是自身的一个对象,代表对象本身,可以理解为:指向对象本身的一个指针.当你想要引用当前对象的某种东西,比如当前对象的某个方法,或当前对象的某个成员,你便可以利用this来实现这个目的.要注意的是this只能在类中的非静态方法中使用,静态方法和静态的代码块中绝对不能出现this.his也可作为构造函数来使用.在后面可以看到 而什么是super,可以理解为是指向自己超(父)类对象的一个指针,而这个超类指的是离自己最近的一个父类.super的作用同样是可

Java collection 的一些介绍 集合

collections主要提供一些,排序的算法,随机的,反向的,  collection 是容器的祖先接口 线性表,链表,哈希表是常用的数据结构,在进行Java开发时,JDK已经为我们提供了一系列相应的类来实现基本的数据结构.这些类均在java.util包中.本文试图通过简单的描述,向读者阐述各个类的作用以及如何正确使用这些类. Collection ├List │├LinkedList │├ArrayList │└Vector │ └Stack └Set Map ├Hashtable ├Has

JAVA中字符串函数subString的用法小结

本篇文章主要是对JAVA中字符串函数subString的用法进行了详细的介绍,需要的朋友可以过来参考下,希望对大家有所帮助 String str; str=str.substring(int beginIndex);截取掉str从首字母起长度为beginIndex的字符串,将剩余字符串赋值给str: str=str.substring(int beginIndex,int endIndex);截取str中从beginIndex开始至endIndex结束时的字符串,并将其赋值给str; demo:

Java 11 新特性介绍

Java 11 已于 2018 年 9 月 25 日正式发布,之前在Java 10 新特性介绍中介绍过,为了加快的版本迭代.跟进社区反馈,Java 的版本发布周期调整为每六个月一次——即每半年发布一个大版本,每个季度发布一个中间特性版本,并且做出不会跳票的承诺.通过这样的方式,Java 开发团队能够将一些重要特性尽早的合并到 Java Release 版本中,以便快速得到开发者的反馈,避免出现类似 Java 9 发布时的两次延期的情况. 按照官方介绍,新的版本发布周期将会严格按照时间节点,于每年

java中静态代码块的用法 static用法详解

(一)java 静态代码块 静态方法区别一般情况下,如果有些代码必须在项目启动的时候就执行的时候,需要使用静态代码块,这种代码是主动执行的;需要在项目启动的时候就初始化,在不创建对象的情况下,其他程序来调用的时候,需要使用静态方法,这种代码是被动执行的. 静态方法在类加载的时候 就已经加载 可以用类名直接调用比如main方法就必须是静态的 这是程序入口两者的区别就是:静态代码块是自动执行的;静态方法是被调用的时候才执行的.静态方法(1)在Java里,可以定义一个不需要创建对象的方法,这种方法就是

在Java 线程中返回值的用法

http://icgemu.iteye.com/blog/467848 在Java 线程中返回值的用法 博客分类: Java Javathread 有时在执行线程中需要在线程中返回一个值:常规中我们会用Runnable接口和Thread类设置一个变量:在run()中改变变量的值,再用一个get方法取得该值,但是run何时完成是未知的:我们需要一定的机制来保证. 在在Java se5有个Callable接口:我们可以用该接口来完成该功能: 代码如: Java代码   package com.thr

【Java学习笔记之二十九】Java中的"equals"和"=="的用法及区别

Java中的"equals"和"=="的用法及区别 在初学Java时,可能会经常碰到下面的代码: 1 String str1 = new String("hello"); 2 String str2 = new String("hello"); 3 System.out.println(str1==str2); 4 System.out.println(str1.equals(str2)); 为什么第4行和第5行的输出结果不一

java中 this 的三种用法

Java中this的三种用法 调用属性 (1)this可以调用本类中的任何成员变量 调用方法(可省略) (2)this调用本类中的成员方法(在main方法里面没有办法通过this调用) 调用构造方法 (3)this调用构造方法只能在本构造方法中调用另一个构造方法(4)this 调用构造方法必须写在第一行 eg: 1 public class ThisDemo { 2 private int id; 3 private String name; 4 public ThisDemo(){ //(1)

Java中PreparedStatement和Statement的用法区别

Java中PreparedStatement和Statement的用法区别 (2012-08-01 11:06:44) 转载▼ 标签: 杂谈   1. PreparedStatement接口继承Statement, PreparedStatement 实例包含已编译的 SQL 语句,所以其执行速度要快于 Statement 对象. 2.作为 Statement 的子类,PreparedStatement 继承了 Statement 的所有功能.三种方法 execute. executeQuery