React源码学习进阶篇（一）新版React如何调试源码？

孟健

发布于 2022-12-19 17:11:55

9360

发布于 2022-12-19 17:11:55

❝React 16版本之后，对源码架构进行了较大的升级调整，项目从gulp/grunt迁移到rollup，采用多包构建的方式组织代码，我们常常debug的是打包后的文件，本文可以解决我们想debug到源码的问题。 ❞

使用`create-react-app`创建项目

npx create-react-app react-debug

此时，我们如果打一个debugger，会发现调用堆栈是bundle.js：

image-20220902202201589

我们先启用VSCode的调试模式，在项目下新建一个launch.json（注意我这里cra启动的端口是3001）：

{
  // Use IntelliSense to learn about possible attributes.
  // Hover to view descriptions of existing attributes.
  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
  "version": "0.2.0",
  "configurations": [
    {
      "type": "pwa-chrome",
      "request": "launch",
      "name": "Launch Chrome against localhost",
      "url": "http://localhost:3001",
      "webRoot": "${workspaceFolder}"
    }
  ]
}

启动调试就可以看到我们已经可以通过VSCode来调试了：

image-20220902202630782

但是目前还只能调试打包后的代码，我们需要定位到源码。

下载React源码

git clone https://github.com/facebook/react.git

然后我们在React下编译一下代码：

yarn
yarn build

接着我们去外层eject一下，方便调整webpack配置：

npm run eject

然后在config/webpack.config.js下增加alias：

alias: {
        'react-dom$': path.resolve(__dirname, '../react/build/node_modules/react-dom/umd/react-dom.development.js'),
        'react$': path.resolve(__dirname, '../react/build/node_modules/react/umd/react.development.js'),
}

这时跑起来我们发现有报错：

image-20220902205300771

这个是因为ModuleScopePlugin的限制，去配置里把这个插件删掉，我们就发现堆栈走到了最新的react代码里：

image-20220902205546585

但是目前我们还是在development.js里面，想要定位到源码，还需要生成sourceMap。

支持`sourceMap`

首先我们将vscode的sourcemap打开，在launch.json中加入配置：

"sourceMaps": true

然后在react源码编译时，加入sourceMap，更改react/scripts/rollup/build.js：

function getRollupOutputOptions(
  outputPath,
  format,
  globals,
  globalName,
  bundleType
) {
  const isProduction = isProductionBundleType(bundleType);

  return {
    file: outputPath,
    format,
    globals,
    freeze: !isProduction,
    interop: false,
    name: globalName,
    sourcemap: true,
    esModule: false,
  };
}

然后重新运行build，会发现如下报错：

image-20220902210001644

这是因为有些rollup插件不支持sourcemap，在文件里面去掉以下4个插件：

    // {
    //   transform(source) {
    //     return source.replace(/['"]use strict["']/g, '');
    //   },
    // }

    // isProduction &&
    //   closure(
    //     Object.assign({}, closureOptions, {
    //       // Don't let it create global variables in the browser.
    //       // https://github.com/facebook/react/issues/10909
    //       assume_function_wrapper: !isUMDBundle,
    //       renaming: !shouldStayReadable,
    //     })
    //   )

    // shouldStayReadable &&
    //   prettier({
    //     parser: 'babel',
    //     singleQuote: false,
    //     trailingComma: 'none',
    //     bracketSpacing: true,
    //   })

    // {
    //   renderChunk(source) {
    //     return Wrappers.wrapBundle(
    //       source,
    //       bundleType,
    //       globalName,
    //       filename,
    //       moduleType
    //     );
    //   },
    // },

这个时候就可以build起来了。我们可以看到map文件已经生成到目录下：