SpringBoot 生產(chǎn)中 16 條最佳實(shí)踐

來源：www.e4developer.com/2018/08/06/

• 1、使用自定義BOM來維護(hù)第三方依賴
• 2、使用自動(dòng)配置
• 3、使用Spring Initializr來開始一個(gè)新的Spring Boot項(xiàng)目
• 4、考慮為常見的組織問題創(chuàng)建自己的自動(dòng)配置
• 5、正確設(shè)計(jì)代碼目錄結(jié)構(gòu)
• 6、保持@Controller的簡(jiǎn)潔和專注
• 7、圍繞業(yè)務(wù)功能構(gòu)建@Service
• 8、使數(shù)據(jù)庫(kù)獨(dú)立于核心業(yè)務(wù)邏輯之外
• 9、保持業(yè)務(wù)邏輯不受Spring Boot代碼的影響
• 10、推薦使用構(gòu)造函數(shù)注入
• 11、熟悉并發(fā)模型
• 12、加強(qiáng)配置管理的外部化
• 13、提供全局異常處理
• 14、使用日志框架
• 15、測(cè)試你的代碼
• 16、使用測(cè)試切片讓測(cè)試更容易，并且更專注
• 總結(jié)

Spring Boot是最流行的用于開發(fā)微服務(wù)的Java框架。在本文中，我將與你分享自2016年以來我在專業(yè)開發(fā)中使用Spring Boot所采用的最佳實(shí)踐。這些內(nèi)容是基于我的個(gè)人經(jīng)驗(yàn)和一些熟知的Spring Boot專家的文章。

在本文中，我將重點(diǎn)介紹Spring Boot特有的實(shí)踐（大多數(shù)時(shí)候，也適用于Spring項(xiàng)目）。以下依次列出了最佳實(shí)踐，排名不分先后。

1、使用自定義BOM來維護(hù)第三方依賴

這條實(shí)踐是我根據(jù)實(shí)際項(xiàng)目中的經(jīng)歷總結(jié)出的。

Spring Boot項(xiàng)目本身使用和集成了大量的開源項(xiàng)目，它幫助我們維護(hù)了這些第三方依賴。但是也有一部分在實(shí)際項(xiàng)目使用中并沒有包括進(jìn)來，這就需要我們?cè)陧?xiàng)目中自己維護(hù)版本。如果在一個(gè)大型的項(xiàng)目中，包括了很多未開發(fā)模塊，那么維護(hù)起來就非常的繁瑣。

怎么辦呢？事實(shí)上，Spring IO Platform就是做的這個(gè)事情，它本身就是Spring Boot的子項(xiàng)目，同時(shí)維護(hù)了其他第三方開源庫(kù)。我們可以借鑒Spring IO Platform來編寫自己的基礎(chǔ)項(xiàng)目platform-bom，所有的業(yè)務(wù)模塊項(xiàng)目應(yīng)該以BOM的方式引入。這樣在升級(jí)第三方依賴時(shí)，就只需要升級(jí)這一個(gè)依賴的版本而已。

???
???????
???????????io.spring.platform
???????????platform-bom
???????????Cairo-SR3
???????????<type>pomtype>
???????????import
???????
???

2、使用自動(dòng)配置

Spring Boot的一個(gè)主要特性是使用自動(dòng)配置。這是Spring Boot的一部分，它可以簡(jiǎn)化你的代碼并使之工作。當(dāng)在類路徑上檢測(cè)到特定的jar文件時(shí)，自動(dòng)配置就會(huì)被激活。

使用它的最簡(jiǎn)單方法是依賴Spring Boot Starters。因此，如果你想與Redis進(jìn)行集成，你可以首先包括：

???org.springframework.boot
???spring-boot-starter-data-redis

如果你想與MongoDB進(jìn)行集成，需要這樣：

???org.springframework.boot
???spring-boot-starter-data-mongodb

借助于這些starters，這些繁瑣的配置就可以很好地集成起來并協(xié)同工作，而且它們都是經(jīng)過測(cè)試和驗(yàn)證的。這非常有助于避免可怕的Jar地獄。

