資訊專欄INFORMATION COLUMN
摘要：大家好，好久沒(méi)有寫(xiě)公眾號(hào)了，最近有朋友參加面試被問(wèn)到開(kāi)發(fā)規(guī)范的問(wèn)題，突然發(fā)現(xiàn)每天干著工作，卻沒(méi)有關(guān)注這個(gè)問(wèn)題，就想著寫(xiě)篇文章，簡(jiǎn)單的說(shuō)下自己公司的開(kāi)發(fā)規(guī)范。
大家好，好久沒(méi)有寫(xiě)公眾號(hào)了，最近有朋友參加面試被問(wèn)到開(kāi)發(fā)規(guī)范的問(wèn)題，突然發(fā)現(xiàn)每天干著工作，卻沒(méi)有關(guān)注這個(gè)問(wèn)題，就想著寫(xiě)篇文章，簡(jiǎn)單的說(shuō)下自己公司的開(kāi)發(fā)規(guī)范。
關(guān)于規(guī)范，每個(gè)公司都有自己獨(dú)特的開(kāi)發(fā)規(guī)范，歸根結(jié)底，好的規(guī)范才能提高一個(gè)團(tuán)隊(duì)的效率，接下來(lái)，簡(jiǎn)單的說(shuō)下自己公司的開(kāi)發(fā)規(guī)范，如果大家能在其中有所收獲，就是值得的，歡迎評(píng)論區(qū)交流。
接口規(guī)范：
1、在開(kāi)發(fā)之前必須要先定義接口，定義接口就必須要思考你的需求，邏輯，在寫(xiě)接口文檔的時(shí)候其實(shí)你就已經(jīng)在你的大腦中實(shí)現(xiàn)了一遍你的需求了。
2、你定義的接口也是要有標(biāo)準(zhǔn)的，包括不包含多余的字段，正式環(huán)境和測(cè)試環(huán)境的數(shù)據(jù)格式必須一致，文檔與真實(shí)開(kāi)發(fā)出來(lái)的接口必須一致等等。
3、在開(kāi)發(fā)的過(guò)程中，如果接口有變化，需要及時(shí)和前端或者客戶端溝通，避免因?yàn)樾畔⒌牟煌絾?wèn)題而導(dǎo)致工期延誤。
4、還有前端和APP拿到你的接口數(shù)據(jù)之后不需要再次的進(jìn)行邏輯處理，比如說(shuō)，狀態(tài)字段是int類型，你把所有的枚舉類型給他，讓他自己去循環(huán)判斷應(yīng)該顯示哪個(gè)中文，如果接口定義成這樣，那這個(gè)接口就是不太合格的，你可以在接口返回?cái)?shù)據(jù)中添加一個(gè)字段來(lái)避免使用者的多余的工作量。
上線規(guī)范：
1、首先在開(kāi)發(fā)完成后，我們需要自測(cè)，自測(cè)的標(biāo)準(zhǔn)并不是特別的高，只需要通過(guò)冒煙測(cè)試，能夠把正常的流程走通就可以了，千萬(wàn)不要自測(cè)還沒(méi)測(cè)好就交給測(cè)試，當(dāng)測(cè)試辛辛苦苦的錄完數(shù)據(jù)，走正常的流程的時(shí)候報(bào)個(gè)系統(tǒng)異常，這種心情應(yīng)該是十分酸爽的。只有當(dāng)這些常規(guī)的測(cè)試走通的時(shí)候，測(cè)試才會(huì)給你測(cè)那些比較不容易發(fā)現(xiàn)的問(wèn)題，如果測(cè)試總是在這些顯而易見(jiàn)的問(wèn)題上兜兜轉(zhuǎn)轉(zhuǎn)，那么在有限的時(shí)間內(nèi)，測(cè)出的產(chǎn)品可能質(zhì)量也并不高。
2、其次測(cè)試通過(guò)之后，關(guān)注下在正式環(huán)境上是否需要資源申請(qǐng)，比如說(shuō)服務(wù)器，redis，數(shù)據(jù)庫(kù)，這些東西需要提前的給運(yùn)維提交工單，讓運(yùn)維能夠從容不迫的去準(zhǔn)備，避免在上線那天因?yàn)橘Y源還沒(méi)準(zhǔn)備好而耽誤太長(zhǎng)的時(shí)間。
3、在測(cè)試通過(guò)，運(yùn)維準(zhǔn)備好資源的時(shí)候，就可以部署到線上了，我們的代碼現(xiàn)在應(yīng)該是在dev分支上，我們需要把代碼合并到master分支上（這里需要說(shuō)明下，master分支上千萬(wàn)不要修改代碼，我們要時(shí)刻保證master分支上的代碼是和線上環(huán)境保持一致的），之后就可以通過(guò)Jenkins或者其他部署工具部署項(xiàng)目了。
4、部署之后，我們不能直接通知測(cè)試來(lái)測(cè)試了，我們需要用我們的測(cè)試用例，自己先訪問(wèn)下我們的正式環(huán)境的接口，看下是否正常，之后在通知測(cè)試回測(cè)。等待著測(cè)試匯報(bào)答復(fù)（每次上線聽(tīng)到測(cè)試說(shuō)沒(méi)有問(wèn)題，心里豁然開(kāi)朗）上線完成。
這里說(shuō)下，在線上部署的同時(shí)需要注意的點(diǎn)，在dev和master分支合并代碼之后要進(jìn)行代碼review，避免自己的誤操作帶來(lái)不必要的問(wèn)題。
當(dāng)在正式環(huán)境遇到問(wèn)題的時(shí)候，我們需要先通過(guò)自己的測(cè)試用例來(lái)定位問(wèn)題，可以單點(diǎn)線上tomcat來(lái)確定服務(wù)是否存在代碼問(wèn)題，如果是代碼問(wèn)題，修改后第二次合并代碼的時(shí)候要慎重，可以使用交叉review的方式。如果問(wèn)題歸屬配置問(wèn)題，及時(shí)找運(yùn)維溝通解決。上線完成后，要對(duì)master分支上打tag，在tag中說(shuō)明此次部署上線的主要內(nèi)容。
以上只是簡(jiǎn)單的說(shuō)了下接口文檔和上線的規(guī)范，接下來(lái)還會(huì)說(shuō)數(shù)據(jù)庫(kù)設(shè)計(jì)相關(guān)的規(guī)范，作為自己的知識(shí)總結(jié)，也希望能幫助到其他人。
這里會(huì)長(zhǎng)期的分享技術(shù)干貨、日常工作總結(jié)與思考，你的點(diǎn)贊和分享是對(duì)我最大的支持，感謝。
如果這篇文章讓你有所收獲，歡迎關(guān)注公眾號(hào) java技術(shù)情報(bào)局
文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請(qǐng)注明本文地址：http://www.ezyhdfw.cn/yun/73940.html
摘要：國(guó)產(chǎn)片的理想之作，國(guó)產(chǎn)科幻片的先行者，未來(lái)可期活動(dòng)預(yù)告月日，將參加在舉辦的活動(dòng)月日，受邀參加由碳鏈價(jià)值主辦的年首次線下活動(dòng)碳話主題為論區(qū)塊鏈共識(shí)機(jī)制關(guān)注我們官網(wǎng)論壇這是雙周報(bào)的第期，如有任何建議或者想法，歡迎大家來(lái)討論留言哦 showImg(https://segmentfault.com/img/bVbokFM?w=1080&h=460); 今年的朋友圈突然變得不那么活躍了？大家是否...
摘要：相比較財(cái)報(bào)這個(gè)振奮人心的消息，筆者更關(guān)注聯(lián)想凌拓的成立。目前聯(lián)想凌拓主要面對(duì)的也還只是中國(guó)市場(chǎng)，未來(lái)聯(lián)想在全球范圍內(nèi)與的合作空間會(huì)有多大尚未可知。開(kāi)年以來(lái)，聯(lián)想可謂好事不斷，一掃去年被各路媒體口誅筆伐的陰霾。在聯(lián)想集團(tuán)剛剛發(fā)布的2018／19財(cái)年第三季度財(cái)報(bào)中，集團(tuán)營(yíng)業(yè)額增至971億人民幣，稅前利潤(rùn)也達(dá)到24．2億。其中，DCG業(yè)務(wù)（數(shù)據(jù)中心集團(tuán)）營(yíng)業(yè)額繼續(xù)保持雙位數(shù)增長(zhǎng)，同比增速達(dá)到31％...
摘要：近日，浙大網(wǎng)新西南云計(jì)算數(shù)據(jù)中心項(xiàng)目正式開(kāi)工，這也標(biāo)志著網(wǎng)新的智慧云服務(wù)將在西南大地發(fā)展壯大，網(wǎng)新向成為全國(guó)性數(shù)據(jù)中心服務(wù)商的目標(biāo)又邁進(jìn)了一步。整體投運(yùn)達(dá)產(chǎn)后，服務(wù)范圍將覆蓋西南大部分地區(qū)，成為中國(guó)西南最大的云計(jì)算數(shù)據(jù)中心。近日，浙大網(wǎng)新西南云計(jì)算數(shù)據(jù)中心項(xiàng)目正式開(kāi)工，這也標(biāo)志著網(wǎng)新的智慧云服務(wù)將在西南大地發(fā)展壯大，網(wǎng)新向成為全國(guó)性數(shù)據(jù)中心服務(wù)商的目標(biāo)又邁進(jìn)了一步。浙大網(wǎng)新集團(tuán)是以產(chǎn)學(xué)研協(xié)同...
閱讀 3185·2021-11-22 15:29
閱讀 1850·2021-10-12 10:11
閱讀 1930·2021-09-04 16:45
閱讀 2493·2021-08-25 09:39
閱讀 2926·2021-08-18 10:20
閱讀 2687·2021-08-11 11:17
閱讀 532·2019-08-30 12:49
閱讀 3406·2019-08-30 12:49
