2. 程式人生 > >代碼規範技術分享手稿

代碼規範技術分享手稿

阿新 • • 發佈：2019-03-21
系統 實體對象 led sta 原理 屬性 有意 ssm架構 user

為什麽要指定代碼規範?

1.項目結構混亂 2.代碼不規範,冗余,無從下手 導致 : 功能維護 的難度加大 >> 浪費時間去閱讀源碼 >> 爛代碼裏面繼續寫爛代碼 >> 維護起來越來越困難

從技術上的角度來講,你們認為什麽樣的代碼才算好代碼?

看不懂的代碼才是好代碼? 經過設計模式層層封裝的代碼才是好代碼? 簡潔明了,通俗一同,註釋齊全 ==> 好代碼 ! 在註重功能,技術深度和廣度的同時, 我們要懂原理,懂技術, 但是更重要的是寫的一手好代碼. talk is cheap,show me your code !
代碼編寫 =(根據)=>規範=(養成)=> 代碼風格 =(學會)=> 重構 =(培養)=> 代碼設計 =(理解)=> 設計模式 代碼規範的第一步,就是要培養代碼風格 下面我們就從溫州項目,一步步了解代碼規範

1.架構

1.1技術

本項目是JavaWeb項目,使用了如下技術
  1. 流行的SSM框架;
  2. log4j2+slf4j+disruptor 作為異步日誌組件
  3. druid 連接池
  4. fastjson和jackson json 工具
  5. AOP+aspect 控制事務和自定義註解
  6. swagger 文檔工具
  7. httpclient 網絡組件
  8. sigar + JMX 系統監控工具
  9. apace commons 系列開發工具
  10. Juint 單元測試
技術分享圖片

1.2 系統結構

系統結構盡量保持層次分明,結構簡單.用包命名的方式區分業務系統代碼和通用代碼,如下圖所示 技術分享圖片
  • commons: 存放通用代碼,比如各種工具類,常量類,日誌組件等.commons下的代碼主要服務於業務代碼
  • console: 主要針對web服務,提供訪問接口,如登錄註冊,權限系統等,,但是獨立cell的存在,有自己的一套訪問數據庫和業務邏輯.但是同樣基於SSM架構.
  • cell: 提供傳統分層中的Service層和Mapper層.保持最小的基礎邏輯單元,即單表
    的增刪改查,分頁查詢和列表查詢. 根據業務要求,也可以提供聯表的查詢服務. 聯表查詢時sql寫在主表標註的位置下(如下圖所示).我們建議,在聯表查詢中,盡量少的使用外聯. 此外,在service中,我們不建議一個方法有更新或新增多張表的行為.盡量保持類的單一職責.如果需要多表操作,請在VS層完成.
  • 技術分享圖片

技術分享圖片
  • s001: 業務代碼.負責提供對外訪問業務接口(Controller),業務邏輯(VS)以及值對象(VO).其中以Controller為單位作為服務調用的功能接口.VS註入多個Service提供復雜的業務邏輯,在業務包下,我們指定如下規範:
    • 以系統為單位,S開頭加系統編號的形式做頂級業務包命名方式並作為系統編號,如S001;
    • 以系統中的模塊為單位,M開頭加模塊編號作為系統包下的模塊包命名並作為模塊編號,如M001;
    • 以模塊中的功能為單位,F開頭加功能編號作為為模塊中的具體功能命名作為功能編號,如F001Controller.以系統編號+模塊編號+方法編號,如 /S001/M001/F001;URL前綴為
      • save*
      • update*
      • query*
      • view*
      • delete*
  • 以功能編號命名的VS層,與相同編號的Controller是一對一的關系,只服務此Controller.方法命名方式與URL前綴一致,用來控制事務.

技術分享圖片

2.開發規範

2.1 命名規範

  1. 英文命名盡量使用駝峰形式,拼音命名盡量通俗易懂,命名的方法或者屬性盡量有意義,並容易理解
    1. 反例: int i = updateXXX(TSignInfo record);
    2. 正例: int signCount = updateTSignInfo (TSignInfo record);
  2. 系統編號, 模塊編號,功能編號有項目經理提前指定並統一管理
  3. URL為系統編號+模塊編號+功能編號+save*/update*/query*/view*/delete*
  4. VS層的方法命名,凡是對數據庫操作的必須以save*/update*/delete*為前綴,方便事務控制

