android開發學習筆記系列(6)－－代碼規範

在開發android的時候，我對本身寫的代碼非常不滿，緣由在於本身看到別人的代碼，非常頭痛，緣由很簡單，別人寫的代碼，我就要去猜他的意思，極其煩惱，嗯，就是他沒有遵循代碼規範，所以我在博客園上尋找一篇有關這個方面的博客。本問就是轉載的，固然，我對其進行了一些編排。

提醒：在命名規範的統一下，在加上註釋，這樣往後維護會高效快捷好多。

當前標識符命名法和英文縮寫規則介紹

在講解命名規範前，先初略介紹下當前主要的標識符命名法和英文縮寫規則。

標識符命名法

標識符命名法最要有四種:

1. 駝峯(Camel)命名法:又稱小駝峯命名法，除首單詞外，其他全部單詞的第一個字母大寫。
2. 帕斯卡(pascal)命名法:又稱大駝峯命名法，全部單詞的第一個字母大寫
3. 下劃線命名法:單詞與單詞間用下劃線作間隔。
4. 匈牙利命名法:普遍應用於微軟編程環境中，在以Pascal命名法的變量前附加小寫序列說明該變量的類型。 量的取名方式爲： + + 範圍前綴，類型前綴，限定詞。

我的以爲標識符命名原則:儘量的用最少的字符而又能完整的表達標識符的含義。

英文縮寫原則：

1. 較短的單詞可經過去掉「元音」造成縮寫
2. 較長的單詞可取單詞的頭幾個字母造成縮寫
3. 此外還有一些約定成俗的英文單詞縮寫.

下面爲常見的英文單詞縮寫:

---

英文名	速寫
icon	ic （主要用在app的圖標）
color	cl（主要用於顏色值）
divider	di（主要用於分隔線，不只包括Listview中的divider，還包括普通佈局中的線）
selector	sl（主要用於某一view多種狀態，不只包括Listview中的selector，還包括按鈕的selector）
average	avg
background	Bg（主要用於佈局和子佈局的背景）
buffer	buf
control	ctrl
delete	del
document	doc
error	err
escape	esc
increment	inc
infomation	info
initial	init
image	img
Internationalization	I18N
length	len
library	lib
message	msg
password	pwd
position	pos
server	srv
string	str
temp	tmp
window	wnd(win)

程序中使用單詞縮寫原則：不要用縮寫，除非該縮寫是約定俗成的。

命名規範

包

包（packages）: 採用反域名命名規則，所有使用小寫字母。一級包名爲com，二級包名爲xx（能夠是公司或則我的的隨便），三級包名根據應用進行命名，四級包名爲模塊名或層級名

---

包名	此包中包含
com.xx.應用名稱縮寫.activities	頁面用到的Activity類 (activities層級名用戶界面層)
com.xx.應用名稱縮寫.base	頁面中每一個Activity類共享的能夠寫成一個i額BaseActivity類 (基礎共享的類)
com.xx.應用名稱縮寫.adapter	頁面用到的Adapter類 (適配器的類)
com.xx.應用名稱縮寫.tools	公共工具方法類（tools模塊名）
com.xx.應用名稱縮寫.bean(或則 com.xx.應用名稱縮寫.unity )	元素類
com.xx.應用名稱縮寫.db	數據庫操做類
com.xx.應用名稱縮寫.view(或則 com.xx.應用名稱縮寫.ui )	自定義的View類等
com.xx.應用名稱縮寫.service	Service服務
com.xx.應用名稱縮寫.broadcast	Broadcast服務

類

類（classes）：名詞，採用大駝峯命名法，儘可能避免縮寫，除非該縮寫是衆所周知的， 好比HTML,URL，若是類名稱中包含單詞縮寫，則單詞縮寫的每一個字母均應大寫。

