Underscore.js 入门

1 Underscore对象封装

Underscore并无在原生的JavaScript对象原型中进行扩展，而是像jQuery同样，将数据封装在一个自定义对象中（下文中称“Underscore对象”）。

你能够经过调用一个Underscore对象的value()方法来获取原生的JavaScript数据，例如：

// 定义一个JavaScript内置对象  
var jsData = {  
    name : 'data'  
}  
 
// 经过_()方法将对象建立为一个Underscore对象  
// underscoreData对象的原型中包含了Underscore中定义的全部方法，你能够任意使用  
var underscoreData = _(jsData);  
 
// 经过value方法获取原生数据, 即jsData  
underscoreData.value();

2 优先调用JavaScript 1.6内置方法

Underscore中有许多方法在JavaScript1.6中已经被归入规范，所以在Underscore对象内部，会优先调用宿主环境提供的内置方法（若是宿主环境已经实现了这些方法），以此提升函数的执行效率。

而对于不支持JavaScript 1.6的宿主环境，Underscore会经过本身的方式实现，而对开发者来讲，这些彻底是透明的。

这里所说的宿主环境，多是Node.js运行环境，或客户端浏览器。

3 改变命名空间

Underscore默认使用_（下划线）来访问和建立对象，但这个名字可能不符合咱们的命名规范，或容易引发命名冲突。

咱们能够经过noConflict()方法来改变Underscore的命名，并恢复_（下划线）变量以前的值，例如：

<script type="text/javascript">  
    var _ = '自定义变量';  
</script>  
<script type="text/javascript" src="underscore/underscore-min.js"></script>  
<script type="text/javascript">  
    // Underscore对象  
    console.dir(_);  
    // 将Underscore对象重命名为us, 后面都经过us来访问和建立Underscore对象  
    var us = _.noConflict();  
    // 输出"自定义变量"  
    console.dir(_);  
</script>

4 链式操做

还记得咱们在jQuery中是如何进行连接操做吗？例如：

$('a')  
    .css('position', 'relative')  
    .attr('href', '#')  
    .show();

Underscore一样支持链式操做，但你须要先调用chain()方法进行声明：

var arr = [10, 20, 30];  
_(arr)  
    .chain()  
    .map(function(item){ return item++; })  
    .first()  
    .value();

若是调用了chain()方法，Underscore会将所调用的方法封装在一个闭包内，并将返回值封装为一个Underscore对象并返回：

// 这是Underscore中实现链式操做的关键函数，它将返回值封装为一个新的Underscore对象，并再次调用chain()方法，为方法链中的下一个函数提供支持。  
var result = function(obj, chain) {  
    return chain ? _(obj).chain() : obj;  
}

5 扩展Underscore

咱们能够经过mixin()方法轻松地向Underscore中扩展自定义方法，例如：

_.mixin({  
    method1: function(object) {  
        // todo  
    },  
    method2: function(arr) {  
        // todo  
    },  
    method3: function(fn) {  
        // todo  
    }  
});

这些方法被追加到Underscore的原型对象中，全部建立的Underscore对象均可以使用这些方法，它们享有和其它方法一样的环境。

6 遍历集合

each()和map()方法是最经常使用用到的两个方法，它们用于迭代一个集合（数组或对象），并依次处理集合中的每个元素，例如：

var arr = [1, 2, 3];  
 
_(arr).map(function(item, i) {  
    arr[i] = item + 1;  
});  
 
var obj = {  
    first : 1,  
    second : 2  
}  
 
_(obj).each(function(value, key) {  
    return obj[key] = value + 1;  
});

map()方法与each()方法的做用、参数相同，但它会将每次迭代函数返回的结果记录到一个新的数组并返回。

7 函数节流

函数节流是指控制一个函数的执行频率或间隔（就像控制水流的闸门同样），Underscore提供了debounce()和throttle()两个方法用于函数节流。

为了更清楚地描述这两个方法，假设咱们须要实现两个需求：

