Lombok 常用注解

最新推荐文章于 2024-03-08 14:02:33 发布
最新推荐文章于 2024-03-08 14:02:33 发布
阅读量899 收藏
点赞数
分类专栏： java 基础 文章标签： java log4j spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u014212540/article/details/129424685
版权

文章目录

简介

Lombok是一款Java开发插件，使得Java开发者可以通过其定义的一些注解来消除业务工程中冗长和繁琐的代码，尤其对于简单的Java模型对象（POJO）。
在开发环境中使用Lombok插件后，Java开发人员可以节省出重复构建，诸如hashCode和equals这样的方法以及各种业务对象模型的accessor和ToString等方法的大量时间。对于这些方法，它能够在编译源代码期间自动帮我们生成这些方法，并没有如反射那样降低程序的性能。

MAVEN 依赖

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <scope>provided</scope>
    <version>1.18.24</version>
</dependency>

常用的注解

1. @Data 注解 :

一般用在类上，提供类所有属性的 get 和 set 方法，此外还提供了equals、canEqual、hashCode、toString等方法；
相当于注解集合。效果等同于 @Getter + @Setter + @ToString + @EqualsAndHashCode + @RequiredArgsConstructor 效果同和这5个注解的效果

需要注意的是，这里不包括@NoArgsConstructor和@AllArgsConstructor
所以, 一般使用@Data时,要配合这两个注解一起使用

2. @Setter 注解：

一般用在属性上，为属性提供 set 方法, 用在再类上则表示当前类中所有属性都生成set方法;

3.@Getter 注解：

用在属性上，为属性提供 get 方法， 用在再类上表示当前类中所有属性都生成get方法;

4.@Log4j or @Slf4j 注解

用在类上，为类提供一个 属性名为log 的 log4j日志对象;

5.@NoArgsConstructor注解：

用在类上，为类提供一个无参的构造方法；

6.@AllArgsConstructor注解：

用在类上，为类提供一个全参的构造方法；

  • 通过 @AllArgsConstructor(access = AccessLevel.PROTECTED) , 可以指定构造器的访问权限
@AllArgsConstructor(access = AccessLevel.PROTECTED)
public class Demo{
    private String name;
    private int age;
}

编译后生成:

public class Demo {
    private String name;
    private int age;

    protected Demo(String name, int age) {
        this.name = name;
        this.age = age;
    }
}
  • @AllArgsConstructor(access = AccessLevel.PROTECTED, staticName = “test”)
@AllArgsConstructor(access = AccessLevel.PROTECTED, staticName = "test")
public class Demo{
    private final int finalVal = 10;
    private String name;
    private int age;
}

编译后 :

public class Demo {
    private String name;
    private int age;

    private Demo(String name, int age) {
        this.name = name;
        this.age = age;
    }

    protected static Demo test(String name, int age) {
        return new Demo(name, age);
    }
}

上面效果为：可以指定生成的构造器的访问权限。但是如果指定了一个静态方法，那么构造器会自动会被private，只通过静态方法对外提供访问，并且我们发现final的属性值，是不会放进构造函数里面的

7.@RequiredArgsConstructor注解:

用在类上，生成一个包含 “特定参数” 的构造器，特定参数指的是那些有加上 final 修饰词的变量们;
@RequiredArgsConstructor注解则会将类中所有带有@NonNull注解 / org.jetbrains.annotations.NotNull注解的或者带有final修饰的成员变量生成对应的构造方法
测试案例:

@RequiredArgsConstructor
public class Demo {

    @NonNull
    private final int finalVal;
    @NonNull
    private String name;
    @NonNull
    private int age;
}

编译后生成:

import lombok.NonNull;

public class Demo {
    @NonNull
    private final int finalVal;
    @NonNull
    private String name;
    @NonNull
    private int age;

    public Demo(@NonNull int finalVal, @NonNull String name, @NonNull int age) {
        if (name == null) {
            throw new NullPointerException("name is marked non-null but is null");
        } else {
            this.finalVal = finalVal;
            this.name = name;
            this.age = age;
        }
    }
}

8.@Builder注解：

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

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

9.@Cleanup注解：

可以用在 IO 流上，用于关闭并释放资源;
例如下面例子，每次IO流操作后要在finally中关闭流，释放资源：

