SpringBoot [ 4.使用Lombok]

最新推荐文章于 2024-07-18 18:46:47 发布
最新推荐文章于 2024-07-18 18:46:47 发布
阅读量433 收藏 1
点赞数 1
分类专栏： Spring-Boot 文章标签： springboot lombok
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/java_jet/article/details/92966163
版权
本文介绍了SpringBoot项目中Lombok的使用，包括如何集成Lombok插件，通过pom引入依赖，以及常用注解如@Getter、@Setter、@ToString、@EqualsAndHashCode、@Data、@RequiredArgsConstructor、@AllArgsConstructor和@Accessors的详细用法，帮助提高编程效率。
摘要由CSDN通过智能技术生成

SpringBoot [ 4.使用Lombok] - 目录

文章目录

1.概述

我前面得几篇博客频繁得使用到了Lombok，这里我就讲一下，我在公司得工作过程当中，我最常用得一些Lombok得注解得用法。

Lombok它是一款使用注解，用来精简代码，提高编程效率得Java工具，
至于它是怎么精简得，以及它得一些特性，下面得内容我会介绍。

2.使用

2.1.编译器集成Lombok插件

Java编译器，idea和eclipse都可以集成Lombok插件，本人使用得是idea，这里就简单介绍一下idea得集成。

打开idea得setting配置，在Plugins中搜索Lombok，点击安装，然后重启编译器即可使用。

在这里插入图片描述

2.2.pom引入依赖

spring-boot-dependencies当中已经有了Lombok得版本管理，这里我们直接引入就好了。

<!-- Lombok -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <scope>provided</scope>
</dependency>


<!-- 依赖统一管理 -->
<dependencyManagement>
    <dependencies>
        <!-- Spring Boot -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>${spring.boot.version}</version>
            <scope>import</scope>
            <type>pom</type>
        </dependency>
    </dependencies>
</dependencyManagement>

3.常用注解

在工作当中，我最常用得就是在，entity，dto，vo这些类上频繁得使用到Lombok得注解; 这些注解得作用其实就是，使用之后不需要编写对应得Java代码，比如说我使用@Getter注解之后，就不需要编写get方法；

不需要编写代码，那项目怎么运行呢，是这样的，在项目进行打包编译得时候它会在.class文件中自动生成对应得代码，只不过在我们项目源码中没有对应得编码。

3.1.类注解

3.1.1.@Getter

在类打上@Getter注解，不需要生成Get方法得代码，其他地方就可直接使用Get方法;

package com.mantou.boot.dto;

import lombok.*;

/**
 * Lombok测试类
 * @author mantou
 */
@Getter
public class LombokDemoDTO {

    /**
     * 标题
     */
    private String title;

    /**
     * 内容
     */
    private String content;
}

在这里插入图片描述

/**
 * Lombok测试接口
 * @author mantou
 */
@Slf4j
@RestController
@RequestMapping("/lombok")
public class LombokDemoController {

    /**
     * 获取Lombok实例
     * @return
     */
    @GetMapping(value = "/getLombokInstance")
    public Result getLombokInstance() {

        LombokDemoDTO lombokDemoDTO = new LombokDemoDTO();
        String content = lombokDemoDTO.getContent();

        return Result.success();
    }
}

3.1.2.@Setter

在类打上@Setter注解，不需要生成Set方法得代码，其他地方就可直接使用Set方法;

package com.mantou.boot.dto;

import lombok.*;

/**
 * Lombok测试类
 * @author mantou
 */
@Getter
@Setter
public class LombokDemoDTO {

    /**
     * 标题
     */
    private String title;

    /**
     * 内容
     */
    private String content;
}

在这里插入图片描述

/**
 * Lombok测试接口
 * @author mantou
 */
@Slf4j
@RestController
@RequestMapping("/lombok")
public class LombokDemoController {

    /**
     * 获取Lombok实例
     * @return
     */
    @GetMapping(value = "/getLombokInstance")
    public Result getLombokInstance() {

        LombokDemoDTO lombokDemoDTO = new LombokDemoDTO();
        lombokDemoDTO.setContent("内容");
        String content = lombokDemoDTO.getContent();

        return Result.success();
    }
}

3.1.3.@ToString

在类打上@ToString注解，会重写类得toString方法

package com.mantou.boot.dto;

import lombok.*;

/**
 * Lombok测试类
 * @author mantou
 */
@Getter
@Setter
@ToString
public class LombokDemoDTO {