　　需求1：当用户在文本框输入搜索条件时，自动查询匹配的关键字并提示给用户（就像在Tmall输入搜索关键字时那样）

首先分析第1个需求，咱们能够绑定文本框的keypress事件，当输入框内容发生变化时，查询匹配关键字并展现。假设我想查询“windows phone”，它包含13个字符，而我输入完成只花了1秒钟（好像有点快，就意思意思吧），那么在这1秒内，调用了13次查询方法。这是一件很是恐怖的事情，若是Tmall也这样实现，我担忧它会不会在光棍节到来以前就挂掉了（固然，它并无这么脆弱，但这绝对不是最好的方案）

更好的方法是，咱们但愿用户已经输入完成，或者正在等待提示（也许他懒得再输入后面的内容）的时候，再查询匹配关键字。

最后咱们发现，在咱们指望的这两种状况下，用户会暂时中止输入，因而咱们决定在用户暂停输入200毫秒后再进行查询（若是用户在不断地输入内容，那么咱们认为他可能很明确本身想要的关键字，因此等一等再提示他）

这时，利用Underscore中的debounce()函数，咱们能够轻松实现这个需求：

<input type="text" id="search" name="search" />  
<script type="text/javascript">  
    var query = _(function() {  
        // 在这里进行查询操做  
    }).debounce(200);  
 
    $('#search').bind('keypress', query);  
</script>

你能看到，咱们的代码很是简洁，节流控制在debounce()方法中已经被实现，咱们只告诉它当query函数在200毫秒内没有被调用过的话，就执行咱们的查询操做，而后再将query函数绑定到输入框的keypress事件。

query函数是怎么来的？咱们在调用debounce()方法时，会传递一个执行查询操做的函数和一个时间（毫秒数），debounce()方法会根据咱们传递的时间对函数进行节流控制，并返回一个新的函数（即query函数），咱们能够放心大胆地调用query函数，而debounce()方法会按要求帮咱们作好控制。

　　需求2：当用户拖动浏览器滚动条时，调用服务器接口检查是否有新的内容

再来分析第2个需求，咱们能够将查询方法绑定到window.onscroll事件，但这显然不是一个好的作法，由于用户拖动一次滚动条可能会触发几十次甚至上百次onscroll事件。

咱们是否可使用上面的debounce()方法来进行节流控制？当用户拖动滚动条完毕后，再查询新的内容？但这与需求不符，用户但愿在拖动的过程当中也能看到新内容的变化。

所以咱们决定这样作：用户在拖动时，每两次查询的间隔很多于500毫秒，若是用户拖动了1秒钟，这可能会触发200次onscroll事件，但咱们最多只进行2次查询。

利用Underscore中的throttle()方法，咱们也能够轻松实现这个需求：

<script type="text/javascript">  
    var query = _(function() {  
        // 在这里进行查询操做  
    }).throttle(500);  
 
    $(window).bind('scroll', query);  
</script>

代码仍然十分简洁，由于在throttle()方法内部，已经为咱们实现的全部控制。

你可能已经发现，debounce()和throttle()两个方法很是类似（包括调用方式和返回值），做用却又有不一样。

它们都是用于函数节流，控制函数不被频繁地调用，节省客户端及服务器资源。

• debounce()方法关注函数执行的间隔，即函数两次的调用时间不能小于指定时间。
• throttle()方法更关注函数的执行频率，即在指定频率内函数只会被调用一次。

5.8 模板解析

Underscore提供了一个轻量级的模板解析函数，它能够帮助咱们有效地组织页面结构和逻辑。

我将经过一个例子来介绍它：

<!-- 用于显示渲染后的标签 -->  
<ul id="element"></ul>  
 
<!-- 定义模板，将模板内容放到一个script标签中 -->  
<script type="text/template" id="tpl">  
    <% for(var i = 0; i < list.length; i++) { %>  
        <% var item = list[i] %>  
        <li>  
            <span><%=item.firstName%> <%=item.lastName%></span>  
            <span><%-item.city%></span>  
        </li>  
    <% } %>  
