1. 程式人生 > 其它 >IDEA中的lombok外掛安裝以及各註解的詳細介紹

IDEA中的lombok外掛安裝以及各註解的詳細介紹

IDEA中的lombok外掛安裝以及各註解的詳細介紹

https://www.cnblogs.com/gaogaoyanjiu/p/9823241.html

IDEA中的lombok外掛安裝以及各註解的詳細介紹

其實對於我們來說, 寫好實體類後,直接用快捷方式生成get,set方法,還有 構造方法就行了,但是對於欄位比較多的, 如果修改一個屬性的話,就要再修改他的get ,set方法,這樣容易出錯,但是用了lombok以後,就不必擔心了,下面給大家說下idea中安裝lombok的方法:

lombok到底是個什麼呢,lombok是一個可以通過簡單的註解的形式來幫助我們簡化消除一些必須有但顯得很臃腫的

Java 程式碼的工具,簡單來說,比如我們新建了一個類,然後在其中寫了幾個欄位,然後通常情況下我們需要手動去建立getter和setter方法啊,建構函式啊之類的,lombok的作用就是為了省去我們手動建立這些程式碼的麻煩,它能夠在我們編譯原始碼的時候自動幫我們生成這些方法。

下載Lombok的jar包

下載地址

一、本地安裝lombok

1:安裝zip包

https://github.com/mplushnikov/lombok-intellij-plugin/releases

 

2:下載好後放在某個盤下,不需要解壓,不要動

 

3:進入idea Annotation  processors      打鉤 

 

4:進入 Plugins   然後點選右邊的Install plugin from disk。。。。現在剛剛下載的zip包,ok後,重啟idea就OK了

 

填坑:

本地安裝會出現如下問題:

版本不一致的問題導致

仔細觀察一下自己的IDEA版本

索性換一個版本試試

 

二、IDEA中安裝lombok外掛:

1.1 .首先在IDEA裡面安裝使用lombok編寫簡略風格程式碼的外掛,開啟IDEA的Settings面板,並選擇Plugins選項,然後點選 “Browse repositories..”

     

1.2 在輸入框輸入”lombok”,得到搜尋結果,選擇第二個,點選安裝,然後安裝提示重啟IDEA,安裝成功;

 

安裝完成先別急著重啟,繼續設定,在File-Setting-Build, Execution, Deployment-Compiler-Annotation Processors中點選Enable annotation processors

    2.在自己的專案裡新增lombok的maven的pom.xml依賴:  

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

   3.寫程式碼測試



package com.tdtk.springcloud.entities;

import java.io.Serializable;
import lombok.*;
import lombok.experimental.Accessors;

@NoArgsConstructor
@Data
@Accessors(chain=true)//支援鏈式程式設計
public class Dept implements Serializable{//必須序列化
private Long deptno; //主鍵
private String dname; //部門名稱
private String db_source;//來自那個資料庫,因為微服務架構可以一個服務對應一個數據庫,同一個資訊被儲存到不同資料庫

public Dept(String dname){
super();
this.dname = dname;
}
}

   4. 測試類



public static void main(String args[]){
//鏈式程式設計
Dept dept = new Dept().setDeptno(3L).setDname("張三").setDb_source("mysql_01");

System.out.println(dept);
}

5. 輸出結果: 

 

 

總結的問題:

既然lombok幫我們生成了getter和setter和構造方法等方法,但是在檢視上並沒有看到,那麼怎麼檢視呢?

其實很簡單:直接通過快捷鍵: Alt+7

或者  View》Tool Windows》Structure

會彈出一個下面的視窗:

可以根據修改不同的註解其中檢視內容的變化

常用的 lombok 註解:

@Data:註解在類上,將類提供的所有屬性都新增get、set方法,並新增、equals、canEquals、hashCode、toString方法
@Setter:註解在類上,為所有屬性新增set方法、註解在屬性上為該屬性提供set方法
@Getter:註解在類上,為所有的屬性新增get方法、註解在屬性上為該屬性提供get方法
@NotNull:在引數中使用時,如果呼叫時傳了null值,就會丟擲空指標異常
@Synchronized 用於方法,可以鎖定指定的物件,如果不指定,則預設建立一個物件鎖定
@Log作用於類,建立一個log屬性
@Builder:使用builder模式建立物件
@NoArgsConstructor:建立一個無參建構函式
@AllArgsConstructor:建立一個全參建構函式
@ToStirng:建立一個toString方法
@Accessors(chain = true)使用鏈式設定屬性,set方法返回的是this物件。
@RequiredArgsConstructor:建立物件
@UtilityClass:工具類
@ExtensionMethod:設定父類
@FieldDefaults:設定屬性的使用範圍,如private、public等,也可以設定屬性是否被final修飾。
@Cleanup: 關閉流、連線點。
@EqualsAndHashCode:重寫equals和hashcode方法。
@toString:建立toString方法。

 

 

