Lombok常用注解

最新推荐文章于 2024-03-02 09:15:00 发布
最新推荐文章于 2024-03-02 09:15:00 发布
阅读量475 收藏 2
点赞数 1
分类专栏： JAVA 文章标签： java lombok
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_22799043/article/details/110253078
版权

Lombok常用注解

  • 加入 maven 依赖
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.12</version>
</dependency>

Lombok常用注解

1. @Getter/@Setter

作用：自动生成 getter/setter方法

  • 使用注解的代码块
@Getter
@Setter
public class User {
    private String name;
    private int age;
}
  • 未使用注解的代码块
public class User {
    private String name;
    private int age;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}

2. @ToString

作用：自动重写 toString() 方法

  • 使用注解的代码块
@ToString
public class User {
    private String name;
    private int age;
}
  • 未使用注解的代码块
public class User {
    private String name;
    private int age;

    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

3. @EqualsAndHashCode

作用：自动生成 equals(Object other) 和 hashcode() 方法，包括所有非静态变量和非 transient 的变量

  • 使用注解的代码块
@EqualsAndHashCode
public class User {
    private String name;
    private int age;
}
  • 未使用注解的代码块
public class User {
    private String name;
    private int age;

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof User)) return false;

        User user = (User) o;

        if (age != user.age) return false;
        return Objects.equals(name, user.name);
    }

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

如果某些变量不想要加进判断，可以透过 exclude 排除，也可以使用 of 指定某些字段

  • 使用注解的代码块
@EqualsAndHashCode(exclude = "name")
public class User {
    private String name;
    private int age;
}
  • 未使用注解的代码块
public class User {
    private String name;
    private int age;

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof User)) return false;
        
        User user = (User) o;
        
        return age == user.age;
    }

    @Override
    public int hashCode() {
        return age;
    }
}

Q : 为什么只有一个整体的 @EqualsAndHashCode 注解，而不是分开的两个 @Equals 和 @HashCode？
A : 在 Java 中有规定，当两个对象 equals 时，他们的 hashcode 一定要相同，反之，当 hashcode 相同时，对象不一定 equals。所以 equals 和 hashcode 要一起实现，免得发生违反 Java 规定的情形发生

4. @NoArgsConstructor、 @AllArgsConstructor、@RequiredArgsConstructor

这三个很像，都是在自动生成该类的构造器，差别只在生成的构造器的参数不一样而已

(1)@NoArgsConstructor

@NoArgsConstructor注解作用：生成一个没有参数的构造器

  • 使用注解的代码块
@NoArgsConstructor
public class User {
    private String name;
    private int age;
}
  • 未使用注解的代码块
public class User {
    private String name;
    private int age;

    public User() {
    }
}

(2)@AllArgsConstructor

@AllArgsConstructor注解作用：生成一个包含所有参数的构造器

  • 使用注解的代码块
@AllArgsConstructor
public class User {
    private String name;
    private int age;
}
  • 未使用注解的代码块
public class User {
    private String name;
    private int age;

    public User(String name, int age) {
        this.name = name;
        this.age = age;
    }
}

这里注意一个 Java 的小坑，当我们没有指定构造器时，Java 编译器会帮我们自动生成一个没有任何参数的构造器给该类，但是如果我们自己写了构造器之后，Java 就不会自动帮我们补上那个无参数的构造器了
然而很多地方（像是 Spring Data JPA），会需要每个类都一定要有一个无参数的构造器，所以你在加上 @AllArgsConstructor 时，一定要补上 @NoArgsConstrcutor，不然会有各种坑等着你

(3)@RequiredArgsConstructor

@RequiredArgsConstructor注解作用 : 生成一个包含 “特定参数” 的构造器，特定参数指的是那些有加上 final 修饰词的变量们

  • 使用注解的代码块
@RequiredArgsConstructor
public class User {
    private final int id;
    private String name;
}
  • 未使用注解的代码块
public class User {
    private final int id;
    private String name;

    public User(int id) {
        this.id = id;
    }
}

补充一下，如果所有的变量都是正常的，都没有用 final 修饰的话，那就会生成一个没有参数的构造器

5. @Data

整合包，只要加了 @Data 这个注解，等于同时加了以下注解

  • @Getter/@Setter
  • @ToString
  • @EqualsAndHashCode
  • @RequiredArgsConstructor
  • 使用注解的代码块
@Data
public class User {
    private int id;
    private String name;
}
  • 未使用注解的代码块
