lombok的使用

最新推荐文章于 2024-08-09 08:46:50 发布
最新推荐文章于 2024-08-09 08:46:50 发布
阅读量376 收藏
点赞数
文章标签： hibernate java 反编译 spring boot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/chushiyan/article/details/103788901
版权

一、lombok是什么

  java中的javabean需要添加相应的getter/setter，即使idea等都提供了自动生成的功能，但是一旦需要修改，哪怕只是修改一个属性的类型、变量名，都得先删除原先的、再重新自动生成。Lombok就是来解决这个麻烦的。
  Lombok通过注解的方式，在编译时自动为属性生成构造函数、getter/setter、equals()、hashcode()、toString()方法。虽然源码中没有getter/setter等方法，但是在编译生成的字节码文件中却有这些方法。

二、lombok的基本使用

1、idea中安装lombok插件

打开idea的settings，点击Plugins，在搜索框中输入lombok进行搜索安装即可。

2、在springboot的项目加入依赖

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

3、javabean上加上注解

import lombok.Data;

import java.io.Serializable;

/**
 * @author chushiyan
 * @email Y2h1c2hpeWFuMDQxNUAxNjMuY29t(base64)
 * @description
 */
 
// 加上Data注解，编译时会自动生成setter/getter/equals/canEqual/hashCode/toString方法，如为final属性，则不会为该属性生成setter方法。
@Data 
public class User implements Serializable {

    private String id;

    private String name;

    private String password;
}

三、lombok常用注解

注解说明
1@Data注解在类，生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。
2@Slf4j类级别注解，生成log常量。
加上这个注解，会在编译时生成如下的常量声明
private static final Logger log = LoggerFactory.getLogger(AdminController.class);
就不用自己声明log，就可以直接在代码中使用log
3@Setter注解在类或字段，注解在类时为所有字段生成setter方法，注解在字段上时只为该字段生成setter方法。
4@Getter使用方法同Setter，区别在于生成的是getter方法。
5@ToString注解在类，添加toString方法。
6@EqualsAndHashCode注解在类，生成hashCode和equals方法。
7@NoArgsConstructor注解在类，生成无参的构造方法。
8@RequiredArgsConstructor注解在类，为类中需要特殊处理的字段生成构造方法，比如final和被@NonNull注解的字段。
9@AllArgsConstructor注解在类，生成包含类中所有字段的构造方法。

四、其他

（一）Data注解帮我们生成了哪些方法？

1、源码中加上Data注解

package org.chushiyan.em.pojo;

import lombok.Data;

import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;
import java.io.Serializable;

/**
 * @author chushiyan
 * @email Y2h1c2hpeWFuMDQxNUAxNjMuY29t(base64)
 * @description
 */
@Data
public class User implements Serializable {

    private String id;

    @NotNull(message = "姓名不能为空")
    @Size(min = 2, max = 20, message = "姓名长度必须在2-20之间")
    private String name;


    @NotNull(message = "密码不能为空")
    @Size(min = 6, max = 60, message = "密码长度必须在6-60之间")
    private String password;
}

2、根据生成的class反编译后的代码

这里使用的Java Decompiler反编译工具，下载使用详见官网：Java Decompiler

package org.chushiyan.em.pojo;

import java.io.Serializable;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;

public class User implements Serializable {
  private String id;
  
