淺談Android編碼規範及命名規範

前言：

　　目前工做負責兩個醫療APP項目的開發，同時使用LeanCloud進行雲端配合開發，徹底單挑。

　　現大框架已經完成，正在進行細節模塊上的開發

　　抽空總結一下Android項目的開發規範：一、編碼規範 二、命名規範　　

　　注：我的經驗，經供參考

--------------------------------------------------------------------------------------------------------------------------

1、Android編碼規範

　　一、學會使用string.xml文件

　　在我看來，當一個文本信息出現的次數大於一次的時候就必需要使用string.xml

　　好比一個保存按鈕 ， 不規範寫法：

　　　　　　<Button
            android:id="@+id/btnSave"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"       
            android:text="保存"
            />

　　這裏給它的文本內容設置爲"保存"，那麼一個app中全部的保存按鈕都這樣寫。當有一天要修改需求了，要求把「保存」文字改爲「提交」，那麼咱們只能去一個個佈局文件中修改，

　　豈不浪費大量時間又可能會存在漏掉修改的狀況。

　　規範寫法：

　　　　　　<Button
            android:id="@+id/btnSave"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"       
            android:text="@string/save"
            />

　　而在string.xml文件中：

    <string name="save">保存</string>

　　這種寫法，日後須要修改，只須要在string.xml文件中修改一行代碼 便實現了整個APP的該文本內容修改。

　　

　　二、學會使用color.xml ,dimens.xml文件的使用

　　同string.xml使用一致，同窗們應該都懂的，切勿由於一時的懶，致使後期的迭代費時費力。

　　

　　三、團隊協同肯定一套標準Activity的onCreate()方法中代碼執行流程

　　其實剛接觸Android的時候，個人不規範代碼是這樣的：

　　 private Button scan;            //掃描按鈕
    private Button create;          //建立按鈕
    private ArrayList<Object> datas; //數據源
    @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控件。設置監聽事件，加載數據源等等。

　　能夠看到如今就2個控件一個數據源，代碼就這麼多了，若是一個界面有10多個控件呢，那onCreate()方法中的代碼量就成倍數的多起來了。

　　因此全部的Activity都要設定一個統一的規範。

　　咱們都知道，一個Activity中有基本都有的操做：

　　　　①、初始化變量

　　　　②、初始化控件

　　　　③、設置監聽事件

　　　　④、加載網絡數據並顯示

　　那麼就能夠將以上的代碼分門別類的放在這幾個方法中

　　好比一段規範代碼：

public class MainActivity extends AppCompatActivity implements View.OnClickListener {

    private Button btn_scan;            //掃描按鈕
    private Button btn_create;          //建立按鈕
    private ArrayList<Object> datas; //數據源
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        initVariables();
        initView();
        initEvent();
        loadData();
    }

    //初始化變量，好比 上一個Activity傳來的Intent的數據  本Activity中一些標記變量等
    private void initVariables() {

    }

    //加載數據源
    private void loadData() {
    }

    //註冊監聽事件
    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);
    }

    //設置點擊事件
    @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()中就那麼幾個方法了，咱們須要找問題的時候在相應的方法中去找便可，既方便又清晰。

　　　　其實這種操做咱們能夠寫一個BaseActivity做爲它的的抽象方法，而後讓Activity繼承這個BaseActivity基類重寫方法便可，涉及到架構，這個日後再說。

 

　　四、團隊協同肯定一種控件的點擊事件OnClickListener()

　　　 Android給咱們提供5種給控件設置OnClick的方法，我的以爲項目中用的最多的就是

　　　①、參數this 而後Activity 實現 View.OnClickListener接口  重寫 onClick()方法

 

btn_create.setOnClickListener(this);

　　   ②、直接參數new OnclickListener()的

btn_create.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                
            }
        });

　　　其餘三個方法我的以爲儘可能不要用。而這兩種方法中第一種 是更好的，由於咱們能夠經過switch--case 的方法區分不一樣控件的點擊事件，代碼更清晰簡約。

　　   固然第二種方法也是能夠的，可是切記同一個項目中最好只有一種方式，便於後期的維護。

　　//設置點擊事件
    @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;
        }
    }

 

   　五、儘可能少用全局變量static進行傳值操做

　　　 static的特性你們應該都是知道的，他會一直佔用一部份內存，雖然不多，可是一個項目中成百上千個使用的話，對項目是很是很差的。

