Android教程網
  1. 首頁
  2. Android 技術
  3. Android 手機
  4. Android 系統教程
  5. Android 游戲
 Android教程網 >> Android技術 >> 關於Android編程 >> Android編碼規范

Android編碼規范

編輯:關於Android編程

介紹

1.為什麼需要編碼規范?

編碼規范對於程序員而言尤為重要,有以下幾個原因:

l 一個軟件的生命周期中,80%的花費在於維護

l 幾乎沒有任何一個軟件,在其整個生命周期中,均由最初的開發人員來維護

l 編碼規范可以改善軟件的可讀性,可以讓程序員盡快而徹底地理解新的代碼

l 如果你將源碼作為產品發布,就需要確任它是否被很好的打包並且清晰無誤,一如你已構建的其它任何產品

 

命名

2.包命名

命名規則:一個唯一包名的前綴總是全部小寫的ASCII 字母並且是一個頂級域名,通常是com,edu,gov,mil,net,org。包名的後續部分根據不同機構各自內部的命名規范而不盡相同。這類命名規范可能以特定目錄名的組成來區分部門 (department) ,項目(project),機器(machine),或注冊名(login names)。

例如: com.yisinian.icampus.activities

 

規約:包命名必須以com.yisinian開始,後面跟有項目名稱(或者縮寫),再後面為模塊名或層級名稱。

如:com.yisinian.項目縮寫.模塊名 à com.yisinian.icampus.bookmark

如:com.yisinian.項目縮寫.層級名 à com.yisinian.icampus.contacts

(之下可建立子包來分類)

 

3.類和接口 命名

命名規則:類名是個一名詞,采用大小寫混合的方式,每個單詞的首字母大寫。盡量使你的類名簡潔而富於描述。使用完整單詞,避免縮寫詞(除非該縮寫詞被更廣泛使用,像 URL,HTML)

接口一般要使用interface、observer 等後綴,或者I作前綴

例如: class SearchInterface; class ISearch;

 

規約:類名必須使用駝峰規則,即首字母必須大寫,如果為詞組,則每個單詞的首字母也必須要大寫,類名必須使用名詞,或名詞詞組。要求類名簡單,不允許出現無意義的單詞。

如:class BookMarkAdd à 正確

如:class AddBookReadPlanActivity à 也可以

4.方法的命名

命名規則:方法名是一個動詞,采用大小寫混合的方式,第一個單詞的首字母小寫,其後單詞的首字母大寫。

例如: public void run(); public StringgetBookName();

 

類中常用方法的命名:

1.類的獲取方法(一般具有返回值)一般要求在被訪問的字段名前加上get,如

getFirstName(),getLastName()。一般來說,get前綴方法返回的是單個值,find前綴的方法返回的是列表值。

2.類的設置方法(一般返回類型為void):被訪問字段名的前面加上前綴 set,如

setFirstName(),setLastName().

3.類的布爾型的判斷方法一般要求方法名使用單詞 is或has 做前綴,如isPersistent(),isString()。或者使用具有邏輯意義的單詞,例如equal 或equals。

4.類的普通方法一般采用完整的英文描述說明成員方法功能,第一個單詞盡可能采用動詞,首字母小寫,如openFile(),addCount()。

5.構造方法應該用遞增的方式寫。(參數多的寫在後面)。

6.toString()方法:一般情況下,每個類都應該定義toString(),其格式為:

 

5.變量命名(最大類成員變量前加m)

命名規則:第一個單詞的首字母小寫,其後單詞的首字母大寫。變量名不應以下劃線或美元符號開頭,盡管這在語法上是允許的。變量名應簡短且富於描述。變量名的選用應該易於記憶,即,能夠指出其用途。盡量避免單個字符的變量名,除非是一次性的臨時變量。臨時變量通常被取名為 i,j,k,m 和 n,它們一般用於整型;c,d,e,它們一般用於字符型。

例如:String bookName;

 

規約:變量命名也必須使用駝峰規則,但是首字母必須小寫,變量名盡可能的使用名詞或名詞詞組。同樣要求簡單易懂,不允許出現無意義的單詞

如:String bookName; à 正確

如:String bookNameString; à錯誤!

 

6.成員變量命名

同變量命名,一般在私有變量前添加m字樣!

7.常量命名

命名規則:類常量的聲明,應該全部大寫,單詞間用下劃線隔開。

