Android項(xiàng)目規(guī)范

Model規(guī)范

命名規(guī)范踪蹬,參考阿里巴巴JAVA規(guī)范

Gson采用注解方式,不需要進(jìn)行混淆配置

public field

equals( ) & hashCode( )

Gson自動(dòng)生成后核對(duì)字段類型,尤其是float或double類型被設(shè)置為int類型

不參與運(yùn)算的數(shù)字類型的仅醇,建議聲明為String類型

id命名規(guī)范

ListView, ViewPager, SwipeRefreshLayout等一般頁(yè)面只有一個(gè)的控件,可以直接命名為listView, viewPager, swipeRefreshLayout

TextView, ImageView, Button等常用的,一個(gè)頁(yè)面一般不止一個(gè)溃论。命名規(guī)范為tv_title, tvName, iv_Icon, iv_banner, bt_commit, bt_back。前綴+功能(討論是否以下劃線形式 tv_title, tv_name)

資源文件命名規(guī)范

Xml文件命名規(guī)范(模塊+類型+頁(yè)面+[功能])

所有文件名加模塊統(tǒng)一前綴痘昌。AAPT打包時(shí)候會(huì)合并資源文件钥勋。

xml文件命名:例如 finance_list_item_equ.xml, finance_fragment_equ_detail.xml, finance_activity_account.xml

drawable文件命名:finance_account_

資源圖片命名規(guī)范

一般命名:模塊+頁(yè)面+組件前綴+功能+狀態(tài)

app_main_home_tab_category_default.png

app_main_home_tab_category_selected.png

app_main_home_tab_category.xml

模塊內(nèi)通用圖片命名:模塊+功能+狀態(tài)

base_toolbar_back_default.png

base_toolbar_back_pressed.png

base_toolbar_back.png

SharedPreference文件命名(+模塊前綴)

App模塊下的UserConifg對(duì)應(yīng)的XML文件名 app_user_config.xml

Finance模塊下的開(kāi)關(guān)控制對(duì)應(yīng)的MXL命名文件finance_settings.xml

Db同上(+模塊前綴)

Style命名規(guī)范

規(guī)范同類命名規(guī)范一致,駝峰辆苔,首字母大寫算灸。例如AppTheme, MainActivityTheme

加模塊前綴。例如:TrpayMainActivityTheme BaseToolbarStyle

Color命名規(guī)范

加模塊前綴

KEY

SharedPreference中的key都以SP_KEY_作為前綴,定義的常量名字作為Value

例如:private static final StringSP_KEY_USER_TOKEN= “SP_USER_TOKEN”;

例如:private static final StringSP_KEY_IS_FIRST_LAUNCH= “SP_IS_FIRST_LAUNCH”;

Activity中Intent的KEY都以INTENT_KEY_作為前綴,定義的常量名字作為Value

例如:private static final StringINTENT_KEY_USER_ID= “INTENT_KEY_USER_ID”;

例如:private static final StringINTENT_KEY_ORDER_MODEL= “INTENT_KEY_ORDER_MODEL”;

Fragment中Bundle的KEY都以BUNDLE_KEY_作為前綴

例如:private static final StringBUNDLE_KEY_ORDER_ID= “BUNDLE_KEY_ORDER_ID”;

典型方法

從網(wǎng)絡(luò)請(qǐng)求數(shù)據(jù) reqGet作為前綴驻啤。例如reqGetUserInfo(), reqGetInvestDetail()

向服務(wù)器提交數(shù)據(jù)reqPost菲驴、reqSubmit、reqSet骑冗、reqUpdate等reqPostUserProfile(),reqUpdateUserName()

靜態(tài)量

靜態(tài)變量以s作為前綴赊瞬,例如priviate static OnPermissionCallbacksOnPermissionCallback;

靜態(tài)常量全大小先煎,下劃線分割單詞,例如public static final intINVEST_TYPE_I_CUN = 1;

注釋

頁(yè)面注釋:

Activity巧涧、Fragment及包含復(fù)雜業(yè)務(wù)的View組件需要有截圖注釋點(diǎn)擊查看示例

Model采用Java標(biāo)準(zhǔn)的文檔注釋

Java文件注釋:

創(chuàng)建文件頭注釋模版

Created by YourName on 2017/3/23.

常量

不同作用的常量放在不同的Java文件里面

適合使用枚舉的地方用常量加注解實(shí)現(xiàn)點(diǎn)我查看示例

?其他

TextUtil.isEmpty( )建議進(jìn)行靜態(tài)導(dǎo)包