附件:

詳述IntelliJ IDEA外掛的安裝及使用方法(圖解)

intellij idea是一款非常優秀的軟體開發工具,它擁有這強大的外掛體系,可以幫助開發者完成很多重量級的功能。熟練的使用外掛,能夠有效提高我們的開發效率以及使用者體驗。

首先,進入外掛安裝介面:

  1. Mac:IntelliJ IDEA -> Preferences -> Plugins;
  2. Windows:File -> Settings -> Plugins.

 

標註 1:顯示 IntelliJ IDEA 的外掛分類,

  1. All plugins:顯示 IntelliJ IDEA 支援的所有外掛;
  2. Enabled:顯示當前以前啟用的外掛;
  3. Disabled:顯示當前未啟用的外掛;
  4. Bundled:顯示 IntelliJ IDEA 所有自帶的外掛;
  5. Custom:顯示我們自己安裝的外掛。

標註 2:打鉤表示為已經啟用的外掛;

標註 3:安裝 JetBrains 開發的外掛;

標註 4:安裝外掛倉庫提供的外掛;

標註 5:安裝本地已經下載完的外掛。

如上圖所示,顯示了 IntelliJ IDEA 對外掛的良好支援。以阿里巴巴最近新推出的「阿里巴巴程式碼規範檢查外掛」為例,在搜尋區輸入Alibaba,就會顯示出相近名稱的外掛(如果顯示No Plugins found,則點選Serach in repositories進行倉庫搜尋),然後點選Install,即可安裝此外掛。在此,需要注意的是:外掛安裝成功後,需要重新啟動 IntelliJ IDEA 使外掛生效

此外,當我們建立一個 IntelliJ IDEA 當前配置並不支援的檔案格式時,IntelliJ IDEA 會自動識別此檔案,並提示我們下載對應的外掛,對其進行支援。如下圖所示,我們建立了一個名為MarkdownPlugins.md的 Markdown 格式的檔案,但當前我們的 IntelliJ IDEA 並沒有支援 Markdown 的外掛,這時 IntelliJ IDEA 就會自動提示我們安裝 Markdown 外掛:

如上圖所示,當我們點選Install plugins之後,選擇對應的外掛下載並安裝(自動),然後重新啟動 IntelliJ IDEA,並輸入 Markdown 格式的內容,進行測試:

如上圖所示,顯然 Markdown 外掛安裝成功,IntelliJ IDEA 已經能夠識別 Markdown 的語法啦!

常用外掛推薦

 

外掛名稱 外掛介紹 官網地址
Alibaba Java Coding Guidelines 阿里巴巴程式碼規範檢查外掛 https://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines
Key promoter 快捷鍵提示外掛 https://plugins.jetbrains.com/plugin/4455?pr=idea
Grep Console 自定義控制檯輸出格式外掛 https://plugins.jetbrains.com/idea/plugin/7125-grep-console
CheckStyle-IDEA 程式碼規範檢查外掛 https://plugins.jetbrains.com/plugin/1065?pr=idea
FindBugs-IDEA 潛在 Bug 檢查 https://plugins.jetbrains.com/plugin/3847?pr=idea
MetricsReloaded 程式碼複雜度檢查 https://plugins.jetbrains.com/plugin/93?pr=idea
Statistic 程式碼統計外掛 https://plugins.jetbrains.com/plugin/4509?pr=idea
JRebel Plugin 熱部署外掛 https://plugins.jetbrains.com/plugin/?id=4441
CodeGlance 顯示程式碼地圖外掛 https://plugins.jetbrains.com/plugin/7275?pr=idea
Markdown Navigator Markdown 編輯器外掛 https://plugins.jetbrains.com/plugin/7896?pr=idea
Eclipse Code Formatter Eclipse 程式碼風格格式化外掛 https://plugins.jetbrains.com/plugin/6546?pr=idea
Jindent-Source Code Formatter 自定義模板外掛 http://plugins.jetbrains.com/plugin/2170?pr=idea
Maven Helper Maven 輔助外掛 https://plugins.jetbrains.com/plugin/7179-maven-helper
Properties to YAML Converter Properties 轉 YAML 格式外掛 https://plugins.jetbrains.com/plugin/8000-properties-to-yaml-converter
Git Flow Integration Git Flow 整合外掛 https://plugins.jetbrains.com/plugin/7315-git-flow-integration

 

 

 

 

 

 