類	描述	例如
activity 類	Aty或者Activity爲後綴標識	Aty或者Activity爲後綴標識
Adapter類	Adp或者Adapte 爲後綴標識	新聞詳情適配器NewtDetailAdp或則直接 NewDetailAdapter
解析類	Hlr爲後綴標識	首頁解析類HomePosterHlr
公共方法類	Tools或Manager爲後綴標識	線程池管理類：ThreadPoolManager 日誌工具類：LogTools
數據庫類	以DBHelper後綴標識	新聞數據庫：NewDBHelper
Service類	以Service爲後綴標識	時間服務TimeService
BroadcastReceive類	以Broadcast爲後綴標識	時間通知TimeBroadcast
ContentProvider	以Provider爲後綴標識
直接寫的共享基礎類	以Base開頭	BaseActivity,BaseFragment

接口

接口（interface）：命名規則與類同樣採用大駝峯命名法，多以able或ible結尾，如interface Runna ble ;interface Accessible 。

方法

方法（methods）：動詞或動名詞，採用小駝峯命名法例如:onCreate(),run()

方法	說明
initXX()	初始化相關方法,使用init爲前綴標識，如初始化佈局initView()
isXX()	checkXX()方法返回值爲boolean型的請使用is或check爲前綴標識
getXX()	返回某個值的方法，使用get爲前綴標識
processXX()	對數據進行處理的方法，儘可能使用process爲前綴標識
displayXX()	彈出提示框和提示信息，使用display爲前綴標識
saveXX()	與保存數據相關的，使用sav爲e前綴標識
resetXX()	對數據重組的，使用reset前綴標識
clearXX()	清除數據相關的
removeXXX()	清除數據相關的
drawXXX()	繪製數據或效果相關的，使用draw前綴標識

變量

變量（variables）採用小駝峯命名法。類中控件名稱必須與xml佈局id保持一致。

用統一的量詞經過在結尾處放置一個量詞，就可建立更加統一的變量，它們更容易理解，也更容易搜索。

例如，請使用strCustomerFirst和strCustomerLast，而不要使用strFirstCustomer和strLastCustomer。

量詞列表	量詞後綴說明
First	一組變量中的第一個
Last	一組變量中的最後一個
Next	一組變量中的下一個變量
Prev	一組變量中的上一個
Cur	一組變量中的當前變量

常量

常量（Constants）所有大寫,採用下劃線命名法.例如：MIN_WIDTH

資源文件

資源文件（圖片drawable文件夾下）：所有小寫，採用下劃線命名法，加前綴區分

命名模式：activity名稱_邏輯名稱/common_邏輯名稱

若是有多種形態如按鈕等除外如btn_xx.xml（selector）

名稱	功能
btn_xx	按鈕圖片使用btn_總體效果（selector）
btn_xx_normal	按鈕圖片使用btn_正常狀況效果
btn_xx_press	按鈕圖片使用btn_點擊時候效果
bg_head	背景圖片使用bg_功能_說明
def_search_cell	默認圖片使用def_功能_說明
icon_more_help	圖標圖片使用icon_功能_說明
seg_list_line	具備分隔特徵的圖片使用seg_功能_說明
sel_ok	選擇圖標使用sel_功能_說明

命名後綴：

後綴	說明
unit	在使用xml的tilemode來配圖片時，element圖片使用此後綴
nor	圖片的狀態，表明普通狀態
hl	圖片的狀態，表明高亮狀態
press	圖片的狀態，表明按下狀態
select	圖片的狀態，表明其所佔的view被選中
unselect	圖片的狀態，表明其所佔的view沒有被選中

資源佈局文件（XML文件（layout佈局文件）

所有小寫，採用下劃線命名法

1)．contentview命名, Activity默認佈局，以去掉後綴的Activity類進行命名。不加後綴：

功能模塊.xml

   例如：main.xml、more.xml、settings.xml

    或則：activity_功能模塊.xml

    例如：activity_main.xml、activity_more.xml

2)．Dialog命名：dialog_描述.xml

例如：dlg_hint.xml

2)．PopupWindow命名：ppw_描述.xml

例如：ppw _info.xml

3). 列表項命名listitem_描述.xml

例如：listitem_city.xml

4)．包含項：include_模塊.xml

例如：include_head.xml、include_bottom.xml

