Lombok常用注解及使用

最新推荐文章于 2024-07-31 22:26:09 发布
最新推荐文章于 2024-07-31 22:26:09 发布
阅读量1.7k 收藏 3
点赞数
分类专栏： # Java 文章标签： java lombok
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/jiduochou963/article/details/104761635
版权

说明：本文是博学谷课程整理的笔记，课程地址：https://xuexi.boxuegu.com/video.html?courseId=1586

lombok官网：https://projectlombok.org/

一、Lombok简介

1. Lombok是什么

Project Lombok is a java library that automatically plugs into your editor and build tools, spicing up your java.
Never write another getter or equals method again, with one annotation your class has a fully featured builder, Automate your logging variables, and much more.

简单说：

Lombok项目是一个Java实用工具库，可以用来帮助开发人员消除Java中的冗长代码，尤其是对于简单的Java对象（POJO），它通过注解来实现这一目的。

2. Lombok原理

JSR 269：插件化注解处理API（Pluggable Annotation Processing API）——编译期（SOURCE）注解，不同于运行期（RUNTIME）注解

官网：https://www.jcp.org/en/jsr/detail?id=269

JDK6提供的特性，在Javac编译期利用注解搞事情！

在这里插入图片描述

3. Lombok安装

3.1 javac
  • 拷贝jar到类路径
  • javac -cp lombok.jar ...
3.2 Maven
<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.12</version>
    <scope>provided</scope>
</dependency>
3.3 Intellij IDEA

官网：https://projectlombok.org/setup/intellij

Add the Lombok IntelliJ plugin to add lombok support for IntelliJ:

  • Go to File > Settings > Plugins
  • Click on Browse repositories...
  • Search for Lombok Plugin
  • Click on Install plugin
  • Restart IntelliJ IDEA

在这里插入图片描述
在这里插入图片描述

二、Lombok常用注解

在这里插入图片描述

1. @Getter/@Setter

package top.onefine.lombok;

import lombok.AccessLevel;
import lombok.Getter;
import lombok.Setter;

// 给所有类中的成员变量生成get/set方法
// 不对static类型产生效果
// 对final类型只会产生get方法，不会产生set方法
@Setter
@Getter
public class User {
	static String s = "";
    final int id2 = 10;
    // 只给id字段添加get/set方法
//    @Getter(AccessLevel.PROTECTED)  // 默认public
//    @Setter  // 默认public
    private Integer id;
    private String userName;
    private String password;
    private String phone;
    @Getter(AccessLevel.NONE)  // 不会生成对应的get方法，@Setter同理
    private String email;
}

2. @ToString

package top.onefine.lombok;

import lombok.ToString;

//@ToString  // 不会打印static类型的
//@ToString(exclude = {"email", "phone"})  // 不打印成员变量email和phone
@ToString(of = {"id2", "userName"})  // 只打印id和成员变量userName
public class User {
    static String s = "";  // 不会打印
    final int id2 = 10;
    private Integer id;
    private String userName;
    private String password;
    private String phone;
    private String email;
}

3. @EqualsAndHashCode

package top.onefine.lombok;

import lombok.EqualsAndHashCode;

//@EqualsAndHashCode  // 自动生成equals、canEqual、hashCode方法
//@EqualsAndHashCode(exclude = {"phone", "password"})  // 判断时不比较phone和password字段
@EqualsAndHashCode(of = {"id"})  // 只根据id判断
public class User {
    static String s = "";
    final int id2 = 10;
    private Integer id;
    private String userName;
    private String password;
    private String phone;
    private String email;
}

4. @NonNull

package top.onefine.lombok;

import lombok.NonNull;

public class User {
	@NonNull private Integer id;
	
    public void test(@NonNull String str) {  // 对实参str进行判断，不允许其为空
        System.out.println(str);
    }

    public static void main(String[] args) {
        new User().test(null);
    }
}

在这里插入图片描述

在这里插入图片描述

对class字节码反编译之后发现：

	// ...
	@NonNull
    private Integer id;
	
	// ...	
	public void test(@NonNull String str) {
        if (str == null) {
            throw new NullPointerException("str is marked non-null but is null");
        } else {
            System.out.println(str);
        }
    }

5. @NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor

package top.onefine.lombok;

