Android教程網 >> Android技術 >> 關於Android編程 >> Android開發規范總結

Android開發規范總結

編輯：關於Android編程

前言

做Android開發這麼多年，見過很多人寫的代碼(開源代碼除外)，其中有的寫的代碼很簡潔、很漂亮，讓人看起來很舒服；有的寫的那是一塌糊塗，根本就沒有心思再往下看。最近就是在做一個項目，由於之前的代碼很復雜，需要對整個軟件進行重構，我是邊重構邊吐槽。說多了都是淚啊！所以就准備寫一下這篇文章。另外說一點，本規范不是標准，只是我自己在開發中所遵循的。所以大家看看就行了。

一、命名規范

1、包的命名：

包的名字都是由小寫單詞組成。

1.1、項目包名(APP的唯一ID)

一般的項目都是：com.公司名.項目名

1.2、功能模塊包名

這個包是項目下的功能模塊分包，主要有兩個命名方式：

按照文件的類型命名：
例如：activity/、adapter/、fragment/ 等。按照功能模塊命名：
例如：login/、register/、setting/ 等。

2、類名

遵循兩點

Java類名遵循大駝峰命名規范。即：以大寫字母開頭、由多個單詞組成時，每一個單詞的首字母都大寫。以功能模塊結尾。例如：LoginActivity、FriendListAdapter、UserModel等。

3、變量

標准的駝峰命名法。

4、靜態變量、常量、枚舉類型

全部大寫，由多個單詞組成的時候，每個單詞之間以“_”連接。

5、方法名

遵循駝峰命名根據方法實現功能來命名初始化一般以init開頭帶有返回值的以get開頭設置數據的以set開頭
例如：initView()、userLogin()、private UserModel getUserInfo()、setUserFriendList(List friendList)等。

6、其他

如果代碼中有需要實現的功能，但是當前沒有實現的代碼為了標記可以打上 //TODO標記

private void initView() {
   //TODO
}

二、布局文件優化

1、多用、標簽

Android方法建議是一個布局文件最多嵌套三層，這個大家應該都知道吧，所以要多用、標簽，這樣的好處有兩點：

減少層次的嵌套增強布局的重復利用性。

2、多用style屬性

這個不用多說了吧，可以減少不少的代碼量。

3、文字顯示用"@string/xxx"

這個在做軟件的國際化的時候，是必須的。就算是不做國際化在需要修改某一個文字時也會很方便。

4、屏幕適配

做Android的應該很關心這一點吧。關於這一點應該網上有很多的教程告訴我們要怎麼去做。我這裡主要說我常用的方式。
先分析頁面的結構，最外層采用什麼樣的layout，如果是LinearLayout 多采用android:layout_weight屬性，如果是RelativeLayout就會多采用android:layout_centerxxx和android:layout_alignParentxxx屬性

三、代碼風格

1、條件判斷

1.1、能用Switch 代替的就用Switch。說一下我覺得用Switch的優點：

有很多else if的時候，用switch case比較清晰。有很多else if的時候，用switch 的計算量少。

1.2、多判斷不成立的條件

拿一個登錄的功能做一個對比：
之前的代碼

if (TextUtils.isEmpty(useName)) {
  //如果用戶名為空
   showMessage("賬號為空，請輸入登錄賬號");
} else {
  //如果用戶名不為空，判斷密碼
  if (TextUtils.isEmpty(pwd)) {
    //如果密碼為空
   showMessage("密碼為空，請輸入密碼");
  }else{
    //如果密碼不為空，登錄
    userLogin();
  }
}

看到這裡朋友不要笑，也不要問誰會這樣寫啊，因為我的回答是，我真的見過有人這樣寫。代碼的邏輯很清晰，但是if..else..的嵌套太多了。而且還加深了代碼的層次。
我們再看看改過之後的代碼：

if (TextUtils.isEmpty(useName)) {
   showMessage("賬號為空，請輸入登錄賬號");
   return;
}
if (TextUtils.isEmpty(useName)) {
   showMessage("密碼為空，請輸入密碼");
   return;
}
userLogin();

相比之下，如何？是不是更簡潔一些？

1.3、判斷為對象為空和字符串為空字符的寫法

1.3.1、判斷一個對象是否為null

我見過很多都是這樣寫的

if(null == obj){
  return;
}

關於這種寫法，我不想多說什麼，但是我不習慣這種寫法，所以我們先看一下Android系統是怎麼判斷一個字符是否為空或者是空字符的寫法：

public class TextUtils {
...
  /** * Returns true if the string is null or 0-length.
   * @param str the string to be examined
   * @return true if str is null or zero length
   */
  public static boolean isEmpty(@Nullable CharSequence str) {
      if (str == null || str.length() == 0)
          return true;
      else
          return false;
  }
....
}

這個是在android.text包下面的一個工具類。借鑒官方的例子，我判斷對象是否為空一般寫法是：

if(obj == null){
  return;
}

1.3.2、判斷字符是否為空字符

我見過最多的寫法是

if(str.equals(""))
  return;
}

可以說我之前帶過的工程師都是這麼寫的，看到這種寫法我都會讓他們改。原因很簡單，如果當str為null的時候，這段代碼是會NullPointerException的，我的寫法如下，可以規避NullPointerException。

if("".equals(str)){
  return;
}

2、final 、static、static final 以及 final static 的區別

為什麼要寫這個呢，感覺和主題無關啊？是啊，本來我也是不想寫這個的，想起之前有人問我：
什麼是靜態變量，什麼是常量，靜態變量和常量之間誰更省內存？
那這個問題就牽涉到了軟件的內存優化的問題，所以還是提一下吧。

