非常實用的Java工具類庫

這篇文章首發于公號《貓瑪尼》

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

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

大家一般都是使用某個IDE（IDE是集成開發環境，它可以有效的提升我們的工作效率），來開發項目。要使用強大的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方法，可以用在類或字段上。在類上面，標注這兩個注解，表示該類中所有的非靜態字段，都會生成相應的getter/setter方法；在字段上標注，則表示只給這個字段生成getter/setter方法，兩者都有，則以標注在字段上優先。@Setter注解對final字段失效。

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

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

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

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

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

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

@Slf4j注解：它也用于記錄日志，關于日志，我基本用的是這個注解。全稱是simple logging facade for java，是Java的簡單的日志門面。它不是具體的日志解決方案，它只服務于各種各樣slf4j-logo的日志系統，比如Java自己的日志系統、Log4j、Log4j2、logback、JBossLog等，用Slf4j可以用統一的風格，編寫日志代碼。以后切換日志系統，也不需要修改任何代碼。

還有其他的一些注解，我不太常用，大家有興趣的也可以去研究一下，比如：@NonFinal、@PackagePrivate、@SuperBuilder、@Wither、@Singular、@Synchronized、@Value、@SneakyThrows等等，具體可以去官網查看他們的使用方法或直接在Jar包里面看代碼。官網是：https://www.projectlombok.org/

有想法的開發者，可能會想，這一切，Lombok是怎么實現的呢？

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

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實現了JSR 269 API，即插入式注解處理API。它提供了一套標準API來處理Annotations，我們可以利用JSR 269提供的API來構建一個功能豐富的元編程(metaprogramming)環境。有興趣的同學，可以自行深入研究。

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

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

點贊是一種態度~感謝老鐵！

【我平時的開發環境】

飯碗：Mac Pro 13寸

IDE：IntelliJ IDEA 2018

JDK：8

打包：Maven 3

歡迎圍觀《貓瑪尼》，基本每天都會給大家帶來服務端的技術分享。

最后編輯于 ：
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發布，文章內容僅代表作者本人觀點，簡書系信息發布平臺，僅提供信息存儲服務。
  • 人面猴
    序言：七十年代末，一起剝皮案震驚了整個濱河市，隨后出現的幾起案子，更是在濱河造成了極大的恐慌，老刑警劉巖，帶你破解...
    沈念sama閱讀 230,825評論 6贊 546
  • 死咒
    序言：濱河連續發生了三起死亡事件，死亡現場離奇詭異，居然都是意外死亡，警方通過查閱死者的電腦和手機，發現死者居然都...
    沈念sama閱讀 99,814評論 3贊 429
  • 救了他兩次的神仙讓他今天三更去死
    文/潘曉璐 我一進店門，熙熙樓的掌柜王于貴愁眉苦臉地迎上來，“玉大人，你說我怎么就攤上這事。” “怎么了？”我有些...
    開封第一講書人閱讀 178,980評論 0贊 384
  • 道士緝兇錄：失蹤的賣姜人
    文/不壞的土叔 我叫張陵，是天一觀的道長。 經常有香客問我，道長，這世上最難降的妖魔是什么？ 我笑而不...
    開封第一講書人閱讀 64,064評論 1贊 319
  • ?港島之戀（遺憾婚禮）
    正文 為了忘掉前任，我火速辦了婚禮，結果婚禮上，老公的妹妹穿的比我還像新娘。我一直安慰自己，他們只是感情好，可當我...
    茶點故事閱讀 72,779評論 6贊 414
  • 惡毒庶女頂嫁案：這布局不是一般人想出來的
    文/花漫 我一把揭開白布。 她就那樣靜靜地躺著，像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上，一...
    開封第一講書人閱讀 56,109評論 1贊 330
  • 城市分裂傳說
    那天，我揣著相機與錄音，去河邊找鬼。 笑死，一個胖子當著我的面吹牛，可吹牛的內容都是我干的。 我是一名探鬼主播，決...
    沈念sama閱讀 44,099評論 3贊 450
  • 雙鴛鴦連環套：你想象不到人心有多黑
    文/蒼蘭香墨 我猛地睜開眼，長吁一口氣：“原來是場噩夢啊……” “哼！你這毒婦竟也來了？” 一聲冷哼從身側響起，我...
    開封第一講書人閱讀 43,287評論 0贊 291
  • 萬榮殺人案實錄
    序言：老撾萬榮一對情侶失蹤，失蹤者是張志新（化名）和其女友劉穎，沒想到半個月后，有當地人在樹林里發現了一具尸體，經...
    沈念sama閱讀 49,799評論 1贊 338
  • ?護林員之死
    正文 獨居荒郊野嶺守林人離奇死亡，尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,515評論 3贊 361
  • ?白月光啟示錄
    正文 我和宋清朗相戀三年，在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,750評論 1贊 375
  • 活死人
    序言：一個原本活蹦亂跳的男人離奇死亡，死狀恐怖，靈堂內的尸體忽然破棺而出，到底是詐尸還是另有隱情，我是刑警寧澤，帶...
    沈念sama閱讀 39,221評論 5贊 365
  • ?日本核電站爆炸內幕
    正文 年R本政府宣布，位于F島的核電站，受9級特大地震影響，放射性物質發生泄漏。R本人自食惡果不足惜，卻給世界環境...
    茶點故事閱讀 44,933評論 3贊 351
  • 男人毒藥：我在死后第九天來索命
    文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧，春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,327評論 0贊 28
  • 一樁弒父案，背后竟有這般陰謀
    文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至，卻和暖如春，著一層夾襖步出監牢的瞬間，已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,667評論 1贊 296
  • 情欲美人皮
    我被黑心中介騙來泰國打工， 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留，地道東北人。 一個月前我還...
    沈念sama閱讀 52,492評論 3贊 400
  • 代替公主和親
    正文 我出身青樓，卻偏偏與公主長得像，于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子，可洞房花燭夜當晚...
    茶點故事閱讀 48,703評論 2贊 380