【React】944- create-react-app初探

前端自习课

共 7901字,需浏览 16分钟

 ·

2021-05-05 09:26

本文由 IMWeb 社区 imweb.io 授权转载自腾讯内部 KM 论坛,原作者:kingfo。点击阅读原文查看 IMWeb 社区更多精彩文章。

create-react-app是一个react的cli脚手架+构建器,我们可以基于CRA零配置直接上手开发一个react的SPA应用通过3种方式快速创建一个React SPA应用:

  1. npm init with initializer (npm 6.1+)

  2. npx with generator (npm 5.2+)

  3. yarn create with initializer (yarn 0.25+)

例如我们新建一个叫my-app的SPA:

  1. my-app

  2. ├── README.md

  3. ├── node_modules

  4. ├── package.json

  5. ├── .gitignore

  6. ├── public

  7. ├── favicon.ico

  8. ├── index.html

  9. └── manifest.json

  10. └── src

  11. ├── App.css

  12. ├── App.js

  13. ├── App.test.js

  14. ├── index.css

  15. ├── index.js

  16. ├── logo.svg

  17. └── serviceWorker.js

通过添加参数生成ts支持:

  1. npx create-react-app my-app --typescript

  2. # or

  3. yarn create react-app my-app --typescript

当然,如果我们是把一个CRA已经生成的js项目改成支持ts,可以:

  1. npm install --save typescript @types/node @types/react @types/react-dom @types/jest

  2. # or

  3. yarn add typescript @types/node @types/react @types/react-dom @types/jest

然后,将.js文件后缀改成.ts重启development server即可。

CRA还能干嘛

CRA除了能帮我们构建出一个React的SPA项目(generator),充当脚手架的作用。还能为我们在项目开发,编译时进行构建,充当builder的作用。可以看到生成的项目中的 package.json包含很多命令:

  1. react-scripts start启动开发模式下的一个dev-server,并支持代码修改时的 HotReload

  2. react-scripts build使用webpack进行编译打包,生成生产模式下的所有脚本,静态资源

  3. react-scripts test执行所有测试用例,完成对我们每个模块质量的保证

这里,我们针对start这条线进行追踪,探查CRA实现的原理。入口为 create-react-app/packages/react-scripts/bin/react-scripts.js,这个脚本会在react-scripts中设置到 package.json的bin字段中去,也就是说这个package可以作为可执行的nodejs脚本,通过cli方式在nodejs宿主环境中。这个入口脚本非常简单,这里只列出主要的一个 switch分支:

  1. switch (script) {

  2. case 'build':

  3. case 'eject':

  4. case 'start':

  5. case 'test': {

  6. const result = spawn.sync(

  7. 'node',

  8. nodeArgs

  9. .concat(require.resolve('../scripts/' + script))

  10. .concat(args.slice(scriptIndex + 1)),

  11. { stdio: 'inherit' }

  12. );

  13. if (result.signal) {

  14. if (result.signal === 'SIGKILL') {

  15. console.log(

  16. 'The build failed because the process exited too early. ' +

  17. 'This probably means the system ran out of memory or someone called ' +

  18. '`kill -9` on the process.'

  19. );

  20. } else if (result.signal === 'SIGTERM') {

  21. console.log(

  22. 'The build failed because the process exited too early. ' +

  23. 'Someone might have called `kill` or `killall`, or the system could ' +

  24. 'be shutting down.'

  25. );

  26. }

  27. process.exit(1);

  28. }

  29. process.exit(result.status);

  30. break;

  31. }

  32. default:

  33. console.log('Unknown script "' + script + '".');

  34. console.log('Perhaps you need to update react-scripts?');

  35. console.log(

  36. 'See: https://facebook.github.io/create-react-app/docs/updating-to-new-releases'

  37. );

  38. break;

  39. }