例如:staticfinal int MIN_WIDTH = 4; (final類不能被繼承)

例如:staticfinal int MAX_WIDTH = 999;

例如:staticfinal int GET_THE_CPU = 1;

8.異常命名

自定義異常的命名必須以Exception為結尾。已明確標示為一個異常。

9.layout 命名

規約:layout xml 的命名必須以 全部單詞小寫,單詞間以下劃線分割,並且使用名詞或名詞詞組,即使用 模塊名_功能名稱 來命名。

如:knowledge_gained_main.xmlà正確

如:list_book.xmlà錯誤!

10.id 命名

規約:layout 中所使用的id必須以全部單詞小寫,單詞間以下劃線分割,並且使用名詞或名詞詞組,並且要求能夠通過id直接理解當前組件要實現的功能。

如:某TextView @+id/textbookname à錯誤 !應為@+id/book_name_text

如:某EditText @+id/textbookname à錯誤 !應為 @+id/book_name_edit

 

11.資源命名

規約:layout中所使用的所有資源(如drawable,style等)命名必須以全部單詞小寫,單詞間以下劃線分割,並且盡可能的使用名詞或名詞組,即使用 模塊名_用途 來命名。如果為公共資源,如分割線等,則直接用用途來命名

如:menu_icon_navigate.png à 正確

如:某分割線:line.png 或 separator.png à正確

 

注釋

Java 程序有兩類注釋:實現注釋(implementationcomments)和文檔注釋(document comments)。實現注釋是使用/*...*/和//界定的注釋。文檔注釋(被稱為"doc comments")由/**...*/界定。文檔注釋可以通過javadoc 工具轉換成HTML 文件。

 

1.文件注釋

所有的源文件都應該在開頭有一個注釋,其中列出類名、版本信息、日期和版權聲明。

如下:

/*

* 文件名

* 包含類名列表

* 版本信息,版本號

* 創建日期。

* 版權聲明

*/

2.類注釋

每一個類都要包含如下格式的注釋,以說明當前類的功能等。

 

/**

* 類名

* @author作者

* 實現的主要功能。

* 創建日期

* 修改者,修改日期,修改內容。

*/

 

3.方法注釋

每一個方法都要包含 如下格式的注釋 包括當前方法的用途,當前方法參數的含義,當前方法返回值的內容和拋出異常的列表。

 

/**

*

* 方法的一句話概述

*

方法詳述(簡單方法可不必詳述)

 

* @param s 說明參數含義

* @return 說明返回值含義

* @throws IOException 說明發生此異常的條件

* @throws NullPointerException 說明發生此異常的條件

*/

 

4.類成員變量和常量注釋

成員變量和常量需要使用java doc形式的注釋,以說明當前變量或常量的含義

/**

*XXXX含義

*/

 

5.其他注釋

方法內部的注釋 如果需要多行 使用/*…… */形式,如果為單行是用//……形式的注釋。不要再方法內部使用 java doc 形式的注釋“/**……**/”,簡單的區分方法是,java doc形式的注釋在 eclipse中為藍色,普通注釋為綠色。

6.XML注釋

規約:如果當前layout 或資源需要被多處調用,或為公共使用的layout(若list_item),則需要在xml寫明注釋。要求注釋清晰易懂。

代碼風格

1.縮進

規約:可以使用Tab進行縮進,或使用空格進行縮進,推薦縮進為2空格。

2.空行

空行將邏輯相關的代碼段分隔開,以提高可讀性。

下列情況應該總是使用空行:

l 一個源文件的兩個片段(section)之間

l 類聲明和接口聲明之間

l 兩個方法之間

l 方法內的局部變量和方法的第一條語句之間

l 一個方法內的兩個邏輯段之間,用以提高可讀性

 

規約:通常在 變量聲明區域之後要用空行分隔,常量聲明區域之後要有空行分隔,方法聲明之前要有空行分隔。

3.行寬

無特別規定,因為現在的顯示器都比較大,所以推薦使用120進行設置。

規約

1.方法

l 一個方法盡量不要超過15行,如果方法太長,說明當前方法業務邏輯已經非常復雜,那麼就需要進行方法拆分,保證每個方法只作一件事。

l 不要使用 try catch 處理業務邏輯!!!!

2.參數和返回值