https://dzone.com/articles/what-is-jar-hell

通過使用以下注解屬性，可以從自動(dòng)配置中排除某些配置類：

@EnableAutoConfiguration（exclude?=?{ClassNotToAutoconfigure.class}）

但只有在絕對(duì)必要時(shí)才應(yīng)該這樣做。

有關(guān)自動(dòng)配置的官方文檔可在此處找到：

https://docs.spring.io/spring-boot/docs/current/reference/html/using-boot-auto-configuration.html。

3、使用Spring Initializr來開始一個(gè)新的Spring Boot項(xiàng)目

這一條最佳實(shí)踐來自Josh Long （Spring Advocate，@starbuxman）。

Spring Initializr 提供了一個(gè)超級(jí)簡(jiǎn)單的方法來創(chuàng)建一個(gè)新的Spring Boot項(xiàng)目，并根據(jù)你的需要來加載可能使用到的依賴。

https://start.spring.io/

使用Initializr創(chuàng)建應(yīng)用程序可確保你獲得經(jīng)過測(cè)試和驗(yàn)證的依賴項(xiàng)，這些依賴項(xiàng)適用于Spring自動(dòng)配置。你甚至可能會(huì)發(fā)現(xiàn)一些新的集成，但你可能并沒有意識(shí)到這些。

4、考慮為常見的組織問題創(chuàng)建自己的自動(dòng)配置

這一條也來自Josh Long（Spring Advocate，@starbuxman）——這個(gè)實(shí)踐是針對(duì)高級(jí)用戶的。

如果你在一個(gè)嚴(yán)重依賴Spring Boot的公司或團(tuán)隊(duì)中工作，并且有共同的問題需要解決，那么你可以創(chuàng)建自己的自動(dòng)配置。

這項(xiàng)任務(wù)涉及較多工作，因此你需要考慮何時(shí)獲益是值得投入的。與多個(gè)略有不同的定制配置相比，維護(hù)單個(gè)自動(dòng)配置更容易。

如果將這個(gè)提供Spring Boot配置以開源庫(kù)的形式發(fā)布出去，那么將極大地簡(jiǎn)化數(shù)千個(gè)用戶的配置工作。

5、正確設(shè)計(jì)代碼目錄結(jié)構(gòu)

盡管允許你有很大的自由，但是有一些基本規(guī)則值得遵守來設(shè)計(jì)你的源代碼結(jié)構(gòu)。

避免使用默認(rèn)包。確保所有內(nèi)容（包括你的入口點(diǎn)）都位于一個(gè)名稱很好的包中，這樣就可以避免與裝配和組件掃描相關(guān)的意外情況；

將Application.java（應(yīng)用的入口類）保留在頂級(jí)源代碼目錄中；

我建議將控制器和服務(wù)放在以功能為導(dǎo)向的模塊中，但這是可選的。一些非常好的開發(fā)人員建議將所有控制器放在一起。不論怎樣，堅(jiān)持一種風(fēng)格！

6、保持@Controller的簡(jiǎn)潔和專注

Controller應(yīng)該非常簡(jiǎn)單。你可以在此處閱讀有關(guān)GRASP中有關(guān)控制器模式部分的說明。你希望控制器作為協(xié)調(diào)和委派的角色，而不是執(zhí)行實(shí)際的業(yè)務(wù)邏輯。以下是主要做法：

https://en.wikipedia.org/wiki/GRASP_(object-oriented_design)#Controller

• 控制器應(yīng)該是無狀態(tài)的！默認(rèn)情況下，控制器是單例，并且任何狀態(tài)都可能導(dǎo)致大量問題；
• 控制器不應(yīng)該執(zhí)行業(yè)務(wù)邏輯，而是依賴委托；
• 控制器應(yīng)該處理應(yīng)用程序的HTTP層，這不應(yīng)該傳遞給服務(wù)；
• 控制器應(yīng)該圍繞用例/業(yè)務(wù)能力來設(shè)計(jì)。

