Java常見開發規範，java規範

Java常見開發規範，java規範
1 背景概述

作為程式員大軍中的一員，筆者工作於瀋陽數通暢聯軟體技術有限公司。在任職工作的第一天就聽領導強調開發規範的重要性，但是筆者心裡還想為什麼開發規範是最重要的，難道是不應該是實現功能就萬事大吉了？

隨著時間的推移，筆者也經曆了幾個軟體項目，越來越意識到開發規範的重要。今天筆者將自己的所聽、所學以及個人的總結匯總出來與大家分享，希望可以為大家提供協助。

2 目的意義

在團隊協作開發的情況下，一套鮮明的編程風格,可以讓共同作業者、後繼者和自己一目瞭然，在很短的時間內看清程式的結構，理解設計的思路。提高代碼的可讀性、可重用性、程式健壯性、可移植性和可維護性。制定開發規範的目的是為了提高軟體開發效率及所開發的軟體的可維護性，提高軟體的品質。通過開發規範的約束提升自身的邏輯思維能力，也側面的提升個人編碼能力及水平。

3 開發規範

作為軟體項目的開發人員而言，對於功能代碼，首要的要求是代碼必須正確的，能夠保證功能是可啟動並執行，並且能夠滿足客戶的需求。第二個的要求是代碼必須清晰易懂，方便於其他的程式員能夠容易理解代碼的原理，增強代碼的可讀性，保證代碼統一一致的編程風格。下面我們通過格式、命名、許可權、效能等幾個方面來明確開發規範。

3.1 統一格式

• 整體風格

• 方法定義

• 嵌套關係

3.2 命名規範

• 包名定義

模型(model)層操作：一般定義在com.agileai.wm.user.module.service中，其中user為模組名稱。

控制器(controller)層操作：一般定義在com.agileai.wm.user.module.handler中。

視圖(view)層操作：一般定義在檔案路徑與對應的報名保持一致中。

• 類名定義

模型(model)層操作：一般定義為，介面類：ForumProvider.java   介面實作類別：ForumProviderImpl.java。

控制器(controller)層操作：一般定義為XXXHandler，如：ForumPostLocatorHandler。

視圖(view)層操作：一般定義為：XXX.jsp，如：ForumUserEdit.jsp。

• 方法命名

• 變數命名

3.3 許可權定義4 代碼封裝

作為物件導向的語言-JAVA，其三大基本特徵就是封裝、繼承以及多態。其中封裝是繼承與多態的基礎。通過封裝不僅可以使代碼邏輯更加清晰，同時也可以實現最小調整達到全域調整的目的。通過程式的代碼的封裝也可以提升複用率減少代碼的冗餘程度。下面我們介紹常見的需要封裝的幾種情境如：本類複用、多類調用等。

4.1 本類複用4.2 多類調用4.3 代碼重構5 優勢說明5.1 降低成本

• 好的開發規範可以儘可能的減少一個軟體的維護成本，雖然在開發過程中要符合開發規範的條條框框看似浪費時間，但是從長遠的軟體代碼維護來看更清晰的代碼邏輯更節省交接以及維護是時間。降低了項目/產品的維護成本。
• 好的開發規範可以增強軟體代碼的可讀性，良好的編程規範可以實現代碼的自注釋，可以讓產品/項目的後續開發人員直觀明確的瞭解代碼的邏輯，較大幅度的降低了因代碼邏輯混亂造成的工作交接困難，進一步影響了整個項目/產品的開發（營運）周期。通過周期的縮短減少人力的投入降低項目/產品的人員成本。

5.2 提高效率

好的開發規範可以最大限度的提高團隊開發的效率；良好的開發規範可以保證代碼風格的統一，保證整個項目/產品的開發風格是一致的，即使人員變更維護或者進行排錯推斷也可以減少因編程風格不統一造成的時間浪費。

5.3 能力提升

長期的規範性編碼還可以促使開發人員養成良好的編程習慣，通過代碼的邏輯性也可體現出開發人員的邏輯思維，不斷提升自己的開發的規範性也可以從側面提升個人邏輯思維能力。

6 個人總結

筆者作為數通暢聯軟體技術有限公司中的一名技術人員，從開始參加工作個人對公司強行要求開發規範的不理解至今深度認知開發規範的重要性。筆者在數通暢聯這個大家庭中，每天耳濡目染學習java常見的開發規範如：命名、許可權、格式等。通過自身的調整以及認知的提升也逐步提升了個人的編碼能力。

筆者認為一個良好的編碼習慣不僅體現出個人的能力水平，也體現出其所在環境，所在團隊的整體風氣。希望大家今後都可以培養自己的編碼習慣使開發規範中的硬性要求成為自己的下意識習慣。