淺談Android編碼規(guī)范及命名規(guī)范
前言:
目前工作負(fù)責(zé)兩個(gè)醫(yī)療APP項(xiàng)目的開發(fā),同時(shí)使用LeanCloud進(jìn)行云端配合開發(fā),完全單挑。
現(xiàn)大框架已經(jīng)完成,正在進(jìn)行細(xì)節(jié)模塊上的開發(fā)
抽空總結(jié)一下Android項(xiàng)目的開發(fā)規(guī)范:1、編碼規(guī)范 2、命名規(guī)范
注:個(gè)人經(jīng)驗(yàn),經(jīng)供參考
一、Android編碼規(guī)范
1、學(xué)會(huì)使用string.xml文件
在我看來,當(dāng)一個(gè)文本信息出現(xiàn)的次數(shù)大于一次的時(shí)候就必須要使用string.xml
比如一個(gè)保存按鈕 , 不規(guī)范寫法:
<Button android:id="@+id/editinfo_btn_save" android:layout_width="wrap_content" android:layout_height="wrap_content" android:text="保存" />
這里給它的文本內(nèi)容設(shè)置為"保存",那么一個(gè)app中所有的保存按鈕都這樣寫。當(dāng)有一天要修改需求了,要求把“保存”文字改成“提交”,那么我們只能去一個(gè)個(gè)布局文件中修改,
豈不浪費(fèi)大量時(shí)間又可能會(huì)存在漏掉修改的情況。
規(guī)范寫法:
<Button android:id="@+id/editinfo_btn_save" android:layout_width="wrap_content" android:layout_height="wrap_content" android:text="@string/save" />
而在string.xml文件中:
<string name="save">保存</string>
這種寫法,往后需要修改,只需要在string.xml文件中修改一行代碼 便實(shí)現(xiàn)了整個(gè)APP的該文本內(nèi)容修改。
2、學(xué)會(huì)使用color.xml ,dimens.xml文件的使用
同string.xml使用一致,同學(xué)們應(yīng)該都懂的,切勿因?yàn)橐粫r(shí)的懶,導(dǎo)致后期的迭代費(fèi)時(shí)費(fèi)力。
3、團(tuán)隊(duì)協(xié)同確定一套標(biāo)準(zhǔn)Activity的onCreate()方法中代碼執(zhí)行流程
其實(shí)剛接觸Android的時(shí)候,我的不規(guī)范代碼是這樣的:
private Button scan; //掃描按鈕 private Button create; //創(chuàng)建按鈕 private ArrayList<Object> datas; //數(shù)據(jù)源 @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); create = (Button) findViewById(R.id.create); scan = (Button) findViewById(R.id.scan); scan.setOnClickListener(this); create.setOnClickListener(this); datas = new ArrayList<>(); datas.add(new Integer(1)); datas.add(new Integer(2)); datas.add(new Integer(3)); datas.add(new Integer(4)); }
什么都不管,所有的操作代碼都寫在onCreate()方法中,包括find控件。設(shè)置監(jiān)聽事件,加載數(shù)據(jù)源等等。
可以看到現(xiàn)在就2個(gè)控件一個(gè)數(shù)據(jù)源,代碼就這么多了,如果一個(gè)界面有10多個(gè)控件呢,那onCreate()方法中的代碼量就成倍數(shù)的多起來了。
所以所有的Activity都要設(shè)定一個(gè)統(tǒng)一的規(guī)范。
我們都知道,一個(gè)Activity中有基本都有的操作:
?、?、初始化變量
?、?、初始化控件
?、邸⒃O(shè)置監(jiān)聽事件
?、堋⒓虞d網(wǎng)絡(luò)數(shù)據(jù)并顯示
那么就可以將以上的代碼分門別類的放在這幾個(gè)方法中
比如一段規(guī)范代碼:
public class MainActivity extends AppCompatActivity implements View.OnClickListener { private Button btn_scan; //掃描按鈕 private Button btn_create; //創(chuàng)建按鈕 private ArrayList<Object> datas; //數(shù)據(jù)源 @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); initVariables(); initView(); initEvent(); loadData(); } //初始化變量,比如 上一個(gè)Activity傳來的Intent的數(shù)據(jù) 本Activity中一些標(biāo)記變量等 private void initVariables() { } //加載數(shù)據(jù)源 private void loadData() { } //注冊監(jiān)聽事件 private void initEvent() { btn_scan.setOnClickListener(this); btn_create.setOnClickListener(this); } //初始化控件 private void initView() { btn_create = (Button) findViewById(R.id.create); btn_scan = (Button) findViewById(R.id.scan); } //設(shè)置點(diǎn)擊事件 @Override public void onClick(View v) { switch (v.getId()){ case R.id.btn_scan: //掃描二維碼 startActivity(new Intent(this,ScanActivity.class)); break; case R.id.btn_create: //生成二維碼 startActivity(new Intent(this,CreateActivity.class)); break; } } }
可以看到,onCreate()中就那么幾個(gè)方法了,我們需要找問題的時(shí)候在相應(yīng)的方法中去找即可,既方便又清晰。
其實(shí)這種操作我們可以寫一個(gè)BaseActivity作為它的的抽象方法,然后讓Activity繼承這個(gè)BaseActivity基類重寫方法即可,涉及到架構(gòu),這個(gè)往后再說。
4、團(tuán)隊(duì)協(xié)同確定一種控件的點(diǎn)擊事件OnClickListener()
Android給我們提供5種給控件設(shè)置OnClick的方法,個(gè)人覺得項(xiàng)目中用的最多的就是
①、參數(shù)this 然后Activity 實(shí)現(xiàn) View.OnClickListener接口 重寫 onClick()方法
btn_create.setOnClickListener(this);
②、直接參數(shù)new OnclickListener()的
btn_create.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View v) { } });
其他三個(gè)方法個(gè)人覺得盡量不要用。而這兩種方法中第一種 是更好的,因?yàn)槲覀兛梢酝ㄟ^switch--case 的方法區(qū)分不同控件的點(diǎn)擊事件,代碼更清晰簡約。
當(dāng)然第二種方法也是可以的,但是切記同一個(gè)項(xiàng)目中最好只有一種方式,便于后期的維護(hù)。
//設(shè)置點(diǎn)擊事件 @Override public void onClick(View v) { switch (v.getId()){ case R.id.scan: //掃描二維碼 startActivity(new Intent(this,ScanActivity.class)); break; case R.id.create: //生成二維碼 startActivity(new Intent(this,CreateActivity.class)); break; } }
5、盡量少用全局變量static進(jìn)行傳值操作
static的特性大家應(yīng)該都是知道的,他會(huì)一直占用一部分內(nèi)存,雖然很少,但是一個(gè)項(xiàng)目中成百上千個(gè)使用的話,對項(xiàng)目是非常不好的。
建議頁面之間的傳值還是用Intent ,實(shí)現(xiàn)沒有好的解決方案的再用static , PS ,我之前公司的項(xiàng)目就非常大量的使用了static
注:有些同學(xué)可能對Activity和Fragment的互相傳值不大會(huì),這里推薦一個(gè)解決方案:淺談EventBus , 對我來說是項(xiàng)目必備,但是也要合理運(yùn)用
6、Activity中盡量不要使用內(nèi)部類
這里以RecyclerView舉例,一款非常棒的控件,有了它再也不用ListView了 ,淺談RecyclerView(完美替代ListView,GridView)
一個(gè)RecyclerView是配套一個(gè)Adapter和一個(gè)ViewHolder的。
不規(guī)范做法:部分同學(xué)圖省事(當(dāng)然放在一個(gè)Activity中確實(shí)方便數(shù)據(jù)傳輸和item點(diǎn)擊事件操作),把它們都寫在一個(gè)Activity中,這樣是不可取的,因?yàn)榇蟠蟮脑黾恿藛蝹€(gè)Activity的代碼量,對維護(hù)來說很不方便。
規(guī)范做法: ViewHolder一個(gè)類 ,Adapter一個(gè)類 , 分工明確 ,避免一個(gè)類中代碼量過多的問題。
注:ListView,ViewPager 使用同上
至于類的分類,有的同學(xué)喜歡一個(gè)功能模塊放在一個(gè)包下,比如一個(gè)功能點(diǎn)的Activity , Adapter ,ViewHolder都放在一個(gè)包下
有的同學(xué)喜歡一種類的放在一個(gè)包下,比如將所有的Activity放在activitys包下,將所有的Adapter放在adapters包下。
這都是后話,將來學(xué)習(xí)架構(gòu)的時(shí)候再詳談
7、使用ArrayList代替HashMap
據(jù)說,是據(jù)說,ArrayList使用的內(nèi)存要低于HashMap,因?yàn)閍ndroid手機(jī)參差不齊,所以開發(fā)過程中對內(nèi)存還是非常重視的,能省則省。
PS:我的項(xiàng)目中基本使用的ArrayList,除非是ArrayList代替不了的數(shù)據(jù)結(jié)構(gòu)
8、團(tuán)隊(duì)規(guī)范統(tǒng)一的第三方
現(xiàn)在方便又好用的第三方太多了,圖片框架好幾個(gè)優(yōu)秀的,推送好幾個(gè)優(yōu)秀的,即時(shí)通訊好幾個(gè)優(yōu)秀的。
注意使用太多的第三方會(huì)導(dǎo)致程序過大,而且應(yīng)用有一個(gè)最大方法數(shù)的限制,避免實(shí)現(xiàn)一種功能的第三方,團(tuán)隊(duì)成員使用的都是不一樣的第三方。
9、統(tǒng)一代碼格式
經(jīng)典的就是for循環(huán)了, 一種是左括號(hào)放在最后,一個(gè)是另起一行。 統(tǒng)一下,界面看起來舒服,個(gè)人建議左括號(hào)放在最后的方式,別問我為啥,大學(xué)老師推薦的,理由:忘了。
for (int i = 0; i < 10; i++) { } for (int i = 0; i < 10; i++) { }
10、不同功能代碼之間要有一行空格分開
配合的寫上注釋,告訴維護(hù)的同學(xué) ,哪一段代碼是進(jìn)行什么操作的
為了代碼清晰 也為了維護(hù)的同學(xué)少長兩根頭發(fā)。。
11、如果你是Android Studio開發(fā)
請頻繁使用Ctrl+A --》 Ctrl +Alt + I
--------------------------------------------------------------------------------------------------------------------------
二、Android命名規(guī)范
命名規(guī)范:駝峰法,下劃線分割法。
1、Java類文件
?、?、Activity:以Activity作為后綴,這個(gè)相信大家AS給你的都幫你做好了。
②、Adapter: 以Adapter作為后綴
③、ViewHolder: 以ViewHolder作為后綴
?、堋?shí)體類Entity:以Entity作為后綴
如下,我是以功能模塊分包,大神勿噴,個(gè)人喜好:
2、xml文件
?、佟ayout.xml
Activity的布局文件以activity_ 開頭,AS提供的。
列表項(xiàng)的布局文件listview 以 item_list_開頭。
?、凇⒖丶拿?/p>
縮寫,這個(gè)看個(gè)人了,
我的經(jīng)驗(yàn),比如:
LayoutView ---- lv
TextView ---- tv
Button ---- btn
ImageView ---- img
切記,不要使用拼音命名,即使英文這么菜的博主我開發(fā)都開著有道詞典。
最后,編碼一定要寫注釋,你命名的如果英文不是立馬能看懂的,請一定要寫上注釋。
相關(guān)文章
Android仿QQ個(gè)人標(biāo)簽添加與刪除功能
這篇文章主要為大家詳細(xì)介紹了Android仿QQ個(gè)人標(biāo)簽添加與刪除功能,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2018-12-12Android Flutter實(shí)現(xiàn)自定義下拉刷新組件
在Flutter開發(fā)中官方提供了多平臺(tái)的下拉刷新組件供開發(fā)者使用。本文將改造一下這些組件,實(shí)現(xiàn)自定義的下拉刷新組件,感興趣的可以了解一下2022-08-08android 指紋識(shí)別調(diào)用實(shí)現(xiàn)方法及示例代碼
這里主要介紹Android 指紋識(shí)別的簡單實(shí)現(xiàn)代碼,希望能幫助開發(fā)這部分應(yīng)用的朋友,有需要的小伙伴可以參考下2016-09-09Android開發(fā)Jetpack組件Lifecycle使用篇
這一篇文章來介紹Android?Jetpack架構(gòu)組件的Lifecycle;?Lifecycle用于幫助開發(fā)者管理Activity和Fragment?的生命周期,?由于Lifecycle是LiveData和ViewModel的基礎(chǔ);所以需要先學(xué)習(xí)它2022-08-08深入Android Handler,MessageQueue與Looper關(guān)系
這篇文章主要介紹了深入Android Handler,MessageQueue與Looper關(guān)系,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2018-08-08Android編程使用ListView實(shí)現(xiàn)數(shù)據(jù)列表顯示的方法
這篇文章主要介紹了Android編程使用ListView實(shí)現(xiàn)數(shù)據(jù)列表顯示的方法,實(shí)例分析了Android中ListView控件的使用技巧,需要的朋友可以參考下2016-01-01Android TabWidget切換卡的實(shí)現(xiàn)應(yīng)用
本篇文章小編為大家介紹,Android TabWidget切換卡的實(shí)現(xiàn)應(yīng)用。需要的朋友參考下2013-04-04