NullUtil靜態(tài)導(dǎo)包

Java代碼規(guī)范

阿里巴巴Java規(guī)范

Googgle Java Style

資源命名規(guī)范

Layout文件

原則:

xml module_what_where_description

例子:

xml mall_activity_order.xml mall_fragment_order.xml mall_dialog_order.xml mall_include_toolbar.xml mall_include_order_header.xml mall_merge_order_content.xml mall_item_goods.xml

Drawable文件

原則

java module_what_where_description 圖標(biāo):ic 背景:bg

例子

account_ic_avatar_default account_bg_goods_list_header

控件ID

原則:

```java

駝峰命名薯蝎,description+控件名縮寫

ListView, ViewPager, SwipeRefreshLayout等一般頁(yè)面只有一個(gè)的控件,可以直接命名為listView, viewPager, swipeRefreshLayout

常用UI控件縮寫表

LinearLayout:layout

RelativeLayout:layout

FrameLayout:layout

TableLayout:layout

Button:btn

ImageButton:btn

TextView:tv

EditText:et

ImageView:iv

```

例子:

xml tvTitle ivAvatar btnCommit tabBottom

Color文件

原則

xml 常見(jiàn)顏色使用colors.xml文件管理 如:white谤绳、black占锯、transparent、colorTheme闷供、colorPrimary烟央、black10、white50 非常見(jiàn)顏色直接寫在布局文件中

例子

xml <android.support.v7.widget.Toolbar xmlns:android="http://schemas.android.com/apk/res/android" xmlns:app="http://schemas.android.com/apk/res-auto" android:id="@+id/toolbar" android:layout_width="match_parent" android:layout_height="@dimen/common_toolbar_height" android:background="?attr/colorPrimary"/> <TextView android:layout_width="match_parent" android:layout_height="wrap_content" android:textColor="#333333""/>

Style文件

原則

java module+what+繼承關(guān)系+where

例子

xml <!--Text Style--> <style name="Mall.TextAppearance" parent="Mall"> <item name="android:textStyle">normal</item> </style> <style name="Mall.TextAppearance.Toolbar.Title"parent="Common.TextAppearance"> <item name="android:textSize">@dimen/common_text_size_large_x</item> <item name="android:textColor">@color/common_toolbar_title_color</item> </style> <style name="Mall.TextAppearance.Toolbar.Menu" parent="Common.TextAppearance"> <item name="android:textSize">@dimen/common_text_size_small</item> <item name="android:textColor">@color/common_toolbar_title_color</item> </style> <!--Activity Style--> <style name="Common.Activity" parent="Theme.AppCompat.Light.NoActionBar" /> <style name="Common.Activity.Base" parent="Common.Activity"> <item name="colorPrimary">@color/common_colorPrimary</item> <item name="colorPrimaryDark">@color/common_colorPrimaryDark</item> <item name="colorAccent">@color/common_colorAccent</item> <item name="android:windowBackground">@null</item> <item name="android:windowSoftInputMode">adjustResize</item> <item name="android:windowAnimationStyle">@style/Common.Animation.Activity.Base</item> <item name="buttonStyle">@style/Widget.AppCompat.Button.Borderless</item> </style> <style name="Common.Activity.Base.FullScreen" parent="Common.Activity.Base"> <item name="android:windowFullscreen">true</item> </style> <style name="Common.Activity.Base.FullScreen.Translucent" parent="Common.Activity.Base.FullScreen"> <item name="android:backgroundDimEnabled">false</item> <item name="android:windowBackground">@color/common_transparent</item> <item name="android:windowIsTranslucent">true</item> <item name="colorPrimaryDark">@color/common_transparent</item> <item name="android:windowAnimationStyle">@null</item> </style>

Dimens歪脏、Integer等文件

原則

java module_what_where_description

例子:

xml <dimen name="common_activity_horizontal_margin">16dp</dimen> <dimen name="common_activity_vertical_margin">16dp</dimen> <dimen name="common_text_size_tiny">10sp</dimen> <dimen name="common_text_size_small">12sp</dimen> <dimen name="common_text_size_normal">14sp</dimen> <dimen name="common_text_size_large">16sp</dimen> <dimen name="common_text_size_large_x">18sp</dimen> <dimen name="common_text_size_large_xx">20sp</dimen> <dimen name="common_toolbar_height">50dp</dimen>

資源文件注意事項(xiàng)

ResourceOptimize

對(duì)UI提供的圖片進(jìn)行壓縮空間的檢測(cè)(tinypng.com)

