Lombok插件使用

最新推荐文章于 2024-01-09 19:20:50 发布
最新推荐文章于 2024-01-09 19:20:50 发布
阅读量963 收藏 2
点赞数
分类专栏： Java类库 文章标签： lombok lombok插件
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u010979642/article/details/88976986
版权

文章目录

添加依赖

Maven添加依赖 pom.xml 文件

<dependencies>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.6</version>
    </dependency>
</dependencies>

Gradle添加依赖 build.gradle 文件

dependencies {
    compileOnly "org.projectlombok:lombok:1.18.6"
}

 

注解

val & var

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

public class AnswerAIL {

    public static void main(String[] args) {

        withLombok();

        System.out.println("\n##############################\n");

        withoutLombok();
    }


    
    private static void withLombok() {
        val map = new HashMap<String, String>();
        map.put("name", "answer");
        map.put("email", "answer_ljm@163.com");
        map.put("address", "pt");

        // val 声明的局部变量为 final 类型， 因此以下代码编译会出错
        // 把 val map = ... 替换成  var map = ... 以下代码编译就不会出错
        map = new HashMap<String, String>();
        
        for (String key: map.keySet()) {
            System.out.println(String.format("key[%s]\t\tvalue[%s]", key, map.get(key)));
        }
    }

    private static void withoutLombok() {
        Map<String, String> map = new HashMap<>();
        map.put("name", "answer");
        map.put("email", "answer_ljm@163.com");
        map.put("address", "pt");

        for (String key: map.keySet()) {
            System.out.println(String.format("key[%s]\t\tvalue[%s]", key, map.get(key)));
        }
    }

}

说明： var 和 val 功能类似(作为局部变量声明的类型)， 异同点: val 声明出来的局部变量为 final 类型

@NonNull

import lombok.Data;
import lombok.NonNull;

public class AnswerAIL {

    public static void main(String[] args) {

        withLombok();

        System.out.println("\n##############################\n");

        withoutLombok();
    }



    private static void withLombok() {
        WithNonNull withLombok = new WithNonNull("answer");

        // 编译出错, 因为 name 字段被 @NonNull 修饰, 不可为空
        withLombok = new WithNonNull();
    }

    private static void withoutLombok() {
        WithoutNonNull withoutLombok = new WithoutNonNull("answer");
    }

}


@Data
class WithNonNull {
    @NonNull
    private String name;

    private String email;

    private String address;
}


@Data
class WithoutNonNull {
    private String name;

    private String email;

    private String address;

    public WithoutNonNull(String name) {
        this.name = name;
    }
}

import lombok.Getter;
import lombok.NonNull;
import lombok.Setter;

public class AnswerAIL {

    public static void main(String[] args) {

//        withLombok();

        System.out.println("\n##############################\n");

        withoutLombok();
    }



    private static void withLombok() {
        WithNonNull withNonNull = new WithNonNull(null);
    }

    private static void withoutLombok() {
        WithoutNonNull withoutNonNull = new WithoutNonNull(null);
    }

}


class WithNonNull {
    @Getter
    @Setter
    private String name;

    public WithNonNull(@NonNull String name) {
        this.name = name;
    }
}


class WithoutNonNull {
    @Getter
    @Setter
    private String name;

    public WithoutNonNull(String name) {
        if (name == null) {
            throw new NullPointerException("name is marked @NonNull but is null");
        }
        this.name = name;
    }
}

@Cleanup

import lombok.Cleanup;
import java.io.*;

public class AnswerAIL {

    public static void main(String[] args) {

//        withLombok();

        System.out.println("\n##############################\n");

        withoutLombok();
    }



