Lombok介绍及使用

最新推荐文章于 2025-04-30 15:58:47 发布

V5放纵丶

最新推荐文章于 2025-04-30 15:58:47 发布

阅读量1.4k

点赞数

分类专栏： Java Java Web 文章标签： Lombok 插件

本文链接：https://blog.youkuaiyun.com/weixin_43611145/article/details/107463392

版权

Lombok是一个Java库，通过注解消除样板代码。本文介绍了如何在IDEA中配置和使用Lombok，包括引入依赖、安装插件以及常用注解的详细解释，如@Data、@Setter和@Getter等，并简要讨论了可能遇到的问题及其解决方案。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

观前提示：

IDEA版本为ultimate 2019.1，JDK版本为1.8.0_141。

1.简介

Lombok项目是一个Java库，它会自动插入编辑器和构建工具中，Lombok提供了一组有用的注释，用来消除Java类中的大量样板代码。仅五个字符(@Data)就可以替换数百行代码从而产生干净，简洁且易于维护的Java类。

官网地址点我

2.IDEA中使用

2.1 引入依赖包

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

注：scope为provided，说明它只在编译阶段生效，不需要打入包中。

2.2 IDEA中加载Lombok插件

点击File->Setting…
在这里插入图片描述
Plugins->搜索Lombok->安装Install->重启IDEA使插件生效

2.3 常用注解

@Setter ：注解在类或字段，注解在类时为所有字段生成setter方法，注解在字段上时只为该字段生成setter方法。
@Getter ：使用方法同上，区别在于生成的是getter方法。
@ToString ：注解在类，添加toString方法。
@EqualsAndHashCode：注解在类，生成hashCode和equals方法。
@NoArgsConstructor：注解在类，生成无参的构造方法。
@RequiredArgsConstructor：注解在类，为类中需要特殊处理的字段生成构造方法，比如final和被@NonNull注解的字段。
@AllArgsConstructor：注解在类，生成包含类中所有字段的构造方法。
@Data：注解在类，生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。
@Slf4j：注解在类，生成log变量，严格意义来说是常量。

3 简单例子

3.1 例1

package testLombok;

import com.sun.istack.internal.NotNull;
import lombok.*;

/**
 * 用户实体
 * @author jjy
 * @date 2020-07-20
 */
@Getter
@Setter
@ToString(of = {
   "name","age"})
@EqualsAndHashCode
@RequiredArgsConstructor
@AllArgsConstructor
@NoArgsConstructor
public class User {
   

    /** 名称 */
    private String name;
    /** 年龄 */
    private Integer age;
    /** 电话 */
    @NotNull
    private String mobile;
    /** email */
    public String email;

}

反编译结果

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

package testLombok;

import com.sun.istack.internal.NotNull;

public class User {
   
    private String name;
    private Integer age;
    @NotNull
    private String mobile;
    public String email;

    public String getName() {
   
        return this.name;
    }

    public Integer getAge() {
   
        return this.age;
    }

    public String getMobile() {
   
        return this.mobile;
    }

    public String getEmail() {
   
        return this.email;
    }

    public void setName(String name