代碼之旅:基礎(chǔ)規(guī)范

在設(shè)計架構(gòu)的時候师郑,要考慮由下而上的模式消别,底層的實踐最終會影響整個系統(tǒng)的架構(gòu)。再好的架構(gòu)低淡,如果沒有輔以有效的工程實踐姓言,那么最終我們得到的只是一只空有其表的架構(gòu)方案。能自下而上影響軟件架構(gòu)的蔗蹋,就只有代碼了何荚。

代碼本身是一種難以衡量的實踐。同一個業(yè)務(wù)功能有不同的代碼實現(xiàn)猪杭。想象一個場景餐塘,我們對外提供了一個 RESTful API 接口,是不是只要我們能以規(guī)范的方式提供這個RESTful API 接口皂吮,代碼的實現(xiàn)方式和質(zhì)量就變得不重要了戒傻?

從短期來看,如果一個API能快速地提供功能以驅(qū)動業(yè)務(wù)增長涮较,那么它就就是一個成功的 API稠鼻。不論其設(shè)計得多么丑陋,代碼質(zhì)量多差狂票,只要不影響性能候齿,未來就有改進(jìn)的空間。可是從長期來看慌盯,API是要能夠面向變化而快速拓展的周霉,如果我們不能方便地在 API 中拓展功能,那么它就真的會影響業(yè)務(wù)了亚皂。盡管重構(gòu)的代碼可以幫助我們走向更好的架構(gòu)俱箱,但是在業(yè)務(wù)進(jìn)度不合理的情況下,我們只能在舊的灭必、丑陋的代碼上不斷堆砌功能狞谱。直至有一天,我們愉快地選擇重寫系統(tǒng)禁漓。

在本節(jié)里跟衅,我們將討論代碼中的一些基礎(chǔ)規(guī)范,他們更多地關(guān)注代碼的可讀性播歼,而不是代碼的質(zhì)量伶跷,我們會在后面的章節(jié)里關(guān)注代碼質(zhì)量。為了提升代碼的可讀性秘狞,我們需要做到以下的幾方面:

  • 規(guī)范代碼組織結(jié)構(gòu)
    • 統(tǒng)一代碼風(fēng)格叭莫,即源代碼的書寫風(fēng)格
    • 組件、函數(shù)等命名規(guī)范
    • 開發(fā)工具規(guī)范

光看這幾點要求烁试,總覺得似乎多了很多條條框框雇初。盡管這種統(tǒng)一性會扼殺團(tuán)隊的多樣性,但是對于代碼層次的風(fēng)格統(tǒng)一是相當(dāng)有必要的减响。

在這些實踐中抵皱,有些并不僅僅是實踐,他還反應(yīng)了架構(gòu)的模式辩蛋,如代碼組織結(jié)構(gòu) —— 從代碼的組織構(gòu)架上,我們可以真真切切地感受到他與系統(tǒng)架構(gòu)的相似之處移盆。由于應(yīng)用內(nèi)的代碼復(fù)用采用組件化的架構(gòu)悼院,所以我們應(yīng)該隔離不同的組件。比如咒循,在 Angular 生成的組件 component 中据途,我們就可以看到一種組件完全獨立的存在形式。

本文由博客一文多發(fā)平臺 OpenWrite 發(fā)布叙甸!

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末颖医,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子裆蒸,更是在濱河造成了極大的恐慌熔萧,老刑警劉巖,帶你破解...
    沈念sama閱讀 216,544評論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異佛致,居然都是意外死亡贮缕,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,430評論 3 392
  • 文/潘曉璐 我一進(jìn)店門俺榆,熙熙樓的掌柜王于貴愁眉苦臉地迎上來感昼,“玉大人,你說我怎么就攤上這事罐脊《ㄉぃ” “怎么了?”我有些...
    開封第一講書人閱讀 162,764評論 0 353
  • 文/不壞的土叔 我叫張陵萍桌,是天一觀的道長宵溅。 經(jīng)常有香客問我,道長梗夸,這世上最難降的妖魔是什么层玲? 我笑而不...
    開封第一講書人閱讀 58,193評論 1 292
  • 正文 為了忘掉前任,我火速辦了婚禮反症,結(jié)果婚禮上辛块,老公的妹妹穿的比我還像新娘。我一直安慰自己铅碍,他們只是感情好润绵,可當(dāng)我...
    茶點故事閱讀 67,216評論 6 388
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著胞谈,像睡著了一般尘盼。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上烦绳,一...
    開封第一講書人閱讀 51,182評論 1 299
  • 那天卿捎,我揣著相機(jī)與錄音,去河邊找鬼径密。 笑死午阵,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的享扔。 我是一名探鬼主播底桂,決...
    沈念sama閱讀 40,063評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼惧眠!你這毒婦竟也來了籽懦?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 38,917評論 0 274
  • 序言:老撾萬榮一對情侶失蹤氛魁,失蹤者是張志新(化名)和其女友劉穎暮顺,沒想到半個月后厅篓,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,329評論 1 310
  • 正文 獨居荒郊野嶺守林人離奇死亡拖云,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,543評論 2 332
  • 正文 我和宋清朗相戀三年贷笛,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片宙项。...
    茶點故事閱讀 39,722評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡乏苦,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出尤筐,到底是詐尸還是另有隱情汇荐,我是刑警寧澤,帶...
    沈念sama閱讀 35,425評論 5 343
  • 正文 年R本政府宣布盆繁,位于F島的核電站掀淘,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏油昂。R本人自食惡果不足惜革娄,卻給世界環(huán)境...
    茶點故事閱讀 41,019評論 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望冕碟。 院中可真熱鬧拦惋,春花似錦、人聲如沸安寺。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,671評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽挑庶。三九已至言秸,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間迎捺,已是汗流浹背举畸。 一陣腳步聲響...
    開封第一講書人閱讀 32,825評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留凳枝,地道東北人俱恶。 一個月前我還...
    沈念sama閱讀 47,729評論 2 368
  • 正文 我出身青樓,卻偏偏與公主長得像范舀,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子了罪,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,614評論 2 353