当前位置：后端开发 >  六，Spring Boot 容器中 Lombok 插件的详细使用，简化配置，提高开发效率

六，Spring Boot 容器中 Lombok 插件的详细使用，简化配置，提高开发效率

cnblogs 2024-09-02 12:09:00 阅读 71

六，Spring Boot 容器中 Lombok 插件的详细使用，简化配置，提高开发效率

@

目录

    <li>六，Spring Boot 容器中 Lombok 插件的详细使用，简化配置，提高开发效率
  • 1. Lombok 介绍
  • 2. Lombok 常用注解
    • 2.1 @ToString
    • 2.2 @Setter
    • 2.3 @Data
    • 2.4 @AllArgsConstructor
    • 2.5 @NoArgsConstructor
  • 3. 在 idea 中 安装 lombok插件
  • 4. 总结：
  • 6. 最后：

1. Lombok 介绍

Lombok 作用：

  1. 简化 Java Bean开发，可以使用 Lombok 的注解让代码更加简洁。
  2. Java项目中，很多没有技术含量但又必须存在的代码；比如：Pojo 的 getter/setter/toString ；异常处理：I/O流的关闭操作等等。
  3. Java项目中，很多没有技术含量但又必须存在的代码：比如：这些代码既没有技术含量，又影响着代码的美观，Lombok 应运而生。

Spring Boot 和 IDEA 官方支持

  1. IDEA 2020已经内置了 Lombok插件
  2. Spring Boot 2.1.x之后的版本也在 Stater中内置了 Lombok 依赖

2. Lombok 常用注解

<code>@Data：注解在类上，提供类所有属性的getting和setting方法，此外还提供了equals,canEqual,hashCode,toString方法

@Setter: 注解在属性上，为属性提供 setting 方法，注解在类上，则为类中的所有属性提供 set()方法。

@Getter: 注解在属性上，为属性提供 getting 方法注解在类上，则为类中的所有属性提供 get()方法。

@Log4j：注解在类上：为类提供了一个属性名为: log 的 log4j的日志对象

@NoArgsConstructor: 注解在类上，为类提供一个无参的构造方法,(一定会提供)

@AllArgsConstructor: 注解在类上，为类提供一个全参的构造方法

@Cleanup: 可以关闭流

@Builder: 被注解的类加个构造者模式

@Synchronized: 加同步锁

@SneakyThrows: 等同于try/catcher捕获异常

@NonNull:如果给参数加个这个注解，参数为null会抛出空指针异常

@Value: 注解和@Value类似，区别在于它会把所有成员变量默认定义为 private final 修饰，并且不会生产set()方法

下面我们测试，使用几个，在开发中比较常用的注解 。

首先想要使用上 Lombok 需要导入相关 jar 依赖，也可以不用特别导入，直接使用 Spring Boot 自带内置的即可。

在这里插入图片描述

<code> <!-- 引入 lombok ，使用版本仲裁-->

<dependency>

<groupId>org.projectlombok</groupId>

<artifactId>lombok</artifactId>

</dependency>

<?xml version="1.0" encoding="UTF-8"?>code>

<project xmlns="http://maven.apache.org/POM/4.0.0"code>

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"code>

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">code>

<modelVersion>4.0.0</modelVersion>

<groupId>com.rainbowsea</groupId>

<artifactId>springboot_lombok</artifactId>

<version>1.0-SNAPSHOT</version>

<!-- 导入SpringBoot 父工程-规定写法-->

<parent>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-parent</artifactId>

<version>2.5.3</version>

</parent>

<dependencies>

<!-- 导入web项目场景启动器：会自动导入和web开发相关的jar包所有依赖【库/jar】-->

<!-- 后面还会在说明spring-boot-starter-web 到底引入哪些相关依赖-->

<dependency>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-web</artifactId>

</dependency>

<!-- 引入 lombok ，使用版本仲裁-->

<dependency>

<groupId>org.projectlombok</groupId>

<artifactId>lombok</artifactId>

</dependency>

</dependencies>

</project>

2.1 @ToString

@ToString： // 在编译时，生成 toString，注意：默认情况下，会生成一个无参构造器。

在这里插入图片描述

<code>package com.rainbowsea.springboot.bean;

import lombok.AllArgsConstructor;

import lombok.Data;

import lombok.Getter;

import lombok.NoArgsConstructor;

import lombok.Setter;

import lombok.ToString;

@ToString // 在编译时，生成 toString，注意：默认情况下，会生成一个无参构造器

public class Furn {

private Integer id = 100;

private String name = "张三";

private Double price = 999.0;

}

使用 lombok 注解简化代码，可以通过 idea 自带的反编译功能 target，看Furn.class的源码，就

可以看到生成的完整代码。

如果目录当中没有 target 目录显示，可以进行如下操作：

在这里插入图片描述

在这里插入图片描述

2.2 @Setter

@Setter 注解： 注解在属性上，为属性提供 setting 方法，注解在类上，则为类中的所有属性提供 set()方法。

首先，我们先注解使用在属性上。

在这里插入图片描述

<code>package com.rainbowsea.springboot.bean;

import lombok.AllArgsConstructor;

import lombok.Data;

import lombok.Getter;

import lombok.NoArgsConstructor;

import lombok.Setter;

import lombok.ToString;

public class Furn {

@Setter // 注解在属性上，编译生成一个，该属性的 set()方法：默认情况下，会生成一个无参构造器

private Integer id = 100;

private String name = "张三";

private Double price = 999.0;

}

在这里插入图片描述

添加到类上，为类中所有的属性都添加，set() 方法。

在这里插入图片描述

在这里插入图片描述

2.3 @Data

