22條 SpringBoot 最佳實(shí)踐，yyds！

本文翻譯自國(guó)外論壇 medium，原文地址：https://medium.com/@raviyasas/spring-boot-best-practices-for-developers-3f3bdffa0090

Spring Boot 是一種廣泛使用且非常流行的企業(yè)級(jí)高性能框架。

以下是一些最佳實(shí)踐和一些技巧，我們可以使用它們來(lái)改進(jìn) Spring Boot 應(yīng)用程序并使其更加高效。這篇文章會(huì)有點(diǎn)長(zhǎng)，完整讀完文章需要一些時(shí)間。

1.正確的包目錄風(fēng)格

正確的包目錄將有助于輕松理解代碼和應(yīng)用程序的流程。

我們可以使用有意義的包目錄來(lái)構(gòu)建我們的應(yīng)用程序。

我們可以將所有控制器包含在單獨(dú)的包中，將服務(wù)包含在單獨(dú)的包中，將 util 類包含在單獨(dú)的包中等等。這種風(fēng)格在小型微服務(wù)中非常方便。

如果我們正在處理龐大的代碼庫(kù)，則可以使用基于功能模塊的方法。我們可以根據(jù)我們的要求來(lái)決定。

基于類型

基于功能模塊

2.使用設(shè)計(jì)模式

沒(méi)什么好說(shuō)的，設(shè)計(jì)模式已經(jīng)是現(xiàn)代編程中編寫(xiě)可維護(hù)、可擴(kuò)展代碼的最佳實(shí)踐。

3.使用 Spring Boot starter

這是 Spring Boot 的一個(gè)很酷的功能。

我們可以非常輕松地使用啟動(dòng)器依賴項(xiàng)，而無(wú)需一一添加單個(gè)依賴項(xiàng)。這些入門依賴項(xiàng)已與所需的依賴項(xiàng)捆綁在一起。

例如，如果我們添加 spring-boot-starter-web 依賴項(xiàng)，默認(rèn)情況下它會(huì)與 jackson、spring-core、spring-mvc 和 spring-boot-starter-tomcat 依賴項(xiàng)捆綁在一起。

所以我們不需要關(guān)心單獨(dú)添加依賴項(xiàng)。它還可以幫助我們避免版本不匹配。

4.使用生產(chǎn)版本的依賴項(xiàng)

始終建議使用最新的穩(wěn)定 GA 版本。

有時(shí)它可能會(huì)因 Java 版本、服務(wù)器版本、應(yīng)用程序類型等而有所不同。

不要使用同一包的不同版本，如果存在多個(gè)依賴項(xiàng)，請(qǐng)始終使用 <properties> 指定版本。

5.使用 Lombok

作為一名 Java 開(kāi)發(fā)人員，我們可能聽(tīng)說(shuō)過(guò) Lombok 項(xiàng)目。

Lombok 是一個(gè) Java 庫(kù)，可用于減少代碼并允許我們使用其注釋編寫(xiě)干凈的代碼。

例如，我們可能在某些類（如實(shí)體、請(qǐng)求/響應(yīng)對(duì)象、dtos 等）中使用大量的 getter 和 setter 行。

但如果你使用 Lombok，它只是一行，你可以根據(jù)你的要求使用@Data、@Getter 或@Setter。

我們也可以使用 Lombok 記錄器注釋。推薦@Slf4j。

6.將構(gòu)造函數(shù)注入與 Lombok 一起使用

當(dāng)我們談?wù)撘蕾囎⑷霑r(shí)，有兩種類型。

一種是“構(gòu)造函數(shù)注入”，另一種是“setter 注入”。除此之外，我們還可以使用非常流行的@Autowired 注釋來(lái)使用“字段注入”。

但我們強(qiáng)烈建議使用構(gòu)造函數(shù)注入而不是其他類型。因?yàn)樗试S應(yīng)用程序在初始化時(shí)初始化所有必需的依賴項(xiàng)。

這對(duì)于單元測(cè)試非常有用。

重要的是，我們可以使用 Lombok 的 @RequiredArgsConstructor 注釋來(lái)使用構(gòu)造函數(shù)注入。

