2013-12-15 21 views
0

我正在開發一個帶有Google App Engine(Java),Google Cloud Endpoints和Objectify的RESTful API。我以下面的方式組織了我的項目。資源,服務,Dao - Namming約定

我只是按名稱調用模型類。

MyModel.java 

然後我有三個類來處理每個模型。

  1. 一種用於處理API調用
  2. 一種用於處理業務邏輯
  3. 一類用於處理持久性和數據庫檢索

有人問課前,即使我班使用Objectify,一個ORM庫,因爲我正在使用事務,所以仍然有足夠的代碼,因此它的價值是它自己的類。

這些類的命名如下,並附有相關的後綴。

MyModelResource.java 
MyModelService.java 
MyModelDao.java 

我的問題是,與命名約定這樣的架構,例如後面添加內聯?

自從我使用Google Cloud Endpoints以來,我也考慮了以下內容。

MyModelEndpoint.java 
MyModelService.java 
MyModelDao.java 

我知道這對任何邏輯都不重要,但命名對我很重要。 這裏有什麼標準?什麼是公約?

回答

1

java代碼conventions表示類名稱應該儘可能簡潔而不縮寫,儘可能具體。我從這裏得到的是,你在那裏有很好的內聯。如果你想要更精確一點,你可能會改變服務,以更具體的東西,並可能寫出非道格式的道。

1

這裏有幾點:

  • 雖然有命名約定,我認爲你已經拿出不指定類代表什麼,在很大程度上的人。
  • 我還將重點放在適當命名的java包名稱中,以便隨着代碼庫變大,有一種邏輯的方式來導航包。換句話說,您的軟件包名稱應該能夠很好地理解可能存在哪些類。
  • 用適當的代碼註釋和單元測試增加上述2點,你應該全部設置。