Underscore.js 是函式式編程走進 JavaScript 的重要功臣,壓縮後僅約 4KB,卻提供了數十個好用的工具函式,Backbone.js 就是建立在它之上。它把全部方法掛在一個下底線物件 _ 上,大致分為集合、陣列、函式、物件與工具五大類。
瀏覽器直接引入 script 即可;在 Node.js 環境則用 npm 安裝:
npm install underscore
注意 Node 中不宜直接用 _ 當變數名,慣例是另取名稱:
var u = require("underscore");
JavaScript 的集合有陣列與物件兩種形式,以下方法兩者通用。
_.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; });
_.each([1, 2, 3], alert); // 與 map 類似,但不回傳值
把每次的運算結果累積到初始值上,全部跑完後回傳累積值:
_.reduce([1, 2, 3], function (memo, num) { return memo + num; }, 0); // 6
_.filter([1,2,3,4,5,6], function (num) { return num % 2 == 0; }); // [2, 4, 6]
_.reject([1,2,3,4,5,6], function (num) { return num % 2 == 0; }); // [1, 3, 5]
_.every([1,2,3,4,5,6], function (num) { return num % 2 == 0; }); // false
_.some([1,2,3,4,5,6], function (num) { return num % 2 == 0; }); // true
_.find([1,2,3,4,5,6], function (num) { return num % 2 == 0; }); // 2
_.contains([1, 2, 3], 3); // true
_.countBy([1,2,3,4,5], function (n) { return n % 2 == 0 ? 'even' : 'odd'; });
// { odd: 3, even: 2 }
_.shuffle([1, 2, 3, 4, 5, 6]); // 回傳打乱後的新集合
_.size({ one: 1, two: 2, three: 3 }); // 3
_.toArray({ a: 0, b: 1, c: 2 }); // [0, 1, 2]
var stooges = [{ name: 'moe', age: 40 }, { name: 'larry', age: 50 }, { name: 'curly', age: 60 }];
_.pluck(stooges, 'name'); // ["moe", "larry", "curly"]
var o = { p: 2, m: function () { console.log(this.p); } };
o.m(); // 2
_.bind(o.m, { p: 1 })(); // 1,this 被換掉了
var buttonView = {
label: 'underscore',
onClick: function () { alert('clicked: ' + this.label); },
onHover: function () { console.log('hovering: ' + this.label); }
};
_.bindAll(buttonView); // 全部方法都綁定在 buttonView 上
var add = function (a, b) { return a + b; };
var add5 = _.partial(add, 5);
add5(10); // 15
var fibonacci = _.memoize(function (n) {
return n < 2 ? n : fibonacci(n - 1) + fibonacci(n - 2);
});
var log = _.bind(console.log, console);
_.delay(log, 1000, 'logged later'); // 一秒後輸出
_.defer(function () { alert('deferred'); }); // 等目前任務清空後執行
這兩個是效能優化最常用的好朋友:
// 每 100 毫秒最多觸發一次
var throttled = _.throttle(updatePosition, 100);
$(window).scroll(throttled);
// 必須間隔 1 秒,否則忽略,可防止連續雙擊重複送出表單
$("button").on("click", _.debounce(submitForm, 1000));
差別在於:throttle 是「固定頻率執行」,適合 scroll、resize、mousemove;debounce 是「停止後才執行」,適合搜尋建議、表單送出。
var initialize = _.once(createApplication);
initialize(); initialize(); // 實際只會建立一次
var renderNotes = _.after(notes.length, render);
_.each(notes, function (note) { note.asyncSave({ success: renderNotes }); });
var hello = function (name) { return "hello: " + name; };
hello = _.wrap(hello, function (func) {
return "before, " + func("moe") + ", after";
});
hello(); // 'before, hello: moe, after'
var greet = function (name) { return "hi: " + name; };
var exclaim = function (s) { return s + "!"; };
_.compose(exclaim, greet)('moe'); // 'hi: moe!'
_.template(templateString, [data], [settings])
三個參數分別是模板字串、傳入的資料、以及設定。
var txt = "<p><%= word %></p>";
_.template(txt, { word: "Hello World" });
若值可能含 & < > " ' 等特殊字元,改用 <%- %> 自動轉義:
var txt = "<%- word %>";
_.template(txt, { word: "H & W" });
var txt = "<% var i = 0; if (i < 1) { %><%= word %><% } %>";
_.template(txt, { word: "Hello World" });
var list = "<% _.each(people, function (name) { %><%= name %><% }); %>";
_.template(list, { people: ['moe', 'curly', 'larry'] });
只傳第一個參數時,會回傳一個函式,之後可重複傳資料進來,效能更好:
var t1 = _.template("Hello <%=user%>!");
t1({ user: "" });
模板中的所有變數,內部其實都是 obj 物件的屬性,因此下面兩句等價:
_.template("Hello <%=user%>!", { user: "" })
_.template("Hello <%=obj.user%>!", { user: "" })
若要改這個名稱,可在第三個參數指定;因為 template 在變數替換時內部使用 with 語句,這樣做速度較快:
_.template("<%if (data.title) { %>Title: <%= title %><% } %>", null, { variable: "data" });
今天的 ES6+ 已原生提供 map / filter / reduce / some / every,lodash 也成為更完整的選擇。但理解 Underscore 的設計思維——尤其是 throttle、debounce、memoize、compose 這些概念——對寫出乾淨的前端程式碼仍然很有幫助。