如何用webpack4从头开始构建react应用

原文: How to Create a React app from scratch using Webpack 4
作者: Linh Nguyen My

译文正文

在过去三个周,我试图从头构建一个React应用以此来熟悉Webpack。我的目标是创建一个简单的webpack配置,将来还能以再扩展。弄清Webpack是一件艰难的事情,不过感谢Valentino Gagliardi的教程,给了我很大的启发。

我计划做一个搜索功能,数据来源于假的JSON文件。在这篇文章里,我将详细阐述我是如何建立我这个项目的。在下一篇里,我将谈到如何写测试。我也想用Node.js做为此项目的服务器,不过目前还不能确定这是否超出此项目需要。

(注意我在文章结尾提供了本项目Webpack的详细配置)

好了,那我们开始吧!

创建一个新项目,并cd进入。

$ mkdir react_search
$ cd react_search

创建package.json文件:

$ npm init

如果你想跳过初始化时的问题,加上 -y:

$ npm init -y

我们需要安装webpack的开发依赖,同时安装webpack-cli以便在命令行使用webpack.

$ npm i webpack webpack-cli -D
  • i: install
  • -D:-- save-dev

创建名为src的目录,并在src里新建index.js,并贴上如下代码:

console.log("hello");

接下来在package.json里加入代码 (script里):

{
  "name": "react_search",
  "version": "1.0.0",
  "description": "Search app using React",
  "main": "index.js",
  "scripts": {
    "start": "webpack --mode development",
    "build": "webpack --mode production"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "webpack": "^4.0.1",
    "webpack-cli": "^2.0.10"
  }
}

Webpack4有两种模式,developmentproduction,代码在后面将会被压缩。

执行看效果:

$ npm run start

此命令执行完毕你会看到新增了一个dist目录,里面有一个main.js文件。


1.png

如果你执行:

$ npm run build

你将会看到如下结果:


2.png

安装 React 和 Babel

如果要使用React,我们必须同时安装Babel。Babel将ES6语法转换成ES5,因为不是所有浏览器都支持ES6(比如IE)

安装reactreact-dom依赖:

$ npm i react react-dom -S
  • -S:-- save

接下来安装babel-core, babel-loader, babel-preset-envbabel-preset-react作为开发依赖(dev dependency)。

$ npm i babel-core babel-loader babel-preset-env babel-preset-react -D
  • babel-core: 将ES6转换程ES5
  • babel-loader: Webpack工具,帮助你用Babel转换Javascript依赖(例如,当你在一个组件里import另一个组件)
  • babel-preset-env: 决定使用什么插件或转换工具(为老旧浏览器提供polyfill。)
  • babel-preset-react: 为所有React插件所用的Babel的预先设置工具,比如将JSX转换成函数(方法)。

我们需要创建webpack.config.js文件,配置我们的babel-loader规则。

module.exports = {
  module: {
    rules: [
      {
        test: /\.js$/,
        exclude: /node_modules/,
        use: {
          loader: "babel-loader"
        }
      }
    ]
  }
};

我们还需要创建.babelrc文件,配置babel-loader选项。你可以将.babelrc的内容直接写到webpack.config.js文件里,不过我看很多项目都是将这两者分开写,这样可读性更强,而且和webpack不相干的工具也可以使用这个配置。当你在webpack.config.js里配置了babel-loader,它就会去找项目里是否有.babelrc这个文件。

{
  "presets": ["env", "react"]
}

接下来,改写你的index.js文件,渲染一个组件:

import React from "react";
import ReactDOM from "react-dom";

const Index = () => {
  return <div>Hello React!</div>;
};

ReactDOM.render(<Index />, document.getElementById("index"));

与此同时,我们需要在src目录下创建一个index.html文件,在其中增加带有id的DOM元素,在这个元素里渲染react组件。

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <meta http-equiv="X-UA-Compatible" content="ie=edge">
  <title>React and Webpack4</title>
</head>
<body>
  <section id="index"></section>
</body>
</html>

安装html-webpack-plugin,并在webpack.config.js中配置该插件。该插件生成一个内嵌<script>的HTML文件,并将该文件写入到dist/index.html中。

安装html-webpack-plugin作为开发依赖:

$ npm i html-webpack-plugin -D

像如下这样更新webpack config:

const HtmlWebPackPlugin = require("html-webpack-plugin");

const htmlPlugin = new HtmlWebPackPlugin({
  template: "./src/index.html",
  filename: "./index.html"
});

module.exports = {
  module: {
    rules: [
      {
        test: /\.js$/,
        exclude: /node_modules/,
        use: {
          loader: "babel-loader"
        }
      }
    ]
  },
  plugins: [htmlPlugin]
};

你也可以这样写配置:

plugins: [
    new HtmlWebPackPlugin({
    template: "./src/index.html",
    filename: "./index.html"
  });
]

但我更喜欢变量的形式,这样我就能对使用的插件一目了然。

template对应的值表示我在哪里去找HTML文件。filename对应的值表示在dist目录中生成的HTML文件的文件名。

现在执行npm run start,你会看见dist目录里生成了index.html

3.png

