非常實用的Java工具類庫

這篇文章首發(fā)于公號《貓瑪尼》

大家好邦邦，我是“貓瑪尼”，一名程序員趋翻。

給大家強烈推薦一個非常實用的Java工具類庫——Lombok睛琳，它可以有效地減少Java代碼的冗長，讓你的代碼踏烙，看上去非常的簡潔掸掏、優(yōu)雅。

大家一般都是使用某個IDE（IDE是集成開發(fā)環(huán)境宙帝，它可以有效的提升我們的工作效率）丧凤，來開發(fā)項目。要使用強大的Lombok步脓，首先需要給你的IDE安裝上相關的插件愿待。

我平常用的是IntelliJ IDEA（下面都簡稱為IDEA），Lombok的安裝步驟如下：

1靴患、打開IntelliJ IDEA左上角的Preferences仍侥，選擇Plugins，在搜索框中輸入“Lombok”鸳君；

2农渊、這個時候搜索結果里面可能沒有，那就需要點擊搜索結果里面藍色字體的“Search in repositories”或颊，就是通過在線倉庫查找Lombok相關插件砸紊。點擊超鏈接后，會彈出“Browse Repositories”在線搜索結果囱挑；

3醉顽、選中結果集中的“Lombok Plugin”，然后在右側的插件介紹面板中點擊“Install”平挑，安裝這個插件游添；

4、IDEA需要下載該插件通熄，然后在后臺安裝唆涝，一般情況下都挺快的，一分鐘不到吧唇辨。安裝完成之后廊酣，剛才你點擊的那個綠色的“Install”按鈕，會變成“Restart IntelliJ IDEA”助泽，點擊這個按鈕啰扛，重新啟動IDEA，就OK了嗡贺。我們可以去Plugins里面看一下隐解，就能看到我們剛才安裝的“Lombok Plugin”插件了。

安裝好了插件诫睬，需要給項目引入Lombok依賴煞茫，可以直接下載Jar丟到你的項目里面，如果是Maven項目的話摄凡，可以在pom文件里面添加上依賴续徽。我這邊的例子是跑在Maven項目里的。

我一般是在

“https://mvnrepository.com/”這個中心倉庫里面查找我想要的各種依賴亲澡。這個中心倉庫東西很全钦扭。在中心倉庫里面搜索“Lombok”，結果里的第一個就是床绪，然后點進去選擇具體的版本客情，我一般會選擇使用最多的那個版本，這里是“1.18.2”：

把依賴文本復制到我們的pom.xml文件里面癞己，然后“import Changes”膀斋，把依賴真正的加到我們項目里面去就OK了：

接下去就可以盡情的使用Lombok工具類庫了。一個簡單的例子如下：

看例子痹雅，能夠很明顯的感覺到仰担，所寫的代碼非常簡潔、清晰绩社，少了大量的getter摔蓝、setter、構造器等代碼愉耙。

一般都是通過注解的方式使用Lombok项鬼，簡單介紹一下常用的一些注解：

@Data注解：為Java類的所有字段生成getter、一個有用的toString方法和hashCode劲阎。還會為所有非final字段生成setter绘盟。該注解的作用等同于：@Getter、@Setter悯仙、@RequiredArgsConstructor龄毡、@ToString、@EqualsAndHashCode一起使用锡垄。

@Getter/@Setter注解：給相應的字段加上getter/setter方法沦零，可以用在類或字段上。在類上面货岭，標注這兩個注解路操，表示該類中所有的非靜態(tài)字段疾渴，都會生成相應的getter/setter方法；在字段上標注屯仗，則表示只給這個字段生成getter/setter方法搞坝，兩者都有，則以標注在字段上優(yōu)先魁袜。@Setter注解對final字段失效桩撮。

@ToString注解：只能標注在類上，給類生成一個具有一定可讀性的toString()方法峰弹。

@NoArgsConstructor注解：給類生成一個無參構造器店量。

@AllArgsConstructor注解：給類生成一個包含所有字段的構造器。

@Builder注解：給類賦予了builder模式（建造者模式）鞠呈。它可以解決字段很多的類重載多個構造器的繁瑣融师，同時鏈式調用簡化了類的構造。例子中“小碼哥”那部分代碼片段用到的就是這種模式蚁吝。

@NonNull注解：可以標注在方法的參數(shù)上面诬滩。如果標注的這個參數(shù)，調用的時候傳過來的值為null灭将，則會拋出NPE（空指針異常）疼鸟，這樣就不需要在代碼中判空了，非常的方便庙曙。

@Log注解：可以給類添加一個日志對象log空镜，使用的時候直接log.info("some info")就行，非常的方便捌朴。它使用的是Java自帶的日志框架吴攒，該對象的類型是java.util.logging.Logger。