要深入這個(gè)內(nèi)容，需要進(jìn)一步地了解設(shè)計(jì)REST API的最佳實(shí)踐。無論你是否想要使用Spring Boot，都是值得學(xué)習(xí)的。

7、圍繞業(yè)務(wù)功能構(gòu)建@Service

Service是Spring Boot的另一個(gè)核心概念。我發(fā)現(xiàn)最好圍繞業(yè)務(wù)功能/領(lǐng)域/用例（無論你怎么稱呼都行）來構(gòu)建服務(wù)。

在應(yīng)用中設(shè)計(jì)名稱類似AccountService, UserService, PaymentService這樣的服務(wù)，比起像DatabaseService、ValidationService、CalculationService這樣的會(huì)更合適一些。

你可以決定使用Controler和Service之間的一對(duì)一映射，那將是理想的情況。但這并不意味著，Service之間不能互相調(diào)用！

8、使數(shù)據(jù)庫(kù)獨(dú)立于核心業(yè)務(wù)邏輯之外

我之前還不確定如何在Spring Boot中最好地處理數(shù)據(jù)庫(kù)交互。在閱讀了羅伯特·C·馬丁的“Clear Architecture”之后，對(duì)我來說就清晰多了。

你希望你的數(shù)據(jù)庫(kù)邏輯于服務(wù)分離出來。理想情況下，你不希望服務(wù)知道它正在與哪個(gè)數(shù)據(jù)庫(kù)通信，這需要一些抽象來封裝對(duì)象的持久性。

羅伯特C.馬丁強(qiáng)烈地說明，你的數(shù)據(jù)庫(kù)是一個(gè)“細(xì)節(jié)”，這意味著不將你的應(yīng)用程序與特定數(shù)據(jù)庫(kù)耦合。過去很少有人會(huì)切換數(shù)據(jù)庫(kù)，我注意到，使用Spring Boot和現(xiàn)代微服務(wù)開發(fā)會(huì)讓事情變得更快。

9、保持業(yè)務(wù)邏輯不受Spring Boot代碼的影響

考慮到“Clear Architecture”的教訓(xùn)，你還應(yīng)該保護(hù)你的業(yè)務(wù)邏輯。將各種Spring Boot代碼混合在一起是非常誘人的……不要這樣做。如果你能抵制誘惑，你將保持你的業(yè)務(wù)邏輯可重用。

部分服務(wù)通常成為庫(kù)。如果不從代碼中刪除大量Spring注解，則更容易創(chuàng)建。

10、推薦使用構(gòu)造函數(shù)注入

這一條實(shí)踐來自Phil Webb（Spring Boot的項(xiàng)目負(fù)責(zé)人, @phillip_webb）。

保持業(yè)務(wù)邏輯免受Spring Boot代碼侵入的一種方法是使用構(gòu)造函數(shù)注入。不僅是因?yàn)?code style="font-size: 14px;overflow-wrap: break-word;padding: 2px 4px;border-radius: 4px;margin-right: 2px;margin-left: 2px;background-color: rgba(27, 31, 35, 0.05);font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;color: rgb(22, 123, 194);">@Autowired注解在構(gòu)造函數(shù)上是可選的，而且還可以在沒有Spring的情況下輕松實(shí)例化bean。

11、熟悉并發(fā)模型

我寫過的最受歡迎的文章之一是“介紹Spring Boot中的并發(fā)”。我認(rèn)為這樣做的原因是這個(gè)領(lǐng)域經(jīng)常被誤解和忽視。如果使用不當(dāng)，就會(huì)出現(xiàn)問題。

https://www.e4developer.com/2018/03/30/introduction-to-concurrency-in-spring-boot/

在Spring Boot中，Controller和Service是默認(rèn)是單例。如果你不小心，這會(huì)引入可能的并發(fā)問題。你通常也在處理有限的線程池。請(qǐng)熟悉這些概念。

如果你正在使用新的WebFlux風(fēng)格的Spring Boot應(yīng)用程序，我已經(jīng)解釋了它在“Spring’s WebFlux/Reactor Parallelism and Backpressure”中是如何工作的。

