經過create-react-app從零搭建react環境

1、 快速開始:

  • 全局安裝腳手架:
$ npm install -g create-react-app
  • 經過腳手架搭建項目:
$ create-react-app <項目名稱>
  • 開始項目:
$ cd <項目名>
$ npm run start

2、 查看項目package.json配置

2.1 package.json 一覽
{
  ......
  "homepage": ".",
  "dependencies": {
    "react": "^16.4.0",
    "react-dom": "^16.4.0",
    "react-scripts": "1.1.4"
  },
  "scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build",
    "test": "react-scripts test --env=jsdom",
    "eject": "react-scripts eject"
  }
}
2.2 可用腳本命令說明:
  • 首先說明:經過npm run 執行下面命令其實是運行 node_modules/react-srcipt/script下對應的腳本文件;
  • npm run start : 開始項目,經過http://localhost:3000 可訪問項目;
  • npm run build : 項目打包,在生產環境中編譯代碼,並放在build目錄中;全部代碼將被正確打包,並進行優化、壓縮同時使用hash重命名文件;執行該命令前須要在package.json中新增條配置"homepage": "."(上面配置文件已給出), 同時build後的項目須要在服務器下才能訪問;不然打開的將是空白頁面;
  • npm run test : 交互監視模式下啓動測試運行程序;
  • npm run eject : 將隱藏的配置導出;須要知道的是create-react-app腳手架本質上是使用react-scripts進行配置項目,全部配置文件信息都被隱藏起來(node_modules/react-scripts);當須要手動修改擴展webpack配置時有時就須要將隱藏的配置暴露出來;特別須要注意的是該操做是一個單向操做,一旦使用eject,那麼就不能恢復了(再次將配置隱藏);

3、 自動生成的項目目錄以及文件解析:

  • node_modules : 項目依賴包目錄;
  • public: 公共目錄,該目錄下的文件都不會被webpack進行加載、解析、打包;經過npm run build進行打包時該項目下的全部文件將會直接被複制到build目錄下;css

    • favicon.ico : 是網站圖標[可替換刪除]
    • index.html: 頁面模板,webpack打包後將輸出文件引入到該模板內;補充:index.html中經過環境變量%PUBLIC_URL% 來指向public目錄路徑;
    • manifest.json: PWA將應用添加至桌面的功能的實現依賴於 manifest.json 。經過manifest.json 文件能夠對圖標、名稱等信息進行配置。
  • src: 是源碼目錄該目錄下除了index.js App.test.js registerServiceWorker.js 文件具備必定意義其他文件都是演示使用可直接刪除html

    • index.js: 是整個項目的入口文件;
    • App.test.js: 測試單元演示文件,暫時並不知道幹嗎用;能夠直接刪除;
    • registerServiceWorker.js: service worker 是在後臺運行的一個線程,能夠用來處理離線緩存、消息推送、後臺自動更新等任務;registerServiceWorker就是爲react項目註冊了一個service worker,用來作資源的緩存,這樣你下次訪問時,就能夠更快的獲取資源。並且由於資源被緩存,因此即便在離線的狀況下也能夠訪問應用(此時使用的資源是以前緩存的資源)。注意,registerServiceWorker註冊的service worker 只在生產環境中生效,而且該功能只有在https下才能有效果;
  • .gitignore: 該文件是github過濾文件配置
  • README.md: 該文件是github描述文件
  • package.json: 定義了項目所須要的各類模塊,以及項目的配置信息(好比名稱、版本、許可證等元數據)。部分依賴模塊被隱藏;
  • yarn.lock:每次經過yarm添加依賴或者更新包版本時 yarn都會把相關版本信息寫入yarn.lock文件;npm也有相似功能,npm 也能夠生成一個鎖文件,就是使用上沒有yarn方便

4、 擴展webpack配置(以 less爲例)

4.1 方法一:將 webpack 配置暴露出來並進行修改
  • 暴露配置文件:
$ npm run eject
說明: 執行eject腳本後,項目下會新增或對部分配置文件進行修改;項目下 script 目錄存放着腳本文件, config 目錄下存放着配置文件
  • 下載安裝依賴:less-loader less
$ npm install less-loader less -dev
  • 修改 config 目錄下的webpack配置文件:
// 需同時修改下面的兩個文件:
// 開發環境下的配置文件:webpack.config.dev.js 
// 生產環境下的配置文件:webpack.config.prod.js
// 兩個文件的修改內容相同,對應修改內容以下(三處須要進行修改)
......
{
    // 【1】修改文件匹配正則
    test: /\.(css|less)$/, 
    use: [
        require.resolve('style-loader'),
        {
            loader: require.resolve('css-loader'),
            options: {
            // 【2】將本來數字 1  改成數字2
            importLoaders: 2,
        },
        },
        { .... },
        // 【3】添加新的加載配置對象
        {
            loader: require.resolve('less-loader'),
        }
    ],
}
......
4.2 方法二:使用 react-app-rewired 對 webpack 進行自定義配置(覆蓋或添加)
  • 安裝依賴包 react-app-rewired:
$ npm install react-app-rewired --save-dev
  • 修改 package.json 中的腳本命令:修改以下
"scripts": {
    "start": "react-app-rewired start",
    "build": "react-app-rewired build",
    "test": "react-app-rewired test --env=jsdom",
    "eject": "react-app-rewired eject"
  }
  • 在項目根目錄下(和 package.json 同級)新建配置文件 config-overrides.js ,並添加以下內容
module.exports = function override(config, env) {
    // 在這裏添加配置
    return config;
}
  • 安裝依賴包 react-app-rewire-less,經過該依賴包來實現對 less 的支持:
