Lombok初遇

最新推荐文章于 2024-08-05 07:53:05 发布
最新推荐文章于 2024-08-05 07:53:05 发布
阅读量322 收藏
点赞数
分类专栏： Tool 文章标签： Lombok
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/trayvontang/article/details/111491183
版权

文章目录

原理

Lombok主要作用于编译阶段，从JDK1.6开始，javac可以处理遵循《JSR 269 Pluggable Annotation Processing API》规范的注解，Lombok的注解处理器就可以在编译阶段被调用。

大致流程如下：

  1. javac对源代码进行分析，生成一棵抽象语法树(AST)
  2. javac编译过程中调用遵循JSR 269规范的Lombok注解处理器
  3. Lombok注解处理器获取到需要处理的AST
  4. Lombok注解处理器找到Lombok注解，生成对应的代码，修改对应的AST，生成新的AST
  5. javac使用新的AST生成字节码文件

安装使用

Lombok需要安装，使用命令行：

java -jar lombok.jar

然后有图形界，可以看到在自动查找IDE，这种方式主要是针对Eclipse。

lombok安装

如果不行，就eclipse.ini手动添加：

; 在启动类路径中添加的Lombok
-Xbootclasspath/D:lombok.jar
; 设置代理
-javaagent:lombok.jar

如果是IDEA，那么就直接通过Marketplace安装。

lombok
安装之后，有依赖Lombok的项目就会自动配置，如果没有就需要手动配置一下。

annotation processing

maven配置

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.16</version>
    <scope>provided</scope>
</dependency>
<repositories>
    <repository>
        <id>projectlombok.org</id>
        <url>http://projectlombok.org/mavenrepo</url>
    </repository>
</repositories>

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.6.0</version>
            <configuration>
                <source>1.8</source>
                <target>1.8</target>
                <annotationProcessorPaths>
                    <path>
                        <groupId>org.projectlombok</groupId>
                        <artifactId>lombok</artifactId>
                        <version>1.18.16</version>
                    </path>                         
                </annotationProcessorPaths>
            </configuration>
        </plugin>
    </plugins>
</build>

常用注解

注解注解目标说明
@Log类生成日志变量，@Log、@Slf4j、@Log4j、@Log4j2等
@Data类大礼包，包含@ToString、@EqualsAndHashCode、@Getter、@Setter、@RequiredArgsConstructor
@Getter类或成员变量生成getter方法
@Setter类或成员变量生成setter方法
@NonNull成员变量和参数变量参数不能为空，否则抛出空指针异常
@Builder类将类转变为建造者模式
@Cleanup变量自动关闭资源，实现java.io.Closeable接口才有效
@ToString类覆盖toString()方法，of包含字段、exclude排除属性排除字段
@SneakyThrows方法捕捉并抛出受检异常
@Synchronized方法和Java自己的synchronized基本一样，实际就是通过synchronized关键字来实现
@EqualsAndHashCode类覆盖equals和hashCode方法
@NoArgsConstructor类生成无参构造函数
@AllArgsConstructor类生成全参构造函数
@RequiredArgsConstructor类生成包含final和@NonNull注解的成员变量的构造函数

实例说明

一个简单的例子，可以看一下，Lombok注解器对不同的注解都生成了什么样的代码。

import lombok.Builder;
import lombok.Data;
import lombok.SneakyThrows;
import lombok.Synchronized;
import lombok.extern.slf4j.Slf4j;

import java.sql.Date;
import java.sql.SQLDataException;

@Data
@Slf4j
@Builder
public class User {

    private Integer id;
    private String name;
    private Date birthday;

    @Synchronized
    public void doSomethingA(){

    }

    @SneakyThrows
    public void doSomethingB(){
        throw new SQLDataException();
    }
}

Lombok处理后的代码：

import java.sql.Date;
import java.sql.SQLDataException;

public class User {
    @java.lang.SuppressWarnings("all")
    private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(User.class);
    @java.lang.SuppressWarnings("all")
    private final java.lang.Object $lock = new java.lang.Object[0];
    private Integer id;
    private String name;
    private Date birthday;

