這個應該說是一個習慣吧，不要直接改變?nèi)雲(yún)⒌闹怠＿@個規(guī)則的初衷是解決函數(shù)副作用問題。如果參數(shù)是一個引用類型的數(shù)據(jù)，如果在函數(shù)內(nèi)修改了參數(shù)，到時候?qū)沟迷镜臄?shù)據(jù)發(fā)生改變，往往會發(fā)生難以追蹤的問題。

參數(shù)的數(shù)量，個人建議就是，超過3個，使用對象進行封裝。因為如果API參數(shù)越多，那么使用對于這個API的記憶成本就越大，易用性也很受影響。

比如下面的例子：

encryptStr: function (str, regArr, type, replacement) {
    var regtext = "",
        Reg = null,
        _type=type||0,
        replaceText = replacement || "*";
    //ecDo.encryptStr("18819322663",[3,5,3],0)
    //result：188*****663
    //repeatStr是在上面定義過的（字符串循環(huán)復制），大家注意哦
    if (regArr.length === 3 && type === 0) {
        regtext = "(w{" + regArr[0] + "})w{" + regArr[1] + "}(w{" + regArr[2] + "})"
        Reg = new RegExp(regtext);
        var replaceCount = this.repeatStr(replaceText, regArr[1]);
        return str.replace(Reg, "$1" + replaceCount + "$2")
    }
    //ecDo.encryptStr("asdasdasdaa",[3,5,3],1)
    //result：***asdas***
    else if (regArr.length === 3 && type === 1) {
        regtext = "w{" + regArr[0] + "}(w{" + regArr[1] + "})w{" + regArr[2] + "}"
        Reg = new RegExp(regtext);
        var replaceCount1 = this.repeatStr(replaceText, regArr[0]);
        var replaceCount2 = this.repeatStr(replaceText, regArr[2]);
        return str.replace(Reg, replaceCount1 + "$1" + replaceCount2)
    }
    //ecDo.encryptStr("1asd88465asdwqe3",[5],0)
    //result：*****8465asdwqe3
    else if (regArr.length === 1 && type === 0) {
        regtext = "(^w{" + regArr[0] + "})"
        Reg = new RegExp(regtext);
        var replaceCount = this.repeatStr(replaceText, regArr[0]);
        return str.replace(Reg, replaceCount)
    }
    //ecDo.encryptStr("1asd88465asdwqe3",[5],1,"+")
    //result："1asd88465as+++++"
    else if (regArr.length === 1 && type === 1) {
        regtext = "(w{" + regArr[0] + "}$)"
        Reg = new RegExp(regtext);
        var replaceCount = this.repeatStr(replaceText, regArr[0]);
        return str.replace(Reg, replaceCount)
    }
}

大家可以看上面的注釋，就知道這段代碼的具體作用了，如果想想就找個參數(shù)，我必須要除了記得4個參數(shù)的作用，還要記得參數(shù)的順序。

如果使用對象記錄參數(shù)，用戶只需要記得4個參數(shù)的作用，不需要記參數(shù)的順序。

encryptStr: function (obj) {
        var _default={
            type:0,
            replacement:"*"
        };
        for(var key in obj){
            _default[key]=obj[key];
        }
},

//調(diào)用方式
ecDo.encryptStr({str:"18819266335",regArr:[5],type:0,replacement:"-"});

這樣還有一個好處就是，比如像剛才的函數(shù)，type這個參數(shù)，我想保留默認值，偷懶不傳。原來的方案，就得這樣傳。

ecDo.encryptStr("1asd88465asdwqe3",[5],"","+");

這樣肯定是會激起不少有代碼潔癖的開發(fā)者，比如我。如果使用對象，就很好避免了。

ecDo.encryptStr({str:"18819266335",regArr:[5],replacement:"-"});

這個應該沒什么可能，就一個意思：必填重要的參數(shù)前置，可省略的參數(shù)后置。

比如下面的例子

/格式化處理字符串
//ecDo.formatText("1234asda567asd890")
//result："12,34a,sda,567,asd,890"
//ecDo.formatText("1234asda567asd890",4," ")
//result："1 234a sda5 67as d890"
//ecDo.formatText("1234asda567asd890",4,"-")
//result："1-234a-sda5-67as-d890"
formatText: function (str, size, delimiter) {
    var _size = size || 3, _delimiter = delimiter || ",";
    var regText = "B(?=(w{" + _size + "})+(?!w))";
    var reg = new RegExp(regText, "g");
    return str.replace(reg, _delimiter);
},