可以看到,当根据不同command,会分别resolve不同的js脚本,执行不同的任务,这里我们继续看 require('../scripts/start')

  1. // Do this as the first thing so that any code reading it knows the right env.

  2. process.env.BABEL_ENV = 'development';

  3. process.env.NODE_ENV = 'development';

因为是开发模式,所以这里把babel,node的环境变量都设置为 development,然后是全局错误的捕获,这些都是一个cli脚本通常的处理方式:

  1. // Makes the script crash on unhandled rejections instead of silently

  2. // ignoring them. In the future, promise rejections that are not handled will

  3. // terminate the Node.js process with a non-zero exit code.

  4. process.on('unhandledRejection', err => {

  5. throw err;

  6. });

确保其他的环境变量配置也读进进程了,所以这里会通过 ../config/env脚本进行初始化:

  1. // Ensure environment variables are read.

  2. require('../config/env');

还有一些预检查,这部分是作为eject之前对项目目录的检查,这里因为eject不在我们范围,直接跳过。然后进入到了我们主脚本的依赖列表:

  1. const fs = require('fs');

  2. const chalk = require('react-dev-utils/chalk');

  3. const webpack = require('webpack');

  4. const WebpackDevServer = require('webpack-dev-server');

  5. const clearConsole = require('react-dev-utils/clearConsole');

  6. const checkRequiredFiles = require('react-dev-utils/checkRequiredFiles');

  7. const {

  8. choosePort,

  9. createCompiler,

  10. prepareProxy,

  11. prepareUrls,

  12. } = require('react-dev-utils/WebpackDevServerUtils');

  13. const openBrowser = require('react-dev-utils/openBrowser');

  14. const paths = require('../config/paths');

  15. const configFactory = require('../config/webpack.config');

  16. const createDevServerConfig = require('../config/webpackDevServer.config');


  17. const useYarn = fs.existsSync(paths.yarnLockFile);

  18. const isInteractive = process.stdout.isTTY;

可以看到,主要的依赖还是webpack,WDS,以及自定义的一些devServer的configuration以及webpack的configuration,可以大胆猜想原理和我们平时使用webpack并没有什么不同。

因为 create-react-appmy-app之后通过模版生成的项目中入口脚本被放置在src/index.js,而入口html被放置在public/index.html,所以需要对这两个文件进行检查:

  1. // Warn and crash if required files are missing

  2. if (!checkRequiredFiles([paths.appHtml, paths.appIndexJs])) {

  3. process.exit(1);

  4. }

下面这部分是涉及C9云部署时的环境变量检查,不在我们考究范围,也直接跳过。react-dev-utils/browsersHelper是一个浏览器支持的帮助utils,因为在 react-scripts v2之后必须要提供一个browser list支持列表,不过我们可以在 package.json中看到,模版项目中已经为我们生成了:

  1. "browserslist": {

  2. "production": [

  3. ">0.2%",

  4. "not dead",

  5. "not op_mini all"

  6. ],

  7. "development": [

  8. "last 1 chrome version",

  9. "last 1 firefox version",

  10. "last 1 safari version"

  11. ]

  12. }

检查完devServer端口后,进入我们核心逻辑执行,这里的主线还是和我们使用webpack方式几乎没什么区别,首先会通过 configFactory创建出一个webpack的configuration object,然后通过 createDevServerConfig创建出一个devServer的configuration object,然后传递webpack config实例化一个webpack compiler实例,传递devServer的configuration实例化一个WDS实例开始监听指定的端口,最后通过openBrowser调用我们的浏览器,打开我们的SPA。