IDEA中的lombok外掛安裝以及各註解的詳細介紹

其實對於我們來說, 寫好實體類後,直接用快捷方式生成get,set方法,還有 構造方法就行了,但是對於欄位比較多的, 如果修改一個屬性的話,就要再修改他的get ,set方法,這樣容易出錯,但是用了lombok以後,就不必擔心了,下面給大家說下idea中安裝lombok的方法:

lombok到底是個什麼呢,lombok是一個可以通過簡單的註解的形式來幫助我們簡化消除一些必須有但顯得很臃腫的 Java 程式碼的工具,簡單來說,比如我們新建了一個類,然後在其中寫了幾個欄位,然後通常情況下我們需要手動去建立getter和setter方法啊,建構函式啊之類的,lombok的作用就是為了省去我們手動建立這些程式碼的麻煩,它能夠在我們編譯原始碼的時候自動幫我們生成這些方法。

下載Lombok的jar包

下載地址

一、本地安裝lombok

1:安裝zip包

https://github.com/mplushnikov/lombok-intellij-plugin/releases

 

2:下載好後放在某個盤下,不需要解壓,不要動

 

3:進入idea Annotation  processors      打鉤 

 

4:進入 Plugins   然後點選右邊的Install plugin from disk。。。。現在剛剛下載的zip包,ok後,重啟idea就OK了

 

填坑:

本地安裝會出現如下問題:

版本不一致的問題導致

仔細觀察一下自己的IDEA版本

索性換一個版本試試

 

二、IDEA中安裝lombok外掛:

1.1 .首先在IDEA裡面安裝使用lombok編寫簡略風格程式碼的外掛,開啟IDEA的Settings面板,並選擇Plugins選項,然後點選 “Browse repositories..”

     

1.2 在輸入框輸入”lombok”,得到搜尋結果,選擇第二個,點選安裝,然後安裝提示重啟IDEA,安裝成功;

 

安裝完成先別急著重啟,繼續設定,在File-Setting-Build, Execution, Deployment-Compiler-Annotation Processors中點選Enable annotation processors

    2.在自己的專案裡新增lombok的maven的pom.xml依賴:  

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

   3.寫程式碼測試



package com.tdtk.springcloud.entities;

import java.io.Serializable;
import lombok.*;
import lombok.experimental.Accessors;

@NoArgsConstructor
@Data
@Accessors(chain=true)//支援鏈式程式設計
public class Dept implements Serializable{//必須序列化
private Long deptno; //主鍵
private String dname; //部門名稱
private String db_source;//來自那個資料庫,因為微服務架構可以一個服務對應一個數據庫,同一個資訊被儲存到不同資料庫

public Dept(String dname){
super();
this.dname = dname;
}
}

   4. 測試類



public static void main(String args[]){
//鏈式程式設計
Dept dept = new Dept().setDeptno(3L).setDname("張三").setDb_source("mysql_01");

System.out.println(dept);
}

5. 輸出結果: 

 

 

總結的問題:

既然lombok幫我們生成了getter和setter和構造方法等方法,但是在檢視上並沒有看到,那麼怎麼檢視呢?

其實很簡單:直接通過快捷鍵: Alt+7

或者  View》Tool Windows》Structure

會彈出一個下面的視窗:

可以根據修改不同的註解其中檢視內容的變化

常用的 lombok 註解:

@Data:註解在類上,將類提供的所有屬性都新增get、set方法,並新增、equals、canEquals、hashCode、toString方法
@Setter:註解在類上,為所有屬性新增set方法、註解在屬性上為該屬性提供set方法
@Getter:註解在類上,為所有的屬性新增get方法、註解在屬性上為該屬性提供get方法
@NotNull:在引數中使用時,如果呼叫時傳了null值,就會丟擲空指標異常
@Synchronized 用於方法,可以鎖定指定的物件,如果不指定,則預設建立一個物件鎖定
@Log作用於類,建立一個log屬性
@Builder:使用builder模式建立物件
@NoArgsConstructor:建立一個無參建構函式
@AllArgsConstructor:建立一個全參建構函式
@ToStirng:建立一個toString方法
@Accessors(chain = true)使用鏈式設定屬性,set方法返回的是this物件。
@RequiredArgsConstructor:建立物件
@UtilityClass:工具類
@ExtensionMethod:設定父類
@FieldDefaults:設定屬性的使用範圍,如private、public等,也可以設定屬性是否被final修飾。
@Cleanup: 關閉流、連線點。
@EqualsAndHashCode:重寫equals和hashcode方法。
@toString:建立toString方法。

 

 