調(diào)用大家都看得出來。如果API這樣設計

formatText: function (size, delimiter, str) {
    var _size = size || 3, _delimiter = delimiter || ",";
    var regText = "B(?=(w{" + _size + "})+(?!w))";
    var reg = new RegExp(regText, "g");
    return str.replace(reg, _delimiter);
},

就得這樣調(diào)用，如果這樣寫API，被批斗的可能性很大！

ecDo.formatText("","","1234asda567asd890")

比如這個例子，頁面有這樣的元素

有一個類似jQuery的css這個API的API。

css: function (dom, json) {
    for (var attr in json) {
        dom.style[attr] = json[attr];
    }
}

然后給這些div設置樣式的時候，代碼如下

var oDiv1 =document.querySelectorAll(".div1");
var oDiv2=document.querySelector("#div1");
ecDo.css(oDiv2,{"height":"100px","width":"100px","background":"#333"});
ecDo.css(oDiv1,{"height":"100px","width":"100px","background":"#09f"});

當運行到ecDo.css(oDiv1,{"height":"100px","width":"100px","background":"#09f"});會提示報錯，原因大家也知道。css這個API里面，只處理了單個元素，并沒有處理元素的集合。

建議的方式是把 css 這個API改成可批量處理元素集合的。

css: function (dom, json) {
    if (dom.length) {
        for (var i = 0; i < dom.length; i++) {
            for (var attr in json) {
                dom[i].style[attr] = json[attr];
            }
        }
    }
    else {
        for (var attr in json) {
            dom.style[attr] = json[attr];
        }
    }
},    
   

一個類似jQuery的html這個API的API-html

之前遇到一個開發(fā)者的處理方式是：獲取元素的innerHTML和設置元素innerHTML分開為兩個方法-getHtml，setHtml。這樣的問題又在于記憶的成本比原生的 innerHTML 還要高。建議的姿勢就是，獲取和設置用同一個API。

html: function (dom) {
    if (arguments.length === 1) {
        return dom.innerHTML;
    } else if (arguments.length === 2) {
        dom.innerHTML = arguments[1];
    }
}

ecDo.html(oDiv);//獲取
ecDo.html(oDiv,"守候");//設置

可擴展性，就是建議遵守開放-封閉原則。對擴展開放，對修改關(guān)閉。比如jQuery的$.fn和$.fn.extend()。

說一個簡單的例子-計算加薪額度

var addMoney = (function () {
    //定義策略類
    var strategies = {
        A:function(money){
            return money + 2000;
        },
        B:function(money){
            return money + 1000;
        }
    };
    //暴露接口
    return {
        //根據(jù)等級和現(xiàn)工資，輸入加薪后的工資
        compute:function(lv,money){
            return strategies[lv](money)
        }
    };
})();

//比如：等級為A，5000+2000
console.log(addMoney.compute("A",5000))//7000
//比如：等級為B，20000+1000
console.log(addMoney.compute("B",20000))//21000

代碼看著沒有問題，但是如果以后需求要增加C等級呢？這就不得不修改strategies。在里面增加方法。
如下

var strategies = {
    A:function(money){
        return money + 2000;
    },
    B:function(money){
        return money + 1000;
    },
    C:function(money){
        return money + 500;
    }
};

這樣實現(xiàn)也簡單，如果以后要增加S等級呢？又得改strategies。這里還有一個問題就是，如果增加的C等級只有在A模塊需要用到，在B模塊不會出現(xiàn)，那么在B模塊引用addMoney的時候，又會把C等級的計算方式也引入進去，造成不必要的資源浪費。
建議的方式是，設置一個接口，擴展strategies。

var addMoney = (function () {
    //定義策略類
    let strategies = {
        A:function(money){
            return money + 2000;
        },
        B:function(money){
            return money + 1000;
        }
    };
    //暴露接口
    return {
        //根據(jù)等級和現(xiàn)工資，輸入加薪后的工資
        compute:function(lv,money){
            return strategies[lv](money)
        },
        //擴展等級
        addRule:function(lv,fn){
            strategies[lv]=fn;
        }
    };
})();
//增加C等級的調(diào)用
addMoney.addRule("C",function(money){
    return money + 500;
});
console.log(addMoney.compute("C",20000))//20500    