</script>  
<script type="text/javascript" src="underscore/underscore-min.js"></script>  
<script type="text/javascript">  
    // 获取渲染元素和模板内容  
    var element = $('#element'),  
        tpl = $('#tpl').html();  
 
    // 建立数据, 这些数据多是你从服务器获取的  
    var data = {  
        list: [  
            {firstName: '<a href="#">Zhang</a>', lastName: 'San', city: 'Shanghai'},  
            {firstName: 'Li', lastName: 'Si', city: '<a href="#">Beijing</a>'},  
            {firstName: 'Wang', lastName: 'Wu', city: 'Guangzhou'},  
            {firstName: 'Zhao', lastName: 'Liu', city: 'Shenzhen'}  
        ]  
    }  
 
    // 解析模板, 返回解析后的内容  
    var html = _.template(tpl, data);  
    // 将解析后的内容填充到渲染元素  
    element.html(html);  
</script>

在本例中，咱们将模板内容放到一个<script>标签中，你可能已经注意到标签的type是text/template而不是text/javascript，由于它没法做为JavaScript脚本直接运行。

我也建议你将模板内容放在<script>中，由于若是你将它们写在一个<div>或其它标签中，它们可能会被添加到DOM树中进行解析（即便你隐藏了这个标签也没法避免）。

 

_.template模板函数只能解析3种模板标签（这比Smarty、JSTL要简单得多）：

<%  %>：用于包含JavaScript代码，这些代码将在渲染数据时被执行。

<%= %>：用于输出数据，能够是一个变量、某个对象的属性、或函数调用（将输出函数的返回值）。

<%- %>：用于输出数据，同时会将数据中包含的HTML字符转换为实体形式（例如它会将双引号转换为&quot;形式），用于避免XSS攻击。

当咱们但愿将数据中的HTML做为文本显示出来时，经常会使用<%- %>标签。

Underscore还容许你修改这3种标签的形式，若是咱们想使用{% %}、{%= %}、{%- %}做为标签，能够经过修改templateSettings来实现，就像这样：

_.templateSettings = {  
    evaluate : /\{%([\s\S]+?)\%\}/g,  
    interpolate : /\{%=([\s\S]+?)\%\}/g,  
    escape : /\{%-([\s\S]+?)%\}/g  
}

在本例中，咱们将模板内容和须要填充的数据传递给template方法，它会按如下顺序进行处理：

• 将模板内容解析为可执行的JavaScript（解析模板标签）
• 经过with语句将解析后的JavaScript做用域修改成咱们传递的数据对象，这使咱们可以直接在模板中经过变量形式访问数据对象的属性
• 执行解析后的JavaScript（将数据填充到模板）
• 返回执行后的结果

咱们常常会遇到一种状况：屡次调用template方法将数据渲染到同一个模板。

假设咱们有一个分页列表，列表中的每一条数据都经过模板渲染，当用户进入下一页，咱们会获取下一页的数据并从新渲染，实际上每次渲染的模板都是同一个，但刚才描述的template全部处理过程总会被执行。

其实Underscore的template方法提供了一种更高效的调用方式，咱们将上面代码中的最后两句修改成：

// 解析模板, 返回解析后的内容  
var render = _.template(tpl);  
var html = render(data);  
// 将解析后的内容填充到渲染元素  
element.html(html);

你会发现细微的差异：咱们在调用template方法时只传递了模板内容，而没有传递数据，此时template方法会解析模板内容，生成解析后的可执行JavaScript代码，并返回一个函数，而函数体就是解析后的JavaScript，所以当咱们调用该函数渲染数据时，就省去了模板解析的动做。

你应该将返回的函数存储起来（就像我将它存储在render变量中同样），再经过调用该函数来渲染数据，特别是在同一个模板可能会被屡次渲染的状况下，这样作能提升执行效率（具体提高多少，应该根据你的模板长度和复杂度而定，但不管如何，这都是一个良好的习惯）。