SpringBoot图文并茂讲解Lombok库的安装与使用

更新时间：2022年06月27日 10:53:33 作者：鸣鼓ming

Lombok想要解决了的是在我们实体Bean中大量的Getter/Setter方法，以及toString, hashCode等可能不会用到，但是某些时候仍然需要复写，以期方便使用的方法；在使用Lombok之后，将由其来自动帮你实现代码生成

1.相关介绍

Lombok是一个通过注解以达到减少代码的Java库,如通过注解的方式减少get,set方法,构造方法等, 同时可以自动化日志变量。

2.安装步骤

1.添加依赖

在pom.xml中添加lombok的依赖

        <!--lombok依赖-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

2.安装插件

IDEA中 File->Settings->Plugins，搜索安装Lombok插件。

安装完成,重启IDEA

如果编译时出错，可能是没有enable注解处理器。Annotation Processors > Enable annotation processing。设置完成之后程序正常运行(记得设置完成重启一下IDEA)。

3.使用注解

Lombok注解文档: https://projectlombok.org/features/all

Lombok提供注解方式来提高代码的简洁性,常用注解有:

注解	作用
@Data	注解在类，生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。
@Setter	注解在类或字段，注解在类时为所有字段生成setter方法，注解在字段上时只为该字段生成setter方法。
@Getter	使用方法同上，区别在于生成的是getter方法。
@AllArgsConstructor	注解在类，生成包含类中所有字段的构造方法。
@NoArgsConstructor	注解在类，生成无参的构造方法。
@ToString	注解在类，添加toString方法。
@NonNull	这个注解可以用在成员方法或者构造方法的参数前面，会自动产生一个关于此参数的非空检查，如果参数为空，则抛出一个空指针异常。
@EqualsAndHashCode	注解在类，生成hashCode和equals方法。
@Log	这个注解用在类上，可以省去从日志工厂生成日志对象这一步，直接进行日志记录，具体注解根据日志工具的不同而不同，同时，可以在注解中使用topic来指定生成log对象时的类名。不同的日志注解总结如下(上面是注解，下面是实际作用)：

@CommonsLog
private static final org.apache.commons.logging.Log log = org.apache.commons.logging.LogFactory.getLog(LogExample.class);
@JBossLog
private static final org.jboss.logging.Logger log = org.jboss.logging.Logger.getLogger(LogExample.class);
@Log
private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(LogExample.class.getName());
@Log4j
private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(LogExample.class);
@Log4j2
private static final org.apache.logging.log4j.Logger log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class);
@Slf4j
private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExample.class);
@XSlf4j
private static final org.slf4j.ext.XLogger log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);

下面演示几个注解的使用

使用注解前

User

package com.limi.entity;
public class User {
    private Integer id;
    private String userName;
    private String passWord;
    public User(){}
    public User(Integer id, String userName, String passWord) {
        this.id = id;
        this.userName = userName;
        this.passWord = passWord;
    }
    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", userName='" + userName + '\'' +
                ", passWord='" + passWord + '\'' +
                '}';
    }
    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
    public String getUserName() {
        return userName;
    }
    public void setUserName(String userName) {
        this.userName = userName;
    }
    public String getPassWord() {
        return passWord;
    }
    public void setPassWord(String passWord) {
        this.passWord = passWord;
    }
}

使用注解, 效果和上面一致, 大大减少了代码量

User

package com.limi.entity;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private Integer id;
    private String userName;
    private String passWord;
}

测试

package com.limi;
import com.limi.entity.User;
import lombok.extern.log4j.Log4j2;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@Log4j2
@SpringBootApplication
public class MainApplication {
    public static void main(String[] args) {
        SpringApplication.run(MainApplication.class, args);
        User user = new User(1, "andy", "123456");
        log.info(user); //使用Lombok的@Log4j2注解, 可以直接使用log
    }
}

到此这篇关于SpringBoot图文并茂讲解Lombok库的安装与使用的文章就介绍到这了,更多相关SpringBoot Lombok库内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

mybatisplus的连表增强插件mybatis plus join
本文主要介绍了mybatisplus的连表增强插件mybatis plus join，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-06-06
浅谈JDK9的特性之JVM的xlog
在java程序中，我们通过日志来定位和发现项目中可能出现的问题。在现代java项目中，我们使用log4j或者slf4j，Logback等日志记录框架来处理日志问题。本文将介绍JDK9的特性之JVM的xlog。
2021-06-06
SpringBoot中使用HTTP客户端工具Retrofit
这篇文章主要为大家介绍了SpringBoot中使用HTTP客户端工具Retrofit方法详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-06-06
SpringBoot整合Javamail实现邮件发送功能
邮件发送是一个很普遍的功能,springboot整合了相关的starter,本文给大家介绍了可以实现一个简单的邮件发送功能的实例,文中通过代码给大家介绍的非常详细,感兴趣的朋友可以参考下
2023-12-12
使用FeignClient调用远程服务时整合本地的实现方法
这篇文章主要介绍了使用FeignClient调用远程服务时整合本地的实现方法，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-03-03
Java实现读取文章中重复出现的中文字符串
本文主要介绍了Java实现读取文章中重复出现的中文字符串的方法。具有很好的参考价值。下面跟着小编一起来看下吧
2017-03-03
spring打包到jar包的问题解决
这篇文章主要给大家介绍了关于spring打包到jar包遇到的问题的解决方法，文中通过实例代码结束的非常详细，对大家的学习或者使用spring打包具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
2020-08-08
java stream使用指南之sorted使用及进阶方式
这篇文章主要介绍了java stream使用指南之sorted使用及进阶方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2024-05-05
详解Java中ThreadLocal类型及简单用法
ThreadLocal实例通常是希望将状态与线程关联起来的类中的私有静态字段，下面通过例子给大家详细介绍Java中ThreadLocal类型及简单用法，感兴趣的朋友跟随小编一起看看吧
2021-10-10
Java实现Kruskal算法的示例代码
Kruskal算法是一种用来寻找最小生成树的算法，由Joseph Kruskal在1956年发表。用来解决同样问题的还有Prim算法和Boruvka算法等。本文将介绍用Java语言实现Kruskal算法的示例代码，需要的可以参考一下
2022-07-07