public class CleanupExample {
  public static void main(String[] args) throws IOException {
    InputStream in = new FileInputStream(args[0]);
    try {
      OutputStream out = new FileOutputStream(args[1]);
      try {
        byte[] b = new byte[10000];
        while (true) {
          int r = in.read(b);
          if (r == -1) break;
          out.write(b, 0, r);
        }
      } finally {
        if (out != null) {
          out.close();
        }
      }
    } finally {
      if (in != null) {
        in.close();
      }
    }
  }
}

类似以上的一个IO流操作的方法使用lombok 的 @Cleanup 注解后可以简化成这样：

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

10.@SneakyThrows 注解：

利用了这一机制，将当前方法抛出的异常，包装成RuntimeException，骗过编译器，使得调用点可以不用显示处理异常信息,使用注解后不需要担心Exception的处理。例如:

import lombok.SneakyThrows;

public class SneakyThrowsExample implements Runnable {
  @SneakyThrows(UnsupportedEncodingException.class)
  public String utf8ToString(byte[] bytes) {
    return new String(bytes, "UTF-8");
  }
  
  @SneakyThrows
  public void run() {
    throw new Throwable();
  }
}

真正生成的代码

import lombok.Lombok;

public class SneakyThrowsExample implements Runnable {
  public String utf8ToString(byte[] bytes) {
    try {
      return new String(bytes, "UTF-8");
    } catch (UnsupportedEncodingException e) {
      throw Lombok.sneakyThrow(e);
    }
  }
  
  public void run() {
    try {
      throw new Throwable();
    } catch (Throwable t) {
      throw Lombok.sneakyThrow(t);
    }
  }
}

11.@Accessors

@Accessors 一个为getter和setter方法设计的更流畅的注解
这个注解要搭配@Getter与@Setter使用，用来修改默认的setter与getter方法的形式。
@Accessors属性详解

fluent 属性 : 链式的形式 这个特别好用，方法连缀越来越方便了
chain 属性 : 流式的形式（若无显示指定chain的值，也会把chain设置为true）
prefix 属性 : 生成指定前缀的属性的getter与setter方法，并且生成的getter与setter方法时会去除前缀
测试不使用@Accessors时
在这里插入图片描述
fluent属性

默认为false，当该值为 true 时，对应字段的 getter 方法前面就没有 get，setter 方法就不会有 set。

在这里插入图片描述
编译后生成:

public class Demo {
    private final int finalVal = 10;
    private String xxName;
    private int yyAge;

    public Demo() {
    }

    public int finalVal() {
        Objects.requireNonNull(this);
        return 10;
    }

    public String xxName() {
        return this.xxName;
    }

    public int yyAge() {
        return this.yyAge;
    }

    public Demo xxName(String xxName) {
        this.xxName = xxName;
        return this;
    }

    public Demo yyAge(int yyAge) {
        this.yyAge = yyAge;
        return this;
    }

    public String toString() {
        int var10000 = this.finalVal();
        return "Demo(finalVal=" + var10000 + ", xxName=" + this.xxName() + ", yyAge=" + this.yyAge() + ")";
    }
}

使用:

public class Main {

    public static void main(String[] args) {
        Demo demo = new Demo();
        // setter方法; 这里包含了chain=true的功能,可以链式设置值
        demo.xxName("lucky").yyAge(20);
        // getter方法
        System.out.println(demo.xxName() + "," + demo.yyAge());
        System.out.println("demo = " + demo);
    }
}

chain属性

不写默认为false，当该值为 true 时，对应字段的 setter 方法调用后，会返回当前对象, 进行链式设置值

在这里插入图片描述
编译后生成:

public class Demo {
    private final int finalVal = 10;
    private String xxName;
    private int yyAge;

    public Demo() {
    }

    public int getFinalVal() {
        Objects.requireNonNull(this);
        return 10;
    }

    public String getXxName() {
        return this.xxName;
    }

    public int getYyAge() {
        return this.yyAge;
    }

    public Demo setXxName(String xxName) {
        this.xxName = xxName;
        return this;
    }

    public Demo setYyAge(int yyAge) {
        this.yyAge = yyAge;
        return this;
    }

