Android架構系列-開發規範

本文介紹了項目裏的各類命名等規範

0 Android架構系列文章

該系列文章會不斷更新Android項目開發中一些好的架構和小技巧

系列一 Android架構系列-基於MVP建立適合本身的架構
系列二 Android架構系列-如何優美的寫Intent
系列三 Android架構系列-開發規範
系列四 Android架構系列-封裝本身的okhttp
系列五 Android架構系列-MVP架構的實際應用

1 目錄規範

• GloabApp 全局application
• RootAct 啓動Activity
• Base 基礎類 BaseActivity BaseFragment Base...
• lib 能夠放置一些非jar module類型的開源代碼
• widget 通用自定義控件類
• util 通用工具類
• xxx(業務模塊)
  • model 數據層。網絡api接口和緩存接口 命名xxxApi xxxCache
  • view 顯示層。（activity fragment adapter）命名 xxxActivity xxxFragment xxxAdapter（也能夠再分一層 activity fragment adapter）
  • present 數據處理層。命名xxxPresent

2 書寫規範

1. 不要將多行代碼寫在一行裏如：if(condition) do_something
2. if / while / for 後面，必定要跟大括號
3. 定義方法時大括號換行，若是是匿名方法，大括號跟方法名一行
4. 不要連續出現2個以上的空行

3 命名規範

注：modulename爲common或者業務模塊xxx

3.1 變量、方法命名

1. 方法命名小駝峯規則如：initView、setData
2. 全局變量命名：mDataList
3. 局部變量命名：dataList
4. 常量命名：PAGE_SIZE
5. 資源變量命名：mBtnLogin

3.2 控件前綴縮寫

控件	前綴縮寫
RelativeLayout	rl
LinearLayout	ll
FrameLayout	fl
TextView	txt
Button	btn
ImageButton	imgBtn
ImageView	img
CheckBox	chb
RadioButton	rdb
DatePicker	dtPk
EditText	edit
TimePicker	tmPk
ProgressBar	proBar
WebView	webVi
ScollView	scrollVi
ListView	lv
GridView	gv
ViewPager	vp

3.3 layout中資源id命名

控件縮寫+描述

如 img_back、txt_name

3.4 layout命名

1. activity
   modulenameactivity描述.xml
2. fragment
   modulenamefragment描述.xml
3. dialog
   modulenamedialog描述.xml
4. 抽取出來複用的xml佈局(include)
   modulenameinclude描述.xml
5. listview item
   modulename_itemlist描述.xml
6. listview header
   modulename_listheader描述.xml
7. listview footer
   modulename_listfooter描述.xml
8. gridview item
   模塊_itemgrid描述.xml
9. widget
   modulenamewidget描述.xml

3.5 資源文件命名

前綴+描述+後綴

前綴即爲類型

1. 圖標 ic
2. 背景 bg
3. 分割線 div
4. 按鈕 btn

後綴是狀態，若是沒有就是普通就沒有

1. 默認圖片 好比加載時的默認頭像背景 default
2. 按下狀態 pressed/unpressed
3. 選中狀態 choosed/unchoosed

3.6 drawable命名

狀態+控件縮寫+描述

狀態，即drawable類型：

1. selector
2. shape等

3.7 string命名

界面+描述
或者common+描述

一般建議把同一個界面的全部string都放到一塊兒

全局的使用common

結尾

更多文章關注個人公衆號

個人公衆號