引言
1. manually

以前，我新開一個網(wǎng)頁項目，然后想到要用jQuery，我會打開瀏覽器，然后找到j(luò)Query的官方網(wǎng)站，點擊那個醒目的“Download jQuery”按鈕，下載到.js文件，然后把它丟在項目目錄里。在需要用到它的地方，這樣用<script>引入它：

<script src="path/to/jquery.js"></script>

2. Bower

后來，我開始用Bower這樣的包管理工具。所以這個過程變成了：先打開命令行用bower安裝jQuery。

bower install jquery

再繼續(xù)用<script>引入它。

<script src="bower_components/jquery/dist/jquery.js"></script>

3. npm&Browserify

現(xiàn)在，我又有了新的選擇，大概是這樣：

命令行用npm安裝jQuery。

npm install jquery

在需要用到它的JavaScript代碼里，這樣引入它：

var $ = require("jquery");

沒錯，這就是使用npm的包的一般方法。但特別的是，這個npm的包是我們熟知的jquery，而它將用在瀏覽器中。

Browserify，正如其名字所體現(xiàn)的動作那樣，讓原本屬于服務(wù)器端的Node及npm，在瀏覽器端也可使用。

顯然，上面的過程還沒結(jié)束，接下來是Browserify的工作（假定上面那段代碼所在的文件叫main.js）：

browserify main.js -o bundle.js

最后，用<script>引用Browserify生成的bundle.js文件。

<script src="bundle.js"></script>

這就是依托Browserify建立起來的第三選擇。

等下，怎么比以前變復(fù)雜了？
CommonJS風(fēng)格的模塊及依賴管理

其實，在這個看起來更復(fù)雜的過程中，require()具有非凡的意義。

Browserify并不只是一個讓你輕松引用JavaScript包的工具。它的關(guān)鍵能力，是JavaScript模塊及依賴管理。（這才是為師的主業(yè)）

就模塊及依賴管理這個問題而言，已經(jīng)有RequireJS和國內(nèi)的Sea.js這些優(yōu)秀的作品。而現(xiàn)在，Browserify又給了我們新的選擇。
Browserify參照了Node中的模塊系統(tǒng)，約定用require()來引入其他模塊，用module.exports來引出模塊。在我看來，Browserify不同于RequireJS和Sea.js的地方在于，它沒有著力去提供一個“運行時”的模塊加載器，而是強調(diào)進行預(yù)編譯。預(yù)編譯會帶來一個額外的過程，但對應(yīng)的，你也不再需要遵循一定規(guī)則去加一層包裹。因此，相比較而言，Browserify提供的組織方式更簡潔，也更符合CommonJS規(guī)范。

像寫Node那樣去組織你的JavaScript，Browserify會讓它們在瀏覽器里正常運行的。
安裝及使用
命令行形式

命令行形式是官方貼出來的用法，因為看起來最簡單。

Browserify本身也是npm，通過npm的方式安裝：

npm install -g browserify

這里-g的參數(shù)表示全局，所以可以在命令行內(nèi)直接使用。接下來，運行browserify命令到你的.js文件（比如entry.js）：

browserify entry.js -o bundle.js

Browserify將遞歸分析你的代碼中的require()，然后生成編譯后的文件（這里的bundle.js）。在編譯后的文件內(nèi)，所有JavaScript模塊都已合并在一起且建立好了依賴關(guān)系。最后，你在html里引用這個編譯后的文件（喂，和引言里的一樣啊）：

<script src="bundle.js"></script>

有關(guān)這個編譯命令的配置參數(shù)，請參照node-browserify#usage。如果你想要做比較精細的配置，命令行形式可能會不太方便。這種時候，推薦結(jié)合Gulp使用。
+ Gulp形式

結(jié)合Gulp使用時，你的Browserify只安裝在某個項目內(nèi)：

npm install browserify --save-dev

建議加上后面的--save-dev以保存到你項目的package.json里。

接下來是gulpfile.js的部分，下面是一個簡單示例：

var gulp = require("gulp");
var browserify = require("browserify");
var sourcemaps = require("gulp-sourcemaps");
var source = require('vinyl-source-stream');
var buffer = require('vinyl-buffer');

gulp.task("browserify", function () {
 var b = browserify({
  entries: "./javascripts/src/main.js",
  debug: true
 });

 return b.bundle()
  .pipe(source("bundle.js"))
  .pipe(buffer())
  .pipe(sourcemaps.init({loadMaps: true}))
  .pipe(sourcemaps.write("."))
  .pipe(gulp.dest("./javascripts/dist"));
});

可以看到，Browserify是獨立的，我們需要直接使用它的API，并將它加入到Gulp的任務(wù)中。

