package.json 中节点和浏览器的不同主入口点

Question

在同构反应应用程序中，我有 myModule，它在节点和浏览器环境中的行为应该不同。我想在package.json 中为myModule 配置这个分割点：

package.json

{
  "private": true,
  "name": "myModule",
  "main": "./myModule.server.js",
  "browser": "./myModule.client.js"
}

file structure

├── myModule
│   ├── myModule.client.js
│   ├── myModule.server.js
│   └── package.json
│ 
├── browser.js
└── server.js

所以当我在 node 中使用myModule 时，我应该只得到myModule.server.js：

server.js

import myModule from './myModule';
myModule(); // invoke myModule.server.js

在浏览器方面应该仅使用myModule.client.js构建捆绑包：

browser.js

import myModule from './myModule';
myModule(); // invoke myModule.client.js

react-starter-kit 使用了这种方法，但我不知道这个配置是在哪里定义的。

---

动机

1. package.json 是进行这种拆分的良好语义点。
2. 客户端包仅包含myModule.client.js。

---

已知的解决方案 - 不是我的答案

你可以有这种文件结构：

├── myModule
│    ├── myModule.client.js
│    ├── myModule.server.js
│    └── index.js           <-- difference
│ 
├── browser.js
└── server.js

在index.js:

if (process.browser) { // this condition can be different but you get the point
    module.exports = require('./myModule.client');
} else {
    module.exports = require('./myModule.server');
}

这样做的主要问题是客户端包包含大量繁重的 kB 后端代码。

---

我的 webpack 配置

我包括我的webpack.config.js。奇怪的是，这个配置总是指向浏览器和节点的myModule.client.js。

const webpack = require('webpack');
var path = require('path');
var fs = require('fs');

const DEBUG = !process.argv.includes('--release');
const VERBOSE = !process.argv.includes('--verbose');
const AUTOPREFIXER_BROWSERS = [
    'Android 2.3',
    'Android >= 4',
    'Chrome >= 35',
    'Firefox >= 31',
    'Explorer >= 9',
    'iOS >= 7',
    'Opera >= 12',
    'Safari >= 7.1',
];

let nodeModules = {};
fs.readdirSync('node_modules')
    .filter(function(x) {
        return ['.bin'].indexOf(x) === -1 ;
    })
    .forEach(function(mod) {
        nodeModules[mod] = 'commonjs ' + mod;
    });

let loaders = [
    {
        exclude: /node_modules/,
        loader: 'babel'
    },
    {
        test: [/\.scss$/,/\.css$/],
        loaders: [
            'isomorphic-style-loader',
            `css-loader?${DEBUG ? 'sourceMap&' : 'minimize&'}modules&localIdentName=` +
            `${DEBUG ? '[name]_[local]_[hash:base64:3]' : '[hash:base64:4]'}`,
            'postcss-loader?parser=postcss-scss'
        ]
    },
    {
        test: /\.(png|jpg|jpeg|gif|svg|woff|woff2)$/,
        loader: 'url-loader',
        query: {
            name: DEBUG ? '[name].[ext]' : '[hash].[ext]',
            limit: 10000,
        },
    },
    {
        test: /\.(eot|ttf|wav|mp3)$/,
        loader: 'file-loader',
        query: {
            name: DEBUG ? '[name].[ext]' : '[hash].[ext]',
        },
    },
    {
        test: /\.json$/,
        loader: 'json-loader',
    },
];

const common = {
    module: {
        loaders
    },
    plugins: [
        new webpack.optimize.OccurenceOrderPlugin(),
    ],
    postcss: function plugins(bundler) {
        var plugins = [
            require('postcss-import')({ addDependencyTo: bundler }),
            require('precss')(),
            require('autoprefixer')({ browsers: AUTOPREFIXER_BROWSERS }),
        ];

        return plugins;
    },
    resolve: {
        root: path.resolve(__dirname, 'src'),
        extensions: ['', '.js', '.jsx', '.json']
    }
};


module.exports = [
    Object.assign({} , common, { // client
        entry: [
            'babel-polyfill',
            './src/client.js'
        ],
        output: {
            path: __dirname + '/public/',
            filename: 'bundle.js'
        },
        target: 'web',
        node: {
            fs: 'empty',
        },
        devtool: DEBUG ? 'cheap-module-eval-source-map' : false,
        plugins: [
            ...common.plugins,
            new webpack.DefinePlugin({'process.env.BROWSER': true }),
        ],
    }),
    Object.assign({} , common, { // server
        entry: [
            'babel-polyfill',
            './src/server.js'
        ],
        output: {
            path: __dirname + '',
            filename: 'server.js'
        },
        target: 'node',
        plugins: [
            ...common.plugins,
            new webpack.DefinePlugin({'process.env.BROWSER': false }),
        ],
        node: {
            console: false,
            global: false,
            process: false,
            Buffer: false,
            __filename: false,
            __dirname: false,
        },
        externals: nodeModules,

    })
];

Answer 1

这里的行为是标准化的：https://github.com/defunctzombie/package-browser-field-spec

虽然这个规范是非官方的，但许多 Javascript 打包器都遵循它，包括 Webpack、Browserify 和 React Native 打包器。浏览器字段不仅允许您更改模块入口点，还可以替换或忽略模块中的单个文件。很强大。

由于默认情况下 Webpack 会为 Web 捆绑代码，因此如果您想使用 Webpack 进行服务器构建，则需要手动禁用浏览器字段。您可以使用target 配置选项来执行此操作：https://webpack.js.org/concepts/targets/

Answer 2

这个问题已经很久没有提出来了。我只是想澄清一下之前的答案。

如果您查看 React Starter Kit 中的 tools/webpack.config.js，您将 看到它导出了两个略有不同的 Webpack 配置， 例如module.exports = [clientConfig，sererConfig]。服务器端 捆绑配置将此字段目标设置为节点（默认情况下是网络）。

似乎没有记录这种 webpack 行为，但是当目标是 'node' 时 webpack 会自动获取 'main' 条目，而当目标是 'web' 时会自动获取 'browser' 条目。

Answer 3

如果您查看React Starter Kit 中的tools/webpack.config.js，您会看到它导出了两个略有不同的Webpack 配置，例如module.exports = [clientConfig, sererConfig]。服务器端捆绑配置将此字段 target 设置为 node（默认为 web）。

https://webpack.github.io/docs/configuration.html#target

您描述的方法非常适用于具有完全相同 API 但实现不同的模块，例如 HTTP 客户端实用程序在其特定于浏览器的实现中使用 XMLHttpRequest 而在其服务器中使用 Node 的 http 模块的情况实现：

https://github.com/kriasoft/react-starter-kit/tree/master/src/core/fetch

Answer 4

要在节点模块中为客户端和服务器设置不同的入口点，您可以使用process.browser 标志并处理相同

if (process.browser) {
  // load client entry point
} else {
  // load server entry point
}