Underscore.js是一個很精干的庫,壓縮后只有4KB。它提供了幾十種函數式編程的方法,彌補了標准庫的不足,大大方便了javaScript的編程。MVC框架Backbone.js就將這個庫作為自己的工具庫。除了可以在瀏覽器環境使用,Underscore.js還可以用於Node.js。
Underscor.js定義了一個下划線(_)對象,函數庫的所有方法都屬於這個對象。這些方法大致上可以分成:集合(collection)、數組(array)、函數(function)、對象(object)和工具(utility)五大類。
集合相關方法
javascript語言的數據集合,包括兩種結構:數組和對象。以下的方法同時適用於這兩種結構。
數組處理
數組處理指的是對數組元素進行加工。
map方法對集合的每個成員依次進行某種操作,將返回的值依次存入一個新的數組。
-
_.map([1, 2, 3], function(num){ return num * 3; }); // [3, 6, 9] _.map({one : 1, two : 2, three : 3}, function(num, key){ return num * 3; }); // [3, 6, 9]
each方法與map類似,依次對數組所有元素進行某種操作,不返回任何值。
-
_.each([1, 2, 3], alert); _.each({one : 1, two : 2, three : 3}, alert);
reduce方法依次對集合的每個成員進行某種操作,然后將操作結果累計在某一個初始值之上,全部操作結束之后,返回累計的值。該方法接受三個參數。第一個參數是被處理的集合,第二個參數是對每個成員進行操作的函數,第三個參數是累計用的變量。
-
_.reduce([1, 2, 3], function(memo, num){ return memo + num; }, 0); // 6
reduce方法的第二個參數是操作函數,它本身又接受兩個參數,第一個是累計用的變量,第二個是集合每個成員的值。
shuffle方法返回一個打亂次序的集合。
-
_.shuffle([1, 2, 3, 4, 5, 6]); // [4, 1, 6, 3, 5, 2]
數組特征
Underscore.js提供了一系列方法,判斷數組元素的特征。這些方法都返回一個布爾值,表示是否滿足條件。
every方法判斷數組的所有元素是否都滿足某個條件。如果都滿足則返回true,否則返回false。
-
_.every([1, 2, 3, 4, 5, 6], function(num){ return num % 2 == 0; }); // false
some方法則是只要有一個元素滿足,就返回true,否則返回false。
-
_.some([1, 2, 3, 4, 5, 6], function(num){ return num % 2 == 0; }); // true
size方法返回集合的成員數量。
-
_.size({one : 1, two : 2, three : 3}); // 3
數組過濾
Underscore.js提供了一系列方法,用於過濾數組,找到符合要求的成員。
filter方法依次對集合的每個成員進行某種操作,只返回操作結果為true的成員。
-
_.filter([1, 2, 3, 4, 5, 6], function(num){ return num % 2 == 0; }); // [2, 4, 6]
reject方法只返回操作結果為false的成員。
-
_.reject([1, 2, 3, 4, 5, 6], function(num){ return num % 2 == 0; }); // [1, 3, 5]
find方法依次對集合的每個成員進行某種操作,返回第一個操作結果為true的成員。如果所有成員的操作結果都為false,則返回undefined。
-
_.find([1, 2, 3, 4, 5, 6], function(num){ return num % 2 == 0; }); // 2
contains方法表示如果某個值在數組內,則返回true,否則返回false。
-
_.contains([1, 2, 3], 3); // true
countBy方法依次對集合的每個成員進行某種操作,將操作結果相同的成員算作一類,最后返回一個對象,表明每種操作結果對應的成員數量。
-
_.countBy([1, 2, 3, 4, 5], function(num) { return num % 2 == 0 ? 'even' : 'odd'; }); // {odd: 3, even: 2}
對象相關方法
toArray方法將對象轉為數組,只包含對象成員的值。典型應用是將對類似數組的對象轉為真正的數組。
-
_.toArray({a:0,b:1,c:2}); // [0, 1, 2]
pluck方法將多個對象的某一個屬性的值,提取成一個數組。
-
var stooges = [{name : 'moe', age : 40}, {name : 'larry', age : 50}, {name : 'curly', age : 60}]; _.pluck(stooges, 'name'); // ["moe", "larry", "curly"]
與函數相關的方法
綁定運行環境和參數
在不同的運行環境下,javaScript函數內部的變量所在的上下文是不同的。這種特性會給程序帶來不確定性,為了解決這個問題,Underscore.js提供了兩個方法,用來給函數綁定上下文。
(1)bind方法
該方法綁定函數運行時的上下文,返回一個新函數。
-
var o = { p: 2, m: function (){console.log(this.p);} }; o.m() // 2 _.bind(o.m,{p:1})() // 1
上面代碼將o.m方法綁定到一個新的對象上面。
除了前兩個參數以外,bind方法還可以接受更多參數,它們表示函數方法運行時所需的參數。
-
var add = function(n1,n2,n3) { console.log(this.sum + n1 + n2 + n3); }; _.bind(add, {sum:1}, 1, 1, 1)() // 4
上面代碼中bind方法有5個參數,最后那三個是給定add方法的運行參數,所以運行結果為4。
(2)bindall方法
該方法可以一次將多個方法,綁定在某個對象上面。
-
var o = { p1 : '123', p2 : '456', m1 : function() { console.log(this.p1); }, m2 : function() { console.log(this.p2); }, }; _.bindAll(o, 'm1', 'm2');
上面代碼一次性將兩個方法(m1和m2)綁定在o對象上面。
(3)partial方法
除了綁定上下文,Underscore.js還允許綁定參數。partial方法將函數與某個參數綁定,然后作為一個新函數返回。
-
var add = function(a, b) { return a + b; }; add5 = _.partial(add, 5); add5(10); // 15
(4)wrap方法
該方法將一個函數作為參數,傳入另一個函數,最終返回前者的一個新版本。
-
var hello = function(name) { return "hello: " + name; }; hello = _.wrap(hello, function(func) { return "before, " + func("moe") + ", after"; }); hello(); // 'before, hello: moe, after'
上面代碼先定義hello函數,然后將hello傳入一個匿名定義,返回一個新版本的hello函數。
(5)compose方法
該方法接受一系列函數作為參數,由后向前依次運行,上一個函數的運行結果,作為后一個函數的運行參數。也就是說,將f(g(),h())的形式轉化為f(g(h()))。
-
var greet = function(name){ return "hi: " + name; }; var exclaim = function(statement){ return statement + "!"; }; var welcome = _.compose(exclaim, greet); welcome('moe'); // 'hi: moe!'
上面代碼調用welcome時,先運行greet函數,再運行exclaim函數。並且,greet函數的運行結果是exclaim函數運行時的參數。
函數運行控制
Underscore.js允許對函數運行行為進行控制。
(1)memoize方法
該方法緩存一個函數針對某個參數的運行結果。
-
var fibonacci = _.memoize(function(n) { return n < 2 ? n : fibonacci(n - 1) + fibonacci(n - 2); });
(2)delay方法
該方法可以將函數推遲指定的時間再運行。
-
var log = _.bind(console.log, console); _.delay(log, 1000, 'logged later'); // 'logged later'
上面代碼推遲1000毫秒,再運行console.log方法,並且指定參數為“logged later”。
(3)defer方法
該方法可以將函數推遲到待運行的任務數為0時再運行,類似於setTimeout推遲0秒運行的效果。
-
_.defer(function(){ alert('deferred'); });
(4)throttle方法
該方法返回一個函數的新版本。連續調用這個新版本的函數時,必須等待一定時間才會觸發下一次執行。
-
// 返回updatePosition函數的新版本 var throttled = _.throttle(updatePosition, 100); // 新版本的函數每過100毫秒才會觸發一次 $(window).scroll(throttled);
(5)debounce方法
該方法返回的新函數有調用的時間限制,每次調用必須與上一次調用間隔一定的時間,否則就無效。它的典型應用是防止用戶雙擊某個按鈕,導致兩次提交表單。
-
$("button").on("click", _.debounce(submitForm, 1000, true));
上面代碼表示click事件發生后,調用函數submitForm的新版本。該版本的兩次運行時間,必須間隔1000毫秒以上,否則第二次調用無效。最后那個參數true,表示click事件發生后,立刻觸發第一次submitForm函數,否則就是等1000毫秒再觸發。
(6)once方法
該方法返回一個只能運行一次的新函數。該方法主要用於對象的初始化。
-
var initialize = _.once(createApplication); initialize(); initialize(); // Application只被創造一次
(7)after方法
該方法返回的新版本函數,只有在被調用一定次數后才會運行,主要用於確認一組操作全部完成后,再做出反應。
-
var renderNotes = _.after(notes.length, render); _.each(notes, function(note) { note.asyncSave({success: renderNotes}); });
上面代碼表示,函數renderNotes是函數render的新版本,只有調用notes.length次以后才會運行。所以,后面就可以放心地等到notes的每個成員都處理完,才會運行一次renderNotes。
工具方法
鏈式操作
Underscore.js允許將多個操作寫成鏈式的形式。
-
_.(users) .filter(function(user) { return user.name === name }) .sortBy(function(user) { return user.karma }) .first() .value()
template
該方法用於編譯html模板。它接受三個參數。
-
_.template(templateString, [data], [settings])
三個參數的含義如下:
- templateString:模板字符串
- data:輸入模板的數據
- settings:設置
(1)templateString
模板字符串templateString就是普通的html語言,其中的變量使用<%= … %>的形式插入;data對象負責提供變量的值。
-
var txt = "<h2><%= word %></h2>"; _.template(txt, {word : "Hello World"}) // "<h2>Hello World</h2>"
如果變量的值包含五個特殊字符(& < > ” ‘ /),就需要用<%- … %>轉義。
-
var txt = "<h2><%- word %></h2>"; _.template(txt, {word : "H & W"}) // <h2>H & W</h2>
JavaScript命令可以采用<% … %>的形式插入。下面是判斷語句的例子。
-
var txt = "<% var i = 0; if (i<1){ %>" + "<%= word %>" + "<% } %>"; _.template(txt, {word : "Hello World"}) // Hello World
常見的用法還有循環語句。
-
var list = "<% _.each(people, function(name) { %> <li><%= name %></li> <% }); %>"; _.template(list, {people : ['moe', 'curly', 'larry']}); // "<li>moe</li><li>curly</li><li>larry</li>"
如果template方法只有第一個參數templateString,省略第二個參數,那么會返回一個函數,以后可以向這個函數輸入數據。
-
var t1 = _.template("Hello <%=user%>!"); t1({ user: "<Jane>" }) // 'Hello <Jane>!'
(2)data
templateString中的所有變量,在內部都是obj對象的屬性,而obj對象就是指第二個參數data對象。下面兩句語句是等同的。
-
_.template("Hello <%=user%>!", { user: "<Jane>" }) _.template("Hello <%=obj.user%>!", { user: "<Jane>" })
如果要改變obj這個對象的名字,需要在第三個參數中設定。
-
_.template("<%if (data.title) { %>Title: <%= title %><% } %>", null, { variable: "data" });
因為template在變量替換時,內部使用with語句,所以上面這樣的做法,運行速度會比較快。