其实,整个流程我们看到这里,已经结束了,我们知道WDS和webpack配合,可以进行热更,file changes watching等功能,我们开发时,通过修改源代码,或者样式文件,会被实时监听,然后webpack中的HWR会实时刷新浏览器页面,可以很方便的进行实时调试开发。

  1. const config = configFactory('development');

  2. const protocol = process.env.HTTPS === 'true' ? 'https' : 'http';

  3. const appName = require(paths.appPackageJson).name;

  4. const useTypeScript = fs.existsSync(paths.appTsConfig);

  5. const urls = prepareUrls(protocol, HOST, port);

  6. const devSocket = {

  7. warnings: warnings =>

  8. devServer.sockWrite(devServer.sockets, 'warnings', warnings),

  9. errors: errors =>

  10. devServer.sockWrite(devServer.sockets, 'errors', errors),

  11. };

  12. // Create a webpack compiler that is configured with custom messages.

  13. const compiler = createCompiler({

  14. appName,

  15. config,

  16. devSocket,

  17. urls,

  18. useYarn,

  19. useTypeScript,

  20. webpack,

  21. });

  22. // Load proxy config

  23. const proxySetting = require(paths.appPackageJson).proxy;

  24. const proxyConfig = prepareProxy(proxySetting, paths.appPublic);

  25. // Serve webpack assets generated by the compiler over a web server.

  26. const serverConfig = createDevServerConfig(

  27. proxyConfig,

  28. urls.lanUrlForConfig

  29. );

  30. const devServer = new WebpackDevServer(compiler, serverConfig);

  31. // Launch WebpackDevServer.

  32. devServer.listen(port, HOST, err => {

  33. if (err) {

  34. return console.log(err);

  35. }

  36. if (isInteractive) {

  37. clearConsole();

  38. }


  39. // We used to support resolving modules according to `NODE_PATH`.

  40. // This now has been deprecated in favor of jsconfig/tsconfig.json

  41. // This lets you use absolute paths in imports inside large monorepos:

  42. if (process.env.NODE_PATH) {

  43. console.log(

  44. chalk.yellow(

  45. 'Setting NODE_PATH to resolve modules absolutely has been deprecated in favor of setting baseUrl in jsconfig.json (or tsconfig.json if you are using TypeScript) and will be removed in a future major release of create-react-app.'

  46. )

  47. );

  48. console.log();

  49. }


  50. console.log(chalk.cyan('Starting the development server...\n'));

  51. openBrowser(urls.localUrlForBrowser);

  52. });


  53. ['SIGINT', 'SIGTERM'].forEach(function(sig) {

  54. process.on(sig, function() {

  55. devServer.close();

  56. process.exit();

  57. });

  58. });

通过 start命令的追踪,我们知道CRA最终还是通过WDS和webpack进行开发监听的,其实 build会比 start更简单,只是在webpack configuration中会进行优化。CRA做到了可以0配置,就能进行react项目的开发,调试,打包。

其实是因为CRA把复杂的webpack config配置封装起来了,把babel plugins预设好了,把开发时会常用到的一个环境检查,polyfill兼容都给开发者做了,所以使用起来会比我们直接使用webpack,自己进行重复的配置信息设置要来的简单很多。


关注我们

IMWeb 团队隶属腾讯公司,是国内最专业的前端团队之一。

我们专注前端领域多年,负责过 QQ 资料、QQ 注册、QQ 群等亿级业务。目前聚焦于在线教育领域,精心打磨 腾讯课堂、企鹅辅导 及 ABCMouse 三大产品。

社区官网

http://imweb.io/

加入我们

https://hr.tencent.com/position_detail.php?id=45616


1. JavaScript 重温系列(22篇全)
2. ECMAScript 重温系列(10篇全)
3. JavaScript设计模式 重温系列(9篇全)
4. 正则 / 框架 / 算法等 重温系列(16篇全)
5. Webpack4 入门(上)|| Webpack4 入门(下)
6. MobX 入门(上) ||  MobX 入门(下)
7. 120+篇原创系列汇总

回复“加群”与大佬们一起交流学习~

点击“阅读原文”查看 120+ 篇原创文章

浏览 18
点赞
评论
收藏
分享

手机扫一扫分享

分享
举报
评论
图片
表情
推荐
点赞
评论
收藏
分享

手机扫一扫分享

分享
举报