函數(shù)的副作用，相信很多人都會遇到過，比如在一個函數(shù)體內(nèi)修改一個外部作用域的變量，或者全局變量，在函數(shù)體內(nèi)修改引用類型的參數(shù)，這些情況多少都會遇到過。

如何避免呢？主要是以下兩個寫代碼習慣。

1.函數(shù)體內(nèi)可以使用參數(shù)，進行操作，但是不能修改。如果修改，用一個臨時變量記錄參數(shù)（如果是引用類型，需要用深拷貝記錄）。這樣可以避免直接修改參數(shù)。

2.對于函數(shù)外的變量，如全局變量。函數(shù)體內(nèi)可以訪問，但是不能修改。

3.如果需要給函數(shù)外的變量賦值，不能在函數(shù)體內(nèi)操作，把值返回到外部，在外部進行賦值。（感覺這里有點啰嗦，因為賦值了，就是修改了外部變量，就違反了第二點）。

//不好做法
var myName="";
function setName(firstName,lastName){
    myName=firstName+lastName;
}
setName("守","侯");
//推薦做法
var myName="";
function setName(firstName,lastName){
    return firstName+lastName;
}
myName=setName("守","侯");

這個建議主要就是為了兼顧以前的寫法。還是拿上面的那個例子吧！
原本傳參方式是這樣

encryptStr: function (str, regArr, type, replacement) {};

后來升級改成這樣

encryptStr: function (obj){}

這樣問題就來了，一個項目里面，因為歷史的原因難免會使用這個API，并且使用了第一種方式傳參。現(xiàn)在API改了，解決的方案有兩個，要么把整個項目使用的這個API的方式，都改成第二種的傳參方式，要么就是對接口進行向下兼容，兼容以前的方案。

encryptStr: function (obj) {
    var _default={
        type:0,
        replacement:"*"
    };
    //如果還是以之前的方式調(diào)用函數(shù)，兼容性判斷
    if(arguments.length>1){
        _default.str=arguments[0];
        _default.regArr=arguments[1];
        _default.type=arguments[2]||0;
        _default.replacement=arguments[3]||"*";
    }
    else{
        for(var key in obj){
            _default[key]=obj[key];
        }
    }
    //下面代碼略
},

如果API已經(jīng)準備來一個大版本的更新，（比如從1.0.0升級到2.0.0，不是1.0.0升級到1.0.1，或者1.0.0升級到1.1.0）。不打算兼容以前的版本了。可以忽略這一步，畢竟兼容性的代碼可能也很多。

這一步可以說是API設計最高級的一步，也是最難開發(fā)的一步，這就是為什么這篇文章會帶有‘大道至簡’的字樣，即使API的實現(xiàn)很難，但使用起來簡單感覺就是高級的API。這一步也直接影響API的好用與否。簡單的API不但是用起來簡單，試試可以一看就懂的API。這樣的API更易理解、記憶、調(diào)試和變更使用方式。

原生的API，比如Date，some、map、find等所有數(shù)組遍歷操作函數(shù)，es6提供的Object.assign，Object.keys，Object.values等。

曾經(jīng)的霸主jQuery，現(xiàn)在的王者react，黑馬vue。這些項目讓人拍手稱贊的原因雖然有很多，但也不可否認的，那便是它們的API設計非常的巧妙。如：jQuery的$,siblings,toogleClass,animate等，react的cloneElement,replaceProps等，vue的nextTick,set等。

jQuery對于現(xiàn)在而言，雖然是過時了，但里面的知識還是值得學習，比如使用的淋漓盡致的 js 寫作技巧，設計模式，以及 API 設計等。

自己寫的API，我也是把API寫得盡量的簡單，最高境界就是讓別人掃一眼文檔，就知道記牢了API的使用方式。這個是我追求的目標，只是現(xiàn)在距離還是有點遠。大家看我encryptStr這個API就知道（此處尷尬一天）。

在我的眼里，一個好的API，會有一個一看就懂的名字，一個強大的功能，一個簡單的調(diào)用方式。雖然只有三個條件，但是這三個條件結(jié)合起來，可不是那么容易做到的。一個好的API，無論是對自己，對團隊，對項目開發(fā)都是一個很好的幫助。

對于設計API的一些個人建議，就到這里了，如果以后有更好的想法，會第一時間分享，和大家交流意見。如果大家有什么想法，歡迎指點迷津。

---------------------------華麗的分割線--------------------------------

想了解更多，關(guān)注我的微信公眾號-守候書閣