    /**
     * 标题
     */
    private String title;

    /**
     * 内容
     */
    private String content;
}

3.1.5.@EqualsAndHashCode

在类打上@EqualsAndHashCode注解，会重写类得equals方法和hashCode方法

import lombok.*;

/**
 * Lombok测试类
 * @author mantou
 */
@Getter
@Setter
@ToString
@EqualsAndHashCode
public class LombokDemoDTO {

    /**
     * 标题
     */
    private String title;

    /**
     * 内容
     */
    private String content;
}

到这里为止，我们可以看一下项目编译过后的.class文件
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
很明显，它生成了get方法，set方法，重写了toString方法，hashCode方法和equals方法.

3.1.4.@Data

这个@Data是我最常用的注解之一，因为具备@Setter，@Getter，@ToString，@EqualsAndHashCode的功能。

这个时候，我们把上面的那四个注解去掉，打上@Data注解

import lombok.*;

/**
 * Lombok测试类
 * @author mantou
 */
@Data
public class LombokDemoDTO {

    /**
     * 标题
     */
    private String title;

    /**
     * 内容
     */
    private String content;
}

打上注解以后，把.class文件clean一下，重写编译，再看.class文件

在这里插入图片描述
在这里插入图片描述
我们可以发现，生成的编码和上面那四个注解生成的编码是一样的.

3.1.5.@RequiredArgsConstructor

这个注解我比较喜欢用，类打上这个注解后，会生成一个静态方法，该方法会返回一个new的对象，这个方法名是由我们自定义的.

package com.mantou.boot.dto;

import lombok.*;

/**
 * Lombok测试类
 * @author mantou
 */
@Data
@RequiredArgsConstructor(staticName = "newLombokDemoDTO")
public class LombokDemoDTO {

    /**
     * 标题
     */
    private String title;

    /**
     * 内容
     */
    private String content;
}

在这里插入图片描述

/**
 * Lombok测试接口
 * @author mantou
 */
@Slf4j
@RestController
@RequestMapping("/lombok")
public class LombokDemoController {

    /**
     * 获取Lombok实例
     * @return
     */
    @GetMapping(value = "/getLombokInstance")
    public Result getLombokInstance() {

        LombokDemoDTO lombokDemoDTO = LombokDemoDTO.newLombokDemoDTO();
        lombokDemoDTO.setContent("内容");

        String content = lombokDemoDTO.getContent();

        return Result.success(lombokDemoDTO.toString());
    }
}

这个时候我们再来看一下.class文件，生成了一个静态的方法，返回一个new的对象
在这里插入图片描述

3.1.6.@AllArgsConstructor

在类打上@AllArgsConstructor注解，会生成一个有所有参数的构造方法

/**
 * Lombok测试类
 * @author mantou
 */
@Data
@AllArgsConstructor
@RequiredArgsConstructor(staticName = "newLombokDemoDTO")
public class LombokDemoDTO {

    /**
     * 标题
     */
    private String title;

    /**
     * 内容
     */
    private String content;
}

看下.class文件

在这里插入图片描述

3.1.7.@Accessors

这个注解其实就是使对象支持链式的set方法

package com.mantou.boot.dto;

import lombok.*;
import lombok.experimental.Accessors;

/**
 * Lombok测试类
 * @author mantou
 */
@Data
@AllArgsConstructor
@Accessors(chain = true)
@RequiredArgsConstructor(staticName = "newLombokDemoDTO")
public class LombokDemoDTO {

    /**
     * 标题
     */
    private String title;

    /**
     * 内容
     */
    private String content;
}

使用

/**
 * Lombok测试接口
 * @author mantou
 */
@Slf4j
@RestController
@RequestMapping("/lombok")
public class LombokDemoController {

    /**
     * 获取Lombok实例
     * @return
     */
    @GetMapping(value = "/getLombokInstance")
    public Result getLombokInstance() {

        LombokDemoDTO lombokDemoDTO = LombokDemoDTO.newLombokDemoDTO()
                .setContent("内容").setTitle("标题");

        String content = lombokDemoDTO.getContent();

        return Result.success(lombokDemoDTO.toString());
    }
}

我们看一下.class文件，其实就是在set方法加了一个返回值

在这里插入图片描述

3.1.8.@Slf4j

这个是一个提供日志对象(log)的注解，我项目中日志使用的是slf4j + logback，我这里就使用@Slf4j注解，如果日志使用的是log4j，那就使用@Log4j注解;