7.使用 slf4j 日志

日志記錄非常重要，如果我們的應(yīng)用程序在生產(chǎn)過(guò)程中出現(xiàn)問(wèn)題，日志記錄是找出根本原因的唯一方法。因此，在添加記錄器、日志消息類型、記錄器級(jí)別和記錄器消息之前應(yīng)該仔細(xì)考慮。

不要使用 System.out.print()建議將 Slf4j 與 Spring Boot 中默認(rèn)的日志框架 logback 一起使用。

始終使用 slf4j 的 {} 占位符語(yǔ)法，避免在記錄器消息中使用字符串插值。因?yàn)樽址逯禃?huì)消耗更多的內(nèi)存。

我們可以使用 Lombok @Slf4j 注釋非常輕松地創(chuàng)建日志記錄器。

如果我們處于微服務(wù)環(huán)境中，則可以使用 ELK 技術(shù)棧。

8.控制器僅用于路由

• 控制器專用于路由。
• 它是無(wú)狀態(tài)且單身的。
• DispatcherServlet 將檢查控制器上的 @RequestMapping
• 控制器是請(qǐng)求的最終目標(biāo)，請(qǐng)求將交給服務(wù)層并由服務(wù)層處理。
• 業(yè)務(wù)邏輯不應(yīng)位于控制器中。

9.使用Service來(lái)實(shí)現(xiàn)業(yè)務(wù)邏輯

• 完整的業(yè)務(wù)邏輯包含驗(yàn)證、緩存等。
• 與持久層通信并接收結(jié)果。
• Service也是單例的。

10.避免空指針異常

• 為了避免 NullPointerException，我們可以使用 java.util 包中的 Optional。
• 我們還可以使用空安全庫(kù)。例如：Apache Commons StringUtils
• 對(duì)已知對(duì)象調(diào)用 equals() 和 equalsIgnoreCase() 方法。
• 使用 valueOf() 而不是 toString()
• 使用基于 IDE 的 @NotNull 和 @Nullable 注釋。

11.使用集合框架的最佳實(shí)踐

• 對(duì)我們的數(shù)據(jù)集使用適當(dāng)?shù)募稀?
• 將 forEach 與 Java 8 功能結(jié)合使用，并避免使用舊版 for 循環(huán)。
• 使用接口類型而不是實(shí)現(xiàn)。
• 使用 isEmpty() 而不是 size() 以獲得更好的可讀性。
• 不返回空值，可以返回空集合。
• 如果我們使用對(duì)象作為要存儲(chǔ)在基于哈希的集合中的數(shù)據(jù)，則應(yīng)重寫(xiě) equals() 和 hashCode() 方法。

12.使用分頁(yè)

這將提高應(yīng)用程序的性能。

如果我們使用 Spring Data JPA，則 PagingAndSortingRepository 使分頁(yè)的使用變得非常容易且?guī)缀醪毁M(fèi)吹灰之力。

13.使用緩存

在談?wù)搼?yīng)用程序性能時(shí)，緩存是另一個(gè)重要因素。

默認(rèn)情況下，Spring Boot 通過(guò) ConcurrentHashMap 提供緩存，我們可以通過(guò) @EnableCaching 注解來(lái)實(shí)現(xiàn)這一點(diǎn)。如果我們對(duì)默認(rèn)緩存不滿意，可以使用 Redis、Hazelcast 或任何其他分布式緩存實(shí)現(xiàn)。

Redis 和 Hazelcast 是內(nèi)存緩存方法。我們還可以使用數(shù)據(jù)庫(kù)緩存實(shí)現(xiàn)。

14.使用自定義異常處理程序和全局異常處理

• 這在使用大型企業(yè)級(jí)應(yīng)用程序時(shí)非常重要。
• 除了一般異常之外，我們可能還會(huì)有一些場(chǎng)景來(lái)識(shí)別某些特定的錯(cuò)誤情況。
• 異常顧問(wèn)可以使用@ControllerAdvice 創(chuàng)建，我們可以創(chuàng)建具有有意義細(xì)節(jié)的單獨(dú)異常。
• 它將使得將來(lái)識(shí)別和調(diào)試錯(cuò)誤變得更加容易。