打开dist/index.html你会在浏览器中看到“Hello React”字样。

安装 webpack-dev-server

如果每次更改了文件内容,想在浏览器里看更新,都需要重新执行上述命令,这未免太繁琐。我们用webpack-dev-server 模块,可以让webpack自动监测你任何组件内代码的修改,并自行刷新网页。

安装webpack-dev-server为开发依赖:

$ npm i webpack-dev-server -D

改写package.json:

{
  "name": "react_search",
  "version": "1.0.0",
  "description": "Search app using React",
  "main": "index.js",
  "scripts": {
    "start": "webpack-dev-server --mode development --open",
    "build": "webpack --mode production"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "dependencies": {
    "react": "^16.2.0",
    "react-dom": "^16.2.0"
  "devDependencies": {
    "babel-core": "^6.26.0",
    "babel-loader": "^7.1.4",
    "babel-preset-env": "^1.6.1",
    "babel-preset-react": "^6.24.1",
    "html-webpack-plugin": "^3.0.6",
    "webpack": "^4.1.1",
    "webpack-cli": "^2.0.10",
    "webpack-dev-server": "^3.1.0"
  }
}

执行npm run start,默认浏览器打开了url地址为localhost:8080的网页,这就是--open的作用。现在,你每改一处代码,浏览器就会自行刷新。

你也可以在启动命令npm run start上加上--hot,这个命令会让浏览器只刷新你更改的组件部分,而不会刷新整个网页。这就是Hot Module Replacement

配置 CSS

最后一部分讲述的是如何配置CSS。在我们的React组件里我们要导入CSS文件,所以我们需要用到css-loader模块来解析它们。一旦解析成功,我们还需要用style-loader将css添加到DOM中——HTML文件<head>下的<style>标签里。

添加开发依赖:

$ npm i css-loader style-loader -D

修改webpack.config.js:

const HtmlWebPackPlugin = require("html-webpack-plugin");

const htmlWebpackPlugin = new HtmlWebPackPlugin({
  template: "./src/index.html",
  filename: "./index.html"
});

module.exports = {
  module: {
    rules: [
      {
        test: /\.js$/,
        exclude: /node_modules/,
        use: {
          loader: "babel-loader"
        }
      },
      {
        test: /\.css$/,
        use: ["style-loader", "css-loader"]
      }
    ]
  },
  plugins: [htmlWebpackPlugin]
};

注意,这里添加loaders的顺序很重要。首先,我们需要解析css文件,然后再通过style-loader将其加入到DOM中。wepack默认按照从右(数组中最后一个元素)到左(数组中第一个元素)的顺序使用loader。

模块化CSS

webpack还可以将CSS模块化,即class名称将根据不同组件进行隔离。

为了实现模块化,我们给css-loader增加一些选项:

const HtmlWebPackPlugin = require("html-webpack-plugin");

const htmlWebpackPlugin = new HtmlWebPackPlugin({
  template: "./src/index.html",
  filename: "./index.html"
});

module.exports = {
  module: {
    rules: [
      {
        test: /\.js$/,
        exclude: /node_modules/,
        use: {
          loader: "babel-loader"
        }
      },
      {
        test: /\.css$/,
        use: [
          {
            loader: "style-loader"
          },
          {
            loader: "css-loader",
            options: {
              modules: true,
              importLoaders: 1,
              localIdentName: "[name]_[local]_[hash:base64]",
              sourceMap: true,
              minimize: true
            }
          }
        ]
      }
    ]
  },
  plugins: [htmlWebpackPlugin]
};

为了设置选项,我们将loader写成了object形式。将module设置成true,使之支持CSS模块化。importLoaders则定义了在css-loader之前需要加载的loaders数量。例如,sass-loader就需要在css-loader之前加载。

localIdentName选项是为了设置生成的class标识。

  • [name] component的名字
  • [local] class/id的名称
  • [hash:base64] 随机生成的CSS hash字符串,每一个component的hash值不一样。

为了更直观,我举个例子。比如我有一个叫Form的component,里面button的class名为primaryButton。与此同时我有另外一个叫Search的component,里面button的class名也为primaryButton。但是这俩class的css值却不一样:

Form button
.primaryButton {
  background-color: green;
}
Search button
.primaryButton {
  background-color: blue;
}

当webpack将你应用打包后,后一个出现的同名css样式将会污染前一个。在这个例子中,你的两个按钮都会是绿色或着蓝色,没有达到预期目标。

这时localIdentName就显得意义重大了。有了它,在你用webpack打包时,你的两个按钮都会拥有唯一的class名称。

4.png

如图所示,Form组件和Search组件里按钮的class名不相同。该class名由组件名、class名、唯一hash字符串组成。

因此,你就不必担心不同组件里会由相同的class名称——你只需要注意同一组件里的class命名即可。

好了,这里就是“如何从头开始创建React应用”的第一部分了。

希望有所帮助!

Github

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,616评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,020评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,078评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,040评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,154评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,265评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,298评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,072评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,491评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,795评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,970评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,654评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,272评论 3 318
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,985评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,223评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,815评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,852评论 2 351

推荐阅读更多精彩内容