lombok 注解

Posted 2022-07-02 weixuqin

lombok 注解

1. 什么是 lombok 注解

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

简单来说，使用 lombok 可以帮助我们减少 getter / setter / toString 等方法的编写，虽然 IDEA也提供了自动生成 getter / setter / toString 的方式，但是使用 lombok 可以让我们的代码更加简洁，减少代码的冗长。

2. 安装

Ctr + Alt + S 打开 IDEA 的 Setting 面板，选择 Plugins 选项，然后点击 "Brower repositories"，在输入框输入 "lombok"，根据搜索结果选择并安装，然后按提示重启 IDEA，安装完成。

这里顺便推荐一下另一个插件："Material Theme UI"，这个是 IDEA 的一个第三方主题插件，实现类似安卓 material design 的风格，个人觉得挺好看的。有兴趣可自行下载安装尝试。

3. 使用

1. 依赖

要使用 lombok，仅仅安装插件是不够的，插件只是为了防止 IDEA 识别报错，我们还要导入相应的依赖，这里以 maven 依赖为例：

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

2. 使用

使用很简单，比如我们要使用下列对象，按平时的开发思路来说，必须要写一些 getter / setter 方法，或者还需要构造器，toString 方法等。

public class Mountain
    private String name;
    private double longitude;
    private String country;

现在有了 lombok，我们只需要添加一行注释：

@Data
public class Mountain
    private String name;
    private double longitude;
    private String country;

使用 Ctr + F12，查看一个类中的所有方法（View | Tool Windows | Structure），可以看到这个类自动生成了这些方法：

当然有时候生成全部方法显得不是那么友好，那么我们可以使用 lombok 提供的更精细化的注解，比如：

• @Getter，@Setter （即是属性注解又是类注解，注解在属性上，为当个属性提供 get/set 方法；注解在类上，为该类所有的属性提供 get/set 方法，并提供默认构造方法）
• @ToString，@AllArgsConstructor （类注解）

关于 lombok 注解的更多用法，参考这篇 文章。

3. 个人习惯

一般情况下，我自己喜欢直接加个 @Data 注解，简单粗暴。