l 一個方法的參數盡可能的不要超過4個!

l 如果一個方法返回的是一個錯誤碼,請使用異常!!

l 盡可能不要使用null, 替代為異常 或者使用空變量 如返回 List 則可以使用Collections.emptyList()

3.神秘的數

代碼中不允許出現單獨的數字,字符!如果需要使用數字或字符,則將它們按照含義封裝為靜態常量!(for語句中除外)

4.控制語句

判斷中如有常量,則應將常量置於判斷式的右側。如:

if ( true == isAdmin())...

盡量不使用三目條件的嵌套。

 

所有if 語句必須用{}包括起來,即便是只有一句:

if (true){

//do something......

}

if (true)

i = 0; //不要使用這種

 

對於循環:

//不推薦方式

while(index < products.getCount()){

//每此都會執行一次getCount()方法,

//若此方法耗時則會影響執行效率

//而且可能帶來同步問題,若有同步需求,請使用同步塊或同步方法

}

//推薦方式

//將操作結構保存在臨時變量裡,減少方法調用次數

final int count =products.getCount();

while(index < count){

}

 

補充:

If語句的嵌套最多兩層。如果有三層及以上,分開寫或者寫成方法。(三層以上時,可以用反邏輯,不滿足rerun《不用break》)

出問題是一般在判斷語句中打log

5.異常的捕捉處理

l 通常的思想是只對錯誤采用異常處理:邏輯和編程錯誤,設置錯誤,被破壞的數據,資源耗盡,等等。

l 通常的法則是系統在正常狀態下以及無重載和硬件失效狀態下,不應產生任何異常。

l 最小化從一個給定的抽象類中導出的異常的個數。對於經常發生的可預計事件不要采用異常。不要使用異常實現控制結構。

l 若有finally 子句,則不要在try 塊中直接返回,亦不要在finally 中直接返回。

 

6.訪問控制

若沒有足夠理由,不要把實例或類變量聲明為公有。通常,實例變量無需顯式的設置(set)和獲取(gotten),通常這作為方法調用的邊緣效應 (side effect)而產生。

一個具有公有實例變量的恰當例子,是類僅作為數據結構,沒有行為。亦即,若你要使用一個結構(struct)而非一個類(如果java 支持結構的話),那麼把類的實例變量聲明為公有是合適的。

7.多打log

在程序中的邏輯部分應多打log。比如

If(TextUtils.isEmpty(name)){

Log.e(TAG, “nameis empty!”);

return false;

}

約定俗成

1.變量賦值

避免在一個語句中給多個變量賦相同的值。它很難讀懂。例如:

fooBar.fChar = barFoo.lchar = 'c';

不要將賦值運算符用在容易與相等關系運算符混淆的地方。例如:

if (c++ = d++) { // AVOID! (Java disallows)

...

}

應該寫成

if ((c++ = d++) != 0) {

...

}

不要使用內嵌(embedded)賦值運算符試圖提高運行時的效率,這是編譯器的工作。例如:

d = (a = b + c) + r; // AVOID!

應該寫成

a = b + c;

d = a + r;

 

2.圓括號

一般而言,在含有多種運算符的表達式中使用圓括號來避免運算符優先級問題,是個好方法。

即使運算符的優先級對你而言可能很清楚,但對其他人未必如此。你不能假設別的程序員和你一樣清楚運算符的優先級。

if (a == b && c ==d) // AVOID!

if ((a == b) && (c ==d)) // RIGHT

 

3.返回值

設法讓你的程序結構符合目的。例如:

if (booleanExpression) {

return true;

} else {

return false;

}

應該代之以如下方法:

return booleanExpression

 

類似地:

if (condition) {

return x;

}

return y;

 

應該寫做:

return (condition ? x : y);

4.條件運算符"?"前的表達式

如果一個包含二元運算符的表達式出現在三元運算符" ? : "的"?"之前,那麼應該給表達式添上一對圓括號。例如:

(x >= 0) ? x : -x

21種代碼的壞味道

應該在編程中盡量避免這21種“壞味道”。

1.Duplicated Code

代碼重復幾乎是最常見的異味了。他也是Refactoring 的主要目標之一。代碼重復往

往來自於copy-and-paste 的編程風格。

2.Long method

它是傳統結構化的“遺毒“。一個方法應當具有自我獨立的意圖,不要把幾個意圖

