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