天天看點

Android程式設計規範不完全指南

命名規則

1). 類名,接口名:

以大寫開頭,如果一個類的類名由多個單詞組成,所有單詞的首字母必須大寫,單詞盡量寫全稱,不要簡寫,除非約定俗成的名字,例如:url,rtmp,rtsp 這些廣泛使用的專有名詞,可以全部大寫,也可以首字母大寫。

例如 httprequest,courseactivity

2). 局部變量,類的成員變量,類的成員函數,函數參數:

以小寫字母開頭其他的單詞首字母大寫,變量名不建議使用下劃線分隔單詞,建議使用駝峰命名法,android的系統類都采用此方法。

例如 tostring()  oncreateview(bundle savedinstancestate)

3). 靜态常量:全部大寫,單詞之間使用下劃線分開,常量單詞全部大寫,是以單詞之間使用下劃線分隔。

例如 what_empty_content

4). 控件變量的命名,控件的id命名:

建議:xml布局檔案中的控件的id的命名與*.java的代碼檔案中的控件對象的命名一緻。

class  myactivity extends activity{ 

textview  txtusername  ; 

… 

protected void oncreate(bundle savedinstancestate) { 

  txtusername =  (textview) findviewbyid(r.id.txtusername); 

5). 常用控件以及類對象命名的規範說明(紅色部分為建議的字首或者字尾):

類名

變量名

textview

txtdescription

progressbar

progressdescription

button

btndescription

seekbar

seekbardescription

imagebutton

imgbtndescription

videoview

vvdescription

imageview

imgdescription

spinner

spindescription

radiobutton

rbdescription

webview

webviewdescription

edittext

editdescription

listview

listviewdescription

scrollview

scrolldescription

gridview

griddescription

handler

descriptionhandler

ratingbar

ratingbardescription

pulltorefreshlistview

pullrefreshviewdescription

adapter

descriptionadapter

fragment

descriptionfragment

activity

descriptionactivity

list<t>

descriptionlist

map<>

mapdescription

<a target="_blank" href="http://www.codeceo.com/article/android-slidingmenu-2.html">slidingmenu</a>

slidmenudescription

viewpager

viewpagerdescription

checkbox

chboxdescription

view

viewdescription

radiogroup

rgdescription

expandablelistview

expdescription

framelayout

framelaydescription

sharedpreferences

spdescription

linearlayout

linelaydescription

relativelayout

relativelaydescription

startactivityforresult(requestcode)

request_code_description

msg.what

what_description

6). 資源命名:

layout資源檔案的命名(全部小寫,下劃線分隔):

activity的資源檔案:activity_description1_description2.xml

fragment的資源檔案:fragment_description1_description2.xml

listview清單項的資源檔案:list_item_description1_description2.xml

可複用(被include)的元件資源檔案: control_description1_description2.xml

drawable資源: controlname_description1_description2_selector.xml

controlname表示該資源要用在什麼類型的控件上面,例如如果是按鈕的圖檔切換則

應該這麼定義 button_bg_sendmessage_selector.xml

selector表示該資源的形式,例如還有shape等

圖檔資源的名字:同上

顔色值的命名:  color_description  以color為字首,全部小寫,下劃線分隔。description既可以是該顔色值使用的功能描述,也可以是該顔色值的英文描述,也可以是具體的顔色值,例如:

&lt;color name="color_white"&gt;#ffffff&lt;/color&gt; 

&lt;color name="color_grey_ccc"&gt;#cccccc&lt;/color&gt; 

&lt;color name="color_grey_ddd"&gt;#dddddd&lt;/color&gt; 

因為grey可能有很多等級,有時候需要不同等級的灰色,沒有那麼多英文名可以區分,是以名字中可以直接使用顔色值

&lt;color name=”color_button_pressed”&gt;#4c4c4c&lt;/color&gt; 根據功能定義description,表示該顔色用于按鈕被按下

注:不允許出現毫無意義的命名,例如textview1,textview2 

關于字面常量

代碼中不允許出現直接寫死的字面常量,如果是控件上面顯示的文本,必須放在strings.xml資源檔案中。

如果是代碼中用到常量字元串,必須定義成 public static final

string類型的常量值,在代碼中使用該定義的常量值。這樣做的好處是以後需要修改該常量值,隻需要修改一個地方。如果是寫死在代碼中則要修改所有使

用它的地方,而且拷貝容易出錯。在activity之間傳遞參數的時候,intent.putextra

的key值也要命名規範,并且統一定義為靜态常量,不能直接寫死在代碼中,否則想要修改的時候很麻煩。某一個activity在被啟動的時候需要接受參

數,那麼這些參數的key定義就應該放在該activity中。

json解析

android中調用服務端的接口一般傳回的是json資料,在解析json的時候,無論是使用原始的手工解析方式,還是使用javabean的解

析方式,解析出來的結果在使用的時候必須都進行判空處理。不允許因為服務端的json出問題,導緻app在解析json的時候出現崩潰。