import lombok.NoArgsConstructor;
import lombok.NonNull;
import lombok.RequiredArgsConstructor;

//@NoArgsConstructor  // 添加无参构造函数
@RequiredArgsConstructor  // 默认对标识NonNull注解或final关键字（不指定值的情况下；但是此时不能有无参的构造函数）的成员变量生成构造函数
public class User {
    static String s = "";
    final int id2;  // = 10;
    @NonNull private Integer id;
    private String userName;
    private String password;
    private String phone;
    private String email;
}

反编译之后：

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package top.onefine.lombok;

import lombok.NonNull;

public class User {
    static String s = "";
    final int id2;
    @NonNull
    private Integer id;
    private String userName;
    private String password;
    private String phone;
    private String email;

    public User(int id2, @NonNull Integer id) {
        if (id == null) {
            throw new NullPointerException("id is marked non-null but is null");
        } else {
            this.id2 = id2;
            this.id = id;
        }
    }
}

package top.onefine.lombok;

import lombok.AllArgsConstructor;
import lombok.NoArgsConstructor;
import lombok.NonNull;
import lombok.RequiredArgsConstructor;

//@NoArgsConstructor  // 添加无参构造函数
//@RequiredArgsConstructor  // 默认对标识NonNull注解或final关键字（不指定值的情况下；但是此时不能有无参的构造函数）的成员变量生成构造函数
@AllArgsConstructor  // 生成所有字段的构造函数
public class User {
    static String s = "";
    final int id2;  // = 10;
    @NonNull private Integer id;
    private String userName;
    private String password;
    private String phone;
    private String email;
}

反编译之后：

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package top.onefine.lombok;

import lombok.NonNull;

public class User {
    static String s = "";
    final int id2;
    @NonNull
    private Integer id;
    private String userName;
    private String password;
    private String phone;
    private String email;

    public User(int id2, @NonNull Integer id, String userName, String password, String phone, String email) {
        if (id == null) {
            throw new NullPointerException("id is marked non-null but is null");
        } else {
            this.id2 = id2;
            this.id = id;
            this.userName = userName;
            this.password = password;
            this.phone = phone;
            this.email = email;
        }
    }
}

6. @Data

package top.onefine.lombok;

import lombok.Data;
import lombok.NonNull;

@Data
public class User {
    static String s = "";
    final int id2; // = 10;
    @NonNull private Integer id;
    private String userName;
    private String password;
    private String phone;
    private String email;
}

直接上图：

在这里插入图片描述

@Data集成了@Getter/@Setter、@ToString、@EqualsAndHashCode、@RequiredArgsConstructor四个注解。

7. @Builder

package top.onefine.lombok;

import lombok.Builder;
import lombok.NonNull;

@Builder
public class User {
    static String s = "";
    final int id2 = 10;
    @NonNull private Integer id;
    private String userName;
    private String password;
    private String phone;
    private String email;
}

直接上图：
在这里插入图片描述
反编译结果：

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package top.onefine.lombok;

import lombok.NonNull;

public class User {
    static String s = "";
    final int id2 = 10;
    @NonNull
    private Integer id;
    private String userName;
    private String password;
    private String phone;
    private String email;

    User(@NonNull Integer id, String userName, String password, String phone, String email) {
        if (id == null) {
            throw new NullPointerException("id is marked non-null but is null");
        } else {
            this.id = id;
            this.userName = userName;
            this.password = password;
            this.phone = phone;
            this.email = email;
        }
    }

    public static top.onefine.lombok.User.UserBuilder builder() {
        return new top.onefine.lombok.User.UserBuilder();
    }
}

用法：

package top.onefine.lombok;

import lombok.Builder;
import lombok.NonNull;
import lombok.ToString;

@Builder
@ToString
public class User {
    static String s = "";
    final int id2 = 10;
    @NonNull private Integer id;
    private String userName;
    private String password;
    private String phone;
    private String email;

    public static void main(String[] args) {
        User user = User.builder().id(123).email("wf963123china@gmail.com").userName("one fine").build();// ...
        System.out.println(user);

    }
}

执行结果：

User(id2=10, id=123, userName=one fine, password=null, phone=null, email=wf963123china@gmail.com)

8. @Log

package top.onefine.lombok;


import lombok.NonNull;
import lombok.extern.java.Log;

