天天看點
傳回

開發規範-Android編碼規範Android編碼規範篇

Android編碼規範篇

為什麼需要編碼規範?

編碼規範對于程式員而言尤為重要，有以下幾個原因：

  • 一個軟體的生命周期中，80%的花費在于維護
  • 幾乎沒有任何一個軟體，在其整個生命周期中，均由最初的開發人員來維護
  • 編碼規範可以改善軟體的可讀性，可以讓程式員盡快而徹底地了解新的代碼
  • 如果你将源碼作為産品釋出，就需要确任它是否被很好的打包并且清晰無誤，一如你已建構的其它任何産品

強制性規範:

  • 代碼中的命名均不能以下劃線或美元符号開始，也不能以下劃線或美元符号結束。
  • 代碼中的命名嚴禁使用拼音與英文混合的方式，更不允許直接使用中文的方式。
  • 類名使用UpperCamelCase 風格，必須遵從駝峰形式。
  • 方法名、參數名、成員變量、局部變量都統一使用 lowerCamelCase 風格，必須遵從駝峰形式。
  • 常量命名全部大寫，單詞間用下劃線隔開，力求語義表達完整清楚，不要嫌名字長例如：MAX_STOCK_COUNT。
  • 抽象類命名使用 Abstract 或 Base 開頭;異常類命名使用 Exception 結尾;測試類 命名以它要測試的類的名稱開始。
  • 杜絕不規範的英文縮寫：AbstractClass 縮寫成AbsClass；condition縮寫成condi;此類随意縮寫嚴重降低了代碼的可閱讀性。
  • 如果使用到了設計模式，建議在類名中展現出具體的模式，例如：

public class ComponentFactory

public class BufferStrategy

public class ScrollerProxy

關于Dao層或ArrayList的命名

  • 插入：insert（推薦）或save
  • 删除：delete
  • 修改：update(推薦)或modify
  • 查詢單個對象：get
  • 查詢多個對象：list
  • 實體類必須重載toString()方法，這樣可以通過調用對象的toString()來排查問題。

  • Object 的 equals 方法容易抛空指針異常，應使用常量或确定有值的對象來調用 equals。

    正例:

    "test".equals(object);

     反例:

    object.equals("test");

  • 避免通過一個類的對象引用通路此類的靜态變量或靜态方法，無謂增加編譯器解析成本，直接用類名來通路即可。

    推薦規範：

  • 集合初始化時，盡量指定集合初始值大小；ArrayList盡量使用ArrayList(int initialCapacity) 初始化 。

  • 使用 entrySet 周遊 Map 類集合 KV，而不是 keySet 方式進行周遊

    說明:keySet 其實是周遊了 2 次，一次是轉為 Iterator 對象，另一次是從 hashMap 中取出 key 所對應的 value。而 entrySet 隻是周遊了一次就把 key 和 value 都放到了 entry 中，效 率更高。如果是 JDK8，使用 Map.foreach 方法。

  • 高度注意 Map 類集合 K/V 能不能存儲 null 值的情況，如下表格:
集合類 Key Value Super 說明
Hashtable 不允許為null 不允許為null Dictionary 線程安全
ConcurrentHashMap 不允許為null 不允許為null AbstractMap 分段鎖技術
TreeMap 不允許為null 允許為null AbstractMap 線程不安全
HashMap 允許為null 允許為null AbstractMap 線程不安全
  • 利用 Set 元素唯一的特性，可以快速對一個集合進行去重操作，避免使用 List 的 contains 方法進行周遊、對比、去重操作。
  • 通過雙重檢查鎖(double-checked locking)(在并發場景)實作延遲初始化的優 化問題隐患(可參考 The “Double-Checked Locking is Broken” Declaration),推薦問題 解決方案中較為簡單一種(适用于 JDK5 及以上版本)，将目标屬性聲明為 volatile 型。

反例

class Foo {
    private Helper helper = null;
    
    public Helper getHelper() {
     if (helper == null) 
            synchronized(this) { 
                if (helper == null)
                    helper = new Helper(); 
            } 
            return helper; 
    } // other functions and members... 
     }

應該為：

class Foo {
    private volatile static Helper helper = null;
    
    public Helper getHelper() {
     if (helper == null) 
            synchronized(this) { 
                if (helper == null)
                    helper = new Helper(); 
            } 
            return helper; 
    } // other functions and members... 
     }

Android代碼規範

