1. 程式人生 > >如何寫出高效可維護並且規範的js程式碼

如何寫出高效可維護並且規範的js程式碼

設計原則:

1.原子思想:即每個function就做一件事;
2.歸納思想:將同一類的操作,全部整合到一起;
3.方便維護:可以便於後來人進行快速維護;
4.方便拓展:即可以根據每個不同的專案進行不同的更改;

5.通用前端設計模式:一些前端可以通用的設計模式

6.注意寫好註釋,將註釋寫的具體點;

具體例項
var gerry =
(function(){
    //建立一個獨立的物件,注入所有的方法,包括你想丟擲去和不想丟擲去的
    var tool = {
        AAAA:function(){},
        BBBB:function(){
            console.log("我只想內部使用,不想給別人用");
        }
    };

    /*
    * 該物件承載所有需要丟擲去的物件
    *   1.該物件中的方法可以自己寫
    *   2.該物件中的方法可以注入(例子中的tempObj.tool.AA)
    *   3.該物件也可以選擇性丟擲給使用者需要的方法,也可以隱藏(tool.BBBB)
    * */
    var tempObj ={
        //reader為一些初始化需要的操作,有時候會有註冊事件等,或者一些預操作
        reader:function(){
        },
        //注入所有的選擇器,方便選擇器變化,直接修改該物件中的選擇器,而不需要全域性去更改
        selector:{
            mySelector:"#mySelector",  //原密碼
        },
        //注入所有的介面地址,方便介面變化可以進行,快速變更,不需要全域性找引用的物件
        interface:{
            loginUrl:"",
        },
        //注入page中所有的事件,統一管理,建議命名規範:事件_命名,例 click_login
        registerEle:{
            click_login:function(){
                //註冊單擊事件
            }
        },
        //注入所有ajax請求,頁面所有請求,將在這裡統一管理,建議命名規範:ajax_命名,例 ajax_login
        /*
        * 該請求中有2種方案,看需求使用
        *  1.不公用一個請求方案
        *  2.公用一個請求,但是回撥處理不一樣
        * */
        ajaxRequest:{
            //不公用一個請求方案
            ajax_login:function(){
                $.post("","",function(data){
                    tempObj.callback.call_login(data);
                });
            },
            //會有多個業務公用這個請求
            ajax_login_T:function(callback){
                //所有介面地址從interface中獲取,callback中tempObj.callback中處理
                $.post("","",callback);
            },
        },
        //處理所有回撥函式,針對一個請求,處理一個回撥
        callback:{
            //不共用請求處理回撥
            call_login:function(data){
                //處理回撥
            },
            //公用請求處理回撥
            call_login_T:function(){
                var temp = function(){

                };
                tempObj.ajaxRequest.ajax_login_T(temp);
            }
        },
        //所有使用的工具類,如果每個專案都單獨的unit.js或者common.js等存放一些公共方法的,這裡可以不使用
        // PS:這裡存放的只是僅針對於這個頁面處理的一些tool,一般沒必要丟擲去,不過看業務而定
        tool:{
            A:function(){
                console.log("我是自己寫的方法");
            },
            AA:tool.AAAA,    //這是我想丟擲去給別人用的東西
        },
        //臨時快取存放區域,僅針對本頁面,如果跨頁面請存放cookie或者localstorage等
        //主要解決有時候會使用頁面控制元件display來快取當前頁面的一些資料
        temp:{

        },
        /*
        * 業務使用區域,針對每個特別的業務去串上面所有的一個個原子
        *   因為上面所有的方法,只是做一件事,這邊可以根據業務進行串服務,很簡單的
        * */
        firm:{

        }
    };

    /*
    * 閉包丟擲去的方法
    * */
    var outputObj =function(){
        //首先執行reader方法,初始化一些操作,比如註冊事件啥啥啥的
        tempObj.reader();
        /*
        * 丟擲給別人使用的物件
        *   想給別人看和使用的東西,可以注入tempObj物件,就像tool中的AA的方式
        *   不想給別人看和使用的東西,就像內部tool物件中的BBBB方法,你內部可以使用,外部是無法引用的
        * */
        return tempObj;
    }

    //丟擲你希望丟擲去的物件,因為你掌控了所有,哈哈。
    return new outputObj();
})();