類成員初始化

所有類的成員變量一定要賦初始值,不允許隻定義,不指派。

int類型常量

函數傳回的時候,如果傳回的int類型的資料并不是真實的實用的資料值(例如表示高度,寬度,大小等值),僅僅表示函數執行成功、失敗、異常的狀态值,并且這些值是有限的幾個值,必須要将這些值使用靜态常量描述,或者使用枚舉,例如:

int  getjsonstring() 

public static final int result_parse_json_exception = -1; 

public static final int result_success = 0; 

public static final int result_network_exception = 1; 

public static final int result_no_data = 2; 

使用這些符号常量值代替字面值的好處是,符号常量值是由大寫的英文單詞組成,是有意義的,可以幫助程式員更好的了解函數傳回值的意義,而且符号常量值對應的具體的指派在後期是很友善修改的。

activity接受參數與子產品化

如果一個activity可能在多個地方被打開,或者一個fragment可能在多個地方被用到。那麼在設計該activity和fragment 的時候一定要考慮低耦合,對外提供統一的參數接口,啟

動activity的過程封裝在該activity類的靜态成員方法裡面,類似如下: 

class myactivity extends activity{ 

... 

public static void startactivity(context context,params param){ 

  intent intent = new intent(context, myactivity.class);  

  intent.putextra("param", param); 

  startactivity(intent); 

public static void startactivityforresult(context context,params param){ 

  startactivityforresult(intent,request_code); 

參數的傳遞最好是封裝在一個model實體類中,避免使用map這種方式進行參數傳遞。建議該實體類實作為對應的activity的靜态可序列化的内部類。

androidstudio工程目錄組織

androidstudio中的項目的包結構應該根據工程各個部分的功能來組織。

handler的封裝

每一個activity裡面幾乎都會定義一個handler内部類,但是很多activity裡面的handler都使用了重複的消息類型,這裡面

是有備援代碼的,是以應該把這些activity都使用到的handler類的消息部分,提取成一個公用的handler類。然後在各個activity

裡面使用繼承的方式,來提供該activity特有的handler消息類型的handler類實作。

另外handler發送消息應該使用handler類的成員函數,不應該直接使用<code>handler.obtainmessage(xxx).sendtotarget();</code>這

種原始的發送消息的方式,這樣不利于降低耦合,這種細節應該隐藏在handler内的裡面。handler的消息類型應該定義為handler類裡面的靜

态常量,而該常量不應是public的,對外部不可見。也就是說使用handler對象發送消息的細節不應該暴露給外部。

list的資料更新

封裝listview的資料更新,在handlermessage中更新資料,避免出現 java.lang.illegalstateexception 問題

activity與fragment之間傳遞參數

activity與fragment的資料傳遞采用interface的方式,這樣可以降低耦合,有利于fragment的複用:

Android程式設計規範不完全指南

網絡請求資料子產品化

一般在activity中我們通過網絡請求服務端的接口獲得資料,這個過程一般是在一個線程中做的,擷取到資料之後,再通過activity中的

handler發送消息來通知activity更新資料。該負責擷取資料的線程類,我們一般都實作為一個activity的内部類,該類可以直接通路

activity的成員變量,例如handler,資料清單對象等。但是這樣不利于該資料擷取線程的複用。如果另一個activity裡面也需要擷取相同

的資料,那麼這個功能是不能複用的,是以這個負責資料請求的線程類,不應該與具體的handler和activity聯系過于緊密。應該定義為一個靜态

類,handler應該作為參數傳遞進來,而不是直接通路外部類的成員變量。

封裝log功能

log功能應該封裝成為自動将目前所在類的類名變成log輸出的tag參數,釋出的app最好是能循環寫日志檔案到系統存儲中,并且日志檔案應該使用反複覆寫的方式重複利用。下面僅僅是一個不完善的例子:

public class mylog { 

  public static final string tag = "myapp "; 

  public static void v(object o,string message) 

  { 

      log.v(tag+o.getclass().getsimplename(),message); 

  } 

使用

mylog.v(this,"hello log"); 

列印結果

v/myapp mainactivity﹕ hello log 

版本控制

使用自動化版本管理,自動生成版本号,使應用程式的版本與版本庫上保持一緻。使用hg替換工程目錄下的app目錄下的build.gradle檔案

即可,如果manifest裡面也有版本号的設定,androidstudio還是以build.gradle為準。不應該在每次釋出的時候,在

androidstudio的工程設定裡面手工修改版本号。

為程式添加全局異常捕獲

應該為app添加全局異常捕獲,app中總會有一些我們未捕獲的異常,一旦使用者使用過程中遇到這樣的異常,程式就會崩潰,我們應該檢測該類未捕獲的異常資訊,程式崩潰的時候通過寫檔案日志,或者發送郵件的方式獲得異常資訊,以便解決bug。

來源:51cto