代碼：

  • Activity 命名一律使用 模功能名+Activity 的方式。例如，LoginActivity、SignupActivity；
  • Fragment 命名一律使用 功能名+Fragment 的方式；
  • 自定義View：Custom(建議)+功能名+View/ViewGroup(具體的元件名稱)。例如：CustomImageScrollerView、CustomRatingBarView。
  • Widget 小元件：ScanView、WeatherView。
  • Dialog對話框：功能名+Dialog。例如：LoginDialog、ProgressDialog
  • 盡量在每一個Activity或類中加入TAG,友善我們檢視Activity的資訊，這裡Android Studio提供了快捷方式logt方式即可快速生成目前類的常量。

  • 對于使用Intent傳遞資料，聲明一些Key的時候：

    EXTRA_KEY_+具體Key名稱，例如我們現在有一個人的名字和年齡要傳那麼首先定義：

    public static final String EXTRA_KEY_PERSON_NAME="extra_key_persion_name"

     然後在具體的頁面

    new Intent()

    ，依次傳遞進去值，這樣寫其實沒什麼問題；但是試想一下，如果你要調用的Activity是類似于一個工具性質或通用的Activity（圖檔選擇器、登入、注冊等等），這時候你要傳遞的key又很多，如果業務複雜的話，你應該會被這樣備援且不易閱讀的代碼直接搞崩潰掉。

    是以最好的辦法就是在你要調用Activity提供一個靜态工廠方法，要知道靜态工廠方法所帶來的好處太多了，由于Activity是不允許通過new的方式來初始化的，是以靜态工廠方法的好處在此就不那麼明顯，但是已經足夠我們優化我們的代碼了。舉個例子，我們有一個筆記 NoteActivity，用于建立筆記和修改筆記

Idprivate static final String EXTRA_KEY_NOTE_ID ="EXTRA_KEY_NOTE_ID" ;//筆記 
private static final String EXTRA_KEY_NOTE_CONTENT ="EXTRA_KEY_NOTE_CONTENT" ;//筆記内容
private static final String EXTRA_KEY_NOTE_MODE ="EXTRA_KEY_NOTE_MODE" ;//筆記模式
//用于建立筆記  
public static void startForCreate(Context context, int noteId) {
   start(context, noteId, null, MODE_CREATE);
}
   //用于編輯筆記
public static void startForEdit(Context context, int noteId, String content) {
   start(context, noteId, content, MODE_UPDATE);
}  
public static void start(Context context, int noteId, String content, int mode) {  
   Intent starter = new Intent(context, TableShareListSettingActivity.class);
   starter.putExtra(EXTRA_KEY_NOTE_ID,noteId);
   starter.putExtra(EXTRA_KEY_NOTE_CONTENT,content);
   starter.putExtra(EXTRA_KEY_NOTE_CONTENT,mode);
   context.startActivity(starter);
}

通過以上方法，我們能夠很好的解耦複雜的Activity之間的調用，再加上靜态方法工廠方法名，代碼可閱讀行大大提高，最終我們看到的調用NoteActivity将會是很簡潔的一段代碼：

NoteActivity.startForCreate(this,noteId);

NoteActivity.startForEdit(this,noteId,content);

此外，Android Studio工具中其實已經在Live Template中提供了這樣的代碼:簡單的輸入starter就可以快速地在目前的Activity中添加一個Intent的靜态操作方法，這其實也說明了Android官方團隊也鼓勵我們這麼做。

  • 增加類注釋 
/**
 * @Title： 
 * @Description：
 * @Author：xuefeng.zhu
 * @Since：${DATE}
 * @Version：1.0.0
 */

設定方式

開發規範-Android編碼規範Android編碼規範篇
  • 所有的常量加上注釋，且功能相同的排放在一起，不同的進行換行；
  • Activity中全局變量采用m開頭+類名。例如，mTable、mPerson；
  • Activity中全局靜态變量采用s開頭+類名。例如：

    private static Handler sHandler
  • Activity中的控件：m+功能名+控件類型名稱。例如，mLoginEditText（mLoginEt）,mLoginTextView（mLoginTv）;
  • 統一Activity中函數的排版規則也能提高我們的閱讀性；列如店播的loginActivity函數排版： 
