很多人都知道,阿裡巴巴在2017發佈了《阿裡巴巴Java開發手冊》,前後推出了很多個版本,併在後續推出了與之配套的IDEA插件和書籍。 相信很多Java開發都或多或少看過這份手冊,這份手冊有7個章節,覆蓋了編程規約、異常日誌、單元測試、安全規約、MySQL資料庫、工程結構以及設計規約等方面。 這份規 ...
很多人都知道,阿裡巴巴在2017發佈了《阿裡巴巴Java開發手冊》,前後推出了很多個版本,併在後續推出了與之配套的IDEA插件和書籍。
相信很多Java開發都或多或少看過這份手冊,這份手冊有7個章節,覆蓋了編程規約、異常日誌、單元測試、安全規約、MySQL資料庫、工程結構以及設計規約等方面。
這份規約可以說是覆蓋了Java開發的方方面面,如果還有人沒看的話,強烈建議大家好好看看,並且仔細研讀。
手冊中,有那麼一些規則,是比較容易理解的。比如一些變數命名規範,有另外一些規則,是不太容易理解的,背後是有很多思考的,有一些則是阿裡這麼多年來遇到的坑的總結。
這份手冊在誕生之初,是在阿裡內部的,那時候就引起了廣泛的討論。最終外界看到的那份手冊,是阿裡無數工程師"挑剔"後的結果,可以說是凝聚了無數工程師成功的經驗、踩過的坑等。
其實,規約最大的價值,應該是促使人去思考規約制定背後的思考。真的去探查規約背後的原理,這個過程中可以學習到很多東西。
《阿裡巴巴Java開發手冊》還沒有的小伙伴可以來私信我【阿裡學習手冊】領取一份
一、為什麼阿裡巴巴禁止工程師直接使用日誌系統(Log4j、Logback)中的 API
在Java生態體系中,圍繞著日誌,有很多成熟的解決方案。關於日誌輸出,主要有兩類工具。
一類是日誌框架,主要用來進行日誌的輸出的,比如輸出到哪個文件,日誌格式如何等。另外一類是日誌門面,主要一套通用的API,用來屏蔽各個日誌框架之間的差異的。
所以,對於Java工程師來說,關於日誌工具的使用,最佳實踐就是在應用中使用如Log4j + SLF4J 這樣的組合來進行日誌輸出。
這樣做的最大好處,就是業務層的開發不需要關心底層日誌框架的實現及細節,在編碼的時候也不需要考慮日後更換框架所帶來的成本。這也是門面模式所帶來的好處。
二、為什麼阿裡巴巴建議集合初始化時,指定集合容量大小?
HashMap有擴容機制,就是當達到擴容條件時會進行擴容。如果我們沒有設置初始容量大小,隨著元素的不斷增加,HashMap會發生多次擴容,而HashMap中的擴容機制決定了每次擴容都需要重建hash表,是非常影響性能的。
預設情況下,當我們設置HashMap的初始化容量時,實際上HashMap會採用第一個大於該數值的2的冪作為初始化容量。
但是,為了最大程度的避免擴容帶來的性能消耗,我們建議可以把預設容量的數字設置成expectedSize / 0.75F + 1.0F 。在日常開發中,可以使用
Map<String,String>map=Maps.newHashMapWithExpectedSize(10);
來創建一個HashMap,計算的過程guava會幫我們完成。
但是,以上的操作是一種用記憶體換性能的做法,真正使用的時候,要考慮到記憶體的影響。
三、為什麼阿裡巴巴禁止在 foreach 迴圈里進行元素的 remove/add 操作
我們使用的增強for迴圈,其實是Java提供的語法糖,其實現原理是藉助Iterator進行元素的遍歷。
但是如果在遍歷過程中,不通過Iterator,而是通過集合類自身的方法對集合進行添加/刪除操作。那麼在Iterator進行下一次的遍歷時,經檢測發現有一次集合的修改操作並未通過自身進行,那麼可能是發生了併發被其他線程執行的,這時候就會拋出異常,來提示用戶可能發生了併發修改,這就是所謂的fail-fast機制。
當然還是有很多種方法可以解決這類問題的。比如使用普通for迴圈、使用Iterator進行元素刪除、使用Stream的filter、使用fail-safe的類等。
四、為什麼阿裡巴巴禁止把SimpleDateFormat定義為static類型的?
SimpleDateFormat主要可以在String和Date之間做轉換,還可以將時間轉換成不同時區輸出。但是在併發場景中SimpleDateFormat是不能保證線程安全的,需要開發者自己來保證其安全性。
SimpleDateFormat中的format方法在執行過程中,會使用一個成員變數calendar來保存時間。這其實就是問題的關鍵。
如果一個SimpleDateFormat使用的是static定義的。那麼這個SimpleDateFormat就是一個共用變數,隨之,SimpleDateFormat中的calendar也就可以被多個線程訪問到。就會有併發安全問題。
五、為什麼阿裡巴巴不建議在for迴圈中使用"+"進行字元串拼接
使用+拼接字元串,其實只是Java提供的一個語法糖,通過反編譯,我們可以發現,其實字元串常量使用"+"在拼接過程中,是將String轉成了StringBuilder後,使用其append方法進行處理的。
如果在一個for迴圈中,使用"+"對字元串進行拼接,那麼每一次都會重新new一個StringBuilder,然後再把String轉成StringBuilder,再進行append。
而頻繁的新建對象當然要耗費很多時間了,不僅僅會耗費時間,頻繁的創建對象,還會造成記憶體資源的浪費。
六、為什麼阿裡巴巴要求程式員謹慎修改serialVersionUID 欄位的值
序列化提供了一種方案,可以讓你在即使JVM停機的情況下也能把對象保存下來的方案。就像我們平時用的U盤一樣。把Java對象序列化成可存儲或傳輸的形式(如二進位流),比如保存在文件中。這樣,當再次需要這個對象的時候,從文件中讀取出二進位流,再從二進位流中反序列化出對象。
虛擬機是否允許反序列化,不僅取決於類路徑和功能代碼是否一致,一個非常重要的一點是兩個類的序列化 ID 是否一致,這個所謂的序列化ID,就是我們在代碼中定義的serialVersionUID。
在進行反序列化時,JVM會把傳來的位元組流中的serialVersionUID與本地相應實體類的serialVersionUID進行比較,如果相同就認為是一致的,可以進行反序列化,否則就會出現序列化版本不一致的異常,即是InvalidCastException。
七、為什麼阿裡巴巴要求謹慎使用ArrayList中的subList方法
subList是List介面中定義的一個方法,該方法主要用於返回一個集合中的一段、可以理解為截取一個集合中的部分元素,他的返回值也是一個List。
但是subList 返回的並不是一個全新的List,而是一個視圖。就是說,SubList並沒有重新創建一個List,而是直接引用了原有的List(返回了父類的視圖),只是指定了一下他要使用的元素的範圍而已(從fromIndex(包含),到toIndex(不包含))。
所以,首先我們無法將subList方法得到的集合直接轉換成ArrayList。因為SubList只是ArrayList的內部類,他們之間並沒有繼承關係,故無法直接進行強制類型轉換。
另外,視圖和原List的修改還需要註意幾點,尤其是他們之間的相互影響:
- 1、對父(sourceList)子(subList)List做的非結構性修改(non-structural changes),都會影響到彼此。
- 2、對子List做結構性修改,操作同樣會反映到父List上。
- 3、對父List做結構性修改,會拋出異常ConcurrentModificationException。
所以,阿裡巴巴Java開發手冊中有另外一條規定:
八、為什麼阿裡巴巴建議開發者謹慎使用繼承?
作為一門面向對象開發的語言,代碼復用是Java引人註意的功能之一。Java代碼的復用有繼承,組合以及代理三種具體的表現形式。
繼承,在寫代碼的時候就要指明具體繼承哪個類,所以,類的繼承關係是在編譯期就確定的。並且從基類繼承來的實現是無法在運行期動態改變的,因此降低了應用的靈活性。
組合,在寫代碼的時候可以採用面向介面編程。所以,類的組合關係一般在運行期確定。另外,代碼復用方式上也有一定區別:
- 繼承結構中,父類的內部細節對於子類是可見的。所以我們通常也可以說通過繼承的代碼復用是一種白盒式代碼復用。如果基類的實現發生改變,那麼派生類的實現也將隨之改變。這樣就導致了子類行為的不可預知性。
- 組合是通過對現有的對象進行拼裝(組合)產生新的、更複雜的功能。因為在對象之間,各自的內部細節是不可見的,所以我們也說通過組合的代碼復用是黑盒式代碼復用。因為組合中一般都定義一個類型,所以在編譯期根本不知道具體會調用哪個實現類的方法。
還有,Java中不支持多繼承,而組合是沒有限制的。就像一個人只能有一個父親,但是他可以有很很多輛車。
九、為什麼阿裡巴巴禁止開發人員使用isSuccess作為變數名
fastjson和jackson在把對象序列化成json字元串的時候,是通過反射遍歷出該類中的所有getter方法,得到getHollis和isSuccess,然後根據JavaBeans規則,他會認為這是兩個屬性hollis和success的值。
但是Gson並不是這麼做的,他是通過反射遍歷該類中的所有屬性,並把其值序列化成json
可以看到,由於不同的序列化工具,在進行序列化的時候使用到的策略是不一樣的,所以,對於同一個類的同一個對象的序列化結果可能是不同的。
如果對於同一個對象,我使用fastjson進行序列化,再使用Gson反序列化,並且恰巧這個對象中某個屬性是以isXXX命名的,那麼就會產生問題。
作為開發者,我們應該想辦法儘量避免這種問題的發生,對於POJO的設計者來說,只需要做簡單的一件事就可以解決這個問題了,那就是把isSuccess改為success。
十、為什麼阿裡巴巴不讓使用 COUNT(列名)或 COUNT(常量)來替代 COUNT(*)呢
因為COUNT(*)是SQL92定義的標準統計行數的語法,所以MySQL對他進行了很多優化,MyISAM中會直接把表的總行數單獨記錄下來供COUNT(*)查詢,而InnoDB則會在掃表的時候選擇最小的索引來降低成本。當然,這些優化的前提都是沒有進行where和group的條件查詢。
在InnoDB中COUNT(*)和COUNT(1)實現上沒有區別,而且效率一樣,但是COUNT(欄位)需要進行欄位的非NULL判斷,所以效率會低一些。
因為COUNT(*)是SQL92定義的標準統計行數的語法,並且效率高,所以請直接使用COUNT(*)查詢表的行數!
十一、為什麼阿裡巴巴不允許使用Executors創建線程池?
Java中的BlockingQueue主要有兩種實現,分別是ArrayBlockingQueue 和 LinkedBlockingQueue。
ArrayBlockingQueue是一個用數組實現的有界阻塞隊列,必須設置容量。
LinkedBlockingQueue是一個用鏈表實現的有界阻塞隊列,容量可以選擇進行設置,不設置的話,將是一個無邊界的阻塞隊列,最大長度為Integer.MAX_VALUE。
這裡的問題就出在:不設置的話,將是一個無邊界的阻塞隊列,最大長度為Integer.MAX_VALUE。也就是說,如果我們不設置LinkedBlockingQueue的容量的話,其預設容量將會是Integer.MAX_VALUE。
而newFixedThreadPool中創建LinkedBlockingQueue時,並未指定容量。此時,LinkedBlockingQueue就是一個無邊界隊列,對於一個無邊界隊列來說,是可以不斷的向隊列中加入任務的,這種情況下就有可能因為任務過多而導致記憶體溢出問題。
上面提到的問題主要體現在newFixedThreadPool和newSingleThreadExecutor兩個工廠方法上,並不是說newCachedThreadPool和newScheduledThreadPool這兩個方法就安全了,這兩種方式創建的最大線程數可能是Integer.MAX_VALUE,而創建這麼多線程,必然就有可能導致OOM。
總結
以上,就是我之前一段時間通過學習《手冊》中的部分規則之後,自己總結的一些內容,這個過程中自己也學習到很多東西。
所以想說,這才是學習《手冊》的正確姿勢,這樣才能最大程度的成長!
這個系列還在繼續更新,後面還會會逐步完善。歡迎關註與交流。
《阿裡巴巴Java開發手冊》還沒有的小伙伴可以來私信我【阿裡學習手冊】領取一份