WebP格式圖片

常見(jiàn)圖片狀態(tài)命名統(tǒng)一:_pressed _default _enable _disable _selected _focused

圖片要根據(jù)UI切圖的屏幕規(guī)格放到對(duì)應(yīng)dpi的drawable文件內(nèi)

shape疑俭、selector等xml資源統(tǒng)一放在drawable(無(wú)dpi后綴)文件夾

Shape類型定義一定要求有背景

啟動(dòng)圖標(biāo)統(tǒng)一防止在對(duì)應(yīng)dpi的mipmap文件內(nèi)

默認(rèn)value文件要包含帶后綴value文件的內(nèi)容,比如婿失,在value-v21文件中聲明的內(nèi)容钞艇,在value中也必須聲明

Manifest內(nèi)Activity要聲明screenOrientation

對(duì)于小圖標(biāo),即使圖片一模一樣但使用的地方毫無(wú)相關(guān)性豪硅,就復(fù)制一份重新命名

XML靈活使用 xmlns:tools=“http://schemas.android.com/tools

XML避免Empty Body

所有Style文件要有BaseStyle并保持合理的繼承關(guān)系

XML內(nèi)常用的組件統(tǒng)一用Style聲明基礎(chǔ)屬性

所有的基礎(chǔ)主題(如AppTheme)需要聲明TextView的textColor\textSize\hintColor,防止因遺漏導(dǎo)致不同系統(tǒng)出現(xiàn)顯示差異哩照、不符合預(yù)期等

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市懒浮,隨后出現(xiàn)的幾起案子飘弧,更是在濱河造成了極大的恐慌,老刑警劉巖砚著,帶你破解...
    沈念sama閱讀 211,948評(píng)論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件次伶,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡稽穆,警方通過(guò)查閱死者的電腦和手機(jī)冠王,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,371評(píng)論 3 385
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)舌镶,“玉大人柱彻,你說(shuō)我怎么就攤上這事〔驼停” “怎么了哟楷?”我有些...
    開(kāi)封第一講書人閱讀 157,490評(píng)論 0 348
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)否灾。 經(jīng)常有香客問(wèn)我卖擅,道長(zhǎng),這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書人閱讀 56,521評(píng)論 1 284
  • 正文 為了忘掉前任磨镶,我火速辦了婚禮,結(jié)果婚禮上健提,老公的妹妹穿的比我還像新娘琳猫。我一直安慰自己,他們只是感情好私痹,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,627評(píng)論 6 386
  • 文/花漫 我一把揭開(kāi)白布脐嫂。 她就那樣靜靜地躺著,像睡著了一般紊遵。 火紅的嫁衣襯著肌膚如雪账千。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書人閱讀 49,842評(píng)論 1 290
  • 那天暗膜,我揣著相機(jī)與錄音匀奏,去河邊找鬼。 笑死学搜,一個(gè)胖子當(dāng)著我的面吹牛娃善,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播瑞佩,決...
    沈念sama閱讀 38,997評(píng)論 3 408
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼聚磺,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了炬丸?” 一聲冷哼從身側(cè)響起瘫寝,我...
    開(kāi)封第一講書人閱讀 37,741評(píng)論 0 268
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎稠炬,沒(méi)想到半個(gè)月后焕阿,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 44,203評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡酸纲,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,534評(píng)論 2 327
  • 正文 我和宋清朗相戀三年捣鲸,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片闽坡。...
    茶點(diǎn)故事閱讀 38,673評(píng)論 1 341
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡栽惶,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出疾嗅,到底是詐尸還是另有隱情外厂,我是刑警寧澤,帶...
    沈念sama閱讀 34,339評(píng)論 4 330
  • 正文 年R本政府宣布代承,位于F島的核電站汁蝶,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜掖棉,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,955評(píng)論 3 313
  • 文/蒙蒙 一墓律、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧幔亥,春花似錦耻讽、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書人閱讀 30,770評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至香伴,卻和暖如春慰枕,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背即纲。 一陣腳步聲響...
    開(kāi)封第一講書人閱讀 32,000評(píng)論 1 266
  • 我被黑心中介騙來(lái)泰國(guó)打工具帮, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人崇裁。 一個(gè)月前我還...
    沈念sama閱讀 46,394評(píng)論 2 360
  • 正文 我出身青樓匕坯,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親拔稳。 傳聞我的和親對(duì)象是個(gè)殘疾皇子葛峻,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,562評(píng)論 2 349