項目組軟件開發(fā)規(guī)范

-.z.工程組軟件開發(fā)行為規(guī)公司所有僅供工程組使用1

概述1.1

編寫目的為了把公司已經(jīng)發(fā)布的軟件開發(fā)過程規(guī)有效地運作于產(chǎn)品開發(fā)活動中，把各種規(guī)“逐步形成工程師的作業(yè)規(guī)〞，特制定本軟件開發(fā)行為規(guī)，以到達提高系統(tǒng)質量的目的。在本規(guī)中，闡述了根本的開發(fā)模式，包括需求驗證、設計、編碼規(guī)、代碼審查、單元測試、配置管理等，并明確開發(fā)過程中的方法、策略、工具以及環(huán)境要求，開發(fā)人員都必須遵守本軟件開發(fā)規(guī)。1.2

讀者對象本規(guī)讀者對象為軟件開發(fā)工程管理者、工程經(jīng)理、測試經(jīng)理、開發(fā)經(jīng)理、開發(fā)組、測試組所有人員2需求評審2.1過程要求按軟件開發(fā)過程經(jīng)歷，問題暴露越早越好。因此，在實施設計和編碼前，需對工程經(jīng)理提供的需求說明文檔進展充分的驗證，在不明確的需求點上，需要和工程經(jīng)理進一步核實，確保對每個需求點有清晰、一致的認識和理解。在需求驗證的過程中，需按以下檢查點進展逐項檢查〔包括不限于〕：所有定義、實現(xiàn)方法是否清楚地表達了用戶的原始要求？是否清楚、明確地描述了所有的功能？是否沒有不能理解或造成誤解的描述？需求定義是否包含了有關功能、性能、限制、目標、質量等方面的所有需求？需否可以驗證〔即是否可以檢驗軟件是否滿足了需求〕？是否有術語定義一覽表？是否標識并定義了在將來可能會變化的需求？各個需求之間是否一致？是否有沖突和矛盾？是否認義了系統(tǒng)所有的輸入、輸出及其來源？主要為柜臺或者其他外部接口，是否明確定義了輸入?yún)?shù)和輸出參數(shù)？是否說明了如何進展系統(tǒng)輸入的合法性檢查？功能性需否覆蓋了所有非正常情況的處理？對異常數(shù)據(jù)產(chǎn)生的結果是否作了準確的描述？是否充分定義了關于人機界面的需求？在不同情況下，是否規(guī)定了系統(tǒng)的響應時間？界面需否使軟硬件系統(tǒng)具有兼容性？是否有對相關日志做明確要求？以滿足稽核相關的需要。針對開發(fā)過程中的需求變更，以上需求驗證點同樣適用，并同時評估需求變更給當前工程的設計和開發(fā)帶來的風險，包括架構、平安、進度等方面，以便工程經(jīng)理進展方案調整和安排。2.2工具及環(huán)境1.在此過程中，使用E*cel對以上檢查點進展跟蹤和標記。記錄文檔需check-in到svn.2.評審完成的需求文檔需check-in到svn。3.任何需求變更文檔需check-in到svn。4.在PM上登記相關問題，并跟蹤其狀態(tài)。3系統(tǒng)設計及評審3.1過程要求概要設計要以軟件需求規(guī)格為根底，必須保證需要實現(xiàn)的需求規(guī)格已經(jīng)被設計。概要設計文檔的需涵蓋以下幾方面：涵蓋系統(tǒng)的總體構造、功能。系統(tǒng)共包含哪些模塊，以及模塊之間的關系。使閱讀者對系統(tǒng)有了全局觀。明確系統(tǒng)使用的外部接口和資源。包括外部柜臺環(huán)境、第三方接口、第三方技術架構等。模塊設計的進一步細化，包括具體的輸入、輸出、處理邏輯、與其他模塊之間的接口等。數(shù)據(jù)構造設計，文檔中明確數(shù)據(jù)的物理構造和邏輯構造，包括數(shù)據(jù)的存儲方式、緩存策略、備份策略、清理策略。容災設計，主要指外部資源或接口不可用時，系統(tǒng)如何處理，包括客戶提示信息、錯誤現(xiàn)場記錄等。監(jiān)控設計，針對系統(tǒng)中的關鍵業(yè)務，特別是對實時性、準確性要求較高的功能，需考慮其監(jiān)控指標、監(jiān)控方法、業(yè)務閥值、告警通知的設計。平安設計，在系統(tǒng)概要設計中，要充分考慮系統(tǒng)平安方面的設計，包括數(shù)據(jù)傳輸、數(shù)據(jù)存儲、網(wǎng)絡攻擊等方面的情況。具體可參見公司的平安開發(fā)規(guī)。其他情況，未在以上提及的工程其他情況，可進展特別說明。同時，在概要設計過程中，需遵循以下原則：當需求規(guī)格發(fā)生變更時，必須修訂相關概要設計文檔。在概要設計文檔，必須記錄、驗證需求和概要設計的跟蹤關系。必須保證概要設計文檔和代碼的一致性。當發(fā)生設計更改時，必須修訂相應設計文檔。概要設計過程完畢前，必須通過評審，并保存評審記錄。設計更改必須經(jīng)過相關評審，并保存評審記錄。在概要設計評審階段，可按以下檢查點進展逐項驗證〔包括但不限于〕：1、是否描述了接口的功能特征"

2、接口是否便于查錯"