　　　 建議頁面之間的傳值仍是用Intent ，實現沒有好的解決方案的再用static ， PS ，我以前公司的項目就很是大量的使用了static 

         注：有些同窗可能對Activity和Fragment的互相傳值不大會，這裏推薦一個解決方案：Android項目實戰（十三）：淺談EventBus ， 對我來講是項目必備，可是也要合理運用

　　

　　六、Activity中儘可能不要使用內部類

　　　　這裏以RecyclerView舉例，一款很是棒的控件，有了它不再用ListView了 ，淺談RecyclerView(完美替代ListView,GridView)

　　　　一個RecyclerView是配套一個Adapter和一個ViewHolder的。

　　　　不規範作法：部分同窗圖省事（固然放在一個Activity中確實方便數據傳輸和item點擊事件操做），把它們都寫在一個Activity中，這樣是不可取的，由於大大的增長了單個Activity的代碼量，對維護來講很不方便。

　　　　規範作法：　ViewHolder一個類 ，Adapter一個類 ， 分工明確 ，避免一個類中代碼量過多的問題。

　　　　注：ListView，ViewPager 使用同上 

　　　　至於類的分類，有的同窗喜歡一個功能模塊放在一個包下，好比一個功能點的Activity ， Adapter ,ViewHolder都放在一個包下

                               有的同窗喜歡一種類的放在一個包下，好比將全部的Activity放在activitys包下，將全部的Adapter放在adapters包下。

　　　　這都是後話，未來學習架構的時候再詳談

 

　　七、使用ArrayList代替HashMap

　　　  聽說，是聽說，ArrayList使用的內存要低於HashMap，由於android手機良莠不齊，因此開發過程當中對內存仍是很是重視的，能省則省。

　　　　PS：個人項目中基本使用的ArrayList，除非是ArrayList代替不了的數據結構

 

　　八、團隊規範統一的第三方

　　　  如今方便又好用的第三方太多了，圖片框架好幾個優秀的，推送好幾個優秀的，即時通信好幾個優秀的。

　　　  注意使用太多的第三方會致使程序過大，並且應用有一個最大方法數的限制，避免實現一種功能的第三方，團隊成員使用的都是不同的第三方。

   

　　九、統一代碼格式

　　　　經典的就是for循環了， 一種是左括號放在最後，一個是另起一行。 統一下，界面看起來舒服，我的建議左括號放在最後的方式，別問我爲啥，大學老師推薦的，理由：忘了。

　　　　 for (int i = 0; i < 10; i++) {
            
        }
        for (int i = 0; i < 10; i++) 
        {
            
        }

 

　　十、不一樣功能代碼之間要有一行空格分開

　　　　配合的寫上註釋，告訴維護的同窗 ，哪一段代碼是進行什麼操做的 

　　　　爲了代碼清晰 也爲了維護的同窗少長兩根頭髮。。

 　　

　　十一、若是你是Android Studio開發

　　　　請頻繁使用Ctrl+A  --》  Ctrl +Alt + I  

--------------------------------------------------------------------------------------------------------------------------

2、Android命名規範

　　命名規範:駝峯法,下劃線分割法。

　　一、Java類文件

　　①、Activity：以Activity做爲後綴，這個相信你們AS給你的都幫你作好了。

　　②、Adapter: 以Adapter做爲後綴

　　③、ViewHolder: 以ViewHolder做爲後綴

　　④、實體類Entity：以Entity做爲後綴

　　　

　　以下，我是以功能模塊分包，大神勿噴，我的喜愛：

　　

　　二、xml文件

　　①、layout.xml

　　　　Activity的佈局文件以activity_ 開頭，AS提供的。

　　　　列表項的佈局文件listview  以 item_list_開頭。

　　②、控件的命名

　　　　縮寫，這個看我的了，

　　　　個人經驗，好比：

　　　　LayoutView    ----    lv

　　　　TextView        ----    tv

           Button          ----    btn

　　　　ImageView     ----    img

 

　　切記，不要使用拼音命名，即便英文這麼菜的博主我開發都開着有道詞典。

　　最後，編碼必定要寫註釋，你命名的若是英文不是立馬能看懂的，請必定要寫上註釋。

     

 　 註釋！

　　註釋！

　　 註釋！