12、加強(qiáng)配置管理的外部化

這一點(diǎn)超出了Spring Boot，雖然這是人們開始創(chuàng)建多個(gè)類似服務(wù)時(shí)常見的問題……

你可以手動(dòng)處理Spring應(yīng)用程序的配置。如果你正在處理多個(gè)Spring Boot應(yīng)用程序，則需要使配置管理能力更加強(qiáng)大。

我推薦兩種主要方法：

• 使用配置服務(wù)器，例如Spring Cloud Config；
• 將所有配置存儲(chǔ)在環(huán)境變量中（可以基于git倉(cāng)庫(kù)進(jìn)行配置）。

這些選項(xiàng)中的任何一個(gè)（第二個(gè)選項(xiàng)多一些）都要求你在DevOps更少工作量，但這在微服務(wù)領(lǐng)域是很常見的。

13、提供全局異常處理

你真的需要一種處理異常的一致方法。Spring Boot提供了兩種主要方法：

• 你應(yīng)該使用HandlerExceptionResolver定義全局異常處理策略；
• 你也可以在控制器上添加@ExceptionHandler注解，這在某些特定場(chǎng)景下使用可能會(huì)很有用。

這與Spring中的幾乎相同，并且Baeldung有一篇關(guān)于REST與Spring的錯(cuò)誤處理的詳細(xì)文章，非常值得一讀。

https://www.baeldung.com/exception-handling-for-rest-with-spring

14、使用日志框架

你可能已經(jīng)意識(shí)到這一點(diǎn)，但你應(yīng)該使用Logger進(jìn)行日志記錄，而不是使用System.out.println()手動(dòng)執(zhí)行。這很容易在Spring Boot中完成，幾乎沒有配置。只需獲取該類的記錄器實(shí)例：

Logger?logger?=?LoggerFactory.getLogger(MyClass.class);

這很重要，因?yàn)樗梢宰屇愀鶕?jù)需要設(shè)置不同的日志記錄級(jí)別。

15、測(cè)試你的代碼

這不是Spring Boot特有的，但它需要提醒——測(cè)試你的代碼！如果你沒有編寫測(cè)試，那么你將從一開始就編寫遺留代碼。

如果有其他人使用你的代碼庫(kù)，那邊改變?nèi)魏螙|西將會(huì)變得危險(xiǎn)。當(dāng)你有多個(gè)服務(wù)相互依賴時(shí)，這甚至可能更具風(fēng)險(xiǎn)。

由于存在Spring Boot最佳實(shí)踐，因此你應(yīng)該考慮將Spring Cloud Contract用于你的消費(fèi)者驅(qū)動(dòng)契約，它將使你與其他服務(wù)的集成更容易使用。

16、使用測(cè)試切片讓測(cè)試更容易，并且更專注

這一條實(shí)踐來自Madhura Bhave（Spring 開發(fā)者, @madhurabhave23）。

使用Spring Boot測(cè)試代碼可能很棘手——你需要初始化數(shù)據(jù)層，連接大量服務(wù)，模擬事物……實(shí)際上并不是那么難！答案是使用測(cè)試切片。

使用測(cè)試切片，你可以根據(jù)需要僅連接部分應(yīng)用程序。這可以為你節(jié)省大量時(shí)間，并確保你的測(cè)試不會(huì)與未使用的內(nèi)容相關(guān)聯(lián)。來自spring.io的一篇名為Custom test slice with Spring test 1.4的博客文章解釋了這種技術(shù)。

https://spring.io/blog/2016/08/30/custom-test-slice-with-spring-boot-1-4

總結(jié)

感謝Spring Boot，編寫基于Spring的微服務(wù)正變得前所未有的簡(jiǎn)單。我希望通過這些最佳實(shí)踐，你的實(shí)施過程不僅會(huì)變得很快，而且從長(zhǎng)遠(yuǎn)來看也會(huì)更加強(qiáng)大和成功。祝你好運(yùn)！