    public void doSomethingA() {
        synchronized (this.$lock) {
        }
    }

    public void doSomethingB() {
        try {
            throw new SQLDataException();
        } catch (final java.lang.Throwable $ex) {
            throw lombok.Lombok.sneakyThrow($ex);
        }
    }

    @java.lang.SuppressWarnings("all")
    User(final Integer id, final String name, final Date birthday) {
        this.id = id;
        this.name = name;
        this.birthday = birthday;
    }


    @java.lang.SuppressWarnings("all")
    public static class UserBuilder {
        @java.lang.SuppressWarnings("all")
        private Integer id;
        @java.lang.SuppressWarnings("all")
        private String name;
        @java.lang.SuppressWarnings("all")
        private Date birthday;

        @java.lang.SuppressWarnings("all")
        UserBuilder() {
        }

        @java.lang.SuppressWarnings("all")
        public User.UserBuilder id(final Integer id) {
            this.id = id;
            return this;
        }

        @java.lang.SuppressWarnings("all")
        public User.UserBuilder name(final String name) {
            this.name = name;
            return this;
        }

        @java.lang.SuppressWarnings("all")
        public User.UserBuilder birthday(final Date birthday) {
            this.birthday = birthday;
            return this;
        }

        @java.lang.SuppressWarnings("all")
        public User build() {
            return new User(this.id, this.name, this.birthday);
        }

        @java.lang.Override
        @java.lang.SuppressWarnings("all")
        public java.lang.String toString() {
            return "User.UserBuilder(id=" + this.id + ", name=" + this.name + ", birthday=" + this.birthday + ")";
        }
    }

    @java.lang.SuppressWarnings("all")
    public static User.UserBuilder builder() {
        return new User.UserBuilder();
    }

    @java.lang.SuppressWarnings("all")
    public Integer getId() {
        return this.id;
    }

    @java.lang.SuppressWarnings("all")
    public String getName() {
        return this.name;
    }

    @java.lang.SuppressWarnings("all")
    public Date getBirthday() {
        return this.birthday;
    }

    @java.lang.SuppressWarnings("all")
    public void setId(final Integer id) {
        this.id = id;
    }

    @java.lang.SuppressWarnings("all")
    public void setName(final String name) {
        this.name = name;
    }

    @java.lang.SuppressWarnings("all")
    public void setBirthday(final Date birthday) {
        this.birthday = birthday;
    }

    @java.lang.Override
    @java.lang.SuppressWarnings("all")
    public boolean equals(final java.lang.Object o) {
        if (o == this) return true;
        if (!(o instanceof User)) return false;
        final User other = (User) o;
        if (!other.canEqual((java.lang.Object) this)) return false;
        final java.lang.Object this$id = this.getId();
        final java.lang.Object other$id = other.getId();
        if (this$id == null ? other$id != null : !this$id.equals(other$id)) return false;
        final java.lang.Object this$name = this.getName();
        final java.lang.Object other$name = other.getName();
        if (this$name == null ? other$name != null : !this$name.equals(other$name)) return false;
        final java.lang.Object this$birthday = this.getBirthday();
        final java.lang.Object other$birthday = other.getBirthday();
        if (this$birthday == null ? other$birthday != null : !this$birthday.equals(other$birthday)) return false;
        return true;
    }

    @java.lang.SuppressWarnings("all")
    protected boolean canEqual(final java.lang.Object other) {
        return other instanceof User;
    }

    @java.lang.Override
    @java.lang.SuppressWarnings("all")
    public int hashCode() {
        final int PRIME = 59;
        int result = 1;
        final java.lang.Object $id = this.getId();
        result = result * PRIME + ($id == null ? 43 : $id.hashCode());
        final java.lang.Object $name = this.getName();
        result = result * PRIME + ($name == null ? 43 : $name.hashCode());
        final java.lang.Object $birthday = this.getBirthday();
        result = result * PRIME + ($birthday == null ? 43 : $birthday.hashCode());
        return result;
    }