@Data ：注解在类上，提供类所有属性的getting和setting方法，此外还提供 equals，canEqual，hashCode，toString方法， @RequiredArgsConstructor

特别说明: @Data 中的 @RequiredArgsConstructor

在我们写controller 或是 Service层的时候，需要注入很多的 mapper接口或者另外的service接口，这时候就会写很多

的@Autowired注解，代码看起来很乱。Lombok 提供了一个注解:

@RequiredArgsConstructor(onConstructor=@_(@AutoWired))

写在类上可以代替@Autowired注解，需要注意的时在注入时，需要用final定义，或者使用 @notnull注解

在这里插入图片描述

<code>package com.rainbowsea.springboot.bean;

import lombok.AllArgsConstructor;

import lombok.Data;

import lombok.Getter;

import lombok.NoArgsConstructor;

import lombok.Setter;

import lombok.ToString;

@Data// 注解等价使用了，如下注解: @Getter,@Setter,@RequiredArgsConstructor @ToString,@EqualsAndHas

public class Furn {

private Integer id = 100;

private String name = "张三";

private Double price = 999.0;

}

在这里插入图片描述

2.4 @AllArgsConstructor

@AllArgsConstructor：在编译时，会生成全参数构造器

在这里插入图片描述

<code>package com.rainbowsea.springboot.bean;

import lombok.AllArgsConstructor;

import lombok.Data;

import lombok.Getter;

import lombok.NoArgsConstructor;

import lombok.Setter;

import lombok.ToString;

@AllArgsConstructor // 在编译时，会生成全参数构造器

public class Furn {

private Integer id = 100;

private String name = "张三";

private Double price = 999.0;

}

在这里插入图片描述

注意：这里：我们会发现一点，就是有全参数构造器，但是，却没有生成一个默认的“无参数构造器”

2.5 @NoArgsConstructor

@NoArgsConstructor： 在编译时，会生成无参构造器（一定会生成），不会受到其它的

在这里插入图片描述

<code>package com.rainbowsea.springboot.bean;

import lombok.AllArgsConstructor;

import lombok.Data;

import lombok.Getter;

import lombok.NoArgsConstructor;

import lombok.Setter;

import lombok.ToString;

@NoArgsConstructor //在编译时，会生成无参构造器（一定会生成），不会受到其它的

public class Furn {

private Integer id = 100;

private String name = "张三";

private Double price = 999.0;

}

在这里插入图片描述

特别说明：

特别说明，虽然上面的@Data,@ToString注解等等，默认情况下都会生成一个无参构造器，但是当你使用了多个注解的时候，可能会覆盖掉无参构造器。 但是当我们有其它多个构造器生成时，你如果你希望仍然有无参构造器就需要使用 @NoArgsConstructor 注解了，因为 @NoArgsConstructor是一定会生成一个无参构造器的（无参构造器很重要，因为框架的使用是涉及到反射机制的，而反射机制，需要一个无参构造器，否则你就无法进行反射获取 bean对象，框架也就无法使用了）。

如下：测试。我们添加上 @Data注解和 @AllArgsConstructor 注解。可以明显的发现，默认的无参数构造器被覆盖掉了

在这里插入图片描述

所以我们需要添加上：@NoArgsConstructor注解，因为@NoArgsConstructor注解，在编译时，会生成无参构造器（一定会生成），不会受到其它的影响，被覆盖。如图

在这里插入图片描述

3. 在 idea 中 安装 lombok插件

不装插件也可以用基本的注解比如：@Data,@Getter...

但是不能使用其扩展功能，比如日志输出...，所以我们还是安装一下，也比较简单。

直接去插件商城，搜索: Lombok 即可

在这里插入图片描述

在这里插入图片描述

<code>package com.rainbowsea.springboot.controller;

import com.rainbowsea.springboot.bean.Furn;

import lombok.extern.slf4j.Slf4j;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;

@Slf4j

@RestController // @Controller + @ResponseBody

public class HiController {

@Autowired

private Furn furn;

@RequestMapping("/hi") // 设置请求映射路径

public String hi(){

log.info("furn-"+furn);

// 占位符方式输出

log.info("furn={} myfurn={}",furn,furn);

return "hi word";

// 使用 slf4j日志输出

}

}

运行测试：

在这里插入图片描述

4. 总结：

    <li>熟悉常用的 Lombok 注解，提供开发效率。
  1. 基本上@注解都会生成一个默认的无参构造器，但是当存在多个注解的时候，这个默认的无参构造器，可能会被覆盖掉，从而导致无法不会被生成。但是，框架的上的使用，基本上都是需要使用上反射 机制的，而反射机制是必须要有一个无参构造器 才可以进行反射，获取到对应的 Bean对象。给框架使用。所以，一般的 bean 对象都会添加上一个@NoArgsConstructor注解该在编译时，会生成无参构造器（一定会生成），不会受到其它的

6. 最后：

“在这个最后的篇章中，我要表达我对每一位读者的感激之情。你们的关注和回复是我创作的动力源泉，我从你们身上吸取了无尽的灵感与勇气。我会将你们的鼓励留在心底，继续在其他的领域奋斗。感谢你们，我们总会在某个时刻再次相遇。”

在这里插入图片描述

上一篇： Python一文轻松搞定正则匹配

下一篇： 网络协议栈应用层的意义（内含思维导图和解析图通俗易懂超易理解）

本文标签

Spring Boot   

声明

本文内容仅代表作者观点，或转载于其他网站，本站不以此文作为商业用途
如有涉及侵权，请联系本站进行删除
转载本站原创文章，请注明来源及作者。

相关文章

阅读排行

热门文章