15.使用自定義響應(yīng)對(duì)象

自定義響應(yīng)對(duì)象可用于返回包含某些特定數(shù)據(jù)的對(duì)象，并滿足 HTTP 狀態(tài)代碼、API 代碼、消息等要求。

我們可以使用構(gòu)建器設(shè)計(jì)模式來(lái)創(chuàng)建具有自定義屬性的自定義響應(yīng)對(duì)象。

16.刪除不必要的代碼、變量、方法和類。

• 未使用的變量聲明將占用一些內(nèi)存。
• 刪除未使用的方法、類等，因?yàn)樗鼤?huì)影響應(yīng)用程序的性能。
• 盡量避免嵌套循環(huán)。我們可以使用map代替。

17.使用注釋

注釋是一個(gè)很好的做法。

不要對(duì)一切代碼發(fā)表注釋。相反，我們可以使用類、函數(shù)、方法、變量等有意義的單詞編寫(xiě)描述性代碼。

刪除注釋代碼、誤導(dǎo)性注釋和故事型注釋。

我們可以使用注釋進(jìn)行警告，并解釋一些乍一看難以理解的內(nèi)容。

18.對(duì)類、方法、函數(shù)、變量和其他屬性使用有意義的詞語(yǔ)。

這看起來(lái)很簡(jiǎn)單，但影響卻是巨大的。

始終使用正確的有意義且可搜索的命名約定以及正確的大小寫(xiě)。

通常，我們?cè)诼暶黝?、變量和常量時(shí)使用名詞或短語(yǔ)。例如：字符串 firstName，const isValid

我們可以使用帶有形容詞的動(dòng)詞和短語(yǔ)來(lái)表示函數(shù)和方法。例如：readFile()、sendData()

避免使用縮寫(xiě)變量名和意圖揭示的名稱。例如：int i;字符串 getExUsr;

如果我們有意義地使用此功能，則可以減少聲明注釋行。由于它具有有意義的名稱，新開(kāi)發(fā)人員可以通過(guò)閱讀代碼輕松理解。

19.使用正確的大小寫(xiě)進(jìn)行聲明

有許多不同的大小寫(xiě)，如大寫(xiě)、小寫(xiě)、駝峰命名、帕斯卡命名、蛇命名、大蛇式命名、短橫線命名等。

但我們需要確定哪個(gè)案例專用于哪個(gè)變量。

通常，我會(huì)遵循：

• 類 — 帕斯卡命名
• 方法和變量 — 駝峰命名
• 常量 — 大蛇式命名
• 數(shù)據(jù)庫(kù)相關(guān)字段 — 短橫線命名

這只是一個(gè)例子,它可能與我們?cè)诠咀裱臉?biāo)準(zhǔn)不同。

20.簡(jiǎn)單點(diǎn)

始終嘗試編寫(xiě)簡(jiǎn)單、可讀的代碼，同樣簡(jiǎn)單的邏輯可以用不同的方式實(shí)現(xiàn)，但是如果不可讀或不理解就很難理解。

有時(shí)復(fù)雜的邏輯會(huì)消耗更多的內(nèi)存，編寫(xiě)代碼時(shí)嘗試使用 KISS、DRY 和 SOLID 原則。

21.使用通用的代碼格式樣式

格式樣式因開(kāi)發(fā)人員而異。編碼風(fēng)格的改變也被認(rèn)為是一種改變，并且會(huì)使代碼合并變得非常困難。

為了避免這種情況，團(tuán)隊(duì)可以采用通用的編碼格式。

22.使用 SonarLint 插件

這對(duì)于識(shí)別小錯(cuò)誤和最佳實(shí)踐非常有用，以避免不必要的錯(cuò)誤和代碼質(zhì)量問(wèn)題。

我們可以將插件安裝到我們最喜歡的 IDE 中。

最后

至此本文講解內(nèi)容到此完畢感謝閱讀，希望本文能對(duì)你有所幫助。