$ npm install react-app-rewire-less --save
說明: 這裏再也不須要額外單獨安裝依賴包:less-loader  less
  • 修改 config-overrides.js 配置文件,爲 webpack 配置 less
const rewireLess = require('react-app-rewire-less');
module.exports = function override(config, env) {
  // 只須要一條配置信息便可實現對less的支持
  config = rewireLess(config, env);
  // 下面註釋用於配置loader的參數
  // config = rewireLess.withLoaderOptions(someLoaderOptions)(config, env);
  return config;
}

5、 在 create-react-app 中使用Antd

5.1 通常使用方法(不推薦)
  • 搭建項目:
$ create-react-app demo
$ cd demo
$ npm run start
  • 引入 antd 依賴包:
$ npm install npm
  • 引入 antd 組件以前須要先引入 antd 樣式( 在項目入口引入全部樣式 ):
import antd/dist/antd.css
  • 在項目中引入 antd 組件
import { Button } from 'antd';
5.2 按需加載
- 上面引入組件和樣式的方式,會一次性加載全部樣式並引入組件中的全部相應模塊;
- 這種引入方式將會影響到應用的網絡性能;
- 相應的就須要改變引入組件和樣式的方式,實現樣式和組件的按需加載;
- 下面將介紹三種按需加載組件樣式的方法:

5.2.1 方法一: 精確加載組件node

import Button from 'antd/lib/button';
import 'antd/lib/button/style'; 
// 或者經過import antd/lib/button/style/css 進行加載樣式

5.2.2 方法二:經過暴露配置 配合 babel-plugin-import插件實現按需加載
babel-plugin-import 是一個用於按需加載組件代碼和樣式的 babel 插件react

  • 暴露配置
$ npm run eject
  • 安裝插件:
$ npm install babel-plugin-import --save-dev
  • 修改 package.json
"babel": {
  "presets": [
    "react-app"
  ],
  "plugins": [
    ["import", { "libraryName": "antd", "libraryDirectory": "es", "style": "css" }]
  ]
},
  • 配置完後可直接導入 antd 的組件,再也不須要另外引入css樣式;
import { Button } from 'antd';9

5.2.2 方法三:經過 babel-plugin-import + react-app-rewired實現按需加載(官網推薦)webpack

  1. react-app-rewired:的使用上文有過描述;主要用於在不暴露配置的狀況下對webpack的配置進行擴展;
  2. babel-plugin-import 是一個用於按需加載組件代碼和樣式的 babel 插件
  • 安裝依賴包:babel-plugin-import
$ npm install babel-plugin-import --save-dev
  • 經過 react-app-rewired 對 webpack 配置進行擴展添加新的babel插件,config-overrides.js 修改 ( 添加 ) 以下內容:
// 引入 react-app-rewired 添加 babel 插件的函數
const { injectBabelPlugin } = require('react-app-rewired');
module.exports = function override(config, env) {
    config = injectBabelPlugin(['import', 
        { libraryName: 'antd', libraryDirectory: 'es', style: 'css' }], config);
    return config;
};
  • 配置完後可直接導入 antd 的組件,再也不須要另外引入css樣式;
import { Button } from 'antd';9
5.3 經過 react-app-rewired 擴展 webpack 來實現 antd 自定義主題

主要經過利用了 less-loader 的 modifyVars 參數來進行主題配置git

  • 安裝配置:react-app-rewired (上文已經詳細介紹過這裏就再也不細說)
  • 安裝依賴包 react-app-rewire-less :實現對 less 的支持同時添加 modifyVars 加載參數設置
$ npm react-app-rewire-less --save-dev
  • 修改 config-overrides.js 配置文件
const rewireLess = require('react-app-rewire-less');
const { injectBabelPlugin } = require('react-app-rewired');
module.exports = function override(config, env) {
    // 擴展 webpack ==> 支持less
    config = rewireLess(config, env);
    // 配置loader參數
    config = rewireLess.withLoaderOptions({
        // 修改默認顏色 實現自定義主題
        modifyVars: { "@primary-color": "#1DA57A" },
   })(config, env);
   // antd 按需加載配置
    config = injectBabelPlugin(['import', 
        { libraryName: 'antd', libraryDirectory: 'es', style: true }], config);
    return config;
}
5.4 經過插件 babel-plugin-transform-decorators-legacy 實現對修飾器的支持

5.4.1 經過暴露配置實現github

  • 暴露配置
$ npm run eject
  • 安裝插件:
$ npm install --save-dev babel-plugin-transform-decorators-legacy
  • 修改 package.json
"babel": {
  "presets": [
    "react-app"
  ],
  "plugins": [
    ["transform-decorators-legacy"]
  ]
},

5.4.2 使用插件 react-app-rewired 對配置進行擴展實現對修飾器的支持web

  • react-app-rewired 的使用詳見上文:
  • 安裝插件:
$ npm install --save-dev babel-plugin-transform-decorators-legacy
  • 編寫 config-overrides.js 配置文件
// 導入添加babel插件的函數
const { injectBabelPlugin } = require('react-app-rewired');
module.exports = function override(config, env) {
  // do stuff with the webpack config...
  // 修飾器擴展 (添加babel插件:transform-decorators-legacy )
  config = injectBabelPlugin('transform-decorators-legacy', config)
  return config;
};

6、 常見問題:

6.1 經過 react-app-rewired 進行擴展配置時 發現啓動項目後並無效果?
  • 在確保一塊兒配置沒有問題下:
  • 請確認是否有對腳本命令進行了正確的修改,使用react-app-rewired 擴展配置須要修改腳本命令
{
  ....
  "scripts": {
    "start": "react-app-rewired start",
    "build": "react-app-rewired build",
    "test": "react-app-rewired test --env=jsdom",
    "eject": "react-app-rewired eject"
  },
...
}
相關文章
相關標籤/搜索