說一下個人理解：

final

修飾類時，表示此類為最終類，不能被繼承修飾方法(不包括構造方法)時，此方法不可以被子類覆蓋。修飾變量時，就變成了常量(不可變量)，一般會伴隨static一起使用

static

修飾變量，即為靜態變量，靜態變量在內存中只有一個拷貝(省內存)，JVM只為靜態分配一次內存，在加載類的過程中完成靜態變量的內存分配，可用類名直接訪問，當然也可以通過對象來訪問(不推薦)。（ps:這就是為什麼final的常量會伴隨static一起使用的原因)static代碼塊是類加載時，初始化自動執行的。如果static代碼塊有多個，JVM將按照它們在類中出現的先後順序依次執行它們，每個代碼塊只會被執行一次。

static{
.....
}

static方法可以直接通過類名調用,static方法只能訪問static的變量和方法

上面首先解答了什麼是常量、什麼是靜態變量的問題，那麼再看一下誰更省內存：

一個完整的Java程序運行過程會涉及以下內存區域：
寄存器：JVM內部虛擬寄存器，存取速度非常快，程序不可控制。
棧：保存局部變量的值，包括：a.用來保存基本數據類型的值；b.保存類的實例，即堆區對象的引用(指針)。也可以用來保存加載方法時的幀。
堆：用來存放動態產生的數據，比如new出來的對象。注意創建出來的對象只包含屬於各自的成員變量，並不包括成員方法。因為同一個類的對象擁有各自的成員變量，存儲在各自的堆中，但是他們共享該類的方法，並不是每創建一個對象就把成員方法復制一次。
常量池：JVM為每個已加載的類型維護一個常量池，常量池就是這個類型用到的常量的一個有序集合。包括直接常量(基本類型，String)和對其他類型、方法、字段的符號引用(1)。池中的數據和數組一樣通過索引訪問。由於常量池包含了一個類型所有的對其他類型、方法、字段的符號引用，所以常量池在Java的動態鏈接中起了核心作用。常量池存在於堆中。
代碼段：用來存放從硬盤上讀取的源程序代碼。
全局數據段：用來存放static定義的靜態成員或全局變量。分配該區時內存全部清0，結果變量的初始化為0。

下圖表示內存分配圖：

static屬性在類加載，也就是第一次用到這個類的時候初始化，對於後來的實例的創建，不再次進行初始化。

常量在代碼執行之前綁定到內存單元,並且在整個程序執行過程中都指向相同的內存單元.
所以，在程序的啟動時，常量要相對與靜態變量占內存，而在軟件運行過程中，他們是一樣的。但是對於小運行內存的手機來說，大量的static 和final 是要盡量要避免的。

3、視圖與邏輯處理分開

這一點很重要。這也是我寫這篇文章的最主要目的，我說過，最近是在對一個項目進行重構。其中，有一個自定義的 View,裡面充斥著大量的邏輯代碼還有網絡請求等等。看到這種代碼，我是徹底無語了。

以下為個人理解：

View本身只是一個控件，可以提供接口或者方法讓外部改變其內容或者形狀，並且需要把自己的觸摸事件返回給調用者。需要做什麼完全交由調用者自己去實現。

所以，一個視圖，僅僅是做顯示的，怎麼能進行邏輯代碼的處理？不管從任何角度來說，都不應該這樣做。

4、分模塊，各司其職

在進行代碼重構的時候，抽時間學習了下MVP(Model View Presenter)模式。這裡先說一下Android中的MVC。在說之前先問大家一個問題:
在你們做過的項目中，哪些是M,哪些是V,哪些又是C?

先不要往下看，先仔細想一想。

相信會有很多人包括之前的我在內，都會認為M就是寫的一些實體類，V就是寫的布局文件，C就是寫在Activity裡面的邏輯代碼。而且有的時候V和C還是混合的。
但是後來發現不是這樣的。

MVC for Android
在Android開發中，比較流行的開發框架模式采用的是MVC框架模式，采用MVC模式的好處是便於UI界面部分的顯示和業務邏輯，數據處理分開。那麼Android項目中哪些代碼來充當M,V,C角色呢？
M層：適合做一些業務邏輯處理，比如數據庫存取操作，網絡操作，復雜的算法，耗時的任務等都在model層處理。
V層：應用層中處理數據顯示的部分，XML布局可以視為V層，顯示Model層的數據結果。
C層：在Android中，Activity處理用戶交互問題，因此可以認為Activity是控制器，Activity讀取V視圖層的數據（eg.讀取當前EditText控件的數據），控制用戶輸入（eg.EditText控件數據的輸入），並向Model發送數據請求（eg.發起網絡請求等）。

同樣的問題，如果采用MVP模式，在你們做過的項目中，哪些是M,哪些是V,哪些又是P?

View層負責處理用戶事件和視圖部分的展示。在Android中，它可能是Activity或者Fragment類。
Model層負責訪問數據。數據可以是遠端的Server API，本地數據庫或者SharedPreference等。
Presenter層是連接（或適配）View和Model的橋梁。

本文的重點不是研究什麼是MVP和什麼是MVC,只是想說，不管是在代碼重構的時候還是說開發新項目的時候，都應該采取一種開發模式，一個是方便代碼的維護，另一個就是方便別人閱讀。
就拿之前重構的那個自定義View類來說，不出bug還好一點，一旦出現什麼問題，那是牽一發而動全身啊！代價很大的。

先寫這麼多吧，如果想到什麼以後再補充。
以上都是個人觀點，不當之處，敬請諒解。