public class User {
    private int id;
    private String name;

    //@RequiredArgsConstructor
    public User() {
    }

    //@Setter/@Getter
    public int getId() {
        return id;
    }

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

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    //@EqualsAndHashCode
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof User)) return false;

        User user = (User) o;

        if (id != user.id) return false;
        return Objects.equals(name, user.name);
    }

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

    //@ToString
    @Override
    public String toString() {
        return "User{" +
                "id='" + id + '\'' +
                ", name='" + name + '\'' +
                '}';
    }
}

@Data 是使用频率最高的 lombok 注解，通常 @Data 会加在一个值可以被更新的对象上，像是日常使用的 DTO 们、或是 JPA里的 Entity 们，就很适合加上 @Data 注解，也就是 @Data for mutable class

6. @Value

也是整合包，但是他会把所有的变量都设成 final 的，其他的就跟 @Data 一样，等于同时加了以下注解

  • @Getter (注意没有setter)
  • @ToString
  • @EqualsAndHashCode
  • @RequiredArgsConstructor
  • 使用注解的代码块
@Value
public class User {
    private final int id;
    private final String name;
}
  • 未使用注解的代码块
public class User {
    private final int id;
    private final String name;

    //@RequiredArgsConstructor
    public User(final int id, final String name) {
        this.id = id;
        this.name = name;
    }

    //@Getter
    public int getId() {
        return id;
    }

    public String getName() {
        return name;
    }

    //@EqualsAndHashCode
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof User)) return false;

        User user = (User) o;

        if (id != user.id) return false;
        return Objects.equals(name, user.name);
    }

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

    //@ToString
    @Override
    public String toString() {
        return "User{" +
                "id='" + id + '\'' +
                ", name='" + name + '\'' +
                '}';
    }
}

上面那个 @Data 适合用在 POJO 或 DTO 上，而这个 @Value 注解，则是适合加在值不希望被改变的类上，像是某个类的值当创建后就不希望被更改，只希望我们读它而已，就适合加上 @Value 注解，也就是 @Value for immutable class
另外注意一下，此 lombok 的注解 @Value 和另一个 Spring 的注解 @Value 撞名，在 import 时不要 import 错了

7. @Builder

自动生成流式 set 值写法，从此之后再也不用写一堆 setter 了

  • 使用注解的代码块
@Builder
public class User {
    private  int id;
    private  String name;
}

public static void main(String[] args) {
       User user = User.builder().id(1).name("大明").build();
       System.out.println(user);
    }
  • 未使用注解的代码块
public class User {
    private int id;
    private String name;

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

    public void setName(String name) {
        this.name = name;
    }
    
}

public static void main(String[] args) {
        User user =new User();
        user.setId(1);
        user.setName("大明");
    }

注意，虽然只要加上 @Builder 注解，我们就能够用流式写法快速设定对象的值，但是 setter 还是必须要写不能省略的，因为 Spring 或是其他框架有很多地方都会用到对象的 getter/setter 对他们取值/赋值
所以通常是 @Data 和 @Builder 会一起用在同个类上，既方便我们流式写代码，也方便框架做事。

8. @Slf4j

自动生成该类的 log 静态常量，要打日志就可以直接打，不用再手动 new log 静态常量了

  • 使用注解的代码块
@Slf4j
public class T {
    public static void main(String[] args) {
        log.info("hello");
    }
}
  • 未使用注解的代码块
public class User {
    private static final Logger logger = LoggerFactory.getLogger(User.class);

    public static void main(String[] args) {
        logger.info("hello");
    }
}

除了 @Slf4j 之外，lombok 也提供其他日志框架的变种注解可以用，像是 @Log、@Log4j…等，他们都是帮我们创建一个静态常量 log，只是使用的库不一样而已

@Log //对应的log语句如下
private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(LogExample.class.getName());

@Log4j //对应的log语句如下
private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(LogExample.class);

SpringBoot默认支持的就是 slf4j + logback 的日志框架，所以也不用再多做啥设定，直接就可以用在 SpringBoot project上，log 系列注解最常用的就是 @Slf4j

