爲了規範編碼質量,開發人員必須牢記程序代碼開發規範要求。
- 每日工作開始前,先使用Git在項目中pull拉取最新代碼。以免其他同事有代碼更新,導致代碼不同步。
- 每日工作完成後,要提交到Git。即可實現備份,協作同事也可同步瞭解進度。提交的代碼,一定要確保編譯及功能無誤。
- 代碼提交commit上去前,注意忽略文件不要提交。
- 注意commit到本地庫後,還需要push到服務器。
- 所有異常必須要捕獲,且要插入到數據庫中存日誌。
- 異常使用try…catch,在catch中使用ExceptionUtil類,寫入異常日誌庫中。
-
下面是錯誤的示例:
正確的處理。使用異常處理類ExceptionUtil中的insertDB方法,記錄異常信息到數據庫。之後,是否返回則看具體業務場景。
- 數據庫查詢
- select查詢,嚴禁使用select * from。必須要查詢指定到具體字段,如select Id,UserName,NickName from。
- 接口傳輸,也是前端需要什麼字段就傳遞什麼字段,嚴禁傳遞多餘字段。服務器網絡帶寬都是按照流量進行計費,多餘網絡傳輸量也會增加服務器成本。
- 項目的package命名空間是:tech.qidian.erp,而不是com.qidian.tech。公司的域名是www.qidian.tech,或者www.qidiantech.net。不是qidian.com。在創建新項目時,要注意命名規則。
- 開發框架使用規範
- 後臺管理類的項目,公司研發了太極平臺框架,必須在要此框架上開發。
- webservice接口服務類項目。
- 無後臺,無需在太極平臺框架上開發,所以項目中無需引入QiDianAdminCommon、QiDianAdminTemplate這2個jar庫。
- 可引入QiDianWebCommon庫,進行輔助開發。庫中封裝了數據庫連接池與常用增刪改查方法,封裝了字符串處理。數據庫使用技巧,見下一節文章。
- 不引入QiDianWebCommon庫,可以根據自己所擅長的技術,完全採用自己的框架。比如struct、hibernate等,但是前提是,必須要在規定的時間週期內,按質量要求完成功能模塊。
- 客戶端項目。採用JavaFx技術進行開發。可找一些基於此JavaFx技術的漂亮UI主題風格(免費的或收費的均可),以後作爲我們的標準。
- 後臺頁面項目。如果在管理後臺中添加內置頁面,必須使用與主體風格一致的樣式,採用我們規定的INSPINIA主題。如果是新頁面,則自由發揮主題樣式風格。
- 網站前端類項目。公司購買了一套bootstrap前臺主題框架Unify,裏面有很多可用的展示效果,可引入使用。但並不強制要求使用此主題框架,可根據所長自由選擇。
- 界面標準
- 列表顯示。
- 字符串。列表字段長度短(10個字以內),居中對齊。長度較大(超過10個字),左對齊。超長(30個字以上),需設置“列表最多字符數”屬性,進行列表自動截斷。
- 數字與貨幣。要右對齊。如果是貨幣,要設置爲貨幣類型,進行格式化。另外,針對可彙總的業務字段,要設置彙總屬性。以便在列表的最後一行顯示彙總數據。
- 搜索。列表基本上都要加上搜索功能,注意檢查覈對。時間的一般按照日期段進行搜索。
- 列表顯示。