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

前言：

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

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

　　抽空總結一下Android項目的開發規范：1、編碼規范 2、命名規范　　

　　注：個人經驗，經供參考

一、Android編碼規范

　　1、學會使用string.xml文件

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

　　比如一個保存按鈕 ， 不規范寫法：

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

    這裡給它的文本內容設置為"保存"，那麼一個app中所有的保存按鈕都這樣寫。當有一天要修改需求了，要求把“保存”文字改成“提交”，那麼我們只能去一個個布局文件中修改，

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

　　規范寫法：

 <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文件中修改一行代碼 便實現了整個APP的該文本內容修改。

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

　　同string.xml使用一致，同學們應該都懂的，切勿因為一時的懶，導致後期的迭代費時費力。

　　3、團隊協同確定一套標准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基類重寫方法即可，涉及到架構，這個往後再說。

　　4、團隊協同確定一種控件的點擊事件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;
 }
 }

    5、盡量少用全局變量static進行傳值操作

　　　 static的特性大家應該都是知道的，他會一直占用一部分內存，雖然很少，但是一個項目中成百上千個使用的話，對項目是非常不好的。

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

       注：有些同學可能對Activity和Fragment的互相傳值不大會，這裡推薦一個解決方案：淺談EventBus ， 對我來說是項目必備，但是也要合理運用

　6、Activity中盡量不要使用內部類

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

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

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

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

　　　　注：ListView，ViewPager 使用同上

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

        有的同學喜歡一種類的放在一個包下，比如將所有的Activity放在activitys包下，將所有的Adapter放在adapters包下。

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

　　7、使用ArrayList代替HashMap

　　　  據說，是據說，ArrayList使用的內存要低於HashMap，因為android手機參差不齊，所以開發過程中對內存還是非常重視的，能省則省。

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

　　8、團隊規范統一的第三方

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

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

　　9、統一代碼格式

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

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

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

　　　　配合的寫上注釋，告訴維護的同學 ，哪一段代碼是進行什麼操作的

　　　　為了代碼清晰 也為了維護的同學少長兩根頭發。。

　 11、如果你是Android Studio開發

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

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

二、Android命名規范

　　命名規范:駝峰法,下劃線分割法。

　　1、Java類文件

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

　　②、Adapter: 以Adapter作為後綴

　　③、ViewHolder: 以ViewHolder作為後綴

　　④、實體類Entity：以Entity作為後綴

　　如下，我是以功能模塊分包，大神勿噴，個人喜好：

　    2、xml文件

　　①、layout.xml

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

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

　　②、控件的命名

　　　　縮寫，這個看個人了，

　　　　我的經驗，比如：

　　　　LayoutView    ----    lv

　　　　TextView        ----    tv

              Button          ----    btn

　　　　ImageView     ----    img

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

　　最後，編碼一定要寫注釋，你命名的如果英文不是立馬能看懂的，請一定要寫上注釋。