我的名字是雪冬
关注
  • 1
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
Intellij IDEA 2017.3使用Lombok及常用注解介绍
08-25
主要介绍了Intellij IDEA 2017.3使用Lombok及常用注解介绍，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
Lombok工具 : 常用注解介绍 (全)
Guizy
08-14 8042
Lombok详细介绍, 全
深入理解Java中的@EqualsAndHashCode注解
最新发布
wenxuankeji的博客
03-02 589
深入理解Java中的@EqualsAndHashCode注解
lombok实用注解（实战介绍）
weixin_55076626的博客
10-05 3834
lombok是一个开源的代码生成库，能以简单的注解形式来简化Java类中的大量样板代码，提高开发人员的开发效率。例如开发中经常需要写的javabean，都需要花时间去添加相应getter/setter，也许还要去写构造器、equals等方法，而且需要维护，当属性多时会出现大量的getter/setter方法，这些显得很冗长也没有太多技术含量。lombok能通过注解的方式，在编译时自动为属性生成构造器、getter/setter、equals、hashcode、toString方法，使代码看起来更简洁。
Lombok常用注解总结
ACGkaka的博客
12-22 1400
Lombok常用注解总结
lombok的jar包
02-22
Lombok常用注解编辑 播报 Data 整合了Getter、Setter、ToString、EqualsAndHashCode、RequiredArgsConstructor注解。 Getter 快速构建Getter方法。 Setter 快速构建Setter方法。 ToString 快速将当前对象转换成字符...
Lombok（Java库）
11-15
Lombok 提供了一些常用功能的注解，包括但不限于以下几种： @Getter / @Setter：自动生成字段的 getter 和 setter 方法。 @ToString：自动生成 toString 方法，方便输出对象的字符串表示。 @EqualsAndHashCode：...
idea lombok插件
01-18
idea的lombok插件，拥抱lombok，你的代码可以更美，更简，更强健。此lombok可以让idea识别lombok.jar引入的注解导致代码检测爆红问题
Lombok初体验
01-20
文章目录一、下载与安装1、下载 Lombok2、引入依赖3、在 Eclipse 中安装 Lombok 插件1）准备 Jar 包2）安装 Lombok 插件3）查看是否安装成功4）重启 IDE 工具二、常用注解1、@Getter/@Setter2、@NonNull3、@ToString...
idea使用Lombok
毅香雪海的博客
05-10 1067
自从从eclipse改为使用iead之后就改不回去了。 idea提供了很多便捷的功能。lombok就其中一个。 Lombok 简介 Lombok的两点主要原因就是：      1.简化冗余的JavaBean代码；      2.大大提高JavaBean中方法的执行效率； idea中使用Lombok需要安装对应的插件。这...
整理：工程pom文件中引入lombok包以及lombok的使用
OuOcnAh9
08-18 3815
一、lombok包的引入 在pom中添加依赖之前应该将lombok包引入，需要手动进行下载 添加IDE工具对Lombok的支持 二、POM中引入依赖 <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.16.18</version&
lombok注解
林竹清_清清清
09-18 566
lombok是一个简化java代码编写的工具类，即通过采用注解的方式，消除代码中的构造方法。 1.@Getter/@Setter /@ToString /@EqualsAndHashCode:即对应这类的这几种方法 2.@NoArgsConstructor/@RequiredArgsConstructor /@AllArgsConstructor :一三分别对应无参/全参构造方法，二是类中所有...
Lombok注解详解
wd520521的博客
12-08 1771
Lombok类中注解详解 1、@Data：在JavaBean中使用，注解包含包含getter、setter、NoArgsConstructor注解 　　@Value注解和@Data类似，区别在于它会把所有成员变量默认定义为private final修饰，并且不会生成set方法 2、@getter：在JavaBean中使用，注解会生成对应的getter方法 3、@setter：在JavaBean中使用，注解会生成对应的setter方法 4、@NoArgsConstructor：在JavaBean中使
lombok的作用和常用注解
Leuke的博客
08-18 2117
Lombok API Lombok是一个java库，可以自动插入到你的编辑器和构建工具中，让你的java变得更加简单。再也不用写其getter、setter、equals等方法，只需要一个注解，你的类就可以拥有一个功能齐全的javaBean。 实体类就不用再写getter、setter、equals、toString等方法了 lombok帮我们自动生成了！！！ ...
lombok常用注解
08-23
以下是Lombok常用的注解： 1. `@Getter`和`@Setter`：为类的属性自动生成getter和setter方法。 2. `@ToString`：自动生成`toString()`方法。 3. `@EqualsAndHashCode`：自动生成`equals()`和`hashCode()`方法。 4. ...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

我的名字是雪冬

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值