java編程命名規範
面向對象命名規範:
一、包名的書寫規範(Package)
推薦使用公司或機構的頂級域名為包名的前綴,目的是保證各公司/機構內所使用的包名的唯一性。包名全部為小寫字母,且具有實際的區分意義
1.1 一般要求
1、選擇有意義的名字,能快速地傳達該類的用途。
2、所有包的命名必須采用小寫英文字母。
1.2 實際應用
應用系統中經常應用分層,Dao層(數據庫訪問)、Service層(業務處理)、Web層(頁面控制action類)。
1、包名的前幾個為固定名稱, 如果是網站的話,采用網站的域名的反寫,如果域名還沒有確定的話,采用公司固定的幾個名稱。如:net.vschool
2、在包名的接下來一個單詞為模塊的名稱。如:用戶模塊,包名為net.vschool.user
3、關於模塊的訪問操作,采用分層形式,一般分為:
Dao層操作:一般定義在net.vschool.xxx.dao中,其中xxx為模塊名稱。
Service層操作:一般定義在net.vschool.xxx.servie中。
web層操作:一般定義在net.vschool.xxx.action中。
1.3 如下關於用戶模塊的例子:
net.vschool.user
net.vschool.user.dao
net.vschool.user.action
net.vschool.user.service
二、不同層級對象命名方式:
A) Service / DAO 層方法命名規約
1 ) 獲取單個對象的方法用 get 做前綴。
2 ) 獲取多個對象的方法用 list 做前綴。
3 ) 獲取統計值的方法用 count 做前綴。
4 ) 插入的方法用 save( 推薦 ) 或 insert 做前綴。
5 ) 刪除的方法用 remove( 推薦 ) 或 delete 做前綴。
6 ) 修改的方法用 update 做前綴。
B) 領域模型命名規約
1 ) 數據對象: xxxDO , xxx 即為數據表名。DO(Domain Object):領域對象,就是從現實世界中抽象出來的有形或無形的業務實體。
2 ) 數據傳輸對象: xxxDTO , xxx 為業務領域相關的名稱。 DTO(Data Transfer Object):數據傳輸對象,這個概念來源於J2EE的設計模式,原來的目的是為了EJB的分布式應用提供粗粒度的數據實體,以減少分布式調用的次數,從而提高分布式調用的性能和降低網絡負載,但在這裏,我泛指用於展示層與服務層之間的數據傳輸對象。
3 ) 展示對象: xxxVO , xxx 一般為網頁名稱。VO(View Object):視圖對象,用於展示層,它的作用是把某個指定頁面(或組件)的所有數據封裝起來。
java編程命名規範