5)．adapter的子佈局：功能模塊_item.xml

例如：main_item.xml、

動畫文件（anim文件夾下）：所有小寫，採用下劃線命名法，加前綴區分。

//前面爲動畫的類型，後面爲方向
動畫命名例子:

規範寫法	備註
fade_in	淡入
fade_out	淡出
push_down_in	從下方推入
push_down_out	從下方推出
push_left	推像左方
slide_in_from_top	從頭部滑動進入
zoom_enter	變形進入
slide_in	滑動進入
shrink_to_middle	中間縮小

資源ID

資源ID（resourcesid）：大小寫規範與方法名一致，採用小駝峯命名法。

命名規範爲「資源控件的縮寫 名」+「變量名」。注意：頁面控件名稱應該和控件id名保持一致

strings.xml，colors.xml等中的id命名：

命名模式：activity名稱_功能模塊名稱_邏輯名稱/activity名稱_邏輯名稱/common_邏輯名稱

strings.xml中，使用activity名稱註釋，將文件內容區分開來

layout中的id命名

命名模式爲：view縮寫_模塊名稱_view的邏輯名稱

view的縮寫詳情以下：

控件	縮寫
LayoutView	lv
RelativeView	rv
TextView	tv
Button	btn
ImageButton	imgBtn
ImageView	mgView 或則 iv
CheckBox	chk
RadioButton	rdoBtn
analogClock	anaClk
DigtalClock	dgtClk
DatePicker	dtPk
EditText	edtTxt
TimePicker	tmPk
toggleButton	tglBtn
ProgressBar	proBar
SeekBar	skBar
AutoCompleteTextView	autoTxt
ZoomControls	zmCtl
VideoView	vdoVi
WdbView	webVi
RantingBar	ratBar
Tab	tab
Spinner	spn
Chronometer	cmt
ScollView	sclVi
TextSwitch	txtSwt
ImageSwitch	imgSwt
listView	lVi 或則lv
ExpandableList	epdLt
MapView	mapVi

activity中的view變量命名

命名模式爲：邏輯名稱+view縮寫

建議：若是layout文件很複雜，建議將layout分紅多個模塊，每一個模塊定義一個moduleViewHolder，其成員變量包含所屬view

styles.xml

將layout中不斷重現的style提煉出通用的style通用組件，放到styles.xml中；

使用layer-list和selector

Android編碼規範建議

1.java代碼中不出現中文，最多註釋中能夠出現中文

2.局部變量命名、靜態成員變量命名

只能包含字母，單詞首字母除第一個外，都爲大寫，其餘字母都爲小寫

3.常量命名

只能包含字母和_，字母所有大寫，單詞之間用_隔開

4.圖片儘可能分拆成多個可重用的圖片

5.服務端能夠實現的，就不要放在客戶端

6.引用第三方庫要慎重，避免應用大容量的第三方庫，致使客戶端包很是大

7.處理應用全局異常和錯誤，將錯誤以郵件的形式發送給服務端

8.圖片的.9處理

9.使用靜態變量方式實現界面間共享要慎重

10.Log(系統名稱模塊名稱接口名稱，詳細描述)

11.單元測試（邏輯測試、界面測試）

12.不要重用父類的handler，對應一個類的handler也不該該讓其子類用到，不然會致使message.what衝突

13.activity中在一個View.OnClickListener中處理全部的邏輯

14.strings.xml中使用%1$s實現字符串的通配

15.若是多個Activity中包含共同的UI處理，那麼能夠提煉一個CommonActivity，把通用部分叫由它來處理，其餘activity只要繼承它便可

16.使用button+activitgroup實現tab效果時，使用Button.setSelected(true)，確保按鈕處於選擇狀態，並使activitygroup的當前activity與該button對應

17.若是所開發的爲通用組件，爲避免衝突，將drawable/layout/menu/values目錄下的文件名增長前綴

18.數據必定要效驗，例如

字符型轉數字型，若是轉換失敗必定要有缺省值；

服務端響應數據是否有效判斷