在上面的代碼中，debug: true是告知Browserify在運行同時生成內(nèi)聯(lián)sourcemap用于調(diào)試。引入gulp-sourcemaps并設(shè)置loadMaps: true是為了讀取上一步得到的內(nèi)聯(lián)sourcemap，并將其轉(zhuǎn)寫為一個單獨的sourcemap文件。vinyl-source-stream用于將Browserify的bundle()的輸出轉(zhuǎn)換為Gulp可用的vinyl（一種虛擬文件格式）流。vinyl-buffer用于將vinyl流轉(zhuǎn)化為buffered vinyl文件（gulp-sourcemaps及大部分Gulp插件都需要這種格式）。

這樣配置好之后，直接運行g(shù)ulp browserify就可以得到結(jié)果了，可能像這樣：

如果你的代碼比較多，可能像上圖這樣一次編譯需要1s以上，這是比較慢的。這種時候，推薦使用watchify。它可以在你修改文件后，只重新編譯需要的部分（而不是Browserify原本的全部編譯），這樣，只有第一次編譯會花些時間，此后的即時變更刷新則十分迅速。

有關(guān)更多Browserify + Gulp的示例，請參考Gulp Recipes。
特性及簡要原理

使用Browserify來組織JavaScript，有什么要注意的地方嗎？

要回答這個問題，我們先看看Browserify到底做了什么。下面是一個比較詳細的例子。

項目內(nèi)現(xiàn)在用到2個.js文件，它們存在依賴關(guān)系，其內(nèi)容分別是：
name.js

module.exports = "aya";

main.js

var name = require("./name");

console.log("Hello! " + name);

然后對main.js運行Browserify，得到的bundle.js的文件內(nèi)容是這樣的：
bundle.js

(function e(t, n, r) {
 // ...
})({
 1: [function (require, module, exports) {
  var name = require("./name");

  console.log("Hello! " + name);
 }, {"./name": 2}],
 2: [function (require, module, exports) {
  module.exports = "aya";
 }, {}]
}, {}, [1])

//# sourceMappingURL=bundle.js.map

請先忽略掉省略號里的部分。然后，它的結(jié)構(gòu)就清晰多了?？梢钥吹?，整體是一個立即執(zhí)行的函數(shù)（IIFE），該函數(shù)接收了3個參數(shù)。其中第1個參數(shù)比較復(fù)雜，第2、3個參數(shù)在這里分別是{}和[1]。
模塊map

第1個參數(shù)是一個Object，它的每一個key都是數(shù)字，作為模塊的id，每一個數(shù)字key對應(yīng)的值是長度為2的數(shù)組?？梢钥闯?，前面的main.js中的代碼，被function(require, module, exports){}這樣的結(jié)構(gòu)包裝了起來，然后作為了key1數(shù)組里的第一個元素。類似的，name.js中的代碼，也被包裝，對應(yīng)到key2。

數(shù)組的第2個元素，是另一個map對應(yīng)，它表示的是模塊的依賴。main.js在key1，它依賴name.js，所以它的數(shù)組的第二個元素是{"./name": 2}。而在key2的name.js，它沒有依賴，因此其數(shù)組第二個元素是空Object{}。

因此，這第1個復(fù)雜的參數(shù)，攜帶了所有模塊的源碼及其依賴關(guān)系，所以叫做模塊map。
包裝

前面提到，原有的文件中的代碼，被包裝了起來。為什么要這樣包裝呢？

因為，瀏覽器原生環(huán)境中，并沒有require()。所以，需要用代碼去實現(xiàn)它（RequireJS和Sea.js也做了這件事）。這個包裝函數(shù)提供的3個參數(shù)，require、module、exports，正是由Browserify實現(xiàn)了特定功能的3個關(guān)鍵字。
緩存

第2個參數(shù)幾乎總是空的{}。它如果有的話，也是一個模塊map，表示本次編譯之前被加載進來的來自于其他地方的內(nèi)容?，F(xiàn)階段，讓我們忽略它吧。
入口模塊

第3個參數(shù)是一個數(shù)組，指定的是作為入口的模塊id。前面的例子中，main.js是入口模塊，它的id是1，所以這里的數(shù)組就是
[1]。數(shù)組說明其實還可以有多個入口，比如運行多個測試用例的場景，但相對來說，多入口的情況還是比較少的。
實現(xiàn)功能

還記得前面忽略掉的省略號里的代碼嗎？這部分代碼將解析前面所說的3個參數(shù)，然后讓一切運行起來。這段代碼是一個函數(shù)，來自于browser-pack項目的prelude.js。令人意外的是，它并不復(fù)雜，而且寫有豐富的注釋，很推薦你自行閱讀。
所以，到底要注意什么？

到這里，你已經(jīng)看過了Browserify是如何工作的。是時候回到前面的問題了。首先，在每個文件內(nèi)，不再需要自行包裝。

你可能已經(jīng)很習(xí)慣類似下面這樣的寫法：

;(function(){
 // Your code here.
}());

但你已經(jīng)了解到，Browserify的編譯會將你的代碼封裝在局部作用域內(nèi)，所以，你不再需要自己做這個事情，像這樣會更好：

