主頁 > 後端開發 > 兩年摸爬滾打 Spring Boot,總結了這 16 條最佳實踐

兩年摸爬滾打 Spring Boot,總結了這 16 條最佳實踐

2020-10-24 18:23:26 後端開發

Spring Boot是最流行的用于開發微服務的Java框架,在本文中,我將與你分享自2016年以來我在專業開發中使用Spring Boot所采用的最佳實踐,這些內容是基于我的個人經驗和一些熟知的Spring Boot專家的文章,

在本文中,我將重點介紹Spring Boot特有的實踐(大多數時候,也適用于Spring專案),以下依次列出了最佳實踐,排名不分先后,

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

這條實踐是我根據實際專案中的經歷總結出的,

Spring Boot專案本身使用和集成了大量的開源專案,它幫助我們維護了這些第三方依賴,但是也有一部分在實際專案使用中并沒有包括進來,這就需要我們在專案中自己維護版本,如果在一個大型的專案中,包括了很多未開發模塊,那么維護起來就非常的繁瑣,

怎么辦呢?事實上,Spring IO Platform就是做的這個事情,它本身就是Spring Boot的子專案,同時維護了其他第三方開源庫,我們可以借鑒Spring IO Platform來撰寫自己的基礎專案platform-bom,所有的業務模塊專案應該以BOM的方式引入,這樣在升級第三方依賴時,就只需要升級這一個依賴的版本而已,

<dependencyManagement>
   <dependencies>
       <dependency>
           <groupId>io.spring.platform</groupId>
           <artifactId>platform-bom</artifactId>
           <version>Cairo-SR3</version>
           <type>pom</type>
           <scope>import</scope>
       </dependency>
   </dependencies>
</dependencyManagement>

2、使用自動配置

Spring Boot的一個主要特性是使用自動配置,這是Spring Boot的一部分,它可以簡化你的代碼并使之作業,當在類路徑上檢測到特定的jar檔案時,自動配置就會被激活,

使用它的最簡單方法是依賴Spring Boot Starters,因此,如果你想與Redis進行集成,你可以首先包括:

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

如果你想與MongoDB進行集成,需要這樣:

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-data-mongodb</artifactId>
</dependency>