    public String toString() {
        int var10000 = this.getFinalVal();
        return "Demo(finalVal=" + var10000 + ", xxName=" + this.getXxName() + ", yyAge=" + this.getYyAge() + ")";
    }
}

使用

public class Main {

    public static void main(String[] args) {
        Demo demo = new Demo();
        // setter方法
        demo.setXxName("lucky").setYyAge(20);
        System.out.println("demo = " + demo);
    }
}

prefix属性
该属性是一个字符串数组，当该数组有值时，表示忽略字段中对应的前缀，生成对应的 getter 和 setter 方法。

如果，我们把它的前缀加到 @Accessors 的属性值中，则可以像没有前缀那样，去调用字段的 getter和 setter 方法。

在这里插入图片描述
这里只是把原有属性的前缀给去掉

风随心飞飞
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
【Java基础系列1】Lombok常用注解
飞楼踏梦
08-05 593
主要讲解Lombok几个常用的基本注解的使用。 最近工作中看到很多这种注解，就统一梳理一下，看一下相关的注解有哪些，便于应用到项目中。 前言 ​Lombok是一款在java开发中简洁化代码十分有用的插件工具，lombok提供了很多注解，在编译时候生成java代码，代替了手工编写一些简单的代码，使程序员可以关注更重要的实现。 插件配置 在使用lombok插件的时候，还要进行添加lombok的Maven依赖，代码示例： <!--lombok注解--> <dependen...
Intellij IDEA 2017.3使用Lombok及常用注解介绍
08-25
主要介绍了Intellij IDEA 2017.3使用Lombok及常用注解介绍，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
Lombok（Java库）
11-15
Lombok 是一个 Java 库，它通过使用注解来消除样板代码（boilerplate code），从而简化 Java 类的开发过程。使用 Lombok 可以让开发者在编写 Java 类时减少冗长的代码，提高代码的可读性和可维护性。 Lombok 提供了一些常用功能的注解，包括但不限于以下几种： @Getter / @Setter：自动生成字段的 getter 和 setter 方法。 @ToString：自动生成 toString 方法，方便输出对象的字符串表示。 @EqualsAndHashCode：自动生成 equals 和 hashCode 方法，用于对象的比较和哈希处理。 @NoArgsConstructor / @RequiredArgsConstructor / @AllArgsConstructor：自动生成构造函数。 @Data：整合了 @Getter、@Setter、@ToString、@EqualsAndHashCode 和 @RequiredArgsConstructor 的功能。 @Builder：通过建造者模式（Builder Pattern
lombok的jar包
02-22
Lombok项目是一个java库，它可以自动插入到编辑器和构建工具中，增强java的性能。不需要再写getter、setter或equals方法，只要有一个注解，你的类就有一个功能齐全的构建器、自动记录变量等等。 Lombok常用注解编辑 播报 Data 整合了Getter、Setter、ToString、EqualsAndHashCode、RequiredArgsConstructor注解。 Getter 快速构建Getter方法。 Setter 快速构建Setter方法。 ToString 快速将当前对象转换成字符串类型，便于log。 EqualsAndHashCode 快速进行相等判断。
LomBok中的常用注解 提升开发效率
最新发布
weixin_43702295的博客
03-08 982
官方文档：https://projectlombok.org/features/ 一、val 和 var 使用var或val，Lombok会从局部变量的初始化表达式推断出具体类型，var和val的差别在于，val修饰的局部变量没有被标记为final 二、@NonNull 在方法上使用@NonNull注解可以做非空判断，如果传入空值的话会直接抛出NullPointerException。 三、@Cleanup 当我们在Java中使用资源时，不可避免地需要在使用后关闭资源。使用@Cleanup注解可以自动关闭
idea lombok插件
01-18
idea的lombok插件，拥抱lombok，你的代码可以更美，更简，更强健。此lombok可以让idea识别lombok.jar引入的注解导致代码检测爆红问题
Lombok初体验
01-20
版权声明：本文为 小异常 原创文章，非商用自由转载-保持署名-注明出处，谢谢！ 本文网址：https://blog.csdn.net/sun8112133/article/details/104380696 文章目录一、下载与安装1、下载 Lombok2、引入依赖3、在 Eclipse 中安装 Lombok 插件1）准备 Jar 包2）安装 Lombok 插件3）查看是否安装成功4）重启 IDE 工具二、常用注解1、@Getter/@Setter2、@NonNull3、@ToString4、@EqualsAndHashCode5、@NoArgsConstructor6、@RequiredArg
java注解 唯一_Java基础系列-Lombok常用注解
weixin_39870132的博客
02-16 427
Lombok注解解析：@NonNull使用在方法的参数或者构造器的参数上，用于生成null验证。Lombok可以识别任何第三方工具的字段上标注的@NonNull名称的注解，并在使用@Data、@AllArgsContruct进行生成方法和构造器时进行null判断。而Lombok的@NonNull注解使用在参数之上，仅仅作用到你自定义的方法和构造器之上。null判断会采用：if (param == ...
Lombok注解超详细解析
最难不过坚持，与你共同进步
08-15 1019
Lombok 是一个 Java 库，用于通过注解方式自动化生成 Java 类的常用方法（如 getter、setter、toString 等），从而简化开发流程并减少重复性代码。
Lombok工具 : 常用注解介绍 (全)
星哲最开心
05-12 2079
Lombok工具 : 常用注解介绍 (全)
lombok实用注解（实战介绍）
weixin_55076626的博客
10-05 3913
lombok是一个开源的代码生成库，能以简单的注解形式来简化Java类中的大量样板代码，提高开发人员的开发效率。例如开发中经常需要写的javabean，都需要花时间去添加相应getter/setter，也许还要去写构造器、equals等方法，而且需要维护，当属性多时会出现大量的getter/setter方法，这些显得很冗长也没有太多技术含量。lombok能通过注解的方式，在编译时自动为属性生成构造器、getter/setter、equals、hashcode、toString方法，使代码看起来更简洁。
Lombok常用注解
热门推荐
哈
04-09 1万+
简介 Lombok是一个通过注解以达到减少代码的Java工具，如通过注解的方式减少get,set方法,构造方法等。 在集成开发工具中使用lombok，首先需要先安装插件： Lombok对应的Maven信息： <dependency> <groupId>org.projectlombok</groupId> <artifactId&gt...
Lombok 注解及实例大全
weixin_44471490的博客
12-07 1838
Project Lombok是一个java库，它可以自动插入到编辑器和构建工具中，为Java增添趣味。 永远不要再编写另一个getter或equals方法，只要有一个注释，你的类就有一个功能齐全的构建器，自动化你的日志变量，等等。 val 用在局部变量前面，相当于将变量声明为 final val map = new HashMap<String, String>(); // 相当于 final Map<String, String> map = new HashMap<&g.
Lombok常用注解总结
ACGkaka的博客
12-22 1503
Lombok常用注解总结
Lombok的使用及注解含义
dongdong199033的博客
08-12 1184
Lombok可以通过注解来帮助我们简化实体对象（POJO）的代码书写。
Java库Lombok常用注解使用
北亮的专栏
06-11 965
Lombok已经是很多Java项目最常用的库之一了，本文通过示例代码介绍那些常用的注解。
lombok常用注解
08-23
Lombok是一个Java库，提供了一些方便的注解，用于减少Java代码的冗余和样板代码的编写。以下是Lombok常用的注解： 1. `@Getter`和`@Setter`：为类的属性自动生成getter和setter方法。 2. `@ToString`：自动生成`toString()`方法。 3. `@EqualsAndHashCode`：自动生成`equals()`和`hashCode()`方法。 4. `@NoArgsConstructor`：生成无参构造函数。 5. `@RequiredArgsConstructor`：生成包含必填参数的构造函数。 6. `@AllArgsConstructor`：生成包含所有参数的构造函数。 7. `@Data`：自动生成`Getter`、`Setter`、`toString()`、`equals()`和`hashCode()`方法。 8. `@Builder`：使用建造者模式生成构造对象的代码。 9. `@SneakyThrows`：在方法上自动添加异常捕获代码。 10. `@Slf4j`：自动生成日志记录器。 这只是Lombok提供的一些常用注解，还有其他很多注解可以用于简化Java开发中的重复代码。你可以根据具体需求选择使用相应的注解。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值