@Log
public class User {
    static String s = "";
    final int id2 = 10;
    @NonNull private Integer id;
    private String userName;
    private String password;
    private String phone;
    private String email;

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

}

执行结果：

3月 09, 2020 11:29:31 下午 top.onefine.lombok.User main
信息: info msg...

反编译之后：

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package top.onefine.lombok;

import java.util.logging.Logger;
import lombok.NonNull;

public class User {
    private static final Logger log = Logger.getLogger(User.class.getName());
    static String s = "";
    final int id2 = 10;
    @NonNull
    private Integer id;
    private String userName;
    private String password;
    private String phone;
    private String email;

    public User() {
    }

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

9. val

package top.onefine.lombok;

import java.util.HashMap;
import lombok.val;

public class User {

    public static void main(String[] args) {
//        HashMap<String, String> map = new HashMap<>();
        val map = new HashMap<String, String>();
        map.put("name", "one fine");
    }
}

反编译后：

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package top.onefine.lombok;

import java.util.HashMap;

public class User {
    public User() {
    }

    public static void main(String[] args) {
        HashMap<String, String> map = new HashMap();
        map.put("name", "one fine");
    }
}

10. @Cleanup

package top.onefine.lombok;

import java.io.*;

import lombok.Cleanup;

public class User {
    
    public static void main(String[] args) throws IOException {
        @Cleanup InputStream in = new FileInputStream("path1");  // 不用手动关闭
        @Cleanup OutputStream out = new FileOutputStream("path2");  // 不用手动关闭

        byte[] b = new byte[100];
        while (true) {
            int r = in.read(b);
            if (r == -1)
                break;
            out.write(b, 0, r);
        }
           
    }
}

字节码反编译之后：

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package top.onefine.lombok;

import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.Collections;

public class User {
    public User() {
    }

