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

来源:http://www.cnblogs.com/xqxacm/archive/2016/12/02/6126412.html
-Advertisement-
Play Games

前言: 目前工作負責兩個醫療APP項目的開發,同時使用LeanCloud進行雲端配合開發,完全單挑。 現大框架已經完成,正在進行細節模塊上的開發 抽空總結一下Android項目的開發規範:1、編碼規範 2、命名規範 註:個人經驗,經供參考 一、Android編碼規範 1、學會使用string.xml ...


前言:

  目前工作負責兩個醫療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的互相傳值不大會,這裡推薦一個解決方案:Android項目實戰(十三):淺談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

 

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

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

     

   註釋!

  註釋!

   註釋!

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • FCC中的javascript中級演算法題解答 中級演算法的題目中用到了很多js的知識點,比如迭代,閉包,以及對json數據的使用等等,現在將自己中級演算法的解答思路整理出來供大家參考討論。歡迎大家提出新的思路,寫出更簡單的解法。 說明:最小的數字並非總在最前面 如:sumAll([4, 1]) 應該返回 ...
  • <!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title></title> <style type="text/css"> #menu { height: 200px; width: 50px; border: 1px solid gra ...
  • 案例分析:前端自動化 1. 實現一個自動創建前端項目文件的js 通過node.js自動創建前端項目目錄,包括js目錄,js目錄css目錄,index.html和對應的內容。 初步的代碼如下: 2.實現一個對合併文件夾內容的程式 場景描述:在前端開發中,常常需要對幾個文件的代碼進行合併。試想,在伺服器 ...
  • CSS常用標簽 一 CSS文字屬性 color : #999999; /*文字顏色*/ font-family : 宋體,sans-serif; /*文字字體*/ font-size : 9pt; /*文字大小*/ font-style:itelic; /*文字斜體*/ font-variant:s ...
  • 在我的這篇博客裡面說明瞭本地獲得設備udid的方法,但是只能在模擬器中獲得http://www.cnblogs.com/liyy2015/p/6090204.html 當然可以在設備上集成蘋果的MDM獲得設備的很多信息,如果只是想獲得udid,那集成麻煩的mdm就沒必要了 在這裡讓你的手機安裝一個描 ...
  • 一個視圖顯示垂直滾動兩級列表中的條目。這不同於列表視圖,允許兩個層次,類似於QQ的好友分組。要實現這個效果的整體思路為: 1.要給ExpandableListView 設置適配器,那麼必須先設置數據源。 2.數據源,就是此處的適配器類,此方法繼承了BaseExpandableListAdapter, ...
  • ...
  • 當下,隨著移動時代的到來,手機功能逐步完善,各個行業針對這一現象紛紛制定了相應的營銷計劃,於是霎時間興起了一股網上訂票/網上訂飯/網上預約的熱潮。 而對於IT行業,成為企業信息化最火的代名詞莫過於移動辦公了,幾乎所有的軟體廠商都把推廣的重點轉移到移動辦公的市場上,幾乎在同一時間,大量的移動辦公APP ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...