Lombok使用

張金寶發(fā)布于2019-08-16 10:58 / 1221人閱讀

摘要：為方法或構(gòu)造函數(shù)的參數(shù)生成檢查語(yǔ)句，相當(dāng)于生成的檢查語(yǔ)句會(huì)插入到方法的最前端，如果是構(gòu)造函數(shù)，則在或調(diào)用之后插入檢查。

Lombok簡(jiǎn)介

Lombok是一個(gè)可以通過(guò)簡(jiǎn)單的注解形式來(lái)幫助我們簡(jiǎn)化消除一些必須有但顯得很臃腫的Java代碼的工具，通過(guò)使用對(duì)應(yīng)的注解，可以在編譯源碼的時(shí)候生成對(duì)應(yīng)的方法。

簡(jiǎn)單來(lái)說(shuō)，我們平時(shí)開(kāi)發(fā)過(guò)程中總是要花很多時(shí)間為Java Bean 去創(chuàng)建getter和setter方法，當(dāng)類里面的屬性很多時(shí)則創(chuàng)建的getter和setter就很多，代碼就很長(zhǎng)。而lombok就可以為我們省去創(chuàng)建getter和setter方法的麻煩，代碼也會(huì)更加簡(jiǎn)潔。

Lombok官方地址: https://projectlombok.org/

使用方法 一、安裝插件

操作步驟：File -> Settings... -> Plugins -> Browse repositories... -> 輸入Lombok搜索并安裝，安裝完成后重啟IntelliJ IDEA。

二、引用jar包

如果是使用Maven構(gòu)建項(xiàng)目，則添加以下依賴：


    
        org.projectlombok
        lombok
        1.16.18
        provided

否則直接下載jar包并引入到項(xiàng)目中，下載地址為：下載Lombok

三、lombok使用

lombok的使用主要是通過(guò)注解方式，官網(wǎng)文檔lombok注解有很詳細(xì)的說(shuō)明。

@@NonNull

@NonNull為方法或構(gòu)造函數(shù)的參數(shù)生成null檢查語(yǔ)句，相當(dāng)于if (param == null) throw new NullPointerException("param");；生成的null檢查語(yǔ)句會(huì)插入到方法的最前端，如果是構(gòu)造函數(shù)，則在this()或super()調(diào)用之后插入null檢查。

使用lombok，我們可以這樣寫(xiě)：

import lombok.NonNull;

public class User extends BaseEntity {
  private String name;
  private String password;
  
  public User(@NonNull Person person) {
    super("Hello");
    this.name = person.getName();
    this.password = person.getPassword();
  }
}

而不使用lombok則是這樣寫(xiě)：

import lombok.NonNull;

public class User extends BaseEntity {
  private String name;
  private String password;
  
  public User(@NonNull Person person) {
    super("Hello");
    if (person == null) {
      throw new NullPointerException("person");
    }
    this.name = person.getName();
    this.password = person.getPassword();
  }
}

@Getter/@Setter

使用@Getter/@Setter給字段注解，lombok會(huì)自動(dòng)生成默認(rèn)的getter/setter方法，在Intellij IDEA的Structure欄中可查看這個(gè)類的概要，就可以看到getter和setter方法已被添加到User類中：

在未指定字段修飾符情況下，lombok生成的getter/setter方法是public的，若要修改其修飾符可設(shè)置AccessLevel的值，如：

import lombok.AccessLevel;
import lombok.Getter;
import lombok.Setter;

public class User {

    private @Getter(AccessLevel.PRIVATE) @Setter String name;

    private @Getter @Setter String password;

}

此時(shí)能看到User類中的getName方法的圖標(biāo)變成了一個(gè)鎖，說(shuō)明getName方法已經(jīng)是private的，將不會(huì)被公開(kāi)：

@ToString

使用@ToString會(huì)生成toString()方法，它會(huì)按順序依次打印類名、字段；若想忽略輸出字段，則可以用exclude設(shè)置參數(shù)；如果有繼承父類，可以設(shè)置callSuper為true讓其調(diào)用父類toString()方法：

@ToString(exclude = "password", callSuper = true)
public class User extends BaseEntity {

    private @Getter @Setter String name;

    private @Getter @Setter String password;

}

@EqualsAndHashCode

使用@EqualsAndHashCode會(huì)生成hashCode()和equals()方法，默認(rèn)會(huì)使用所有非靜態(tài)、非transient字段；
如果想排除某些字段可設(shè)置exclude參數(shù)；
如果有繼承父類，可以設(shè)置callSuper為true讓其調(diào)用父類生成的equals()和hashCode方法，但是當(dāng)沒(méi)有繼承父類并設(shè)置callSuper為true時(shí)會(huì)在編譯時(shí)報(bào)錯(cuò)：

import lombok.*;

@EqualsAndHashCode(exclude = "password")
public class User {

    private @Getter @Setter String name;

    private @Getter @Setter String password;

    @EqualsAndHashCode(callSuper = true)
    public static class Department extends BaseEntity {
        private @Getter @Setter String departmentName;
    }
}

在Intellij IDEA的Structure欄中可查看到有equals()和hashCode()方法：

@NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor

@NoArgsConstructor

生成一個(gè)無(wú)參數(shù)構(gòu)造函數(shù)：

@RequiredArgsConstructor

生成構(gòu)造函數(shù)；如果帶有參數(shù)，則該參數(shù)必須是以final修飾并未初始化的字段或@NonNull注解的并未初始化的字段，參數(shù)的順序和字段在類中的聲明順序一致。

以@NonNull注解并未初始化的：

以final修飾并未初始化的：

正確和錯(cuò)誤示例：

@AllArgsConstructor

生成全參數(shù)構(gòu)造函數(shù)，將類中的每個(gè)字段生成帶有1個(gè)參數(shù)的構(gòu)造函數(shù)，例如有3個(gè)字段，則構(gòu)造函數(shù)的參數(shù)為3個(gè)：

@Data

@Data包含了@ToString, @EqualsAndHashCode, @Getter, @Setter, @RequiredArgsConstructor的功能：

@Builder

@Builder為類、構(gòu)造器、方法上生成復(fù)雜的構(gòu)建器API；構(gòu)造實(shí)例時(shí)，其屬性不再需要多帶帶set，可以通過(guò)以下方式進(jìn)行實(shí)例化：
Person.builder().name("Adam Savage").city("San Francisco").job("Mythbusters").job("Unchained Reaction").build();

其他注解

val、@Cleanup、@SneakyThrows、@Synchronized、@Getter(lazy=true)、@Log、experimental等就不再做介紹，用法和說(shuō)明可查看官網(wǎng)文檔https://projectlombok.org/features/all。

總結(jié)

使用lombok能夠?yàn)槲覀兪∪ナ謩?dòng)創(chuàng)建getter和setter方法的麻煩，lombok 有助于代碼的整潔、效率的提高以及冗余的減少，但也同時(shí)降低了源代碼文件的可讀性和完整性。

不可過(guò)度依賴lombok。

參考

以簡(jiǎn)單的方式消除 Java 的冗長(zhǎng)
Lombok features
lombok

原文地址：https://www.lwhweb.com/2017/11/08/lombok-use/

文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請(qǐng)注明本文地址：http://www.ezyhdfw.cn/yun/70823.html

發(fā)表評(píng)論

登陸后可評(píng)論

0條評(píng)論

張金寶

男|高級(jí)講師

我要關(guān)注我要私信

TA的文章

CSS選擇器

閱讀 2132·2019-08-30 15:52
css 阻斷合并及其他影響

閱讀 2507·2019-08-29 18:37
浮動(dòng)(Float)

閱讀 865·2019-08-29 12:33
magix中的2種事件綁定方式

閱讀 2909·2019-08-29 11:04
NPM酷庫(kù)051：xml2js，解析XML格式數(shù)據(jù)

閱讀 1637·2019-08-27 10:57
Node 引入 ESM 新方案

閱讀 2160·2019-08-26 13:38
瀏覽器輸入url到發(fā)起http請(qǐng)求所經(jīng)歷的過(guò)程

閱讀 2834·2019-08-26 12:25
JavaScript對(duì)象內(nèi)部屬性及其特性總結(jié)

閱讀 2521·2019-08-26 12:23

亚洲中字慕日产2020,大陆极品少妇内射AAAAAA,无码av大香线蕉伊人久久,久久精品国产亚洲av麻豆网站

資訊專欄INFORMATION COLUMN

上云采購(gòu)季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺(tái)、長(zhǎng)期優(yōu)惠，快來(lái)選購(gòu)！

Lombok使用

@NoArgsConstructor

@RequiredArgsConstructor

@AllArgsConstructor

相關(guān)文章

lombok的使用

**使用神器Lombok優(yōu)雅編碼**

**途牛原創(chuàng)｜使用 lombok 簡(jiǎn)化 Java 代碼**

**使用Lombok來(lái)精簡(jiǎn)你的項(xiàng)目代碼**

Lombok介紹、使用方法和總結(jié)

發(fā)表評(píng)論

0條評(píng)論

張金寶

男|高級(jí)講師

TA的文章

CSS選擇器

css 阻斷合并及其他影響

浮動(dòng)(Float)

magix中的2種事件綁定方式

NPM酷庫(kù)051：xml2js，解析XML格式數(shù)據(jù)

Node 引入 ESM 新方案

瀏覽器輸入url到發(fā)起http請(qǐng)求所經(jīng)歷的過(guò)程

JavaScript對(duì)象內(nèi)部屬性及其特性總結(jié)

最新活動(dòng)

資訊專欄INFORMATION COLUMN

上云采購(gòu)季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺(tái)、長(zhǎng)期優(yōu)惠，快來(lái)選購(gòu)！

Lombok使用

@NoArgsConstructor

@RequiredArgsConstructor

@AllArgsConstructor

相關(guān)文章

發(fā)表評(píng)論

0條評(píng)論

男|高級(jí)講師

TA的文章

最新活動(dòng)

上云采購(gòu)季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺(tái)、長(zhǎng)期優(yōu)惠，快來(lái)選購(gòu)！