附件:

詳述IntelliJ IDEA外掛的安裝及使用方法(圖解)

intellij idea是一款非常優秀的軟體開發工具,它擁有這強大的外掛體系,可以幫助開發者完成很多重量級的功能。熟練的使用外掛,能夠有效提高我們的開發效率以及使用者體驗。

首先,進入外掛安裝介面:

  1. Mac:IntelliJ IDEA -> Preferences -> Plugins;
  2. Windows:File -> Settings -> Plugins.

 

標註 1:顯示 IntelliJ IDEA 的外掛分類,

  1. All plugins:顯示 IntelliJ IDEA 支援的所有外掛;
  2. Enabled:顯示當前以前啟用的外掛;
  3. Disabled:顯示當前未啟用的外掛;
  4. Bundled:顯示 IntelliJ IDEA 所有自帶的外掛;
  5. Custom:顯示我們自己安裝的外掛。

標註 2:打鉤表示為已經啟用的外掛;

標註 3:安裝 JetBrains 開發的外掛;

標註 4:安裝外掛倉庫提供的外掛;

標註 5:安裝本地已經下載完的外掛。

如上圖所示,顯示了 IntelliJ IDEA 對外掛的良好支援。以阿里巴巴最近新推出的「阿里巴巴程式碼規範檢查外掛」為例,在搜尋區輸入Alibaba,就會顯示出相近名稱的外掛(如果顯示No Plugins found,則點選Serach in repositories進行倉庫搜尋),然後點選Install,即可安裝此外掛。在此,需要注意的是:外掛安裝成功後,需要重新啟動 IntelliJ IDEA 使外掛生效

此外,當我們建立一個 IntelliJ IDEA 當前配置並不支援的檔案格式時,IntelliJ IDEA 會自動識別此檔案,並提示我們下載對應的外掛,對其進行支援。如下圖所示,我們建立了一個名為MarkdownPlugins.md的 Markdown 格式的檔案,但當前我們的 IntelliJ IDEA 並沒有支援 Markdown 的外掛,這時 IntelliJ IDEA 就會自動提示我們安裝 Markdown 外掛:

如上圖所示,當我們點選Install plugins之後,選擇對應的外掛下載並安裝(自動),然後重新啟動 IntelliJ IDEA,並輸入 Markdown 格式的內容,進行測試:

如上圖所示,顯然 Markdown 外掛安裝成功,IntelliJ IDEA 已經能夠識別 Markdown 的語法啦!

常用外掛推薦

 

外掛名稱 外掛介紹 官網地址
Alibaba Java Coding Guidelines 阿里巴巴程式碼規範檢查外掛 https://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines
Key promoter 快捷鍵提示外掛 https://plugins.jetbrains.com/plugin/4455?pr=idea
Grep Console 自定義控制檯輸出格式外掛 https://plugins.jetbrains.com/idea/plugin/7125-grep-console
CheckStyle-IDEA 程式碼規範檢查外掛 https://plugins.jetbrains.com/plugin/1065?pr=idea
FindBugs-IDEA 潛在 Bug 檢查 https://plugins.jetbrains.com/plugin/3847?pr=idea
MetricsReloaded 程式碼複雜度檢查 https://plugins.jetbrains.com/plugin/93?pr=idea
Statistic 程式碼統計外掛 https://plugins.jetbrains.com/plugin/4509?pr=idea
JRebel Plugin 熱部署外掛 https://plugins.jetbrains.com/plugin/?id=4441
CodeGlance 顯示程式碼地圖外掛 https://plugins.jetbrains.com/plugin/7275?pr=idea
Markdown Navigator Markdown 編輯器外掛 https://plugins.jetbrains.com/plugin/7896?pr=idea
Eclipse Code Formatter Eclipse 程式碼風格格式化外掛 https://plugins.jetbrains.com/plugin/6546?pr=idea
Jindent-Source Code Formatter 自定義模板外掛 http://plugins.jetbrains.com/plugin/2170?pr=idea
Maven Helper Maven 輔助外掛 https://plugins.jetbrains.com/plugin/7179-maven-helper
Properties to YAML Converter Properties 轉 YAML 格式外掛 https://plugins.jetbrains.com/plugin/8000-properties-to-yaml-converter
Git Flow Integration Git Flow 整合外掛 https://plugins.jetbrains.com/plugin/7315-git-flow-integration