A Super Guide to Programming with Browserify with jQuery

Introduction 1. manually

In the past, I started a new web project, and then I thought about using jQuery. I would open the browser, then find the official website of jQuery, click the eye-catching "Download jQuery" button, download it to a .js file, and then put it Drop it in the project directory. Where you need to use it, use to introduce it like this:

Copy after login 2. Bower

Later, I started using package management tools like Bower. So the process becomes: first open the command line and use bower to install jQuery.

bower install jquery

Copy after login Continue to use to introduce it.

Copy after login 3. npm&Browserify

Now, I have a new choice, probably like this:

Use npm to install jQuery from the command line.

npm install jquery

Copy after login In the JavaScript code that needs to use it, introduce it like this:

var $ = require("jquery");

Copy after login Yes, this is the general method of using npm packages. But what's special is that this npm package is the well-known jquery, and it will be used in the browser.

Browserify, as its name implies, allows Node and npm, which originally belong to the server side, to be used on the browser side.

Obviously, the above process is not over yet, the next step is the work of Browserify (assuming that the file where the above code is located is called main.js):

browserify main.js -o bundle.js

Copy after login Finally, use to reference the bundle.js file generated by Browserify.

Copy after login Copy after login This is the third option built on Browserify.

Wait, why is it more complicated than before? CommonJS style module and dependency management

In fact, require() has extraordinary significance in this seemingly more complicated process.

Browserify is not just a tool that allows you to easily reference JavaScript packages. Its key capabilities are JavaScript modules and dependency management. (This is the main job of being a teacher)

As far as module and dependency management are concerned, there are already excellent works such as RequireJS and domestic Sea.js. And now, Browserify has given us a new choice. Browserify refers to the module system in Node and agrees to use require() to introduce other modules and module.exports to export modules. In my opinion, Browserify is different from RequireJS and Sea.js in that it does not focus on providing a "runtime" module loader, but emphasizes pre-compilation. Precompilation will bring an additional process, but correspondingly, you no longer need to follow certain rules to add a layer of packaging. Therefore, in comparison, the organization method provided by Browserify is more concise and more consistent with the CommonJS specification.

Organize your JavaScript like you write Node, and Browserify will make it run normally in the browser. Installation and use Command line form

The command line form is the official usage, because it seems the simplest.

Browserify itself is also npm, installed through npm:

npm install -g browserify

Copy after login The -g parameter here represents global, so it can be used directly in the command line. Next, run the browserify command into your .js file (such as entry.js):

browserify entry.js -o bundle.js

Copy after login Browserify will recursively analyze the require() in your code, and then generate the compiled file (bundle.js here). Within the compiled file, all JavaScript modules have been merged together and dependencies established. Finally, you quote this compiled file in html (hey, it’s the same as in the introduction):

Copy after login Copy after login For the configuration parameters of this compilation command, please refer to node-browserify#usage. If you want to do more detailed configuration, the command line form may be inconvenient. In this case, it is recommended to use it in conjunction with Gulp. Gulp form

When used in conjunction with Gulp, your Browserify is only installed in a certain project:

npm install browserify --save-dev

Copy after login It is recommended to add --save-dev to save it to the package.json of your project.

Next is the part of gulpfile.js, here is a simple example:

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")); });

Copy after login 可以看到，Browserify是独立的，我们需要直接使用它的API，并将它加入到Gulp的任务中。

在上面的代码中，debug: true是告知Browserify在运行同时生成内联sourcemap用于调试。引入gulp-sourcemaps并设置loadMaps: true是为了读取上一步得到的内联sourcemap，并将其转写为一个单独的sourcemap文件。vinyl-source-stream用于将Browserify的bundle()的输出转换为Gulp可用的vinyl（一种虚拟文件格式）流。vinyl-buffer用于将vinyl流转化为buffered vinyl文件（gulp-sourcemaps及大部分Gulp插件都需要这种格式）。

这样配置好之后，直接运行gulp browserify就可以得到结果了，可能像这样：

如果你的代码比较多，可能像上图这样一次编译需要1s以上，这是比较慢的。这种时候，推荐使用watchify。它可以在你修改文件后，只重新编译需要的部分（而不是Browserify原本的全部编译），这样，只有第一次编译会花些时间，此后的即时变更刷新则十分迅速。

有关更多Browserify + Gulp的示例，请参考Gulp Recipes。 特性及简要原理

使用Browserify来组织JavaScript，有什么要注意的地方吗？

要回答这个问题，我们先看看Browserify到底做了什么。下面是一个比较详细的例子。

项目内现在用到2个.js文件，它们存在依赖关系，其内容分别是： name.js

module.exports = "aya";

Copy after login main.js

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

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

Copy after login 然后对main.js运行Browserify，得到的bundle.js的文件内容是这样的： 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

Copy after login 请先忽略掉省略号里的部分。然后，它的结构就清晰多了。可以看到，整体是一个立即执行的函数（IIFE），该函数接收了3个参数。其中第1个参数比较复杂，第2、3个参数在这里分别是{}和[1]。 模块map

第1个参数是一个Object，它的每一个key都是数字，作为模块的id，每一个数字key对应的值是长度为2的数组。可以看出，前面的main.js中的代码，被function(require, module, exports){}这样的结构包装了起来，然后作为了key1数组里的第一个元素。类似的，name.js中的代码，也被包装，对应到key2。