    private static void withLombok() {
        try {
            @Cleanup InputStream in = new FileInputStream("C:/ftpshare/answer.txt");
            @Cleanup OutputStream out = new FileOutputStream("C:/ftpshare/copy.txt");

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

    }

    private static void withoutLombok() {
        InputStream in = null;
        OutputStream out = null;
        try {
            in = new FileInputStream("C:/ftpshare/answer.txt");

            out = new FileOutputStream("C:/ftpshare/copy.txt");

            byte[] b = new byte[10000];
            while (true) {
                int r = in.read(b);
                if (r == -1) break;
                out.write(b, 0, r);
            }
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            if (out != null) {
                try {
                    out.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
            if (in != null) {
                try {
                    in.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
    }

}

可以使用 @Cleanup 确保在代码执行路径退出当前作用域之前自动清理给定的资源。

可以使用@Cleanup 注释对任何局部变量声明进行注释。

@Getter and @Setter

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

public class AnswerAIL {

    public static void main(String[] args) {

        withLombok();

        System.out.println("\n##############################\n");

        withoutLombok();
    }



    private static void withLombok() {
        WithLombok withLombok = new WithLombok();
        withLombok.setName("answer");
        withLombok.setEmail("answer@ljm@163.com");

        System.out.println(withLombok.toString());
    }

    private static void withoutLombok() {
        WithoutLombok withoutLombok = new WithoutLombok();
        withoutLombok.setName("answer");
        withoutLombok.setEmail("answer@ljm@163.com");

        System.out.println(withoutLombok.toString());
    }

}


class WithLombok {
    @Getter
    @Setter
    private String name;

    @Setter(AccessLevel.PROTECTED)
    private String email;

    @Override
    public String toString() {
        return String.format("name[%s]\t\temail[%s]", name, email);
    }
}


class WithoutLombok {
    private String name;
    private String email;

    @Override
    public String toString() {
        return String.format("name[%s]\t\temail[%s]", name, email);
    }

    public String getName() {
        return name;
    }

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

    protected void setEmail(String email) {
        this.email = email;
    }
}

@ToString

import lombok.ToString;

public class AnswerAIL {

    public static void main(String[] args) {

        Student student = new Student();

        System.out.println(student.toString());
    }

}


@ToString
class Person {
    private String name = "answer";

    private int sex = 1;
}


/**
 * # @ToString()
 *      Student(schoolName=ptwz)
 *
 * # @ToString(callSuper = true, includeFieldNames = false)
 *      Student(super=Person(name=answer, sex=1), ptwz)
 *
 * # @ToString(callSuper = true)
 *      Student(super=Person(name=answer, sex=1), schoolName=ptwz)
 * */
@ToString()
class Student extends Person {
    private String schoolName = "ptwz";

    // 重写 ToString 方法时， 排除掉 stuNo 字段
    @ToString.Exclude
    private String stuNo = "100000001";
}

@EqualsAndHashCode

import lombok.EqualsAndHashCode;

public class AnswerAIL {

}

@EqualsAndHashCode
class Person {
    private String name = "answer";

    private int sex = 1;
}


@EqualsAndHashCode(callSuper = false, of = {"schoolName"})
class Student extends Person {
    private String schoolName = "ptwz";

    // 此处编译会出错， 因为和 EqualsAndHashCode 中的 of 参数冲突
//    @EqualsAndHashCode.Exclude
    private String stuNo = "100000001";
}
  • 生成 equals(Object other) 和 hashCode() 方法的实现
  • 它默认使用所有非静态，非瞬态字段
  • 可通过参数 @EqualsAndHashCode.Exclude 排除一些属性
  • 可通过参数 of 指定仅使用哪些属性
  • 默认仅使用该类中定义的属性且不调用父类的方法， 可通过设置 callSuper = false 来让其生成的方法中调用父类的方法

@NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor

import lombok.AccessLevel;
import lombok.NonNull;
import lombok.RequiredArgsConstructor;
import lombok.ToString;

public class AnswerAIL {

    public static void main(String[] args) {
        Person person = Person.answerMethod("answer", 10);

        System.out.println(person.toString());
    }
}

// 定义静态方法的名称为 answerMethod， 修饰符为 public
@RequiredArgsConstructor(staticName = "answerMethod", access = AccessLevel.PUBLIC)
@ToString
class Person {
    @NonNull
    private String name;
    private final int age;
    private String email;

}

/* Output： Person(name=answer, age=10, email=null) */
  • RequiredArgsConstructor: 为所有 final 和 @NonNull 修饰的字段生成一个构造方法， 生成的构造方法是private，如何想要对外提供使用可以使用 staticName 选项生成一个static方法
  • NoArgsConstructor： 生成一个无参数的构造方法
  • AllArgsConstructor： 生成一个包含所有变量，同时如果变量使用了@NonNull修饰， 会进行是否为空的校验

@Data

import lombok.Data;
import lombok.NonNull;

public class AnswerAIL {

    public static void main(String[] args) {

        Person person = Person.newInstance("answer", "answer_ljm@163.com");
        System.out.println(person.toString());

    }

}

@Data(staticConstructor = "newInstance")
class Person {
    @NonNull
    private String name;
    @NonNull
    private String email;

}

/* Output： Person(name=answer, email=answer_ljm@163.com) */

说明： @Data 注释已经隐式的包含了 @Getter、@Setter、@ToString、@EqualSandHashCode 以及 @RequiredArgsConstructor 注释

@Value

https://projectlombok.org/features/Value

@Builder

https://projectlombok.org/features/Builder

@SneakyThrows

@SneakyThrows
public void method() {
    dataService.queryList();
}

// 反编译后代码
public void method() {
    try {
        this.dataService.queryList();
    } catch (Throwable var2) {
        throw var2;
    }
}

https://projectlombok.org/features/SneakyThrows

@Synchronized

https://projectlombok.org/features/Synchronized

@Getter(lazy=true)

https://projectlombok.org/features/GetterLazy

@Log (and friends)

@Log

import lombok.extern.java.Log;

// withLombok
@Log
public class AnswerAIL {
    // withoutLombok
//    private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(AnswerAIL.class.getName());

    public static void main(String[] args) {

        log.severe("answer ai l");

        log.info("answer ai l");

    }

}

@Slf4j

import lombok.extern.slf4j.Slf4j;

// withLombok
@Slf4j
public class AnswerAIL {
    // withoutLombok
//    private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(AnswerAIL.class.getName());

    public static void main(String[] args) {

        log.info("answer ai l");

    }

}

@CommonsLog

import lombok.extern.apachecommons.CommonsLog;

// withLombok, 指定 topic 值, 默认为 类的全限定名
@CommonsLog(topic = "AnswerLog")
public class AnswerAIL {
    // withoutLombok, LogFactory.getLog(AnswerAIL.class);
//    private static final org.apache.commons.logging.Log log = org.apache.commons.logging.LogFactory.getLog("AnswerLog");

    public static void main(String[] args) {

        log.info("answer ai l");

    }

}

@Delegate

通过 @Delegate 注释实现代理模式

public interface IUserService {
    int insertUser();
    List<String> findUserNames();
    int updateUser();
    int deleteUser();
    // 注意此方法对应 UserMapper.findUserIds
    List<Long> queryUserIds();
}

@Service
public class UserServiceImpl implements IUserService {
    @lombok.experimental.Delegate
    private final UserMapper userMapper;

    @Autowired
    public UserServiceImpl(UserMapper userMapper) {
        this.userMapper = userMapper;
    }

    @Override
    public List<Long> queryUserIds() {
        return this.userMapper.findUserIds();
    }
}

public interface UserMapper {
    int insertUser();
    List<String> findUserNames();
    int updateUser();
    int deleteUser();
    List<Long> findUserIds();
}

public class UserServiceImpl {
    /**
     * 代理 userMapper 的所有方法(对外提供的方法名和代理的方法名一致)
     * */
    @Delegate
    private final UserMapper userMapper;

    public UserServiceImpl(UserMapper userMapper) {
        this.userMapper = userMapper;
    }
}

@Accessors

链式风格

@Data
@Accessors(chain = true)
public class OrderDTO {
    private String orderNo;
    private Double orderAmt;
    private Byte orderStatus;
}

OrderDTO order = new OrderDTO();
order.setOrderNo("201912110001").setOrderAmt(12.542).setOrderStatus((byte)10);

它有三个选项：（以 name 成员变量为例）

  • fluent： 默认值是 false。如果是 false ，setter 生成的函数是 String setName（String name）; 如果是 true, setter 是生成的是 User name(String name) ，返回的是 this，是种链式 Setter，同时 chain 会是 true。
  • chain： 默认值是 false。如果是 true，setter 生成的函数是 User setName（String name）。否则的是void setName（String name）
  • prefix： 比如成员变量是 gk_name,加上注解 @Accessors(prefix = “gk_”),生成的 Getter 和 Setter 中则没有 gk_ 前缀

 

附录 - References

Jaemon
关注
专栏目录
lombok插件
05-25
**正文** Lombok插件是Java开发者常用的工具...通过正确使用Lombok插件，开发者可以专注于业务逻辑，而不是样板代码，从而提升开发效率和代码质量。理解并熟练应用Lombok的注解，将有助于编写更简洁、优雅的Java代码。
使用Lombok@Builder、@Data（没有生成无参构造方法）这个坑要注意
念念不忘，必有回响
05-17 8901
Lombok为我们开发带来了极大便利，特别是在想要使用建造者模式的时候只需要在类上加@Builder注解即可。但是不小心也会引发隐藏的bug。 我们来看看案例 在维护旧代码的时候，由于以前创建类的时候是使用普通的new + 一系列的set方法去构建 需要构建的类如下，属性有缩减 @Data public class SearchCondition { private String years; private List<String> months; private
Lombok 插件如何使用
m0_65735686的博客
11-13 1033
Lombok 插件如何使用
【工具篇】Lombok 介绍及使用（详细教程）
小杨的博客
07-31 1万+
本文核心： 1，Lombok插件的介绍？ 2，Lombok插件的下载？ 3，Lombok插件的实现原理？ 4，Lombok插件的使用？
lombok的使用
weixin_44795196的博客
02-06 574
作用：通过用简单的注释集代替众多的代码。 常用注解： @Setter ：注解在类或字段，注解在类时为所有字段生成setter方法，注解在字段上时只为该字段生成setter方法。 @Getter ：使用方法同上，区别在于生成的是getter方法。 @ToString ：注解在类，添加toString方法。 @EqualsAndHashCode： 注解在类，生成hashCode和equals方法。 @...
一篇文章教你学会使用Lombok（Lombok使用详解）
路漫漫其修远兮，吾将上下而求索。小手点一波关注进阶的李仙桎，我们一起携手进步，
06-26 329
一个标准的 Java对象中通常具备具有几个属性。每个属性具有一个get和set方法。通常还会有toString()方法。对于每一个类中都会写大量的这些方法，尽管可以使用快捷键生成， 但是当再一个类里面添加或者修改属性的时候有需要修改或者增加get和set方法，重写toString()方法。这样无疑显得很麻烦，但是使用LomBok插件就可以代替这些繁琐的工作，你学还是不学？
eclipse 安装lombok插件
08-27
本文将详细讲解如何在Eclipse中安装Lombok插件。 首先，我们需要从Lombok的官方网站获取插件。Lombok的下载地址有两个： 1. 直接下载jar文件：https://projectlombok.org/downloads/lombok.jar 2. 或者访问官网：...
lombok 插件idea 下载
04-10
在标题和描述中提到的"Lombok插件 IDEA 下载"，主要是指在IntelliJ IDEA这个流行的Java开发环境中安装和使用Lombok插件的过程。 Lombok插件的安装通常有两种方式：在线安装和离线安装。在线安装是通过IDEA的内置...
Lombok插件
04-27
**Lombok插件详解** Lombok是一款非常实用的Java编程工具，它的主要目的是为了简化Java对象的创建和维护，减少冗余的样板代码。通过在源代码中添加特定的注解，Lombok可以在编译时自动生成getter，setter，toString...
idea lombok插件
01-05
1. **代码提示与自动完成**：在使用Lombok注解时，IDEA Lombok插件会提供代码提示和自动完成，使得编写代码更加高效。 2. **代码预览**：当你添加了Lombok注解，插件会显示预生成的代码，方便查看和理解。 3. **代码...
Java - Lombok介绍、使用、工作原理、优缺点
m0_65228708的博客
12-10 1157
介绍 Lombok的使用 示例 Lombok工作原理 常用注解 注解使用有风险
MySQL篇—通过Clone插件进行本地克隆数据（第二篇，总共三篇）
最新发布
奈斯DBA的博客
01-09 1426
通过MySQL的Clone插件进行本地克隆数据。
IDEA从零到精通（24）之lombok插件的安装与使用
热门推荐
编程界明世隐的博客
03-25 2万+
IDEA从零到精通（24）之lombok插件的安装与使用
笃学私教：Lombok入门使用教程及其优缺点详解
weixin_46898270的博客
10-22 1534
在Java开发中，因工作需要，你可能会学习或被迫去学习Lombok这个工具，这玩意用起来可以说是贼爽，很方便，可玄武老师实际上并不推荐大家使用，至于Lombok是什么？怎么入门？为什么不推荐使用？下面，玄武老师会慢慢跟你讲解。 一、Lombok是什么？ 1、官方网站地址：点击直达 2、官网对Lombok的描述如下： Project Lombok is a java library that automatically plugs into your editor and build tools, spic
lombok插件的使用和技巧
weixin_54828627的博客
02-19 172
在过往的Java项目中，充斥着太多不友好的代码：POJO的getter/setter/toString；异常处理；I/O流的关闭操作等等，这些样板代码既没有技术含量，又影响着代码的美观，于是Lombok应运而生。Lombok能够达到的效果就是在源码中不需要写一些通用的方法，但是在编译生成的字节码文件中会帮我们生成这些方法,减少代码冗余.
javassist简单介绍以及如何使用它来实现lombok的功能
记忆碎片
07-10 830
最近在学习MyBatis的源码，在阅读的过程中，发现有一个叫做javaassist的工具，查阅了一些资料，这个工具和ASM的功能类似，可以直接修改Java的字节码文件，而ASM要更偏向底层一些。 下面我们通过一个例子来学习其使用方法: public class Run { public static void main(String[] args) { Class...
Lombok使用与踩坑
Lee_01的博客
09-17 2408
一、使用Lombok 1.在pom文件中引入依赖 <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </depen...
Lombok：lombok中使用@Builder
苦行僧
08-21 1万+
文章摘自：https://www.baeldung.com/lombok-builder 1. Overview Project Lombok’s @Builder is a useful mechanism for using the Builder pattern without writing boilerplate code. We can apply this annotation ...
idealombok插件怎么使用
04-15
关于idealombok插件的使用请参考以下步骤： 1. 在您的Java项目中添加idealombok插件的依赖 2. 配置pom.xml文件，添加lombok依赖 3. 在Java类中添加注解，如@NoArgsConstructor、@AllArgsConstructor等 4. 使用相应...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

Jaemon

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

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

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

打赏作者

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

抵扣说明：

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

余额充值