借助于這些starters,這些繁瑣的配置就可以很好地集成起來并協同作業,而且它們都是經過測驗和驗證的,這非常有助于避免可怕的Jar地獄(https://dzone.com/articles/what-is-jar-hell),

通過使用以下注解屬性,可以從自動配置中排除某些配置類:

@EnableAutoConfiguration(exclude = {ClassNotToAutoconfigure.class})

但只有在絕對必要時才應該這樣做,

有關自動配置點擊這里有一篇實戰文章,官方檔案可在此處找到:https://docs.spring.io/spring-boot/docs/current/reference/html/using-boot-auto-configuration.html,

3、使用Spring Initializr來開始一個新的Spring Boot專案

這一條最佳實踐來自Josh Long (Spring Advocate,@starbuxman),

Spring Initializr(https://start.spring.io/)提供了一個超級簡單的方法來創建一個新的Spring Boot專案,并根據你的需要來加載可能使用到的依賴,

使用Initializr創建應用程式可確保你獲得經過測驗和驗證的依賴項,這些依賴項適用于Spring自動配置,你甚至可能會發現一些新的集成,但你可能并沒有意識到這些,

4、考慮為常見的組織問題創建自己的自動配置

這一條也來自Josh Long(Spring Advocate,@starbuxman)——這個實踐是針對高級用戶的,

如果你在一個嚴重依賴Spring Boot的公司或團隊中作業,并且有共同的問題需要解決,那么你可以創建自己的自動配置,

這項任務涉及較多作業,因此你需要考慮何時獲益是值得投入的,與多個略有不同的定制配置相比,維護單個自動配置更容易,

如果將這個提供Spring Boot配置以開源庫的形式發布出去,那么將極大地簡化數千個用戶的配置作業,有關自動配置點擊這里有一篇實戰文章,

5、正確設計代碼目錄結構

盡管允許你有很大的自由,但是有一些基本規則值得遵守來設計你的源代碼結構,

  • 避免使用默認包,確保所有內容(包括你的入口點)都位于一個名稱很好的包中,這樣就可以避免與裝配和組件掃描相關的意外情況;

  • 將Application.java(應用的入口類)保留在頂級源代碼目錄中;

  • 我建議將控制器和服務放在以功能為導向的模塊中,但這是可選的,一些非常好的開發人員建議將所有控制器放在一起,不論怎樣,堅持一種風格!

6、保持@Controller的簡潔和專注

Controller應該非常簡單,你可以在此處閱讀有關GRASP中有關控制器模式部分的說明(https://en.wikipedia.org/wiki/GRASP_(object-oriented_design)#Controller),你希望控制器作為協調和委派的角色,而不是執行實際的業務邏輯,以下是主要做法:

  • 控制器應該是無狀態的!默認情況下,控制器是單例,并且任何狀態都可能導致大量問題;

  • 控制器不應該執行業務邏輯,而是依賴委托;

  • 控制器應該處理應用程式的HTTP層,這不應該傳遞給服務;

  • 控制器應該圍繞用例/業務能力來設計,

要深入這個內容,需要進一步地了解設計REST API的最佳實踐,無論你是否想要使用Spring Boot,都是值得學習的,

7、圍繞業務功能構建@Service

Service是Spring Boot的另一個核心概念,我發現最好圍繞業務功能/領域/用例(無論你怎么稱呼都行)來構建服務,

在應用中設計名稱類似AccountService, UserService, PaymentService這樣的服務,比起像DatabaseService、ValidationService、CalculationService這樣的會更合適一些,

你可以決定使用Controler和Service之間的一對一映射,那將是理想的情況,但這并不意味著,Service之間不能互相呼叫!

8、使資料庫獨立于核心業務邏輯之外

我之前還不確定如何在Spring Boot中最好地處理資料庫互動,在閱讀了羅伯特·C·馬丁的“Clear Architecture”之后,對我來說就清晰多了,

你希望你的資料庫邏輯于服務分離出來,理想情況下,你不希望服務知道它正在與哪個資料庫通信,這需要一些抽象來封裝物件的持久性,

羅伯特C.馬丁強烈地說明,你的資料庫是一個“細節”,這意味著不將你的應用程式與特定資料庫耦合,過去很少有人會切換資料庫,我注意到,使用Spring Boot和現代微服務開發會讓事情變得更快,

9、保持業務邏輯不受Spring Boot代碼的影響

考慮到“Clear Architecture”的教訓,你還應該保護你的業務邏輯,將各種Spring Boot代碼混合在一起是非常誘人的……不要這樣做,如果你能抵制傭訓,你將保持你的業務邏輯可重用,

部分服務通常成為庫,如果不從代碼中洗掉大量Spring注解,則更容易創建,

10、推薦使用建構式注入

這一條實踐來自Phil Webb(Spring Boot的專案負責人, @phillip_webb),

保持業務邏輯免受Spring Boot代碼侵入的一種方法是使用建構式注入, 不僅是因為@Autowired注解在建構式上是可選的,而且還可以在沒有Spring的情況下輕松實體化bean,

11、熟悉并發模型

我寫過的最受歡迎的文章之一是“介紹Spring Boot中的并發”(https://www.e4developer.com/2018/03/30/introduction-to-concurrency-in-spring-boot/),我認為這樣做的原因是這個領域經常被誤解和忽視,如果使用不當,就會出現問題,

在Spring Boot中,Controller和Service是默認是單例,如果你不小心,這會引入可能的并發問題, 你通常也在處理有限的執行緒池,請熟悉這些概念,

如果你正在使用新的WebFlux風格的Spring Boot應用程式,我已經解釋了它在“Spring’s WebFlux/Reactor Parallelism and Backpressure”中是如何作業的,

12、加強配置管理的外部化

這一點超出了Spring Boot,雖然這是人們開始創建多個類似服務時常見的問題……

你可以手動處理Spring應用程式的配置,如果你正在處理多個Spring Boot應用程式,則需要使配置管理能力更加強大,

我推薦兩種主要方法:

  • 使用配置服務器,例如Spring Cloud Config;

  • 將所有配置存盤在環境變數中(可以基于git倉庫進行配置),

這些選項中的任何一個(第二個選項多一些)都要求你在DevOps更少作業量,但這在微服務領域是很常見的,

13、提供全域例外處理

你真的需要一種處理例外的一致方法,Spring Boot提供了兩種主要方法:

  • 你應該使用HandlerExceptionResolver定義全域例外處理策略;

  • 你也可以在控制器上添加@ExceptionHandler注解,這在某些特定場景下使用可能會很有用,

這與Spring中的幾乎相同,并且Baeldung有一篇關于REST與Spring的錯誤處理的詳細文章(https://www.baeldung.com/exception-handling-for-rest-with-spring),非常值得一讀,

14、使用日志框架

你可能已經意識到這一點,但你應該使用Logger進行日志記錄,而不是使用System.out.println()手動執行,這很容易在Spring Boot中完成,幾乎沒有配置,只需獲取該類的記錄器實體:

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

這很重要,因為它可以讓你根據需要設定不同的日志記錄級別,有關Spring Boot日志集成點擊這里有一篇實戰文章

15、測驗你的代碼

這不是Spring Boot特有的,但它需要提醒——測驗你的代碼!如果你沒有撰寫測驗,那么你將從一開始就撰寫遺留代碼,

如果有其他人使用你的代碼庫,那邊改變任何東西將會變得危險,當你有多個服務相互依賴時,這甚至可能更具風險,

由于存在Spring Boot最佳實踐,因此你應該考慮將Spring Cloud Contract用于你的消費者驅動契約,它將使你與其他服務的集成更容易使用,有關Spring Boot單元測驗點擊這里有一篇實戰文章

16、使用測驗切片讓測驗更容易,并且更專注

這一條實踐來自Madhura Bhave(Spring 開發者, @madhurabhave23),

使用Spring Boot測驗代碼可能很棘手——你需要初始化資料層,連接大量服務,模擬事物……實際上并不是那么難!答案是使用測驗切片,

使用測驗切片,你可以根據需要僅連接部分應用程式,這可以為你節省大量時間,并確保你的測驗不會與未使用的內容相關聯,來自spring.io的一篇名為Custom test slice with Spring test 1.4的博客文章(https://spring.io/blog/2016/08/30/custom-test-slice-with-spring-boot-1-4)解釋了這種技術,

總結

感謝Spring Boot,撰寫基于Spring的微服務正變得前所未有的簡單,我希望通過這些最佳實踐,你的實施程序不僅會變得很快,而且從長遠來看也會更加強大和成功,祝你好運!

作者:Bartosz Jedrzejewski
https://www.e4developer.com/2018/08/06/
編譯:嚴小雨

推薦去我的博客閱讀更多:

1.Java JVM、集合、多執行緒、新特性系列教程

2.Spring MVC、Spring Boot、Spring Cloud 系列教程

3.Maven、Git、Eclipse、Intellij IDEA 系列工具教程

4.Java、后端、架構、阿里巴巴等大廠最新面試題

覺得不錯,別忘了點贊+轉發哦!

轉載請註明出處,本文鏈接:https://www.uj5u.com/houduan/189215.html

標籤:Java

上一篇:SQL 優化極簡法則,還有誰不會?

下一篇:陣列

標籤雲
其他(157675) Python(38076) JavaScript(25376) Java(17977) C(15215) 區塊鏈(8255) C#(7972) AI(7469) 爪哇(7425) MySQL(7132) html(6777) 基礎類(6313) sql(6102) 熊猫(6058) PHP(5869) 数组(5741) R(5409) Linux(5327) 反应(5209) 腳本語言(PerlPython)(5129) 非技術區(4971) Android(4554) 数据框(4311) css(4259) 节点.js(4032) C語言(3288) json(3245) 列表(3129) 扑(3119) C++語言(3117) 安卓(2998) 打字稿(2995) VBA(2789) Java相關(2746) 疑難問題(2699) 细绳(2522) 單片機工控(2479) iOS(2429) ASP.NET(2402) MongoDB(2323) 麻木的(2285) 正则表达式(2254) 字典(2211) 循环(2198) 迅速(2185) 擅长(2169) 镖(2155) 功能(1967) .NET技术(1958) Web開發(1951) python-3.x(1918) HtmlCss(1915) 弹簧靴(1913) C++(1909) xml(1889) PostgreSQL(1872) .NETCore(1853) 谷歌表格(1846) Unity3D(1843) for循环(1842)

熱門瀏覽
  • 【C++】Microsoft C++、C 和匯編程式檔案

    ......

    uj5u.com 2020-09-10 00:57:23 more
  • 例外宣告

    相比于斷言適用于排除邏輯上不可能存在的狀態,例外通常是用于邏輯上可能發生的錯誤。 例外宣告 Item 1:當函式不可能拋出例外或不能接受拋出例外時,使用noexcept 理由 如果不打算拋出例外的話,程式就會認為無法處理這種錯誤,并且應當盡早終止,如此可以有效地阻止例外的傳播與擴散。 示例 //不可 ......

    uj5u.com 2020-09-10 00:57:27 more
  • Codeforces 1400E Clear the Multiset(貪心 + 分治)

    鏈接:https://codeforces.com/problemset/problem/1400/E 來源:Codeforces 思路:給你一個陣列,現在你可以進行兩種操作,操作1:將一段沒有 0 的區間進行減一的操作,操作2:將 i 位置上的元素歸零。最終問:將這個陣列的全部元素歸零后操作的最少 ......

    uj5u.com 2020-09-10 00:57:30 more
  • UVA11610 【Reverse Prime】

    本人看到此題沒有翻譯,就附帶了一個自己的翻譯版本 思考 這一題,它的第一個要求是找出所有 $7$ 位反向質數及其質因數的個數。 我們應該需要質數篩篩選1~$10^{7}$的所有數,這里就不慢慢介紹了。但是,重讀題,我們突然發現反向質數都是 $7$ 位,而將它反過來后的數字卻是 $6$ 位數,這就說明 ......

    uj5u.com 2020-09-10 00:57:36 more
  • 統計區間素數數量

    1 #pragma GCC optimize(2) 2 #include <bits/stdc++.h> 3 using namespace std; 4 bool isprime[1000000010]; 5 vector<int> prime; 6 inline int getlist(int ......

    uj5u.com 2020-09-10 00:57:47 more
  • C/C++編程筆記:C++中的 const 變數詳解,教你正確認識const用法

    1、C中的const 1、區域const變數存放在堆疊區中,會分配記憶體(也就是說可以通過地址間接修改變數的值)。測驗代碼如下: 運行結果: 2、全域const變數存放在只讀資料段(不能通過地址修改,會發生寫入錯誤), 默認為外部聯編,可以給其他源檔案使用(需要用extern關鍵字修飾) 運行結果: ......

    uj5u.com 2020-09-10 00:58:04 more
  • 【C++犯錯記錄】VS2019 MFC添加資源不懂如何修改資源宏ID

    1. 首先在資源視圖中,添加資源 2. 點擊新添加的資源,復制自動生成的ID 3. 在解決方案資源管理器中找到Resource.h檔案,編輯,使用整個專案搜索和替換的方式快速替換 宏宣告 4. Ctrl+Shift+F 全域搜索,點擊查找全部,然后逐個替換 5. 為什么使用搜索替換而不使用屬性視窗直 ......

    uj5u.com 2020-09-10 00:59:11 more
  • 【C++犯錯記錄】VS2019 MFC不懂的批量添加資源

    1. 打開資源頭檔案Resource.h,在其中預先定義好宏 ID(不清楚其實ID值應該設定多少,可以先新建一個相同的資源項,再在這個資源的ID值的基礎上遞增即可) 2. 在資源視圖中選中專案資源,按F7編輯資源檔案,按 ID 型別 相對路徑的形式添加 資源。(別忘了先把檔案拷貝到專案中的res檔案 ......

    uj5u.com 2020-09-10 01:00:19 more
  • C/C++編程筆記:關于C++的參考型別,專供新手入門使用

    今天要講的是C++中我最喜歡的一個用法——參考,也叫別名。 參考就是給一個變數名取一個變數名,方便我們間接地使用這個變數。我們可以給一個變數創建N個參考,這N + 1個變數共享了同一塊記憶體區域。(參考型別的變數會占用記憶體空間,占用的記憶體空間的大小和指標型別的大小是相同的。雖然參考是一個物件的別名,但 ......

    uj5u.com 2020-09-10 01:00:22 more
  • 【C/C++編程筆記】從頭開始學習C ++:初學者完整指南

    眾所周知,C ++的學習曲線陡峭,但是花時間學習這種語言將為您的職業帶來奇跡,并使您與其他開發人員區分開。您會更輕松地學習新語言,形成真正的解決問題的技能,并在編程的基礎上打下堅實的基礎。 C ++將幫助您養成良好的編程習慣(即清晰一致的編碼風格,在撰寫代碼時注釋代碼,并限制類內部的可見性),并且由 ......

    uj5u.com 2020-09-10 01:00:41 more
最新发布
  • Rust中的智能指標:Box<T> Rc<T> Arc<T> Cell<T> RefCell<T> Weak

    Rust中的智能指標是什么 智能指標(smart pointers)是一類資料結構,是擁有資料所有權和額外功能的指標。是指標的進一步發展 指標(pointer)是一個包含記憶體地址的變數的通用概念。這個地址參考,或 ” 指向”(points at)一些其 他資料 。參考以 & 符號為標志并借用了他們所 ......

    uj5u.com 2023-04-20 07:24:10 more
  • Java的值傳遞和參考傳遞

    值傳遞不會改變本身,參考傳遞(如果傳遞的值需要實體化到堆里)如果發生修改了會改變本身。 1.基本資料型別都是值傳遞 package com.example.basic; public class Test { public static void main(String[] args) { int ......

    uj5u.com 2023-04-20 07:24:04 more
  • [2]SpinalHDL教程——Scala簡單入門

    第一個 Scala 程式 shell里面輸入 $ scala scala> 1 + 1 res0: Int = 2 scala> println("Hello World!") Hello World! 檔案形式 object HelloWorld { /* 這是我的第一個 Scala 程式 * 以 ......

    uj5u.com 2023-04-20 07:23:58 more
  • 理解函式指標和回呼函式

    理解 函式指標 指向函式的指標。比如: 理解函式指標的偽代碼 void (*p)(int type, char *data); // 定義一個函式指標p void func(int type, char *data); // 宣告一個函式func p = func; // 將指標p指向函式func ......

    uj5u.com 2023-04-20 07:23:52 more
  • Django筆記二十五之資料庫函式之日期函式

    本文首發于公眾號:Hunter后端 原文鏈接:Django筆記二十五之資料庫函式之日期函式 日期函式主要介紹兩個大類,Extract() 和 Trunc() Extract() 函式作用是提取日期,比如我們可以提取一個日期欄位的年份,月份,日等資料 Trunc() 的作用則是截取,比如 2022-0 ......

    uj5u.com 2023-04-20 07:23:45 more
  • 一天吃透JVM面試八股文

    什么是JVM? JVM,全稱Java Virtual Machine(Java虛擬機),是通過在實際的計算機上仿真模擬各種計算機功能來實作的。由一套位元組碼指令集、一組暫存器、一個堆疊、一個垃圾回收堆和一個存盤方法域等組成。JVM屏蔽了與作業系統平臺相關的資訊,使得Java程式只需要生成在Java虛擬機 ......

    uj5u.com 2023-04-20 07:23:31 more
  • 使用Java接入小程式訂閱訊息!

    更新完微信服務號的模板訊息之后,我又趕緊把微信小程式的訂閱訊息給實作了!之前我一直以為微信小程式也是要企業才能申請,沒想到小程式個人就能申請。 訊息推送平臺🔥推送下發【郵件】【短信】【微信服務號】【微信小程式】【企業微信】【釘釘】等訊息型別。 https://gitee.com/zhongfuch ......

    uj5u.com 2023-04-20 07:22:59 more
  • java -- 緩沖流、轉換流、序列化流

    緩沖流 緩沖流, 也叫高效流, 按照資料型別分類: 位元組緩沖流:BufferedInputStream,BufferedOutputStream 字符緩沖流:BufferedReader,BufferedWriter 緩沖流的基本原理,是在創建流物件時,會創建一個內置的默認大小的緩沖區陣列,通過緩沖 ......

    uj5u.com 2023-04-20 07:22:49 more
  • Java-SpringBoot-Range請求頭設定實作視頻分段傳輸

    老實說,人太懶了,現在基本都不喜歡寫筆記了,但是網上有關Range請求頭的文章都太水了 下面是抄的一段StackOverflow的代碼...自己大修改過的,寫的注釋挺全的,應該直接看得懂,就不解釋了 寫的不好...只是希望能給視頻網站開發的新手一點點幫助吧. 業務場景:視頻分段傳輸、視頻多段傳輸(理 ......

    uj5u.com 2023-04-20 07:22:42 more
  • Windows 10開發教程_編程入門自學教程_菜鳥教程-免費教程分享

    教程簡介 Windows 10開發入門教程 - 從簡單的步驟了解Windows 10開發,從基本到高級概念,包括簡介,UWP,第一個應用程式,商店,XAML控制元件,資料系結,XAML性能,自適應設計,自適應UI,自適應代碼,檔案管理,SQLite資料庫,應用程式到應用程式通信,應用程式本地化,應用程式 ......

    uj5u.com 2023-04-20 07:22:35 more