#寫好業(yè)務(wù)代碼#3.工程標準化

本文集說的都是些平凡的小事苦掘,但往往是這些小事區(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)系。

圖1

同樣眯牧,在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

圖2

那么禁偎,看起來“遵循腳本規(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è)計网沾。

圖3

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

圖4

core-fw的POM

圖5

core-fw-ex的POM

圖6

sdk-platform的POM

圖7

sdk-platform-springboot的POM

圖8

db-product1的POM

圖9

bu-common的POM

圖10

bu-product1-feature1的POM

圖11

bu-product1-composite的POM

圖12

bu-product1-website的POM

圖13

源代碼:GitHub

3.總結(jié)

本文通過一個典型的微服務(wù)應(yīng)用系統(tǒng)為例,展示了如何達到工程標準化蕊爵。

最后辉哥,我們用魯迅先生的話結(jié)束本文:“規(guī)范千萬條,工程第一條在辆。工程不規(guī)范证薇,親人兩行淚”

圖14
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末度苔,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子浑度,更是在濱河造成了極大的恐慌寇窑,老刑警劉巖,帶你破解...
    沈念sama閱讀 216,496評論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件箩张,死亡現(xiàn)場離奇詭異甩骏,居然都是意外死亡,警方通過查閱死者的電腦和手機先慷,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,407評論 3 392
  • 文/潘曉璐 我一進店門饮笛,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人论熙,你說我怎么就攤上這事福青。” “怎么了脓诡?”我有些...
    開封第一講書人閱讀 162,632評論 0 353
  • 文/不壞的土叔 我叫張陵无午,是天一觀的道長。 經(jīng)常有香客問我祝谚,道長宪迟,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,180評論 1 292
  • 正文 為了忘掉前任交惯,我火速辦了婚禮次泽,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘席爽。我一直安慰自己意荤,他們只是感情好,可當我...
    茶點故事閱讀 67,198評論 6 388
  • 文/花漫 我一把揭開白布只锻。 她就那樣靜靜地躺著袭异,像睡著了一般。 火紅的嫁衣襯著肌膚如雪炬藤。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,165評論 1 299
  • 那天碴里,我揣著相機與錄音沈矿,去河邊找鬼。 笑死咬腋,一個胖子當著我的面吹牛羹膳,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播根竿,決...
    沈念sama閱讀 40,052評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼陵像,長吁一口氣:“原來是場噩夢啊……” “哼就珠!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起醒颖,我...
    開封第一講書人閱讀 38,910評論 0 274
  • 序言:老撾萬榮一對情侶失蹤妻怎,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后泞歉,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體逼侦,經(jīng)...
    沈念sama閱讀 45,324評論 1 310
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,542評論 2 332
  • 正文 我和宋清朗相戀三年腰耙,在試婚紗的時候發(fā)現(xiàn)自己被綠了榛丢。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,711評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡挺庞,死狀恐怖晰赞,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情选侨,我是刑警寧澤掖鱼,帶...
    沈念sama閱讀 35,424評論 5 343
  • 正文 年R本政府宣布,位于F島的核電站侵俗,受9級特大地震影響锨用,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜隘谣,卻給世界環(huán)境...
    茶點故事閱讀 41,017評論 3 326
  • 文/蒙蒙 一增拥、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧寻歧,春花似錦掌栅、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,668評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至噪珊,卻和暖如春晌缘,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背痢站。 一陣腳步聲響...
    開封第一講書人閱讀 32,823評論 1 269
  • 我被黑心中介騙來泰國打工磷箕, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人阵难。 一個月前我還...
    沈念sama閱讀 47,722評論 2 368
  • 正文 我出身青樓岳枷,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子空繁,可洞房花燭夜當晚...
    茶點故事閱讀 44,611評論 2 353

推薦閱讀更多精彩內(nèi)容