    public static void main(String[] args) throws IOException {
        FileInputStream in = new FileInputStream("path1");

        try {
            FileOutputStream out = new FileOutputStream("path2");

            try {
                byte[] b = new byte[100];

                while(true) {
                    int r = in.read(b);
                    if (r == -1) {
                        return;
                    }

                    out.write(b, 0, r);
                }
            } finally {
                if (Collections.singletonList(out).get(0) != null) {
                    out.close();
                }

            }
        } finally {
            if (Collections.singletonList(in).get(0) != null) {
                in.close();
            }

        }
    }
}
IoneFine
关注
专栏目录
Lombok的注解使用
qq_44346427的博客
06-10 190
Lombok注解 前言 Lombok是一款Java开发插件，使得Java开发者可以通过其定义的一些注解来消除业务工程中冗长和繁琐的代码，尤其对于简单的Java模型对象（POJO）。在开发环境中使用Lombok插件后，Java开发人员可以节省出重复构建，诸如hashCode和equals这样的方法以及各种业务对象模型的accessor和ToString等方法的大量时间。对于这些方法，它能够在编译源代码期间自动帮我们生成这些方法，并没有如反射那样降低程序的性能。 它所有的增强都是通过注解实现，所以了解其使用主
lombok常用注解及使用方法
weixin_44572370的博客
07-20 1058
文章目录一、安装lombok二、变量@NonNull三、实体类@Setter@Getter@RequiredArgsConstructor@AllArgsConstructor@NoArgsConstructor@ToString@EqualsAndHashCode@Data@Value@Builder@Slf4j@Synchronized四、代码块@Cleanup 一、安装lombok idea下载lombok插件 [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-J6KG
lombok注解介绍
热门推荐
sunsfan的博客
12-09 6万+
lombok注解介绍 lombok注解文档 lombok官网下载 lombok是一个可以帮助我们简化java代码编写的工具类，尤其是简化javabean的编写，即通过采用注解的方式，消除代码中的构造方法，getter/setter等代码，使我们写的类更加简洁 @NonNull
科普文：Lombok使用及工作原理详解
为无为，事无事，味无味。
07-31 1254
举例来说，现在有一个实现了Pluggable Annotation Processing API的程序A，那么使用javac编译时的具体流程如下： 1. javac编译器对源码进行分析，生成一个抽象的语法树（AST) 2. javac编译器运行A程序 3. A程序完成逻辑，一般是修改此语法树 4. javac使用修改后的语法树生成可执行的字节码文件 Lomok便是通过Pluggable Annotation Processing API来实现代码生成的。
Lombok注解详解
wd520521的博客
12-08 1831
Lombok类中注解详解 1、@Data：在JavaBean中使用，注解包含包含getter、setter、NoArgsConstructor注解 　　@Value注解和@Data类似，区别在于它会把所有成员变量默认定义为private final修饰，并且不会生成set方法 2、@getter：在JavaBean中使用，注解会生成对应的getter方法 3、@setter：在JavaBean中使用，注解会生成对应的setter方法 4、@NoArgsConstructor：在JavaBean中使
lombok 使用
kylin
09-15 168
Lombok注解 @Data：注解在类上，将类提供的所有属性都添加get、set方法，并添加、equals、canEqual、hashCode、toString方法 @Setter：注解在类上，为所有属性添加set方法、注解在属性上为该属性提供set方法 @Getter：注解在类上，为所有的属性添加get方法、注解在属性上为该属性提供get方法 @NotNull：在参数中使用时，如果调用时传了nu...
Lombok 常用注解
u014212540的博客
03-09 1594
Lombok 常用注解
【Java基础系列1】Lombok常用注解
飞楼踏梦
08-05 623
主要讲解Lombok几个常用的基本注解的使用。 最近工作中看到很多这种注解，就统一梳理一下，看一下相关的注解有哪些，便于应用到项目中。 前言 ​Lombok是一款在java开发中简洁化代码十分有用的插件工具，lombok提供了很多注解，在编译时候生成java代码，代替了手工编写一些简单的代码，使程序员可以关注更重要的实现。 插件配置 在使用lombok插件的时候，还要进行添加lombok的Maven依赖，代码示例： <!--lombok注解--> <dependen...
SpringBoot终幕——日志的输出以及Lombok常用注解
未见花闻的博客
08-16 1982
本篇文章将介绍SpringBoot日志文件，日志的作用，自定义日志，日志级别，Lombok框架的常用注解。
lombok 常用注解
最新发布
09-22
以下是Lombok中一些常用的注解： 1. `@Getter` 和 `@Setter`: 自动生成getter和setter方法，简化属性访问。例如： ```java @Data // 等同于 @NoArgsConstructor, @AllArgsConstructor, @ToString, @...
Lombok常用注解
dxx707099957的博客
07-22 918
加入 maven 依赖 <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.12</version> </dependency> 1. @Getter/@Setter 自动产生 getter/setter ...
lombok注解的使用
m0_50997249的博客
01-12 182
lombok注解
lombok注解使用
影子的博客
11-19 517
下面主要是针对Maven项目的使用： 在Pom中添加Jar依赖 &amp;lt;dependencies&amp;gt; &amp;lt;dependency&amp;gt; &amp;lt;groupId&amp;gt;org.projectlombok&amp;lt;/groupId&amp;gt; &amp;lt;artifactId&amp;gt;lombok&amp;lt;/artifac
lombok使用及其注解
weixin_32541351的博客
05-11 1810
如何使用： 1.pom文件中添加添lombok 2.idea添加lombok插件，并在File-- Settings设置界面，开启Enable AnnocationProcessors。 注解： @Getter/@Setter: 作用类上，生成所有成员变量的getter/setter方法；作用于成员变量上，生成该成员变量的getter/setter方法。可以设定访问权限及是否懒加载等。 @ToString：作用于类，覆盖默认的toString()方法，可以通过of属性限定显示某些字段，通过exc.
Lombok注解的使用方法
Junnix的博客
04-08 1353
字段修饰的属性的构造方法。注解，它生成的属性都被。
Lombok注解使用详解
wh柒八九的博客
08-29 427
本文来说下Lombok注解使用 文章目录概述 概述
Lombok 注解及使用大全
demo_yo的博客
07-11 1629
一、Lombok 注解大全 优点： 能通过注解的形式自动生成构造器、getter / setter、equals、hashcode、toString 等方法，提高了一定的开发效率，让代码变得简洁，不用过多的去关注相应的方法。 属性做修改时，也简化了维护为这些属性所生成的 getter / setter 方法等。缺点： 不支持多种参数构造器的重载。 虽然省去了手动创建一系列方法的麻烦，但大大降低了源代码的可读性和完整性，降低了阅读源代码的舒适度。.........
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值