怎样写一个能同时用于 Node 和浏览器的 JavaScript 包？

   <p>我在这个问题上见过很多困惑，即使是很有经验的 JavaScript 开发者也可能难以把握其中的巧妙之处。因此我认为值得为它书写一小段教程。</p>    <p>假设你有一个 JavaScript 的模块想要发布到 npm 上，它是同时适用于 Node 和浏览器的。但是请注意！这个特殊的模块在 Node 版本和浏览器版本上的实现有着细微的区别。</p>    <p>这种情况出现得实在频繁，因为在 Node 和浏览器间有着很多微小的环境差别。在这种情况下，可以用比较巧妙的方法来正确地实现，尤其是当你在尝试着使用最小的 browser 包（bundle）来优化的时候。</p>    <h3>让我们构建一个 JS 包</h3>    <p>因此让我们来写一个小的 JavaScript 包，叫做 base64-encode-string 。它所做的只是接收一个字符串作为输入，输出其 base64 编码的版本。</p>    <p>对于浏览器来说，这很简单：我们只需要使用自带的 btoa 函数：</p>    <pre>  <code class="language-javascript">module.exports = function (string) {    return btoa(string);  };</code></pre>    <p>然而在 Node 里并没有 btoa 函数。因此，作为替代，我们需要自己创建一个 Buffer ，然后在上面调用 <a href="/misc/goto?guid=4959737421405510223" rel="nofollow,noindex">buffer.toString()</a> ：</p>    <pre>  <code class="language-javascript">module.exports = function (string) {    return Buffer.from(string, 'binary').toString('base64');  };</code></pre>    <p>对于一个字符串，这两者都应提供其正确的 base64 编码版本，比如：</p>    <pre>  <code class="language-javascript">var b64encode = require('base64-encode-string');  b64encode('foo');    // Zm9v  b64encode('foobar'); // Zm9vYmFy</code></pre>    <p>现在我们只需要一些方法来检测我们究竟是在浏览器上运行还是在 Node 上，好让我们能保证使用正确的版本。Browserify 和 Webpack 都定义了一个叫 process.browser 的字段，它会返回 true （译者注：即浏览器环境下），然而在 Node 上这个字段返回 false 。所以我们只需要简单地：</p>    <pre>  <code class="language-javascript">if (process.browser) {    module.exports = function (string) {      return btoa(string);    };  } else {    module.exports = function (string) {      return Buffer.from(string, 'binary').toString('base64');    };  }</code></pre>    <p>现在我们只需要把我们的文件命名为 index.js ，键入 npm publish ，我们就完成了，对不对？好的吧，这个方法有效，但不幸的是，这种实现有一个巨大的性能问题。</p>    <p>因为我们的 index.js 文件包含了对 Node 自带的 process 和 Buffer 模块的引用，Browserify 和 Webpack 都会自动引入 <a href="/misc/goto?guid=4959737421496614999" rel="nofollow,noindex">其</a> polyfill ，来将它们打包进这些模块。</p>    <p>对于这个简单的九行模块，我算了一下， Browserify 和 Webpack 会创建 一个压缩后有 24.7KB 的包 (7.6KB min+gz)。对于这种东西，用掉的空间实在是太多，因为在浏览器里，只需要 btoa 就能表示这个。</p>    <h3>“browser” 字段，我该如何爱你</h3>    <p>如果你在 Browserify 或者 Webpack 文档里找解决这个问题的提示，你可能最后会发现 node-browser-resolve 。这是一个对于 package.json 内 "browser" 字段的规范，可以被用于定义在浏览器版本构建时需要被换掉的东西。</p>    <p>使用这种技术，我们可以将接下来这段加入我们的 package.json ：</p>    <pre>  <code class="language-javascript">{    /* ... */    "browser": {      "./index.js": "./browser.js"    }  }</code></pre>    <p>然后将函数分割成两个不同的文件： index.js 和 browser.js ：</p>    <pre>  <code class="language-javascript">// index.js  module.exports = function (string) {    return Buffer.from(string, 'binary').toString('base64');  };    // browser.js  module.exports = function (string) {    return btoa(string);  };</code></pre>    <p>有了这次改进以后，Browserify 和 Webpack 会给出 更加合理的包 ：Browserify 的包压缩后是 511 字节（315 min+gz)，Webpack 的包压缩后是 550 字节（297 min+gz）。</p>    <p>当我们将我们的包发布到 npm 时，在 Node 里运行 require('base64-encode-string') 的人将得到 Node 版的代码，在 Browserfy 和 Webpack 里跑的人会得到浏览器版的代码。</p>    <p>对于 Rollup 来说，这就有点复杂了，但也不需要太多额外的工作。Rollup 用户需要使用 rollup-plugin-node-resolve 并在选项里将 browser 设置为 true 。</p>    <p>对 jspm 来说，很不幸地， 没有对 “browser” 字段的支持 ，但是 jspm 用户可以通过 require('base64-encode-string/browser') 或者 jspm install npm:base64-encode-string -o "{main:'browser.js'}" 来迂回地解决问题。另一种方法是，包的作者可以在他们的 package.json 里 指定一个 “jspm” 字段 。</p>    <h3>进阶技巧</h3>    <p>这种直接使用的 "browser" 方法可以工作得很好，但是对于大型项目来说，我发现它在 package.json 和代码库间引入了一种尴尬的耦合。比如说，我们的 package.json 会很快长成这样：</p>    <pre>  <code class="language-javascript">{    /* ... */    "browser": {      "./index.js": "./browser.js",      "./widget.js": "./widget-browser.js",      "./doodad.js": "./doodad-browser.js",      /* etc. */    }  }</code></pre>    <p>在这种情况下，任何时候你想要一个适配于浏览器的模块，都需要分别创建两个文件，并且要记住在 "browser" 字段上添加额外行来将它们连接起来。还要注意不能拼错任何东西！</p>    <p>并且，你会发现你在费尽心机地将微小的代码提取到分离的模块里，仅仅是因为你想要避免 if (process.browser) {} 检查。当这些 *-browser.js 文件积累起来的时候，它们会开始让代码库变得很难跳转。</p>    <p>如果这种情况变得实在太笨重了，有一些别的解决方案。我自己的偏好是使用 Rollup 作为构建工具，来自动地将单个代码库分割到不同的 index.js 和 browser.js 文件里。这对于将你提供给用户的代码的解模块化有额外的价值， 节省了空间和时间 。</p>    <p>要这样做的话，先安装 rollup 和 rollup-plugin-replace ，然后定义一个 rollup.config.js 文件：</p>    <pre>  <code class="language-javascript">import replace from 'rollup-plugin-replace';  export default {    entry: 'src/index.js',    format: 'cjs',    plugins: [      replace({ 'process.browser': !!process.env.BROWSER })    ]  };</code></pre>    <p>（我们将使用 process.env.BROWSER 作为一种方便地在浏览器构建和 Node 构建间切换的方式。）</p>    <p>接下来，我们可以创建一个带有单个函数的 src/index.js 文件，使用普通的 process.browser 条件：</p>    <pre>  <code class="language-javascript">export default function base64Encode(string) {    if (process.browser) {      return btoa(string);    } else {      return Buffer.from(string, 'binary').toString('base64');    }  }</code></pre>    <p>然后将 prepublish 步骤添加到 package.json 内，来生成文件：</p>    <pre>  <code class="language-javascript">{    /* ... */    "scripts": {      "prepublish": "rollup -c > index.js && BROWSER=true rollup -c > browser.js"    }  }</code></pre>    <p>生成的文件都相当直白易读：</p>    <pre>  <code class="language-javascript">// index.js  'use strict';    function base64Encode(string) {    {      return Buffer.from(string, 'binary').toString('base64');    }  }    module.exports = base64Encode;    // browser.js  'use strict';    function base64Encode(string) {    {      return btoa(string);    }  }    module.exports = base64Encode;</code></pre>    <p>你将注意到，Rollup 会按需自动地将 process.browser 转换成 true 或者 false ，然后去掉那些无用代码。所以在生成的浏览器包里不会有对于 process 或者 Buffer 的引用。</p>    <p>使用这个技巧，在你的代码库里可以有任意个的 process.browser 切换，并且发布的结果是两个小的集中的 index.js 和 browser.js 文件，其中对于 Node 只有 Node 相关的代码，对于浏览器只有浏览器相关的代码。</p>    <p>作为附带的福利，你可以配置 Rollup 来生成 ES 模块构建，IIFE 构建，或者 UMD 构建。如果你想要示例的话，可以查看我的项目 marky ，这是一个拥有多个 Rollup 构建目标的简单库。</p>    <p>在这篇文章里描述的实际项目（ base64-encode-string ）也同样被 发布到 npm 上 ，你可以审视它，看看它是怎么做到的。</p>    <p> </p>    <p>来自：http://www.jianshu.com/p/b05869ac5fa8</p>    <p> </p>