LoginActivity extends BindingBaseActivity{

     @Override
     protected int getLayoutId() {
         return R.layout.activity_login;
     }
 
     @Override
     protected LoginViewModel getViewModel() {
         return new LoginViewModel(getBinding(), getIntent());
     }
 
     @ClickTrace
     @Override
     public void onClick(View v) {
         super.onClick(v);
         int i = v.getId();
         if (i == R.id.wx_login_tv_layout) { //微信登入
             getBinding().getViewModel().authorize(new Wechat());
         } else if (i == R.id.pick_other_login_way_tv) { //選擇其他登入方式
             getBinding().getViewModel().showLoginWayDialog(this);
         } else if (i == R.id.has_referrer_tv) { //我有推薦人
             requestRecommend();
         } else if (i == R.id.close_iv) {
             finish();
         }
     }

   @Override
   public String getEventCode(int viewId) {
        com.analysis.statistics.http.RequestParams params = new com.analysis.statistics.http.RequestParams();
        params.put(Constant.PAGE, "00100000000");
        if (viewId == R.id.has_referrer_tv) {
            params.put(Constant.ACTION_CODE, "008");
            params.put(Constant.Z_ACTION_CODE, "001");
        }
        //無子操作編碼不上報埋點
        String zActionCode = params.get(Constant.Z_ACTION_CODE);
        if (TextUtils.isEmpty(zActionCode)) {
            return "";
        }
        String code = params.formJsonString();
        params.clear();
        return code;
    }     
 }

先是實作父類的getLayoutId方法，顯示頁面布局；之後傳回目前頁面的viewModel;再然後是頁面的點選事件…最後才是頁面埋點方法；

資源Res

  • 按照資源的類型，分為以下幾種

    命名規則:控件Id命名：功能（name)_控件縮寫(tv)

Resources Type 命名規則
TextView tv_ame
EditText et_name
ImageView iv_name
Button bt_name
ListView lv_name
GridView gv_name
CheckBox cb_name
RadioButton rb_name
LinearLayout ll_name
RelativeLayout rl_name
FrameLayout fl_name
GridLayout gv_name
Color資源命名,String資源命名

命名規則:元件名_具體作用名

Color資源命名

Resources Type 命名規則
color 子產品（具體作用名_color。例R.color.color_text,R.color.color_bg)

String資源命名

Resources Type 命名規則
string 具體功能。 例 R.string.hello

Drawable資源命名

Resources Type 命名規則
launcher icon ic_launcher。例R.drawable.ic_launcher、R.drawable.arrow_left、R.drawable.bg_login
normal icon ic_功能。例R.drawable.ic_audio_pause
Toolbar icon ic_ab_功能名。例如ic_ab_search
selector selector_功能名。例如 selector_login_button
shape shape_子產品功能名狀态。例如 R.drawable.shape_login_button_normal
Layout命名規則

命名規則:功能名_具體作用名

Resources Type 命名規則
activity activity_子產品名。例如 R.layout.activity_login
fragment fragment_子產品名。例如 R.layout.fragment_login_layout_header
include layout_子產品名_功能名。例如 @layout/layout_login_bottom
adapter adapter_item_子產品名_功能名。例R.layout.item_simple_text
dialog dialog_子產品_功能名。例如 R.layout.dialog_time_picker
list header header_子產品_功能。例如 R.layout.header_main_top_ad
list footer footer_子產品_功能。例如 R.layout.footer_main_bottom_action
widget widget_子產品_功能。例如 R.layout.widget_app_clock
Menu資源命名

命名規則:功能名

Resources Type 命名規則
menu 子產品名。例如 login
MenuValues資源命名

命名規則:功能名(login)_元件(color)

Resources Type 命名規則
color color。例如 login_text_color
dimens dimens。例如 dp_12、sp_12
style style。例如 login_text_style
themes themes。例如 login_themes

代碼規範插件安裝

  • checkstyle簡介

    checkstyle是idea中的一個插件，可以很友善的幫我們檢查java代碼中的格式錯誤，它能夠自動化代碼規範檢查過程，進而使得開發人員從這項重要，但是枯燥的任務中解脫出來。

  • 使用步驟

    下載下傳checkstyle插件。在最上方的菜單欄中找到File中的settings，plugins即是下載下傳插件的地方，我們再點選下方的Browse repositories，在其中查找checkstyle，并點選install就可以等待下載下傳成功了

    配置checkstyle檔案。下載下傳好之後我們需要重新開機idea來啟用插件，然後在settings>>Editor>>Inspections中可以确認是否啟用

    接着在settings>>Other settings>>checkstyles的Configration file最右邊有一個加号，點選它來添加配置檔案，配置檔案在項目根目錄，檔案名：code_template

總結：

其實代碼規範隻是一個Guideline，大家遵從規範的目的是為了提高開發效率，并且使得代碼容易閱讀且維護性高！

開發規範
上一篇: 微信公衆開發平台報錯：該公衆号暫時無法提供服務請稍後再試 的解決方案
下一篇: 重構 改善既有代碼的設計（要點總結一）

繼續閱讀