淺談Android編碼規(guī)范及命名規(guī)范
前言:
目前工作負(fù)責(zé)兩個醫(yī)療APP項目的開發(fā),同時使用LeanCloud進(jìn)行云端配合開發(fā),完全單挑。
現(xiàn)大框架已經(jīng)完成,正在進(jìn)行細(xì)節(jié)模塊上的開發(fā)
抽空總結(jié)一下Android項目的開發(fā)規(guī)范:1、編碼規(guī)范 2、命名規(guī)范
注:個人經(jīng)驗,經(jīng)供參考
一、Android編碼規(guī)范
1、學(xué)會使用string.xml文件
在我看來,當(dāng)一個文本信息出現(xiàn)的次數(shù)大于一次的時候就必須要使用string.xml
比如一個保存按鈕 , 不規(guī)范寫法:
<Button android:id="@+id/editinfo_btn_save" android:layout_width="wrap_content" android:layout_height="wrap_content" android:text="保存" />
這里給它的文本內(nèi)容設(shè)置為"保存",那么一個app中所有的保存按鈕都這樣寫。當(dāng)有一天要修改需求了,要求把“保存”文字改成“提交”,那么我們只能去一個個布局文件中修改,
豈不浪費大量時間又可能會存在漏掉修改的情況。
規(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文件中修改一行代碼 便實現(xiàn)了整個APP的該文本內(nèi)容修改。
2、學(xué)會使用color.xml ,dimens.xml文件的使用
同string.xml使用一致,同學(xué)們應(yīng)該都懂的,切勿因為一時的懶,導(dǎo)致后期的迭代費時費力。
3、團隊協(xié)同確定一套標(biāo)準(zhǔn)Activity的onCreate()方法中代碼執(zhí)行流程
其實剛接觸Android的時候,我的不規(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個控件一個數(shù)據(jù)源,代碼就這么多了,如果一個界面有10多個控件呢,那onCreate()方法中的代碼量就成倍數(shù)的多起來了。
所以所有的Activity都要設(shè)定一個統(tǒng)一的規(guī)范。
我們都知道,一個Activity中有基本都有的操作:
?、?、初始化變量
?、?、初始化控件
?、?、設(shè)置監(jiān)聽事件
?、堋⒓虞d網(wǎng)絡(luò)數(shù)據(jù)并顯示
那么就可以將以上的代碼分門別類的放在這幾個方法中
比如一段規(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();
}
//初始化變量,比如 上一個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è)置點擊事件
@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()中就那么幾個方法了,我們需要找問題的時候在相應(yīng)的方法中去找即可,既方便又清晰。
其實這種操作我們可以寫一個BaseActivity作為它的的抽象方法,然后讓Activity繼承這個BaseActivity基類重寫方法即可,涉及到架構(gòu),這個往后再說。
4、團隊協(xié)同確定一種控件的點擊事件OnClickListener()
Android給我們提供5種給控件設(shè)置OnClick的方法,個人覺得項目中用的最多的就是
①、參數(shù)this 然后Activity 實現(xiàn) View.OnClickListener接口 重寫 onClick()方法
btn_create.setOnClickListener(this);
②、直接參數(shù)new OnclickListener()的
btn_create.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
}
});
其他三個方法個人覺得盡量不要用。而這兩種方法中第一種 是更好的,因為我們可以通過switch--case 的方法區(qū)分不同控件的點擊事件,代碼更清晰簡約。
當(dāng)然第二種方法也是可以的,但是切記同一個項目中最好只有一種方式,便于后期的維護(hù)。
//設(shè)置點擊事件
@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)該都是知道的,他會一直占用一部分內(nèi)存,雖然很少,但是一個項目中成百上千個使用的話,對項目是非常不好的。
建議頁面之間的傳值還是用Intent ,實現(xiàn)沒有好的解決方案的再用static , PS ,我之前公司的項目就非常大量的使用了static
注:有些同學(xué)可能對Activity和Fragment的互相傳值不大會,這里推薦一個解決方案:淺談EventBus , 對我來說是項目必備,但是也要合理運用
6、Activity中盡量不要使用內(nèi)部類
這里以RecyclerView舉例,一款非常棒的控件,有了它再也不用ListView了 ,淺談RecyclerView(完美替代ListView,GridView)
一個RecyclerView是配套一個Adapter和一個ViewHolder的。
不規(guī)范做法:部分同學(xué)圖省事(當(dāng)然放在一個Activity中確實方便數(shù)據(jù)傳輸和item點擊事件操作),把它們都寫在一個Activity中,這樣是不可取的,因為大大的增加了單個Activity的代碼量,對維護(hù)來說很不方便。
規(guī)范做法: ViewHolder一個類 ,Adapter一個類 , 分工明確 ,避免一個類中代碼量過多的問題。
注:ListView,ViewPager 使用同上
至于類的分類,有的同學(xué)喜歡一個功能模塊放在一個包下,比如一個功能點的Activity , Adapter ,ViewHolder都放在一個包下
有的同學(xué)喜歡一種類的放在一個包下,比如將所有的Activity放在activitys包下,將所有的Adapter放在adapters包下。
這都是后話,將來學(xué)習(xí)架構(gòu)的時候再詳談
7、使用ArrayList代替HashMap
據(jù)說,是據(jù)說,ArrayList使用的內(nèi)存要低于HashMap,因為android手機參差不齊,所以開發(fā)過程中對內(nèi)存還是非常重視的,能省則省。
PS:我的項目中基本使用的ArrayList,除非是ArrayList代替不了的數(shù)據(jù)結(jié)構(gòu)
8、團隊規(guī)范統(tǒng)一的第三方
現(xiàn)在方便又好用的第三方太多了,圖片框架好幾個優(yōu)秀的,推送好幾個優(yōu)秀的,即時通訊好幾個優(yōu)秀的。
注意使用太多的第三方會導(dǎo)致程序過大,而且應(yīng)用有一個最大方法數(shù)的限制,避免實現(xiàn)一種功能的第三方,團隊成員使用的都是不一樣的第三方。
9、統(tǒng)一代碼格式
經(jīng)典的就是for循環(huán)了, 一種是左括號放在最后,一個是另起一行。 統(tǒng)一下,界面看起來舒服,個人建議左括號放在最后的方式,別問我為啥,大學(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類文件
?、佟ctivity:以Activity作為后綴,這個相信大家AS給你的都幫你做好了。
②、Adapter: 以Adapter作為后綴
③、ViewHolder: 以ViewHolder作為后綴
④、實體類Entity:以Entity作為后綴
如下,我是以功能模塊分包,大神勿噴,個人喜好:

2、xml文件
?、佟ayout.xml
Activity的布局文件以activity_ 開頭,AS提供的。
列表項的布局文件listview 以 item_list_開頭。
②、控件的命名
縮寫,這個看個人了,
我的經(jīng)驗,比如:
LayoutView ---- lv
TextView ---- tv
Button ---- btn
ImageView ---- img
切記,不要使用拼音命名,即使英文這么菜的博主我開發(fā)都開著有道詞典。
最后,編碼一定要寫注釋,你命名的如果英文不是立馬能看懂的,請一定要寫上注釋。
相關(guān)文章
Android studio無法創(chuàng)建類和接口和提示問題的完美解決辦法
這篇文章主要介紹了Android studio無法創(chuàng)建類和接口和提示問題解決辦法,內(nèi)容比較簡單,非常不錯,具有參考借鑒價值,需要的朋友可以參考下2018-04-04
Kotlin中Lambda表達(dá)式與高階函數(shù)使用分析講解
lambda 本質(zhì)上是可以傳遞給函數(shù)的一小段代碼,Kotlin 與 Java 中的 Lambda 有一定的區(qū)別,除了對 lambda 的全面支持外,還有內(nèi)聯(lián)函數(shù)等簡潔高效的特性。下面我們來仔細(xì)看一下2022-12-12
Android手機鬧鐘服務(wù)AlarmManagerk開發(fā)案例
這篇文章主要為大家詳細(xì)介紹了Android手機鬧鐘服務(wù)AlarmManagerk開發(fā)案例的資料,需要的朋友可以參考下2016-05-05
Android 6.0以上權(quán)限拒絕打開權(quán)限設(shè)置界面的解決方法
今天小編就為大家分享一篇Android 6.0以上權(quán)限拒絕打開權(quán)限設(shè)置界面的解決方法,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2018-07-07
Android?App隱私合規(guī)檢測輔助工具Camille詳解
Camille是一款A(yù)ndroid?App隱私合規(guī)檢測輔助工具,現(xiàn)如今APP隱私合規(guī)十分重要,各監(jiān)管部門不斷開展APP專項治理工作及核查通報,不合規(guī)的APP通知整改或直接下架,下面小編給大家介紹下Android?App隱私合規(guī)檢測輔助工具Camille,感興趣的朋友一起看看吧2022-02-02