@Slf4j注解：它也用于記錄日志砂蔽，關于日志洼怔，我基本用的是這個注解。全稱是simple logging facade for java左驾，是Java的簡單的日志門面镣隶。它不是具體的日志解決方案，它只服務于各種各樣slf4j-logo的日志系統(tǒng)诡右，比如Java自己的日志系統(tǒng)安岂、Log4j、Log4j2帆吻、logback域那、JBossLog等，用Slf4j可以用統(tǒng)一的風格猜煮，編寫日志代碼次员。以后切換日志系統(tǒng)败许，也不需要修改任何代碼。

還有其他的一些注解淑蔚，我不太常用市殷，大家有興趣的也可以去研究一下，比如：@NonFinal束倍、@PackagePrivate被丧、@SuperBuilder盟戏、@Wither绪妹、@Singular、@Synchronized柿究、@Value邮旷、@SneakyThrows等等，具體可以去官網(wǎng)查看他們的使用方法或直接在Jar包里面看代碼蝇摸。官網(wǎng)是：https://www.projectlombok.org/

有想法的開發(fā)者婶肩，可能會想，這一切貌夕，Lombok是怎么實現(xiàn)的呢律歼？

萬變不離其宗，就算工具在我們編寫代碼的這一步做了手腳啡专，編譯后的代碼還是會還原最真實的面貌险毁。編譯后的代碼，如下圖：

package com.mmn.sum.example;

import java.util.ArrayList;

import java.util.List;

