开发人员必备的常用工具lombok

本文涉及的产品
检索分析服务 Elasticsearch 版,2核4GB开发者规格 1个月
智能开放搜索 OpenSearch行业算法版,1GB 20LCU 1个月
实时计算 Flink 版,5000CU*H 3个月
简介: 开发人员必备的常用工具lombok

1.什么是 Lombok

Java 语言的排名一直名列前茅,但是有时候我们的代码与业务无关,并且过于冗长,并例如在实体类中,经常写很多 getter 或者 setter 方法。
这时候我们使用 Lombok 来使用一些功能,使其代替我们把 Java 字节码自动编译到 class 文件中。

2.Lombok 配置

目前作者在用的 idea 版本为 2022.1.1 ,已经默认集成了 Lombok 插件,低版本的 idea 可以自行去插件库安装 Lombok 插件。

Maven 引入 Lombok 依赖

这里是Lombok更新日志与可用版本

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

pom.xml 中引入的上述依赖,可以看到 scopeprovided 状态,此状态表示此依赖只在编译与测试时有效,当我们项目打包成 *.jar 的时候并不会打入进去。

3.为什么要使用 Lombok

很多技术我们会有疑问,就是为什么要用这项技术?下面来揭晓

引入 Lombok 前 , 我们的实体类

package com.test;
public class TestModel {
    private String name;
    private Integer age;
    private String sex;
    public Integer getAge() {
        return age;
    }
    public void setAge(Integer age) {
        this.age = age;
    }
    public String getSex() {
        return sex;
    }
    public void setSex(String sex) {
        this.sex = sex;
    }
}

可以看到上面的实体代码中,已经多了很多 get 与 set 方法,这还是处于实体属性字段少的情况下。平时项目开发过程中,属性字段存在 30+ 的时候,大约会有 180+ 行 getset 方法冗余代码。整个实体很臃肿。这个时候我们引入 Lombok 看下

package com.test;
import lombok.Getter;
import lombok.Setter;
@Setter
@Getter
public class TestModel {
    private String name;
    private Integer age;
    private String sex;
    public static void main(String[] args) {
        TestModel model = new TestModel();
        model.setName("张三");
    }
}

我们加入了@Setter@Getter注解后,这时 Lombok 会代替我们在编译的时候,去 class 文件增加 getset 方法。

经常使用的时候,还会使用一个 @ToString 的注解,这时候发现类上已经追加了三个注解,再算上我们 swagger 和 jpa 等注解。


@Data注解

image.png

image.png

@Getter and Setter注解

image.png


@AllArgsConstructor注解image.png

@Accessors注解

当字段繁多的时候,我们使用这种链式的 set 方式使代码更加直观与整洁。

日常使用下的 set 方法是这样操作的

TestModel model = new TestModel();
model.setName("张三");
model.setAge(18);

get 方法是如下这样的


System.out.println(model.getName() + "-" + model.getAge());

get*() 与 set*() 写多了也会降低开发效率,并且看起来并不是很直观,因为这些大多是与逻辑无关的操作。

image.png

@Slf4j注解


image.png

@Builder实体建造者模式

以下代码为设置一个 api 请求的实体

public class ApiSettings {
    private String host;
    private int port;
    private String username;
    private String password;
    // 其他字段
    // 空构造方法
}
像上述这种情况,我们希望当创建完成一个 api 请求的设置后不会被 set 方法更改,这时需要设计一个建造者模式的实体。
使用 Lombok 的优点又体现出来,我们参考如下代码,使用 @Builder 注解。
@Builder
public class ApiSettings {
    // ... 类中代码保持不变
}

下面我们使用此模式来构建一个 api 请求类,如下:

ApiSettings.builder()
        .host("127.0.0.1")
        .port(8080)
        .username("admin")
        .password("admin")
        .build();


相关文章
|
2月前
|
Java
java小工具util系列5:java文件相关操作工具,包括读取服务器路径下文件,删除文件及子文件,删除文件夹等方法
java小工具util系列5:java文件相关操作工具,包括读取服务器路径下文件,删除文件及子文件,删除文件夹等方法
84 9
|
3月前
|
监控 Java 测试技术
Java开发现在比较缺少什么工具?
【10月更文挑战第15天】Java开发现在比较缺少什么工具?
41 1
|
2月前
|
SQL Java 索引
java小工具util系列2:字符串工具
java小工具util系列2:字符串工具
146 83
|
5天前
|
人工智能 自然语言处理 Java
FastExcel:开源的 JAVA 解析 Excel 工具,集成 AI 通过自然语言处理 Excel 文件,完全兼容 EasyExcel
FastExcel 是一款基于 Java 的高性能 Excel 处理工具,专注于优化大规模数据处理,提供简洁易用的 API 和流式操作能力,支持从 EasyExcel 无缝迁移。
53 9
FastExcel:开源的 JAVA 解析 Excel 工具,集成 AI 通过自然语言处理 Excel 文件,完全兼容 EasyExcel
|
1月前
|
Java 开发者 微服务
Spring Boot 入门:简化 Java Web 开发的强大工具
Spring Boot 是一个开源的 Java 基础框架,用于创建独立、生产级别的基于Spring框架的应用程序。它旨在简化Spring应用的初始搭建以及开发过程。
58 6
Spring Boot 入门:简化 Java Web 开发的强大工具
|
2月前
|
Java 数据库
java小工具util系列1:日期和字符串转换工具
java小工具util系列1:日期和字符串转换工具
60 26
|
2月前
|
Java
java小工具util系列4:基础工具代码(Msg、PageResult、Response、常量、枚举)
java小工具util系列4:基础工具代码(Msg、PageResult、Response、常量、枚举)
56 24
|
2月前
|
数据采集 存储 监控
Java爬虫:数据采集的强大工具
在数据驱动的时代,Java爬虫技术凭借其强大的功能和灵活性,成为企业获取市场信息、用户行为及竞争情报的关键工具。本文详细介绍了Java爬虫的工作原理、应用场景、构建方法及其重要性,强调了在合法合规的前提下,如何有效利用Java爬虫技术为企业决策提供支持。
|
2月前
|
Java 数据格式 索引
使用 Java 字节码工具检查类文件完整性的原理是什么
Java字节码工具通过解析和分析类文件的字节码,检查其结构和内容是否符合Java虚拟机规范,确保类文件的完整性和合法性,防止恶意代码或损坏的类文件影响程序运行。
56 5
|
2月前
|
Java API Maven
如何使用 Java 字节码工具检查类文件的完整性
本文介绍如何利用Java字节码工具来检测类文件的完整性和有效性,确保类文件未被篡改或损坏,适用于开发和维护阶段的代码质量控制。
119 5