1.可維護性
代碼的可維護性和可擴展性的第一責任在架構,因為架構要做相關(guān)的分析模型,劃分相關(guān)的單元模塊和接口,考慮組件和復用等各方面的問(wèn)題. 架構設計是高層次的往往只抽象出相關(guān)的類(lèi)和包,對于每一個(gè)類(lèi)中應該設計哪些方法和函數,并如何組織這些方法和子函數的調用關(guān)系,還必須進(jìn)行詳細設計,這是編碼的可維護性和可擴展性的兩個(gè)最基礎的內容.
能夠準確表達代碼實(shí)現意圖的言簡(jiǎn)意駭的注釋是源代碼可讀性的一個(gè)重要內容.好的源代碼應該是可以自解釋的,因此注釋不應該太多也不應該全是些照字面翻譯語(yǔ)句的垃圾注釋.注釋的量一般占代碼總量的10-20%就可以了(如果注釋量超過(guò)30%說(shuō)明垃圾注釋太多,代碼的自解釋性不好很多應該拆分為子函數的沒(méi)有拆分等原因).源代碼文件的文件頭要有注釋說(shuō)明整個(gè)類(lèi)的實(shí)現功能和流程,調用多個(gè)子函數的主方法方法頭要有明確的實(shí)現意圖和調用步驟的注釋(很重要),以方便維護人員和自己閱讀代碼.
方法和變量命名等要嚴格遵守相關(guān)的編碼規范進(jìn)行命名.名稱(chēng)不要怕長(cháng),名稱(chēng)要能夠完全的體現出方法所實(shí)現的功能.如根據某一客戶(hù)編號查詢(xún)其的所有定單,則GetInfo,GetOrderInfo等不是最好的方法名.而應該采用GetOrderInfoByCustomerNo,通過(guò)這種方法名稱(chēng)即使不加任何注釋其它人員也可以很好的閱讀你寫(xiě)的代碼.
一個(gè)類(lèi)文件建立代碼行不易超過(guò)2000行,超過(guò)2000行都應該拆分相關(guān)的擴展類(lèi)或Helper類(lèi).在一個(gè)類(lèi)文件中一個(gè)方法或函數不易超過(guò)50行,超過(guò)50行的可以考慮拆分相關(guān)的子函數.但這個(gè)規則也需要靈活考慮,比如對于一些數據有效性或完整性判斷的函數,超過(guò)50行一般不會(huì )存在任何問(wèn)題.
每個(gè)軟件開(kāi)發(fā)項目開(kāi)發(fā)前都應該定義相關(guān)的編碼約定或規范,該文件包含了命名,縮進(jìn),注釋,布局等各方面的內容,在此就不再做過(guò)多的敘述.
2.可擴展性
編碼可擴展性的源頭是需求的可擴展性,首先需求人員要在需求分析過(guò)程中分析出哪些需求是易變化或會(huì )擴展的需求.只有需求考慮到了可擴展性,架構在設計過(guò)程中才能夠有針對性的進(jìn)行設計,否則只能夠后期對代碼進(jìn)行重構來(lái)實(shí)現源代碼的可擴展性.
可擴展性基于原有的經(jīng)驗積累和他人的最佳實(shí)踐.充分理解面向對象分析和設計的思想和重要的設計模式.設計模式的精髓就是面向接口設計,而這個(gè)也是保持代碼的可擴展性的一個(gè)重要思路.另外在面向結構方法中我們對數據表的字段或方法參數預留一些擴展字段也是常用的支持系統擴展的方法.好的擴展性的判斷準則有
a.設計到需求變更或新需求時(shí)候或是新增類(lèi)文件或是新增方法,而不是對已經(jīng)有的多個(gè)源代碼文件造成影響
b.設計一些簡(jiǎn)單的擴展時(shí)候,可以靈活的通過(guò)配置文件來(lái)實(shí)現而基本不用修改源代碼
我們對需求的理解也是逐漸細化的過(guò)程,因此一開(kāi)始就得到完全健壯的代碼是很難的,通過(guò)需求的不斷細化和需求的變更來(lái)Review我們的代碼實(shí)現,適時(shí)而不斷的對代碼進(jìn)行重構才可能得到健壯和可擴展的代碼.
3.安全性
安全性仍然屬于代碼內在質(zhì)量的一個(gè)內容.但平時(shí)在開(kāi)發(fā)過(guò)程中往往并不會(huì )特別注意代碼的安全性.對于軟件系統的安全性基本可以專(zhuān)門(mén)開(kāi)專(zhuān)題來(lái)討論,在這里僅僅簡(jiǎn)要說(shuō)明一下.
首先是源代碼應該防止被反編譯,相關(guān)的重要數據和數據庫連接串等信息都應該加密進(jìn)行存放.其實(shí)是在分布式應用中要注意數據傳輸的安全性,防止數據被非法獲取.對于暴露的遠程服務(wù)要注意身份認證和識別,防止他人偽造客戶(hù)端進(jìn)行調用.其次整個(gè)系統應該有完善的權限模型,除了最簡(jiǎn)單的業(yè)務(wù)功能權限外,還應該根據需要對系統中相關(guān)的業(yè)務(wù)對象有完善的靜態(tài)權限和動(dòng)態(tài)權限的控制機制.
4.系統的健壯性
系統的健壯性比較重要的一點(diǎn)就是系統對異常的捕獲和處理能力.因此對于一個(gè)軟件系統應該有完善和獨立的異常處理和日志記錄機制.當出現不可預見(jiàn)的錯誤時(shí)候不會(huì )導致整個(gè)軟件系統或操作系統的崩潰.同時(shí)系統還需要記錄足夠的異常和日志信息,以方便后續維護人員對問(wèn)題進(jìn)行跟蹤和分析.
文章來(lái)源于領(lǐng)測軟件測試網(wǎng) http://kjueaiud.com/