2.2 開發規範

  1. 類和方法必須寫註釋作為描述說明,接口方法上寫明調用頁面 . 靜態常量要有業務場景或使用說明
  2. controller層必須進行數據校驗
    1. 基本數據類型設置默認值. 如 pageSize = 10
    2. String類型的參數要做判空處理. (推薦使用 apache.commons.lang3.StringUtils)
    3. json類型的數據做json格式校驗
  3. controller層數據返回必須按照規範
    1. 操作數據 使用 ResultModel ,異常使用 ResultModel 返回對應狀態實體對象
    2. mini ui的分頁查詢 使用MiniList或者規定格式的數據作為返回值 ,異常時返回 {total:0,data:null} 字符串或者MiniList.emptyList();
    3. 字典表返回List,異常是返回 [] 字符串
  4. controller層必須進行異常時的數據返回處理
  5. controller層的每個接口方法必須使用try-catch捕獲異常
  6. controller層每個接口方法必須做日誌記錄.
  7. VS層在進行數據庫操作時,必須對操作返回的數值驗證,不正常的返回值進行異常處理 如 update(T t) = 0
  8. service,dao必須繼承 BaseService, BaseMapper接口,實現規範.生成的基礎邏輯代碼不可修改.有問題聯系項目經理.查詢代碼可自己實現
  9. 代碼中避免使用魔鬼數字,狀態字段等盡量使用有意義的常量,並且使用常量類統一維護 反例 : obj.setStatus("1");
  10. 頁面上的 操作請求 必須對返回值狀態 進行判斷 並進行相應的操作 ( 無論是成功還是失敗);
  11. 精確計算時,必須使用BigDecimal. 避免使用float和double. 浮點運算必須使用BigDecimal或整型運算,如
    1. 0.5 * 0.01 >> 50*1

代碼規範技術分享手稿

相關推薦

代碼規範技術分享手稿

系統 實體對象 led sta 原理 屬性 有意 ssm架構 user 為什麽要指定代碼規範? 1.項目結構混亂 2.代碼不規範,冗余,無從下手 導致 : 功能維護 的難度加大 >> 浪費時間去閱讀源碼 >> 爛代碼裏面

分針網——每日分享：10個程序員常用的代碼簡寫技術

代碼簡寫 加入職業技能圈 q群：272292492 更多文章：www.f-z.cn 今天小編我給大家整理了一份10個程序員常用的代碼簡寫技術，看懂一種是入門，全懂就是大神，你能知道幾個呢？

web開發之菜鳥的代碼規範

好的編碼 ray function 指定 參數說明 原則 特殊 第一個 約定 筆者菜鳥裏最不會飛的那個,所以這些基礎的習慣都沒養成，正好抽時間特意做個筆記以方便自己規範代碼, 有興趣的大佬多多指點. 養成好的編碼習慣收益良多, 總結下編碼時應註意的細節《借鑒高程裏代碼約束》

C#項目代碼規範

內聯 www 一份 import ext ret unit 返回值 會員積分 .Net 項目代碼風格要求 PDF版下載：項目代碼風格要求V1.0.pdf 代碼風格沒有正確與否，重要的是整齊劃一，這是我擬的一份《.Net 項目代碼風格要求》，供大家參考。 1. C#

Django Web項目代碼規範參考

code leg blob guid htm archive .cn .html html Python：PEP8+GoogleStyle+DjangoSytlePEP8中文版：http://www.cnblogs.com/huazi/archive/2012/11/28/

Jumpserver代碼規範

property 代碼 readme 最新 變量 添加 osi 詳細介紹 timeline Jumpserver 項目規範（Draft） 語言框架 Python 3.6.1 (當前最新) Django 1.11 (當前最新) Flask 0.12 Luna

代碼規範

作用 ron 語句 操作 vc++ ctrl 刪除 spa else 代碼規範有七大原則 1.空行　　空行起著分割隔程序段落的作用 定義變量後要空行，盡可能的在定義變量的同時初始化該變量，即遵循就近原則 每個函數定義結束後都要加空行 兩個相對獨立的程序塊，變量說明之後必須

Hibernate事務代碼規範寫法