  @NotNull(message = ")
  @Size(min = 2, max = 20, message = ")
  private String name;
  
  @NotNull(message = ")
  @Size(min = 6, max = 60, message = ")
  private String password;
  
  public void setId(String id) {
    this.id = id;
  }
  
  public void setName(String name) {
    this.name = name;
  }
  
  public void setPassword(String password) {
    this.password = password;
  }
  
  public boolean equals(Object o) {
    if (o == this)
      return true; 
    if (!(o instanceof User))
      return false; 
    User other = (User)o;
    if (!other.canEqual(this))
      return false; 
    Object this$id = getId(), other$id = other.getId();
    if ((this$id == null) ? (other$id != null) : !this$id.equals(other$id))
      return false; 
    Object this$name = getName(), other$name = other.getName();
    if ((this$name == null) ? (other$name != null) : !this$name.equals(other$name))
      return false; 
    Object this$password = getPassword(), other$password = other.getPassword();
    return !((this$password == null) ? (other$password != null) : !this$password.equals(other$password));
  }
  
  protected boolean canEqual(Object other) {
    return other instanceof User;
  }
  
  public int hashCode() {
    int PRIME = 59;
    result = 1;
    Object $id = getId();
    result = result * 59 + (($id == null) ? 43 : $id.hashCode());
    Object $name = getName();
    result = result * 59 + (($name == null) ? 43 : $name.hashCode());
    Object $password = getPassword();
    return result * 59 + (($password == null) ? 43 : $password.hashCode());
  }
  
  public String toString() {
    return "User(id=" + getId() + ", name=" + getName() + ", password=" + getPassword() + ")";
  }
  
  public String getId() {
    return this.id;
  }
  
  public String getName() {
    return this.name;
  }
  
  public String getPassword() {
    return this.password;
  }
}

说明Data注解会为类的属性自动生成setter/getter、equals、canEqual、hashCode、toString方法。

（二）我们自己编写的toString()等方法会被lombok覆盖掉吗

1、源码

自己编写（或者使用idea自动生成）equals()/hashCode()/toString()

package org.chushiyan.em.pojo;

import lombok.Data;
import lombok.NoArgsConstructor;

import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;
import java.io.Serializable;

/**
 * @author chushiyan
 * @email Y2h1c2hpeWFuMDQxNUAxNjMuY29t(base64)
 * @description
 */
@Data
@NoArgsConstructor
public class User implements Serializable {

    private String id;

    @NotNull(message = "姓名不能为空")
    @Size(min = 2, max = 20, message = "姓名长度必须在2-20之间")
    private String name;


    @NotNull(message = "密码不能为空")
    @Size(min = 6, max = 60, message = "密码长度必须在6-60之间")
    private String password;


    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;

        User user = (User) o;

        if (id != null ? !id.equals(user.id) : user.id != null) return false;
        return name != null ? name.equals(user.name) : user.name == null;
    }

    @Override
    public int hashCode() {
        int result = id != null ? id.hashCode() : 0;
        result = 31 * result + (name != null ? name.hashCode() : 0);
        return result;
    }

    @Override
    public String toString() {
        return "User{" +
                "id='" + id + '\'' +
                ", name='" + name + '\'' +
                '}';
    }
}
2、根据生成的class反编译后的代码
package org.chushiyan.em.pojo;

import java.io.Serializable;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;

public class User implements Serializable {
  private String id;
  
  @NotNull(message = ")
  @Size(min = 2, max = 20, message = ")
  private String name;
  
  @NotNull(message = ")
  @Size(min = 6, max = 60, message = ")
  private String password;
  
  public void setId(String id) {
    this.id = id;
  }
  
  public void setName(String name) {
    this.name = name;
  }
  
  public void setPassword(String password) {
    this.password = password;
  }
  
  public String getId() {
    return this.id;
  }
  
  public String getName() {
    return this.name;
  }
  
  public String getPassword() {
    return this.password;
  }
  
  public boolean equals(Object o) {
    if (this == o)
      return true; 
    if (o == null || getClass() != o.getClass())
      return false; 
    User user = (User)o;
    if ((this.id != null) ? !this.id.equals(user.id) : (user.id != null))
      return false; 
    return (this.name != null) ? this.name.equals(user.name) : ((user.name == null));
  }
  
  public int hashCode() {
    int result = (this.id != null) ? this.id.hashCode() : 0;
    result = 31 * result + ((this.name != null) ? this.name.hashCode() : 0);
    return result;
  }
  
  public String toString() {
    return "User{id='" + this.id + '\'' + ", name='" + this.name + '\'' + '}';
  }
}

可以看到，equals()/hashCode()/toString()都是一样的。说明lombok对于已经存在的方法不会覆盖掉。

chushiyan
关注
Lombok使用总结
拾年一剑 的专栏
02-09 603
简单介绍Lombok和日常使用总结
lombok使用
Anlesurn的博客
11-15 196
1 lombok作用 引入这个包实体类可以省略get、set等方法，简化代码 2 lombok使用 2.1 引入jar包（依赖包） <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.4</version> </dependency> 2.2
lombok特性(一)
约会远行的专栏
08-14 1万+
介绍 lombok项目通过增加处理程序使java语言更加简洁和快速，帮助开发人员消除 Java 的冗长，尤其是对于简单的 Java 对象，在源码中不需要写一些通用的方法，但是在编译生成的字节码文件中会生成这些方法 github项目地址 Lombok原理 lombok注解不是我们常见的runtime注解，而是source注解或者class注解，在没有jsr之前我们可以通过反射在运行是获取...
Lombok中返回的最大值和最小值
荣山的博客
03-31 623
Lombok中返回的最大值和最小值
Lombok 使用教程-@EqualsAndHashCode | 自动生成类的 Equals 和 HashCode 方法
最新发布
smart_an的专栏
08-09 880
任何类的定义都可以用来注释，让lombok生成和hashCode()方法的实现。默认情况下，它将使用所有非静态、非瞬时的字段，但是你可以通过用或标记类型成员来修改哪些字段被使用（甚至指定各种方法的输出被使用）。另外，你可以通过用标记它们并使用来精确指定你希望使用的字段或方法。如果将应用于一个子类，这个功能就变得有点棘手了。通常情况下，为这类自动生成equals和hashCode方法是个坏主意，因为父类也定义了字段，这些字段也需要代码，但这些代码不会被生成。通过设置callSuper为true。
Lombok超详解
qq_53317005的博客
11-16 8550
以前的Java项目中，充斥着太多不友好的代码：POJO的getter/setter/toString/构造方法；打印日志；I/O流的关闭操作等等，这些代码既没有技术含量，又影响着代码的美观，Lombok应运而生。LomBok可以通过注解，帮助开发人员消除JAVA中尤其是POJO类中的冗长代码。使用LomBok之前使用LomBok之后。
lombok常用注解的使用
qq_41307492的博客
03-31 191
常用注解： @Setter ：注解在类或字段，注解在类时为所有字段生成setter方法，注解在字段上时只为该字段生成setter方法。 @Getter ：使用方法同上，区别在于生成的是getter方法。 @ToString ：注解在类，添加toString方法。 @EqualsAndHashCode： 注解在类，生成hashCode和equals方法。 @NoArgsConstructo...
Lombok中关于@Data的使用
热门推荐
death05的博客
10-10 3万+
当你在使用 Lombok 的 @Data 注解时，其实会有一些坑需要关注，今天就让我们来见识一下。 Lombok 先来简单介绍一下 Lombok ，其官方介绍如下： Project Lombok makes java a spicier language by adding 'handlers' that know how to build and compile simple, boilerp...
Lombok使用讲解及原理1
08-04
下面我们将深入探讨 Lombok 的主要注解及其使用场景。 首先，Lombok 提供的 `val` 注解允许你声明一个局部变量为 final，这在你需要确保变量值不会被改变的情况下非常有用。 `@NonNull` 注解用于方法参数，当检测...
lombok使用demo
08-13
这个"lombok使用demo"很可能是为了展示如何在实际项目中应用 Lombok，以便提高开发效率和代码的整洁性。 在Java编程中，Lombok 提供了一系列的注解，如 @Data、@AllArgsConstructor、@NoArgsConstructor、@Setter、...
Lombok使用
Phbeats的博客
04-08 278
什么是Lombok Lombok就是一个通过注解方式生成Java代码的偷懒工具。 为什么要使用Lombok package com.phbeats.pojo; public class Person { private String name; private Integer age; public String getName() { return n...
lombok插件
08-15
里面包含3个版本插件，0.19-2017.3；0.19-2018.1；0.19-2018.EAP，我用的IDEA版本是2017.3.4的，插件的本地安装方法文档有写
lombok @Builder 注解继承 问题 @SuperBuilder
王者丶丿风范
10-23 1万+
节约时间的利器：lombok lombok一直用的很爽，最近用它优化了本人写的桥梁模式，就出现了父类子类继承时@Builder找不到父类属性的问题，仔细研究了一下，发现lombok在新版本已经优化了这个注解，先来更新一下这个版本，直接上最新的 1.18.16 ，上maven仓库看了一下用的人数还可以，比较稳定。 compile group: 'org.projectlombok', name: 'lombok', version: '1.18.16' 之后在父类和子类中都使用 @SuperBuilder
Lombok教程
qq_39714973的博客
03-19 505
Lombok教程 一、背景 我们在开发过程中，通常都会定义大量的JavaBean，然后通过IDE去生成其属性的构造器、getter、setter、equals、hashcode、toString方法，当要对某个属性进行改变时，比如命名、类型等，都需要重新去生成上面提到的这些方法，那java中有没有一种方式能够避免这种重复的劳动呢？答案是有，我们来看一下下面这张图，右面是一个简单的Java...
lombok的canEqual/equals
feiyuyuniao的专栏
11-22 3151
[code="java"] public boolean equals(Object o) { if (o == this) return true; if (!(o instanceof PayType)) return false; PayType other = (PayType)o; return other....
lombok的介绍、使用、简单分析和插件
weixin_30375427的博客
07-27 81
学习下Lombok。 关于POJO Java面向对象编程中的特性中有封闭性和安全性。封闭性即对类中的域变量进行封闭操作，即用private来修饰他们。如此一来，其他类就不能对该变量访问了。这样，我们就将这些变量封闭在了类的内部，提高了数据的安全性。 当我们想要操作这些域变量的时候，有两种办法。第一种是通过public方式的构造器（或称构造函数），对象一实例化就对该变量赋值。第二种就...
重载、重写
Vector丶
03-07 816
一个（无法覆盖，返回类型与void不兼容return type is incompatible）问题的引发 重写：（发生在继承，父子关系） 方法名相同 参数个数和类型完全相同（完全相同） 返回类型相同 子类不能抛出比父类的异常大也不能抛出新的异常 访问权限不能小于父类的 父类final方法不能重写（final修饰的类也不能继承） 子类中必须重写父类中的abstract方法 重载：（发生在同一个...
lombok插件各个注解介绍
越努力越幸运的博客
11-08 742
打开IDEA，点击File 》 Settings…然后点击Plugins（插件），在Marketplace里面搜索 Lombok 下载即可。（这里我因为已经下载好了，所以他存放的位置是 Installed）下载完成后，我们只需要在我们的项目中引入依赖就可以使用啦！
lombok 使用示例
04-04
Lombok可以在Java代码中自动化生成getter，setter和构造函数等常见的代码。以下是一个简单的Lombok使用示例： 1. 首先，在项目的pom.xml文件中添加Lombok依赖： ```xml <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.20</version> <scope>provided</scope> </dependency> ``` 2. 假设我们有一个Java类Person，包含三个属性：name，age和address。使用Lombok，我们可以简化这个类的代码： ```java import lombok.Data; @Data public class Person { private String name; private int age; private String address; } ``` 使用@Data注解，Lombok会自动为我们生成getter、setter、equals、hashCode和toString等方法。 3. 我们还可以使用其他Lombok注解来简化代码。例如，@AllArgsConstructor注解可以自动生成包含所有属性的构造函数： ```java import lombok.AllArgsConstructor; import lombok.Data; @Data @AllArgsConstructor public class Person { private String name; private int age; private String address; } ``` 4. 最后，在实际代码中，我们可以像使用普通Java类一样使用这个Person类： ```java public class Main { public static void main(String[] args) { Person person = new Person("Tom", 25, "New York"); System.out.println(person.getName()); // 输出：Tom } } ``` 使用Lombok，我们可以大大减少Java类的样板代码，提高代码的可读性和可维护性。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值