public class LombokUser {

? ? private String name;

? ? private Integer age;

? ? private List<String> hobby;

? ? public static void main(String[] args) {

? ? ? ? LombokUser anonymous = new LombokUser();

? ? ? ? System.out.println(anonymous);

? ? ? ? List<String> mmnHobby = new ArrayList();

? ? ? ? mmnHobby.add("打代碼");

? ? ? ? LombokUser mmn = new LombokUser("貓瑪尼", 27, mmnHobby);

? ? ? ? System.out.println(mmn);

? ? ? ? List<String> littleZHobby = new ArrayList();

? ? ? ? littleZHobby.add("吃東西");

? ? ? ? LombokUser littleZ = new LombokUser();

? ? ? ? littleZ.setAge(18);

? ? ? ? littleZ.setName("小張");

? ? ? ? littleZ.setHobby(littleZHobby);

? ? ? ? System.out.println(littleZ);

? ? ? ? LombokUser xmg = builder().age(36).name("小碼哥").hobby(new ArrayList()).build();

? ? ? ? System.out.println(xmg);

? ? }

? ? public static LombokUser.LombokUserBuilder builder() {

? ? ? ? return new LombokUser.LombokUserBuilder();

? ? }

? ? public String getName() {

? ? ? ? return this.name;

? ? }

? ? public Integer getAge() {

? ? ? ? return this.age;

? ? }

? ? public List<String> getHobby() {

? ? ? ? return this.hobby;

? ? }

? ? public void setName(String name) {

? ? ? ? this.name = name;

? ? }

? ? public void setAge(Integer age) {

? ? ? ? this.age = age;

? ? }

? ? public void setHobby(List<String> hobby) {

? ? ? ? this.hobby = hobby;

? ? }

? ? public boolean equals(Object o) {

? ? ? ? if (o == this) {

? ? ? ? ? ? return true;

? ? ? ? } else if (!(o instanceof LombokUser)) {

? ? ? ? ? ? return false;

? ? ? ? } else {

? ? ? ? ? ? LombokUser other = (LombokUser)o;

? ? ? ? ? ? if (!other.canEqual(this)) {

? ? ? ? ? ? ? ? return false;

? ? ? ? ? ? } else {

? ? ? ? ? ? ? ? label47: {

? ? ? ? ? ? ? ? ? ? Object this$name = this.getName();

? ? ? ? ? ? ? ? ? ? Object other$name = other.getName();

? ? ? ? ? ? ? ? ? ? if (this$name == null) {

? ? ? ? ? ? ? ? ? ? ? ? if (other$name == null) {

? ? ? ? ? ? ? ? ? ? ? ? ? ? break label47;

? ? ? ? ? ? ? ? ? ? ? ? }

? ? ? ? ? ? ? ? ? ? } else if (this$name.equals(other$name)) {

? ? ? ? ? ? ? ? ? ? ? ? break label47;

? ? ? ? ? ? ? ? ? ? }

? ? ? ? ? ? ? ? ? ? return false;

? ? ? ? ? ? ? ? }

? ? ? ? ? ? ? ? Object this$age = this.getAge();

? ? ? ? ? ? ? ? Object other$age = other.getAge();

? ? ? ? ? ? ? ? if (this$age == null) {

? ? ? ? ? ? ? ? ? ? if (other$age != null) {

? ? ? ? ? ? ? ? ? ? ? ? return false;

? ? ? ? ? ? ? ? ? ? }

? ? ? ? ? ? ? ? } else if (!this$age.equals(other$age)) {

? ? ? ? ? ? ? ? ? ? return false;

? ? ? ? ? ? ? ? }

? ? ? ? ? ? ? ? Object this$hobby = this.getHobby();

? ? ? ? ? ? ? ? Object other$hobby = other.getHobby();

? ? ? ? ? ? ? ? if (this$hobby == null) {

? ? ? ? ? ? ? ? ? ? if (other$hobby != null) {

? ? ? ? ? ? ? ? ? ? ? ? return false;

? ? ? ? ? ? ? ? ? ? }

? ? ? ? ? ? ? ? } else if (!this$hobby.equals(other$hobby)) {

? ? ? ? ? ? ? ? ? ? return false;

? ? ? ? ? ? ? ? }

? ? ? ? ? ? ? ? return true;

? ? ? ? ? ? }

? ? ? ? }

? ? }

? ? protected boolean canEqual(Object other) {

? ? ? ? return other instanceof LombokUser;

? ? }

? ? public int hashCode() {

? ? ? ? int PRIME = true;

? ? ? ? int result = 1;

? ? ? ? Object $name = this.getName();

? ? ? ? int result = result * 59 + ($name == null ? 43 : $name.hashCode());

? ? ? ? Object $age = this.getAge();

? ? ? ? result = result * 59 + ($age == null ? 43 : $age.hashCode());

? ? ? ? Object $hobby = this.getHobby();

? ? ? ? result = result * 59 + ($hobby == null ? 43 : $hobby.hashCode());

? ? ? ? return result;

? ? }

? ? public String toString() {

? ? ? ? return "LombokUser(name=" + this.getName() + ", age=" + this.getAge() + ", hobby=" + this.getHobby() + ")";

? ? }

? ? public LombokUser() {

? ? }

? ? public LombokUser(String name, Integer age, List<String> hobby) {

? ? ? ? this.name = name;

? ? ? ? this.age = age;

? ? ? ? this.hobby = hobby;

? ? }

? ? public static class LombokUserBuilder {

? ? ? ? private String name;

? ? ? ? private Integer age;

? ? ? ? private List<String> hobby;

? ? ? ? LombokUserBuilder() {

? ? ? ? }

? ? ? ? public LombokUser.LombokUserBuilder name(String name) {

? ? ? ? ? ? this.name = name;

? ? ? ? ? ? return this;

? ? ? ? }

? ? ? ? public LombokUser.LombokUserBuilder age(Integer age) {

? ? ? ? ? ? this.age = age;

? ? ? ? ? ? return this;

? ? ? ? }

? ? ? ? public LombokUser.LombokUserBuilder hobby(List<String> hobby) {

? ? ? ? ? ? this.hobby = hobby;

? ? ? ? ? ? return this;

? ? ? ? }

? ? ? ? public LombokUser build() {

? ? ? ? ? ? return new LombokUser(this.name, this.age, this.hobby);

? ? ? ? }

? ? ? ? public String toString() {

? ? ? ? ? ? return "LombokUser.LombokUserBuilder(name=" + this.name + ", age=" + this.age + ", hobby=" + this.hobby + ")";

? ? ? ? }

? ? }

}

我們可以清楚的看到们童，編譯后的代碼畔况，比原來多了很多的Getter、Setter慧库，還有equals跷跪、LombokUserBuilder等。

我們做技術的齐板，在個人能力沒有觸達的地方吵瞻，可以通過強大的Google、Baidu來借助高人甘磨。

我翻閱了一些資料听皿，原來 Lombok實現(xiàn)了JSR 269 API，即插入式注解處理API宽档。它提供了一套標準API來處理Annotations尉姨，我們可以利用JSR 269提供的API來構建一個功能豐富的元編程(metaprogramming)環(huán)境。有興趣的同學吗冤，可以自行深入研究又厉。

用起來很簡單九府，但是背后的設計思想還是很厲害的。

感謝高人覆致，為我們提供了這么好的工具類庫~

點贊是一種態(tài)度~感謝老鐵侄旬！

【我平時的開發(fā)環(huán)境】

飯碗：Mac Pro 13寸

IDE：IntelliJ IDEA 2018

JDK：8

打包：Maven 3

歡迎圍觀《貓瑪尼》，基本每天都會給大家?guī)矸斩说募夹g分享煌妈。