// Your code here.

類似的，如果你想用"use strict";啟用嚴格模式，直接寫在外面就可以了，這表示在某個文件的代碼范圍內(nèi)啟用嚴格模式。

其次，保持局部變量風(fēng)格。我們很習(xí)慣通過window.jQuery和window.$這樣的全局變量來訪問jQuery這樣的庫，但如果使用Browserify，它們都應(yīng)只作為局部變量：

var $ = require("jquery");

$("#alice").text("Hello!");

這里的$就只存在于這個文件的代碼范圍內(nèi)（獨立的作用域）。如果你在另一個文件內(nèi)要使用jQuery，需要按照同樣的方式去require()。

然而，新的問題又來了，既然jQuery變成了這種局部變量的形式，那我們熟悉的各種jQuery插件要如何使用呢？
browserify-shim

你一定熟悉這樣的jQuery插件使用方式：

<script src="jquery.js"></script>
<script src="jquery.plugin.js"></script>
<script>
 // Now the jQuery plugin is available.
</script>

很多jQuery插件是這樣做的：默認window.jQuery存在，然后取這個全局變量，把自己添加到j(luò)Query中。顯然，這在Browserify的組織方式里是沒法用的。

為了讓這樣的“不兼容Browserify”（其實是不兼容CommonJS）的JavaScript模塊（如插件）也能為Browserify所用，于是有了browserify-shim。

下面，以jQuery插件jquery.pep.js為例，請看browserify-shim的使用方法。
使用示例

安裝browserify-shim：

npm install browserify-shim --save-dev

然后在package.json中做如下配置：

"browserify": {
 "transform": [ "browserify-shim" ]
},
"browser": {
 "jquery.pep" : "./vendor/jquery.pep.js"
},
"browserify-shim": {
 "jquery.pep" : { "depends": ["jquery:jQuery"] }
}

最后是.js中的代碼：

var $ = require("jquery");
require("jquery.pep");

$(".move-box").pep();

完成！到此，經(jīng)過Browserify編譯后，將可以正常運行這個jQuery插件。

這是一個怎樣的過程呢？

在本例中，jQuery使用的是npm里的，而jquery.pep.js使用的是一個自己下載的文件（它與很多jQuery插件一樣，還沒有發(fā)布到npm）。查看jquery.pep.js源碼，注意到它用了這樣的包裝：

;(function ( $, window, undefined ) {
 // ...
}(jQuery, window));

可以看出，它默認當(dāng)前環(huán)境中已存在一個變量jQuery（如果不存在，則報錯）。package.json中的"depends": ["jquery:jQuery"]是為它添加依賴聲明，前一個jquery表示require("jquery")，后一個jQuery則表示將其命名為jQuery（賦值語句）。這樣，插件代碼運行的時候就可以正常找到j(luò)Query變量，然后將它自己添加到j(luò)Query中。

實際上，browserify-shim的配置并不容易。針對代碼包裝（盡管都不兼容CommonJS，但也存在多種情況）及使用場景的不同，browserify-shim有不同的解決方案，本文在此只介紹到這。

關(guān)于配置的更多說明，請參照browserify-shim官方文檔。更多參考可以查看browserify shim recipes。此外，如果你覺得browserify-shim有些難以理解或者對它的原理也有興趣，推薦閱讀這篇Stack Overflow上的回答。

當(dāng)然，對于已經(jīng)處理了CommonJS兼容的庫或插件（比如已經(jīng)發(fā)布到npm），browserify-shim是不需要的。
其實還有的更多transform

在前面browserify-shim的例子中，"browserify": {"transform": [ "browserify-shim" ]}其實是Browserify的配置?？梢钥闯?，browserify-shim只是Browserify的其中一種transform。在它之外，還有很多的transform可用，分別應(yīng)對不同的需求，使Browserify的體系更為完善。

比如，還記得本文引言里的Bower嗎？debowerify可以讓通過Bower安裝的包也可以用require()引用。npm和bower同為包管理工具，Browserify表示你們都是我的翅膀。
一點提示

Browserify是靜態(tài)分析編譯工具，因此不支持動態(tài)require()。例如，下面這樣是不可以的：

var lang = "zh_cn";
var i18n = require("./" + lang);

文檔資料

有關(guān)Browserify更詳細的說明文檔，請看browserify-handbook。
結(jié)語

我覺得Browserify很有趣，它用了這樣一個名字，讓你覺得它好像只是一個Node的瀏覽器端轉(zhuǎn)化工具。為此，它還完成了Node中大部分核心庫的瀏覽器端實現(xiàn)。但實際上，它走到了更遠的地方，并在JavaScript模塊化開發(fā)這個重要的領(lǐng)域中，創(chuàng)立了一個全新的體系。

喜歡CommonJS的簡潔風(fēng)格？請嘗試Browserify！

最新評論