原子性 更新 自動生成 key mage 數據庫方言 limit this 關鍵字 ----------------siwuxie095 事務相關概念 1、什麽是事務 邏輯上的一組操作，構成這組操作的各個單元，

javascript代碼規範和性能整理

asc javascrip ognl nginx c++ 5% spa 代碼 ogg struts2%E4%B9%8Bognl%E8%A1%A8%E8%BE%BE%E5%BC%8F%E5%92%8C%E5%80%BC%E6%A0%88 pythonspark???????

這篇文章不錯——代碼規範

don 大量 回顧 衡量 再次 人員 其他 發生 明顯 該文章來自於阿裏巴巴技術協會（ATA）精選文章。 個人經歷 對我代碼質量影響最大的是在一家外資企業，在這家公司我覺得有以下幾個方面做的很不錯。 團隊編碼風格統一 統一到什麽程度? 不看代碼作者，你很難區分代碼是誰寫

html代碼規範

html中 add 問題 width guid 當我 內部 cells eight HTML代碼規範 　 我們知道，前端工程師入門容易，通過學習基本的HTML和CSS就能在瀏覽器上看到實際的效果，可是要寫好的HTML，就不是那麽容易了。這裏將和大家分享HTML規範，希望大

解讀阿裏官方代碼規範

JavaScript代碼規範及其他註意事項

數字 bsp 使用 代碼規範 添加 註意 script 註意事項 方式 　　　　　　代碼執行一般自上而下，變量需要在使用的函數段之前進行聲明並賦予初值。 代碼規範書寫： 　　　　　　1.選中代碼段後使用Tab鍵，可令代碼段整體向右移動一段位置（一般是4位），善用Tab鍵可使

作業20170928—1代碼規範，結對要求

初步 最終 空行 分行 問題 其中 填充 部分 空格 要求1 《代碼規範》包括10項條款。制定條款的目的是在程序設計的過程中(觸犯和)約束代碼風格，希望切實可行，容易觀察和客觀檢驗。 比如， 每個函數不超過5行，對於初學者是不切實際的; 大括號匹配縱列對齊，是切實可行的;

軟件工程第四周作業代碼規範

符號 expr sca 小寫 表達 類型 tab mil 我們 一.縮進與對齊: 1)大括號匹配縱列對齊。 2)對於縮進，除了編譯器提供的符號縮進之外，我們可以自己給自己一個規範(請少用或者不用 Tab)，比如每一塊代碼相較上一個代碼塊有 4 個空格的縮進。 二.函數長度

2017年軟件工程第四次作業-1代碼規範

不同 都沒有 ucid word -1 代碼量 目的 tex studio one 結對同學：黃澤宇 地址：http://www.cnblogs.com/ddzchild/p/7635239.html two 要求1 《代碼規範》包括10項條款。制定條款的目的是在程序設計的

軟件工程第四次作業——代碼規範

兩個人 擴展 情況下 ++ 軟件 代碼註釋 編譯 swe 次數 作業要求：https://edu.cnblogs.com/campus/nenu/SWE2017FALL/homework/993 代碼規範文檔： 結對夥伴：田繼平 一、代碼規範原因： 代碼是程序

軟件工程----代碼規範

觀察 內容 變量 檔案 函數名 calc 開發程序 順序 初學 結對同學：王航 http://www.cnblogs.com/wangh013/ 要求1 《代碼規範》包括10項條款。制定條款的目的是在程序設計的過程中(觸犯和)約束代碼風格，希望切實可行，容易觀察和客觀檢

軟件工程第四次作業-1代碼規範

下劃線 多功能 是否 技術分享 說明 困難 image 變量命名 ase 結對同學：姜珊 排版規範 1.在兩個以上的關鍵字、變量、常量進行對等操作時，它們之間的操作符之前、之後或者前後要加空格；進行非對等操作時，如果是關系密切的立即操作符（如－>），後不應加空格，

第四次作業之代碼規範

釋放 初始化 進行 過程 函數名 實現 在底部 查找 合成 這次作業，由我和李圓圓同學共同完成，結合老師的要求和對資料的查閱，對程序實施有效的約束，讓其方便觀察。 要求1 《代碼規範》包括10項條款。制定條款的目的是在程序設計的過程中(觸犯和)約束代碼風格，希望切實可