什么是Lombok

Lombok是一款Java開(kāi)發(fā)插件，可以通過(guò)它定義的注解來(lái)精簡(jiǎn)冗長(zhǎng)和繁瑣的代碼，主要針對(duì)簡(jiǎn)單的Java模型對(duì)象（POJO）。

好處就顯而易見(jiàn)了，可以節(jié)省大量重復(fù)工作，特別是當(dāng)POJO類(lèi)的屬性增減時(shí)，需要重復(fù)修改的Getter/Setter、構(gòu)造器方法、equals方法和toString方法等。

而且Lombok針對(duì)這些內(nèi)容的處理是在編譯期，而不是通過(guò)反射機(jī)制，這樣的好處是并不會(huì)降低系統(tǒng)的性能。

下面我們就看看具體的使用。

Lombok的安裝

Lombok的安裝分兩部分：Idea插件的安裝和maven中pom文件的導(dǎo)入。

第一步，在Idea的插件配置中搜索Lombok或官網(wǎng)下載本地安裝。

第二步，引入pom中依賴(lài)，當(dāng)前最細(xì)版本1.18.10。

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.10</version>
</dependency>

不知道什么原因，我在使用Idea安裝插件一直失敗，所以只在pom中引入了依賴(lài)，也是能正常使用。

Lombok的使用

@Data

@Data最常用的注解之一。注解在類(lèi)上，提供該類(lèi)所有屬性的getter/setter方法，還提供了equals、canEqual、hashCode、toString方法。

這里的提供什么意思？就是開(kāi)發(fā)人員不用手寫(xiě)相應(yīng)的方法，而Lombok會(huì)幫你生成。

使用@Data示例如下，最直觀(guān)的就是不用寫(xiě)getter/setter方法。

package pojo;

public class User {
    private int id;
    private String name;
    private String pwd;

    public User(int id, String hello, String pwd) {
    }

    public int getId() {
        return id;
    }

    public String getName() {
        return name;
    }

    public String getPwd() {
        return pwd;
    }

    public void setId(int id) {
        this.id = id;
    }

    public void setName(String name) {
        this.name = name;
    }

    public void setPwd(String pwd) {
        this.pwd = pwd;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", pwd='" + pwd + '\'' +
                '}';
    }
}

@Data
public class User {
    private int id;
    private String name;
    private String pwd;

}

對(duì)比之下效果顯而易見(jiàn)。

@Setter

作用于屬性上，為該屬性提供setter方法; 作用與類(lèi)上，為該類(lèi)所有的屬性提供setter方法， 都提供默認(rèn)構(gòu)造方法。

public class Demo {
	private int id;
	@Setter
	private String remark;
}

@Setter
public class Demo {
	private int id;
	private String remark;
}

@Getter

基本使用同@Setter方法，不過(guò)提供的是getter方法，不再贅述。

@Log4j

作用于類(lèi)上，為該類(lèi)提供一個(gè)屬性名為log的log4j日志對(duì)象。

@Log4j
public class Demo {
}

該屬性一般使用于Controller、Service等業(yè)務(wù)處理類(lèi)上。與此注解相同的還有@Log4j2，顧名思義，針對(duì)Log4j2。

@AllArgsConstructor

作用于類(lèi)上，為該類(lèi)提供一個(gè)包含全部參的構(gòu)造方法，注意此時(shí)默認(rèn)構(gòu)造方法不會(huì)提供。

@AllArgsConstructor
public class Demo {
	private int id;
	private String remark;
}

效果如下：

public class Demo {
    private int id;
    private String remark;

    public Demo(final int id, final String remark) {
        this.id = id;
        this.remark = remark;
    }
}

@NoArgsConstructor

作用于類(lèi)上，提供一個(gè)無(wú)參的構(gòu)造方法。可以和@AllArgsConstructor同時(shí)使用，此時(shí)會(huì)生成兩個(gè)構(gòu)造方法：無(wú)參構(gòu)造方法和全參構(gòu)造方法。

@EqualsAndHashCode

作用于類(lèi)上，生成equals、canEqual、hashCode方法。具體效果參看最開(kāi)始的@Data效果。

@NonNull

作用于屬性上，提供關(guān)于此參數(shù)的非空檢查，如果參數(shù)為空，則拋出空指針異常。

public class Demo {
	@NonNull
	private int id;
	private String remark;
}

@RequiredArgsConstructor

作用于類(lèi)上，由類(lèi)中所有帶有@NonNull注解或者帶有final修飾的成員變量作為參數(shù)生成構(gòu)造方法。

@Cleanup

作用于變量，保證該變量代表的資源會(huì)被自動(dòng)關(guān)閉，默認(rèn)調(diào)用資源的close()方法，如果該資源有其它關(guān)閉方法，可使用@Cleanup(“methodName”)來(lái)指定。