数组的第2个元素，是另一个map对应，它表示的是模块的依赖。main.js在key1，它依赖name.js，所以它的数组的第二个元素是{"./name": 2}。而在key2的name.js，它没有依赖，因此其数组第二个元素是空Object{}。

因此，这第1个复杂的参数，携带了所有模块的源码及其依赖关系，所以叫做模块map。 包装

前面提到，原有的文件中的代码，被包装了起来。为什么要这样包装呢？

因为，浏览器原生环境中，并没有require()。所以，需要用代码去实现它（RequireJS和Sea.js也做了这件事）。这个包装函数提供的3个参数，require、module、exports，正是由Browserify实现了特定功能的3个关键字。 缓存

第2个参数几乎总是空的{}。它如果有的话，也是一个模块map，表示本次编译之前被加载进来的来自于其他地方的内容。现阶段，让我们忽略它吧。 入口模块

第3个参数是一个数组，指定的是作为入口的模块id。前面的例子中，main.js是入口模块，它的id是1，所以这里的数组就是 [1]。数组说明其实还可以有多个入口，比如运行多个测试用例的场景，但相对来说，多入口的情况还是比较少的。 实现功能

还记得前面忽略掉的省略号里的代码吗？这部分代码将解析前面所说的3个参数，然后让一切运行起来。这段代码是一个函数，来自于browser-pack项目的prelude.js。令人意外的是，它并不复杂，而且写有丰富的注释，很推荐你自行阅读。 所以，到底要注意什么？

到这里，你已经看过了Browserify是如何工作的。是时候回到前面的问题了。首先，在每个文件内，不再需要自行包装。

你可能已经很习惯类似下面这样的写法：

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

Copy after login 但你已经了解到，Browserify的编译会将你的代码封装在局部作用域内，所以，你不再需要自己做这个事情，像这样会更好：

// Your code here.

Copy after login 类似的，如果你想用"use strict";启用严格模式，直接写在外面就可以了，这表示在某个文件的代码范围内启用严格模式。

其次，保持局部变量风格。我们很习惯通过window.jQuery和window.$这样的全局变量来访问jQuery这样的库，但如果使用Browserify，它们都应只作为局部变量：

var $ = require("jquery");

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

Copy after login 这里的$就只存在于这个文件的代码范围内（独立的作用域）。如果你在另一个文件内要使用jQuery，需要按照同样的方式去require()。

然而，新的问题又来了，既然jQuery变成了这种局部变量的形式，那我们熟悉的各种jQuery插件要如何使用呢？ browserify-shim

你一定熟悉这样的jQuery插件使用方式：

// Now the jQuery plugin is available.

Copy after login 很多jQuery插件是这样做的：默认window.jQuery存在，然后取这个全局变量，把自己添加到jQuery中。显然，这在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"] } }

Copy after login 最后是.js中的代码：

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

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

Copy after login 完成！到此，经过Browserify编译后，将可以正常运行这个jQuery插件。

这是一个怎样的过程呢？

在本例中，jQuery使用的是npm里的，而jquery.pep.js使用的是一个自己下载的文件（它与很多jQuery插件一样，还没有发布到npm）。查看jquery.pep.js源码，注意到它用了这样的包装：

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

Copy after login 可以看出，它默认当前环境中已存在一个变量jQuery（如果不存在，则报错）。package.json中的"depends": ["jquery:jQuery"]是为它添加依赖声明，前一个jquery表示require("jquery")，后一个jQuery则表示将其命名为jQuery（赋值语句）。这样，插件代码运行的时候就可以正常找到jQuery变量，然后将它自己添加到jQuery中。

实际上，browserify-shim的配置并不容易。针对代码包装（尽管都不兼容CommonJS，但也存在多种情况）及使用场景的不同，browserify-shim有不同的解决方案，本文在此只介绍到这。

关于配置的更多说明，请参照 browserify-shim官方文档 。更多参考可以查看 browserify shim recipes 。此外，如果你觉得browserify-shim有些难以理解或者对它的原理也有兴趣， 推荐阅读这篇Stack Overflow上的回答 。

当然，对于已经处理了CommonJS兼容的库或插件（比如已经发布到npm），browserify-shim是不需要的。 其实还有的更多transform

在前面browserify-shim的例子中，"browserify": {"transform": [ "browserify-shim" ]}其实是Browserify的配置。可以看出，browserify-shim只是Browserify的其中一种transform。在它之外，还有很多的transform可用，分别应对不同的需求，使Browserify的体系更为完善。

比如，还记得本文引言里的Bower吗？debowerify可以让通过Bower安装的包也可以用require()引用。npm和bower同为包管理工具，Browserify表示你们都是我的翅膀。 一点提示

Browserify是静态分析编译工具，因此不支持动态require()。例如，下面这样是不可以的：

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

Copy after login 文档资料

有关Browserify更详细的说明文档，请看 browserify-handbook 。 结语

我觉得Browserify很有趣，它用了这样一个名字，让你觉得它好像只是一个Node的浏览器端转化工具。为此，它还完成了Node中大部分核心库的浏览器端实现。但实际上，它走到了更远的地方，并在JavaScript模块化开发这个重要的领域中，创立了一个全新的体系。

喜欢CommonJS的简洁风格？请尝试Browserify！

A Super Guide to Programming with Browserify with jQuery_jquery