3、接口相互之間、和其他模塊、和需求說明書及接口規(guī)格書保持一致？4、對接口的數(shù)量和復雜度進展了有效的平衡，使接口數(shù)量控制在一個較小數(shù)量，每個接口具有可承受的復雜度？5、是否所有的接口都能描述了必要的類型、數(shù)量、質量等信息？6、操作界面是否考慮了用戶〔例如：提供準確、清晰、有用的提示信息〕7、是否模塊化設計？8、模塊遵循高聚、低耦合的原則？9、是否每一局部的設計都可以追溯到需求說明書，接口規(guī)格說明書、或其他產(chǎn)品文檔？10、對所繼承下來的那些特別和不常用的特性對目前設計的影響是否進展了分析？11、需求規(guī)格評審中不完整的需求(TBD)是否都已經(jīng)解決"

12、設計是否考慮了檢錯和恢復措施？〔例如：輸入檢查〕13、是否考慮了異常情況？14、是否完全準確描述了所有的出錯情況？15、設計是否能夠滿足所有系統(tǒng)集成方面的要求？3.3工具及環(huán)境1.概要設計文檔及其評審文檔需check-in到svn中。2.概要設計過程中的問題跟蹤需在PM中記錄。4系統(tǒng)實現(xiàn)4.1過程要求編碼必須以設計文檔為根底，必須保證所有的設計都被編碼實現(xiàn)。當設計發(fā)生變更時，必須修改相關代碼。同時必須保證設計文檔和代碼的一致性。當代碼的修改已經(jīng)造成設計更改時，必須修訂相應設計文檔。在系統(tǒng)實現(xiàn)過程中，需遵循以下規(guī)：遵照各項編碼規(guī)。具體見附錄。所有代碼使用svn進展統(tǒng)一管理，并使用maven做為構建工具，并至少提供開發(fā)、測試、生產(chǎn)三種構建腳本。在系統(tǒng)開場之前，需在svn上創(chuàng)立對應的分支，開發(fā)工作統(tǒng)一在分支上進展。針對開發(fā)任務的分解，需要參照單人單任務在兩天以完成的標準。開發(fā)過程中，單元測試通過的代碼需要及時check-in到svn。代碼進入系統(tǒng)測試前需進展評審，可以是集中評審或者穿插評審的方式。評審容包括根本編碼規(guī)、根本邏輯、日志規(guī)、出錯處理等，具體見附錄中的代碼評審表。單元測試的覆蓋率需在80%以上。具體的單元測試要點如下：對所測模塊的數(shù)據(jù)流進展測試。檢查不正確或不一致的數(shù)據(jù)類型說明、使用尚未附值或尚未初始化的變量、錯誤的初始值或缺省值。設計測試用例查找由于不正確的計算〔包括算法錯、表達式符號表示不正確、運算精度不夠等〕、不正確的比擬或不正常的控制流〔包括不同數(shù)據(jù)類型量的相互比擬、不適當?shù)匦薷牧搜h(huán)變量、錯誤的或不可能的循環(huán)終止條件等〕而導致的錯誤。檢查模塊有沒有對預見錯誤的條件設計比擬完善的錯誤處理功能，保證其邏輯上的正確性。邊界檢查，注意設計數(shù)據(jù)流、控制流中剛好等于、大于或小于確定的比擬值的用例。開發(fā)過程中，需進展持續(xù)化構建，保證check-in的代碼質量?？芍赜玫腢I需check-in至組件庫。工程中引進的新技術需經(jīng)過統(tǒng)一評審。4.2工具及環(huán)境開發(fā)過程中用到的工具包括：代碼管理工具：svn、maven開發(fā)工具：sts、webstorm、a*ure、photoshop等。測試工具：JUnit、JMock、SoapUI、Jmeter等。代碼評審工具：Collaborator自動構建工具：Jenkins應用效勞器：apache、weblogic、tomcat其他第三方框架包括但不限于spring,struts,ibatis,hibernate,bootstrap,jquery,phoneGap,ehcache,vert.*,redis等。5測試5.1過程要求在系統(tǒng)交付給測試組進展測試前，開發(fā)人員需在部進展第一輪功能測試，具體測試方法可參照工程經(jīng)理提供的測試用例。測試過程中需保持測試代碼的準確性和測試環(huán)境的獨立性。具體測試容包含但不限于以下幾方面：1.功能測試。對照需求文檔中的功能點，對系統(tǒng)的功能進展測試驗證，確保系統(tǒng)完全滿足需求文檔中的要求。2.平臺兼容性測試。在不同的瀏覽器、硬件配置環(huán)境下進展測試，主要瀏覽器包括Firefo*,safari,IE,chrome。針對移動端，需涵蓋三個主流操作系統(tǒng)，iOS,

Android和Windows

Mobile。硬件兼容性則包括不同的智能終端，PC,MAC,IPAD等其他機型的不同分辨率下的兼容性測試。3．不同網(wǎng)絡環(huán)境下測試。針對移動端的應用，驗證不同網(wǎng)絡環(huán)境下，終端應用功能與性能方面是否正常(數(shù)據(jù)業(yè)務是否會中斷，業(yè)務模塊是否出現(xiàn)異常)。網(wǎng)絡環(huán)境包含：4G信號，3G信號，2G強信號。4.安裝、卸載測試。針對系統(tǒng)中涉及的控件、第三方插件，或者移動端APP，需進展安裝、卸載的測試。5.2工具及環(huán)境1.測試過程中發(fā)現(xiàn)的問題需統(tǒng)一記錄在PM上，并進展跟蹤。2.測試過程可以使用開源的第三方工具，如Jmeter,Selenium,Robot等工具。6配置管理6.1過程要求開發(fā)過程中的配置管理主要包括兩局