放在一起。

3.Large Class

大類就是你把太多的責任交給了一個類。這裡的規則是One Class One Responsibility。

4.Divergent Change

一個類裡面的內容變化率不同。某些狀態一個小時變一次,某些則幾個月一年才變一次;某些狀態因為這方面的原因發生變化,而另一些則因為其他方面的原因變一次。面向對象的抽象就是把相對不變的和相對變化相隔離。把問題變化的一方面和另一方面相隔離。這使得這些相對不變的可以重用。問題變化的每個方面都可以單獨重用。這種相異變化的共存使得重用非常困難。

5.Shotgun Surgery

這正好和上面相反。對系統一個地方的改變涉及到其他許多地方的相關改變。這些變化率和變化內容相似的狀態和行為通常應當放在同一個類中。

6.Feature Envy

對象的目的就是封裝狀態以及與這些狀態緊密相關的行為。如果一個類的方法頻繁用get 方法存取其他類的狀態進行計算,那麼你要考慮把行為移到涉及狀態數目最多的那個類。

7.Data Clumps

某些數據通常像孩子一樣成群玩耍:一起出現在很多類的成員變量中,一起出現在許多方法的參數中…..,這些數據或許應該自己獨立形成對象。

8.Primitive Obsession

面向對象的新手通常習慣使用幾個原始類型的數據來表示一個概念。譬如對於范圍,他們會使用兩個數字。對於Money,他們會用一個浮點數來表示。因為你沒有使用對象來表達問題中存在的概念,這使得代碼變的難以理解,解決問題的難度大大增加。好的習慣是擴充語言所能提供原始類型,用小對象來表示范圍、金額、轉化率、郵政編碼等等。

9.Switch Statement

基於常量的開關語句是OO 的大敵,你應當把他變為子類、state 或strategy。

10.Parallel InheritanceHierarchies

並行的繼承層次是shotgun surgery 的特殊情況。因為當你改變一個層次中的某一個類時,你必須同時改變另外一個層次的並行子類。

11.Lazy Class

一個干活不多的類。類的維護需要額外的開銷,如果一個類承擔了太少的責任,應當消除它。

 

12.Speculative Generality

一個類實現了從未用到的功能和通用性。通常這樣的類或方法唯一的用戶是testcase。不要猶豫,刪除它。

13.Temporary Field

一個對象的屬性可能只在某些情況下才有意義。這樣的代碼將難以理解。專門建立一個對象來持有這樣的孤兒屬性,把只和他相關的行為移到該類。最常見的是一個特定的算法需要某些只有該算法才有用的變量。

14.Message Chain

消息鏈發生於當一個客戶向一個對象要求另一個對象,然後客戶又向這另一對象要求另一個對象,再向這另一個對象要求另一個對象,如此如此。這時,你需要隱藏分派。

15.Middle Man

對象的基本特性之一就是封裝,而你經常會通過分派去實現封裝。但是這一步不能走得太遠,如果你發現一個類接口的一大半方法都在做分派,你可能需要移去這個中間人。

16.Inappropriate Intimacy

某些類相互之間太親密,它們花費了太多的時間去磚研別人的私有部分。對人類而言,我們也許不應該太假正經,但我們應當讓自己的類嚴格遵守禁欲主義。

17.Alternative Classes withDifferent Interfaces

做相同事情的方法有不同的函數signature,一致把它們往類層次上移,直至協議一致。

18.Incomplete Library Class

要建立一個好的類庫非常困難。我們大量的程序工作都基於類庫實現。然而,如此廣泛而又相異的目標對庫構建者提出了苛刻的要求。庫構建者也不是萬能的。有時候我們會發現庫類無法實現我們需要的功能。而直接對庫類的修改有非常困難。這時候就需要用各種手段進行Refactoring。

19.Data Class

對象包括狀態和行為。如果一個類只有狀態沒有行為,那麼肯定有什麼地方出問題了。

20.Refused Bequest

超類傳下來很多行為和狀態,而子類只是用了其中的很小一部分。這通常意味著你的類層次有問題。

21.Comments

經常覺得要寫很多注釋表示你的代碼難以理解。如果這種感覺太多,表示你需要Refactoring。

  1. 上一頁:
  2. 下一頁:
熱門文章
閱讀排行版
Copyright © Android教程網 All Rights Reserved