/**
 * Lombok测试接口
 * @author mantou
 */
@Slf4j
@RestController
@RequestMapping("/lombok")
public class LombokDemoController {

    /**
     * 获取Lombok实例
     * @return
     */
    @GetMapping(value = "/getLombokInstance")
    public Result getLombokInstance() {

        LombokDemoDTO lombokDemoDTO = LombokDemoDTO.newLombokDemoDTO()
                .setContent("内容").setTitle("标题");

        String content = lombokDemoDTO.getContent();

        log.info("content : {}", content);

        return Result.success(lombokDemoDTO.toString());
    }

再看一下.class文件，生成了一个日志对象
在这里插入图片描述

我在实际的开发当中，最常用的Lombok注解就这些了.

我是馒头啊
关注
  • 1
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
SpringBoot第三天 - Lombok
adas5f1a51的博客
05-19 103
SpringBoot - Lombok 1. 简介 官方介绍： Project Lombok is a java library that automatically plugs into your editor and build tools, spicing up your java. Never write another getter or equals method again, with one annotation your class has a fully featured builde
SpringBoot 项目中 Lombok 的使用
grammer_du的博客
07-31 312
Lombok 是一个 Java 的类库，可以通过注解等方式插入到项目代码中，来增加 Java 代码的功能，只需要通过指定的注解，就可以实现指定的功能，极大的简化代码编写。Lombok 能通过注解的方式，在编译期间自动为类属性生成构造函数、get/set 方法等内容，保持代码简洁的情况下保证类信息的完整性。
springboot依赖lombok插件、lombok常用注解
IT_Most的博客
11-22 7141
springboot依赖lombok插件、lombok常用注解讲解
注解的使用（一）：APT，编译时注解处理器
bugyinyin的博客
12-04 451
关于编译时注解（APT）由浅入深有三部分，分别是： 自定义注解处理器 ： 例如 ButterKnife、Room 根据注解生成新的类； 利用 JcTree 在编译时修改代码：像 Lombok 自动往类中新增 getter/setter 方法、往方法中插入代码行等； 自定义 Gradle 插件在编译时修改代码 ：例如一些代码插桩框架，以及我司一些应用使用了这种方式。 这篇文章以Demo的形式，介绍如何从零开始创建一个自定义的注解处理器，并生成一个新的类。这个类中有一个静态方法，方法返回添加了自定义注解的所
SpringBoot框架学习笔记（三）：Lombok 和 Spring Initailizr
最新发布
2301_76144723的博客
07-18 921
（1）Lombok 作用简化JavaBean开发，可以使用Lombok的注解让代码更加简洁Java项目中，很多没有技术含量又必须存在的代码：POJO的getter/setter/toString；异常处理；I/O流的关闭操作等等，这些代码既没有技术含量，又影响着代码的美观，Lombok应运而生（2）SpringBoot 和 IDEA 官方支持IDEA 2020已经内置了Lombok插件SpringBoot 2.1.x之后的版本也在Starter中内置了Lombok依赖。
SpringBoot系列-- SpringBoot中使用lombok简化开发
Gang-bb的博客
01-29 2234
目录1. 项目环境2.添加依赖和安装插件3. 实体类常用注解总结3.1 @Setter、@Getter3.1.1 注解在属性上3.1.2 注解在类上3.1.3 注解对静态属性和final类型属性3.2 @NoArgsConstructor3.3 @AllArgsConstructor3.4 @RequiredArgsConstructor3.5 @ToString3.6 @EqualsAndHashCode3.7 @Data(常用)3.8 @Builder3.9 @Value3.10 @NonNull4.
Spring Boot整合Lombok全过程及详细用法
weixin_52721608的博客
09-16 1340
Lombok是一个Java库，它通过注解的方式简化了Java代码的编写。它可以自动为我们生成一些常见的方法和代码，如getter和setter方法、构造函数以及toString()方法等。在Spring Boot项目中使用Lombok可以大大减少冗余的代码，使代码更加简洁和易于维护。本文将介绍如何在Spring Boot项目中整合Lombok，并详细说明Lombok的常用注解及用法。
Springboot整合Lombok插件使用
青春不散场的专栏
06-19 298
Lombok是目前比较流行的java插件，其内部原理是在编译期通过注解对类进行方法扩展，也是目前非常多的项目使用的主流组件，能够节省很多代码，让代码更容易阅读，更方便编写，也是我最喜欢的插件之一...
Springboot 集成 lombok.jar过程解析
08-25
Springboot 集成 lombok.jar 过程解析 Spring Boot 是一个高效的开发框架，而 Lombok 则是一套代码模板解决方案，它可以极大地提升开发的效率。Lombok 的主要目的是解决在实体 Bean 中大量的 Getter/Setter 方法，...
SpringBoot使用LomBok的示例代码
08-27
SpringBoot 使用 LomBok 的示例代码 在本文中，我们将详细介绍如何使用 LomBok 在 SpringBoot 项目中，以简化代码编写过程。LomBok 是一个 Java 库，可以帮助开发者消除重复的代码，例如 setter、getter、构造函数...
详解SpringBoot优雅编码之Lombok加持
08-27
详解SpringBoot优雅编码之Lombok加持 Lombok是一款功能强大且广泛使用的Java库，旨在简化Java开发过程，提高代码质量和开发效率。下面我们将详细介绍Lombok的使用方法和优雅编码技巧。 Lombok的优点： 1. 简化...
springboot application.yml配置学习.docx
07-10
import lombok.Data;@Datapublic class Classroom { @JsonProperty("clazz") private String className; @JsonProperty("grade") private String gradeName; @JsonProperty("seatNum") private Integer seatNumber; ...
InterJ IDEA搭建 SpringBoot整合MyBatis.7z SprintBootMyBatis lombok
02-07
4. **创建实体类（Entity）**：Lombok可以帮助我们生成实体类的getter、setter等方法。例如，创建一个名为`User`的实体类，添加`@Data`注解： ```java @Data public class User { private Long id; private ...
【SpringBoot新手篇】SpringBoot集成Lombok
输入技术、输出想法
04-30 1610
SpringBoot集成LombokLombok是什么? Lombok是什么? 它是一个能帮我们消除那些必须要写但是重复的代码，比如setter，getter，构造函数之类的方法。 idea安装lombok: 在idea的settings（windows）或者Preferences（mac），下找到plugins菜单，点击Browse repositories，如图 然后搜索lombok，点击右侧下载，下载完成重启即可，如图 新建项目，在pom文件中加入lombok依赖，完整pom如下： <depe
Spring Boot的Lombok详解
rm -rf/坏习惯
08-21 1401
Lombok是一个Java库，旨在通过自动生成样板代码来减少开发人员需要编写的冗余代码，从而提高代码的可读性和简洁性。它通过注解的方式，让开发人员能够在编写代码时自动产生一些常见的方法和字段，如getter、setter、构造函数、equalshashCode等，从而简化了Java类的创建和维护。Lombok使得你可以在代码中专注于核心逻辑，而不必担心冗长的样板代码。Lombok大大简化了Java开发过程中的样板代码编写，使开发人员能够专注于核心逻辑，提高代码的可维护性和可读性。
springboot中使用lombok
stein的博客
01-11 3014
lombok log.info
Springboot使用Lombok库
小hui的博客
06-21 1923
java怎么整合lombok库,各个注解的作用及使用方法
Spring Boot中Lombok的使用
qq1140037586的博客
04-12 208
1、Lombok简介 Lombok项目是一个Java库，它会自动插入您的编辑器和构建工具中，从而为您的Java增光添彩。 永远不要再编写另一个getter或equals方法，一个带有注释的类将具有功能全面的生成器，自动执行日志记录变量等等。 简而言之，就是自动帮您生成setter和getter，toString、equals等方法 官方地址下载 github地址 2、常用的 lom...
SpringBoot - Lombok使用详解
鱼的博客
08-13 1516
SpringBoot - Lombok使用详解 我们创建 POJO 类时，经常需要先写属性，然后手写或者自动生成 get 和 set 方法，然后还要重写 toString 方法…一系列操作下来，这个 POJO 类便会产生太多的样板式代码。 ​ 这种传统的方式不仅使得代码十分臃肿，有时也不方便维护，比如：当变量名或者是修饰符改变了，我们就要删除 set、get 方法重新生成。 ​ 而 Lombok 出现就是为了解决代码书写的冗余问题，下面对其进行详细进行介绍。 一、基本介绍 1，Lombok 介绍
springboot使用lombok
07-27
import lombok.Getter; import lombok.Setter; @Getter @Setter public class MyClass { private String name; private int age; } ``` 这样，Lombok会在编译时自动生成`getName()`、`setName()`、`getAge()`和`...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值