public void jedisExample(String[] args) {
    try {
        @Cleanup Jedis jedis =   redisService.getJedis();
    } catch (Exception ex) {
        logger.error(“Jedis異常:”,ex)
    }
}

效果相當(dāng)于：

public void jedisExample(String[] args) {

    Jedis jedis= null;
    try {
        jedis = redisService.getJedis();
    } catch (Exception e) {
        logger.error(“Jedis異常:”,ex)
    } finally {
        if (jedis != null) {
            try {
                jedis.close();
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }
}

@ToString

作用于類(lèi)上，生成包含所有參數(shù)的toString方法。見(jiàn)@Data中toString方法。

@Value

作用于類(lèi)上，會(huì)生成全參數(shù)的構(gòu)造方法、getter方法、equals、hashCode、toString方法。與@Data相比多了全參構(gòu)造方法，少了默認(rèn)構(gòu)造方法、setter方法和canEqual方法。

該注解需要注意的是：會(huì)將字段添加上final修飾，個(gè)人感覺(jué)此處有些失控，不太建議使用。

@SneakyThrows

作用于方法上，相當(dāng)于把方法內(nèi)的代碼添加了一個(gè)try-catch處理，捕獲異常catch中用Lombok.sneakyThrow(e)拋出異常。使用@SneakyThrows(BizException.class)指定拋出具體異常。

@SneakyThrows
public int getValue(){
	int a = 1;
	int b = 0;
	return a/b;
}

效果如下：

public int getValue() {
    try {
        int a = 1;
        int b = 0;
        return a / b;
    } catch (Throwable var3) {
        throw var3;
    }
}

@Synchronized

作用于類(lèi)方法或?qū)嵗椒ㄉ希Чcsynchronized相同。區(qū)別在于鎖對(duì)象不同，對(duì)于類(lèi)方法和實(shí)例方法，synchronized關(guān)鍵字的鎖對(duì)象分別是類(lèi)的class對(duì)象和this對(duì)象，而@Synchronized的鎖對(duì)象分別是私有靜態(tài)final對(duì)象lock和私有final對(duì)象lock。也可以指定鎖對(duì)象。

public class FooExample { 

 private final Object readLock = new Object(); 

 @Synchronized 
 public static void hello() { 
     System.out.println("world");   
 } 

 @Synchronized("readLock") 
 public void foo() { 
   System.out.println("bar"); 
 } 

}

效果相當(dāng)于：

public class FooExample { 

  private static final Object $LOCK = new Object[0]; 
  private final Object readLock = new Object(); 

  public static void hello() { 
    synchronized($LOCK) { 
      System.out.println("world"); 
    } 
  }   

  public void foo() { 
    synchronized(readLock) { 
        System.out.println("bar");   
    } 
  } 

}

val

使用val作為局部變量聲明的類(lèi)型，而不是實(shí)際寫(xiě)入類(lèi)型。 執(zhí)行此操作時(shí)，將從初始化表達(dá)式推斷出類(lèi)型。

public Map<String, String> getMap() {
	val map = new HashMap<String, String>();
	map.put("1", "a");
	return map;
}

效果如下：

public Map<String, String> getMap() {
    HashMap<String, String> map = new HashMap();
    map.put("1", "a");
    return map;
}

也就是說(shuō)在局部變量中，Lombok幫你推斷出具體的類(lèi)型，但只能用于局部變量中。

@Builder

作用于類(lèi)上，如果你喜歡使用Builder的流式操作，那么@Builder可能是你喜歡的注解了。

@Builder
public class Demo {
	private int id;
	private String remark;
}

效果如下：

public class Demo {
    private int id;
    private String remark;

    Demo(final int id, final String remark) {
        this.id = id;
        this.remark = remark;
    }

    public static Demo.DemoBuilder builder() {
        return new Demo.DemoBuilder();
    }

    public static class DemoBuilder {
        private int id;
        private String remark;

        DemoBuilder() {
        }

        public Demo.DemoBuilder id(final int id) {
            this.id = id;
            return this;
        }

        public Demo.DemoBuilder remark(final String remark) {
            this.remark = remark;
            return this;
        }

        public Demo build() {
            return new Demo(this.id, this.remark);
        }

        public String toString() {
            return "Demo.DemoBuilder(id="   this.id   ", remark="   this.remark   ")";
        }
    }
}

Lombok的優(yōu)缺點(diǎn)

優(yōu)點(diǎn)：

1、能通過(guò)注解的形式自動(dòng)生成構(gòu)造器、getter/setter、equals、hashcode、toString等方法，提高了一定的開(kāi)發(fā)效率
2、讓代碼變得簡(jiǎn)潔，不用過(guò)多的去關(guān)注相應(yīng)的方法
3、屬性做修改時(shí)，也簡(jiǎn)化了維護(hù)為這些屬性所生成的getter/setter方法等

缺點(diǎn)：

強(qiáng)X隊(duì)友
因?yàn)長(zhǎng)ombok的使用要求開(kāi)發(fā)者一定要在IDE中安裝對(duì)應(yīng)的插件。如果未安裝插件的話(huà)，使用IDE打開(kāi)一個(gè)基于Lombok的項(xiàng)目的話(huà)會(huì)提示找不到方法等錯(cuò)誤。導(dǎo)致項(xiàng)目編譯失敗。也就是說(shuō)，如果項(xiàng)目組中有一個(gè)人使用了Lombok，那么其他人就必須也要安裝IDE插件。否則就沒(méi)辦法協(xié)同開(kāi)發(fā)。更重要的是，如果我們定義的一個(gè)jar包中使用了Lombok，那么就要求所有依賴(lài)這個(gè)jar包的所有應(yīng)用都必須安裝插件，這種侵入性是很高的。代碼可讀性，可調(diào)試性低
在代碼中使用了Lombok，確實(shí)可以幫忙減少很多代碼，因?yàn)長(zhǎng)ombok會(huì)幫忙自動(dòng)生成很多代碼。
但是這些代碼是要在編譯階段才會(huì)生成的，所以在開(kāi)發(fā)的過(guò)程中，其實(shí)很多代碼其實(shí)是缺失的。
在代碼中大量使用Lombok，就導(dǎo)致代碼的可讀性會(huì)低很多，而且也會(huì)給代碼調(diào)試帶來(lái)一定的問(wèn)題。
比如，我們想要知道某個(gè)類(lèi)中的某個(gè)屬性的getter方法都被哪些類(lèi)引用的話(huà)，就沒(méi)那么簡(jiǎn)單了。有坑
因?yàn)長(zhǎng)ombok使代碼開(kāi)發(fā)非常簡(jiǎn)便，這就使得部分開(kāi)發(fā)者對(duì)其產(chǎn)生過(guò)度依賴(lài)。在使用Lombok過(guò)程中，如果對(duì)于各種注解的底層原理不理解的話(huà)，很容易產(chǎn)生意想不到的結(jié)果。舉一個(gè)簡(jiǎn)單的例子，我們知道，當(dāng)我們使用@Data定義一個(gè)類(lèi)的時(shí)候，會(huì)自動(dòng)幫我們生成equals()方法 。但是如果只使用了@Data，而不使用@EqualsAndHashCode(callSuper=true)的話(huà)，會(huì)默認(rèn)@EqualsAndHashCode(callSuper=false),這時(shí)候生成的equals()方法只會(huì)比較子類(lèi)的屬性，不會(huì)考慮從父類(lèi)繼承的屬性，無(wú)論父類(lèi)屬性訪(fǎng)問(wèn)權(quán)限是否開(kāi)放。這就可能得到意想不到的結(jié)果。影響升級(jí)
因?yàn)長(zhǎng)ombok對(duì)于代碼有很強(qiáng)的侵入性，就可能帶來(lái)一個(gè)比較大的問(wèn)題，那就是會(huì)影響我們對(duì)JDK的升級(jí)。按照如今JDK的升級(jí)頻率，每半年都會(huì)推出一個(gè)新的版本，但是Lombok作為一個(gè)第三方工具，并且是由開(kāi)源團(tuán)隊(duì)維護(hù)的，那么他的迭代速度是無(wú)法保證的。所以，如果我們需要升級(jí)到某個(gè)新版本的JDK的時(shí)候，若其中的特性在Lombok中不支持的話(huà)就會(huì)受到影響。還有一個(gè)可能帶來(lái)的問(wèn)題，就是Lombok自身的升級(jí)也會(huì)受到限制。因?yàn)橐粋€(gè)應(yīng)用可能依賴(lài)了多個(gè)jar包，而每個(gè)jar包可能又要依賴(lài)不同版本的Lombok，這就導(dǎo)致在應(yīng)用中需要做版本仲裁，而我們知道，jar包版本仲裁是沒(méi)那么容易的，而且發(fā)生問(wèn)題的概率也很高。破壞封裝性
以上幾個(gè)問(wèn)題，我認(rèn)為都是有辦法可以避免的。但是有些人排斥使用Lombok還有一個(gè)重要的原因，那就是他會(huì)破壞封裝性。眾所周知，Java的三大特性包括封裝性、繼承性和多態(tài)性。如果我們?cè)诖a中直接使用Lombok，那么他會(huì)自動(dòng)幫我們生成getter、setter 等方法，這就意味著，一個(gè)類(lèi)中的所有參數(shù)都自動(dòng)提供了設(shè)置和讀取方法。

參考博客：
Java開(kāi)發(fā)神器Lombok使用詳解
Lombok插件的安裝與簡(jiǎn)單使用步驟

到此這篇關(guān)于Lombok的詳細(xì)使用及優(yōu)缺點(diǎn)總結(jié)的文章就介紹到這了,更多相關(guān)Lombok使用內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論