本文集說的都是些平凡的小事苦掘,但往往是這些小事區(qū)分了產(chǎn)品的偉大與平庸。
1.雜談工程標準化
(1)關(guān)于工程
任何編譯構(gòu)建系統(tǒng)戏自,都存在“代碼工程”的概念望浩,也就是架構(gòu)師所說的“代碼視圖”。筆者覺得Visual Studio定義的最為“形象恨课、合理”,我們可以先從這個角度來理解代碼工程:
解決方案:解決方案只是一個容器岳服,用于包含一個或多個相關(guān)項目剂公,以及生成信息、Visual Studio 窗口設(shè)置和不與特定項目關(guān)聯(lián)的任何雜項文件吊宋。?解決方案由格式唯一的文本文件(擴展名 .sln)描述纲辽;不應(yīng)對其進行手動編輯 。
項目:在 Visual Studio 中創(chuàng)建應(yīng)用璃搜、網(wǎng)站拖吼、插件等時,會從項目開始 这吻。?在邏輯意義上吊档,項目包含所有將編譯到可執(zhí)行文件、庫或網(wǎng)站中的源代碼文件唾糯、圖標怠硼、圖像鬼贱、數(shù)據(jù)文件等。?項目還包含編譯器設(shè)置以及程序?qū)⑴c之通信的各種服務(wù)或組件需要的其他配置文件香璃。
——MSDN
解決方案是一個容器这难,包含了N個代碼工程。
每個代碼工程是一個編譯單元——可以輸出可執(zhí)行文件(例如:exe)葡秒,可以輸出動態(tài)庫(例如:dll)姻乓。
代碼工程之間存在依賴關(guān)系。
同樣眯牧,在Maven的世界蹋岩、Webpack的世界也有類似的概念,只是術(shù)語不同炸站。
(2)關(guān)于工程標準化
通常編譯構(gòu)建系統(tǒng)會定義一套標準化的腳本星澳,供程序猿按照架構(gòu)師的“設(shè)計圖紙”劃分代碼工程,描述代碼工程間的依賴關(guān)系旱易。以Maven的POM為例:
POM stands for "Project Object Model". It is an XML representation of a Maven project held in a file named?pom.xml. When in the presence of Maven folks, speaking of a project is speaking in the philosophical sense, beyond a mere collection of files containing code. A project contains configuration files, as well as the developers involved and the roles they play, the defect tracking system, the organization and licenses, the URL of where the project lives, the project's dependencies, and all of the other little pieces that come into play to give code life. It is a one-stop-shop for all things concerning the project. In fact, in the Maven world, a project need not contain any code at all, merely a?pom.xml.
From http://maven.apache.org/pom.html
那么禁偎,看起來“遵循腳本規(guī)范,標準化的編寫就能夠輕松愉快的實現(xiàn)工程標準化了”阀坏。
事實并非如此如暖,現(xiàn)代化的軟件開發(fā)分工很細(也不排除程序猿個體的學習動力),往往一個產(chǎn)品剛開始的代碼框架忌堂、工程腳本由一個程序猿大牛搭建好的盒至,后來者基本不用了解Maven這些編譯構(gòu)建系統(tǒng)的細節(jié),即使日后需要用到士修,也只需要把以前產(chǎn)品的完整代碼復制粘貼再刪除多余的代碼——筆者接觸過我廠很多工作5年的Java程序猿枷遂,對Maven的理解僅停留在聽說過“Maven”這個單詞的水平——這的確是一個不太樂觀的現(xiàn)實。
2.基于Maven的工程標準化
(1)看懂架構(gòu)師的圖紙
首先棋嘲,我們來假設(shè)一種場景:“希望業(yè)務(wù)側(cè)代碼是一套酒唉,但是能夠兼容不同微服務(wù)開發(fā)框架(例如:同時兼容SpringCloud和Dubbo)”。有實戰(zhàn)經(jīng)驗的同學一眼就能發(fā)現(xiàn)這種需求場景對于“BS/微服務(wù)”系統(tǒng)具有一定的典型性沸移。
再來痪伦,看看“架構(gòu)師的圖紙”。本文重點講解“如何根據(jù)架構(gòu)師的圖紙來構(gòu)建標準化的Maven工程”雹锣,不展開討論圖紙本身如何設(shè)計网沾。
core-fw/core-fw-ex:內(nèi)外部三方件
sdk-platform:平臺適配層的接口
sdk-platform-springboot:針對SpringBoot平臺適配層的實現(xiàn)
sdk-platform-dubbo:針對Dubbo平臺適配層的實現(xiàn)
db-product1:產(chǎn)品1的數(shù)據(jù)庫層
bu-product1-feature1/bu-product1-featureN:產(chǎn)品1的特性1~N的single層
bu-product1-composite:產(chǎn)品1的組合層
bu-product1-website:產(chǎn)品1的View層
(2)POM編寫
解決方案的POM
core-fw的POM
core-fw-ex的POM
sdk-platform的POM
sdk-platform-springboot的POM
db-product1的POM
bu-common的POM
bu-product1-feature1的POM
bu-product1-composite的POM
bu-product1-website的POM
3.總結(jié)
本文通過一個典型的微服務(wù)應(yīng)用系統(tǒng)為例,展示了如何達到工程標準化蕊爵。
最后辉哥,我們用魯迅先生的話結(jié)束本文:“規(guī)范千萬條,工程第一條在辆。工程不規(guī)范证薇,親人兩行淚”