快捷導(dǎo)航

SpringBoot圖文并茂講解Lombok庫(kù)的安裝與使用

更新時(shí)間：2022年06月27日 10:53:33 作者：鳴鼓ming

Lombok想要解決了的是在我們實(shí)體Bean中大量的Getter/Setter方法，以及toString, hashCode等可能不會(huì)用到，但是某些時(shí)候仍然需要復(fù)寫，以期方便使用的方法；在使用Lombok之后，將由其來自動(dòng)幫你實(shí)現(xiàn)代碼生成

1.相關(guān)介紹

Lombok是一個(gè)通過注解以達(dá)到減少代碼的Java庫(kù),如通過注解的方式減少get,set方法,構(gòu)造方法等, 同時(shí)可以自動(dòng)化日志變量。

2.安裝步驟

1.添加依賴

在pom.xml中添加lombok的依賴

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

2.安裝插件

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

安裝完成,重啟IDEA

如果編譯時(shí)出錯(cuò)，可能是沒有enable注解處理器。Annotation Processors > Enable annotation processing。設(shè)置完成之后程序正常運(yùn)行(記得設(shè)置完成重啟一下IDEA)。

3.使用注解

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

Lombok提供注解方式來提高代碼的簡(jiǎn)潔性,常用注解有:

注解	作用
@Data	注解在類，生成setter/getter、equals、canEqual、hashCode、toString方法，如為final屬性，則不會(huì)為該屬性生成setter方法。
@Setter	注解在類或字段，注解在類時(shí)為所有字段生成setter方法，注解在字段上時(shí)只為該字段生成setter方法。
@Getter	使用方法同上，區(qū)別在于生成的是getter方法。
@AllArgsConstructor	注解在類，生成包含類中所有字段的構(gòu)造方法。
@NoArgsConstructor	注解在類，生成無參的構(gòu)造方法。
@ToString	注解在類，添加toString方法。
@NonNull	這個(gè)注解可以用在成員方法或者構(gòu)造方法的參數(shù)前面，會(huì)自動(dòng)產(chǎn)生一個(gè)關(guān)于此參數(shù)的非空檢查，如果參數(shù)為空，則拋出一個(gè)空指針異常。
@EqualsAndHashCode	注解在類，生成hashCode和equals方法。
@Log	這個(gè)注解用在類上，可以省去從日志工廠生成日志對(duì)象這一步，直接進(jìn)行日志記錄，具體注解根據(jù)日志工具的不同而不同，同時(shí)，可以在注解中使用topic來指定生成log對(duì)象時(shí)的類名。不同的日志注解總結(jié)如下(上面是注解，下面是實(shí)際作用)：

@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);

下面演示幾個(gè)注解的使用

使用注解前

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;
}

測(cè)試

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
    }
}