    @java.lang.Override
    @java.lang.SuppressWarnings("all")
    public java.lang.String toString() {
        return "User(id=" + this.getId() + ", name=" + this.getName() + ", birthday=" + this.getBirthday() + ")";
    }
}

如果想要看更多注解生成的代码，可以自己动手实验一下，使用下面的delombok获取Lombok处理之后的Java源代码。

delombok

通过delombok可以查看编译之后的Java源文件是咋样的。

# 编译整个src目录
java -jar lombok.jar delombok src -d src-delomboked

# 打印编译之后的Java文件
java -jar lombok.jar delombok -p MyJavaSourceFile.java
java -jar lombok.jar delombok -p E:\workspace\learning\src\main\java\org\curitis\lombok\User.java

文档资料

annotation-process
github
Lombok注解
Lombok下载
delombok
Lombok开始

trayvontang
关注
专栏目录
安装lombok插件_Lombok的介绍及安装
weixin_39759589的博客
01-30 618
简介Lombok是一个java库，它可以自动插入到编辑器和构建工具中，从而简化我们的ava代码。不用再重新编写getter和equals方法。通过在类上添加注释，可以使类带有功能全面的生成器，自动化的日志记录变量等等。总之一句话Lombok是一个通过在类上添加注解来简化我们的java代码，避免编写一些觉得相对比较臃肿的代码的工具包。原理Lombok本质上就是一个实现了“JSR 269 API”的程...
JAVA中Lombok插件详述
weixin_68138130的博客
07-11 397
JAVA中Lombok插件详述
使用 Lombok 的高版本 JDK 项目编译报错
Zero's Blog
01-10 660
项目使用了高版本 JDK (>1.8)，在依赖 Lombok 时，编译报错。
Java 开发神器 Lombok：告别冗余，拥抱优雅！
最新发布
qq_36807888的博客
08-05 404
你是否厌倦了 Java 代码中无处不在的 Getter、Setter、构造函数？Lombok 横空出世，为我们带来了福音！本文将深入浅出地介绍 Lombok 的功能和使用方法，并结合实际案例，带你领略 Lombok 的魅力，从此告别冗余，拥抱优雅编码！作为 Java 开发者，我们每天都要和各种类、对象打交道。而每个类中，几乎都少不了 Getter、Setter、构造函数、toString()、equals() 等方法。这些代码虽然必不可少，但编写起来却十分枯燥乏味，而且容易出错。
Java神奇工具——Lombok[最全]
IPOmonkey的博客
10-30 3419
最近刚接触，结果官网访问速度很慢，网上博客又没有介绍全，打算自己做个详细的，以防后面复习使用。 目录   Lombok 如何用Lombok——两种方法 有哪些注解可以使用呢[1.16.18版本一共18个注解，有一个注解不推荐使用] @AllArgsConstructor / @NoArgsConstructor / @RequiredArgsConstructor @Builde...
Lombok原理及使用
Jinghua_Guo的博客
04-29 471
前言 项目中使用到了Lombok，但对于它的实现原理以及缺点却知之甚少，而本文将会从Lombok的原理出发，手动实现一个简易版的Lombok，来理解这个热门技术背后的执行原理，以及它的优缺点。 1. 简介 Lombok 是一个非常热门的开源项目 (https://github.com/rzwitserloot/lombok)，可以通过简单的注解的形式来帮助我们简化消除一些必须有但显得很臃肿的...
LombokLombokLombok
04-03
Lombok是一款Java库，它通过注解处理器在编译时自动插入代码，从而简化Java对象的创建和维护。它的核心目标是减少样板代码，提高代码的可读性和简洁性。Lombok提供了各种注解，例如`@NonNull`、`@Data`、`@...
lombok 1.18.24
05-26
Lombok 是一个 Java 开发工具，它通过注解处理器在编译时自动插入代码，以减少样板代码。Lombok 的最新版本是 1.18.24，这个版本修复了一些已知问题，并可能引入了新的特性或改进。在 Java 开发中，Lombok 提供的...
lombok_lombok_源码.zip
09-30
Lombok 是一个 Java 开发工具库，它通过注解处理器自动为 Java 类生成常见的 getter、setter、构造器、equals、hashCode 和 toString 方法，极大地减少了样板代码。本压缩包"Lombok_lombok_源码.zip"包含了 Lombok ...
lombok.zip
05-19
Lombok 是一个非常实用的Java库，它通过提供一系列注解来简化代码，尤其是在处理getter、setter、equals、hashCode、toString等常规样板代码时。Lombok 的目标是减少Java开发中的冗余代码，提高开发效率，使代码更加...
Lombok-全面详解（学习总结---从入门到深化）
热门推荐
12-01 1万+
以前的Java项目中，充斥着太多不友好的代码：POJO的 getter/setter/toString/构造方法；打印日志；I/O流的关闭操作等 等，这些代码既没有技术含量，又影响着代码的美观，Lombok应 运而生。LomBok可以通过，帮助开发人员消除JAVA中尤其是POJO类中 的冗长代码。1、使用LomBok之前2、使用LomBok之后。
Lombook简介以及使用
夏目_muzi_920316的博客
05-28 6444
lombok是一个可以通过简单的注解的形式来帮助我们简化消除一些必须有但显得很臃肿的 Java 代码的工具，简单来说，比如我们新建了一个实体类，然后在其中写了几个字段，然后通常情况下我们需要手动去建立getter和setter方法以及构造方法等，lombok的作用就是为了省去我们手动创建这些代码的麻烦，它能够在我们编译源码的时候自动帮我们生成这些方法，这样的代码就显得简洁干净。1、添加依赖：   ...
Lombok简介、使用、工作原理、优缺点（转载）
uzong
01-23 5759
文章转载：https://www.jianshu.com/p/453c379c94bd   Lombok简介、使用、工作原理、优缺点 1.Lombok简介 官方介绍 Project Lombok is a java library that automatically plugs into your editor and build tools, spicing up your ja...
lombok使用，需要安装才能使用（有版本兼容问题）
honcy_li的博客
05-29 8141
注意：使用之前，做以下几步让eclipse支持该注解。 先下载lombok.jar: https://projectlombok.org/download.html 一般来说将下载好的lombok.jar  放在和eclipse.ini文件同一目录； 双击lombok.jar，一般会自动扫描出所有的eclipse.exe，选中你需要lombok的eclipse，点击"install/upda...
JDK和Lombok版本兼容问题
u011393781的博客
07-07 3726
@Getter @AllArgsConstructor public enum XXX { ADD("ADD"), UPDATE("UPDATE"), DELETE("DELETE"), ; private String operateType; } 错误：java: constructor LanguageOperateTypeEnum in enum com.timevale.open.service.enums.LanguageOperateT.
一个lombok与JDK16的兼容性问题
超威半导体
05-06 8984
问题 在公司下载了最新的 JDK16，我们的项目用到了lombok，启动项目的时候报错如下： java: java.lang.ExceptionInInitializerError Unable to make field private com.sun.tools.javac.processing.JavacProcessingEnvironment$DiscoveredProcessors com.sun.tools.javac.processing.JavacProcessingEnvironment
LomBok使用讲解
Happy_lifer的博客
06-13 3933
当我调试程序项目代码到调用Mybatis的插入SQL对应的方法的时候时，我看到NMetaVerify对象的nMetaType属性还是有数据的，但是执行插入之后，数据库的nMetaType就是一直是null，原先我以为是我的枚举类型写法不正确，看了下别的同样具有枚举类型的细分，也是正常能插入到数据库当中的，这更让我感觉到疑惑了。可以以链的形式调用；顶级类Object⾥⾯的⽅法，所有类都是继承Object的，返回值int类型根据⼀定的hash规则(存储地址，字段，或者⻓度等)，映射成⼀个数值，即散列值。
Lombok介绍及常用注解
qq_45780458的博客
03-10 352
Lombok介绍及常用注解
Lombok库压缩包使用指南
资源摘要信息: "Lombok-Jar包使用与配置指南" 知识点一：Lombok概述 Lombok是一个Java库，它通过注解的方式自动生成那些繁琐且重复性的代码，如getter和setter方法、equals和hashCode方法、toString方法等。通过...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值