React 搭建开发环境

  1. 云栖社区>
  2. 博客列表>
  3. 正文

React 搭建开发环境

溜达向日葵 2018-07-06 17:17:07 浏览6972 评论0

摘要: 本系列文章介绍了本人以及团队从无到有使用React的过程,我们将从Nodejs、webpack的环境搭建开始说起随后的内容会逐步深入到React的所有内容。工欲善必须利其器,想要高效的开发react,必须保证有一个高效有序的开发环境。

React

本文记录了本人以及目前团队从无到有使用React的过程,我们将从webpack开始说起,一步一步展现React最基本的开发生态。在这里并不会介绍任何jsx或es6相关的语法,只聚焦于如何使用react生态搭建利于团队协作、有利于提升开发效率的开发环境。

脚手架工具——webpack 

工欲善必须利其器,想要高效的开发react,必须保证有一个高效有序的开发环境。我们使用的是Facebook开源的脚手架工具——webpack来搭建一个完全不依赖服务器的开发环境。实现高效集成、实时编辑可见、动态编译jsx和es6等强悍功能。

添加webpack

webpack最早是Facebook的instagram团队研发出的脚手架工具,用于支持前端系统的开发。虽然webpack一直都和react嵌套在一起使用,但是他的使用场景并不局限于react,你可以把他应用于所有的前端开发场景。

webpack也是依赖nodejs和npm的,在安装webpack之前务必先安装nodejs的环境,如果在此之前你还没有安装nodejs的环境,可以看这篇关于nodejs安装的文章获得一些参考。

可以像下面这样安装一个全局的webpack环境。

$ npm install webpack -g

或者以依赖工程的方式安装

# 进入项目目录
# 确定已经有 package.json,没有就通过 npm init 创建
# 安装 webpack 依赖
$ npm install webpack --save-dev

测试运行webpack

(本例子的代码存放在:https://github.com/chkui/webpack-demo。下载后用 npm install 下载npm依赖即可使用。)

Setp1:简单打包

首先我们增加一些用于测试元素。先写一个index.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
    <script src="bundle.js"></script>
</body>
</html>

然后添加一个entry.js

/**
 * Created by chkui on 2016/11/16.
 */
require("!style!css!./style.css");
document.write('<h1>hello webpack</h1>');

然后就可以执行打包命令了:

$ webpack ./entry.js bundle.js

运行以后,就会发现在目录中生成了一个bundle.js文件。浏览器中打开index.html就会看到执行效果。

Step2:利用webpack分析工具打包 

增加一个名为module.js的文件:

/**
 * Created by chkui on 2016/11/16.
 */
module.exports = 'It works from module.js.'

在原来的entry.js增加引用:

/**
 * Created by chkui on 2016/11/16.
 */
require("!style!css!./style.css");
document.write('<h1>hello webpack</h1>');
//新增对module.js的引用
document.write(require('./module.js'));

然后同样执行webpack打包命令:

$ webpack ./entry.js bundle.js

然后在打开index.html,会发现我们新增加的module.js的内容被正确输出。这是因为我们在页面中通过nodejs的require的方式引入的module.js,而使用webpack打包时会自动在依赖关系中引入module.js。

加载器

webpack提供了一个非常强大的loader功能,这个功能可以用于管理各种依赖关系模块,在webpack中所有的文件都视作一个模块。

首先npm导入webpack loader:

npm install css-loader style-loader

添加一个用于测试的style.css文件:

h1{
    color:red;
}

在entry.js中添加引用:

/**
 * Created by chkui on 2016/11/16.
 */
require("!style!css!./style.css");//添加对css的引用
document.write('<h1>hello webpack</h1>');
document.write(require('./module.js'));

使用命令行打包:

webpack ./entry.js bundle.js --module-bind 'css=style!css'

会发现css的样式生效了。可以将繁琐的“!style!css!./style.css”简写成"./style.css"。

使用配置管理

细心的人会发现,我们每次使用命令行打包都带了大量的参数,这样不仅繁琐更不利于规模化使用。webpack同样可以使用标准化配置文件来替代命令行中的各种参数。

webpack的配置文件是nodejs的文件,通常命名为 webpack.config.js。我们在工程中增加配置文件:

/**
 * Created by chkui on 2016/11/16.
 */
module.exports = {
    entry: './entry.js',//定义要引入的js文件
    output: {
        path: __dirname,
        filename: 'bundle.js' //定义要输出的js文件
    },
    module: {
        loaders: [//定义加载内容
            {test: /\.css$/, loader: 'style!css'}
        ]
    }
}

现在,我们在命令行中输入webpack就可以实现和前面一样的打包。

丰富打包输出内容

可以使用:

webpack --progress --colors

命令来丰富打包输出的内容,更容易了解出现的问题。

监听更新模式

在我们进行编码开发的时候,每次对文件的编辑我们都想立即看到编译效果,如果每次编辑都要去打包,会非常麻烦。webpack提供了一个监听模式(类似grunt的watch),用于监听每次对文件的修改,修改后会立即进行增量更新。启用监听模式:

webpack --progress --colors --watch

监听模式使用的是内存增量更新。webpack会将所有需要打包的文件copy到内存,然后监控文件修改,如果文件发生了修改,会将修改的文件替换内存中的对应文件。因此开发完之后,切记进行一次手动打包才能生效。

开发环境模式

webpack更强大的是,他整合了nodejs的express提供了一个静态服务器。(虽然没有官方正式,我觉得webstrom和微信本地开发环境都是整合的nodejs的express)

使用了开发环境模式,我们所有的动态修改和操作都可以实时看到效果,并且解决了静态资源各种路径引用的问题。首先npm安装工具:

npm install webpack-dev-server -g

然后使用命令行工具启用开发环境:

webpack-dev-server --progress --colors

webpack的开发环境模式很强悍,比使用--watch更犀利的地方在于可以实现编辑即可见。浏览器立即同步刷新运行。开发环境模式可以延伸到生产环境实现代码同步级别的热部署。 

开发环境扩展——Linux下文件变化监控个数配置

webpack在linux下监控文件的变化用到了 Inotify机制。有可能在文件比较多的时候修改、编辑文件无法触发webpack热部署。我们可以通过一下方式检测并调整监控文件个数:

#检查inotify监控文件的个数
cat /proc/sys/fs/inotify/max_user_watches

然后可以

#将同时监控的文件个数修改为18000
echo fs.inotify.max_user_watches=18000 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p

再次查看个数可以看到输出已经配置的参数

开发环境扩展——webstorm的坑

由于本人的前端页面使用webstorm开发,在使用过程中发现了一个webstorm的坑。webstorm有文件缓存的功能,在编辑完毕保存之后并不会实时的更新磁盘文件,这样的就导致webpack的开发环境无法同步更新文件。以下是解决方法:

1.File->settings->System Settings

2.找到弹出框的Use "safe write",将其勾选解除。

React 搭建开发环境

输出调试信息

webpack的配置较为复杂,一不小心就会出现错误。它提供了一个输出调试信息的参数:

$ webpack --display-error-details

调试运行webpack命令出错的时候使用。Webpack 中涉及路径配置最好使用绝对路径,建议通过 path.resolve(__dirname, "app/folder") 或 path.join(__dirname, "app", "folder") 的方式来配置,以兼容 Windows 环境。

webpack插件

某些时候,webpack的常规功能无法满足我们的需求,我们可以为webpack开发插件,或者使用其他开发团队已经完成的插件。

下面是一个插件的标准格式:

function MyPlugin(options) {
  // Configure your plugin with options...
}

MyPlugin.prototype.apply = function(compiler) {
  compiler.plugin("compile", function(params) {
    console.log("The compiler is starting to compile...");
  });

  compiler.plugin("compilation", function(compilation) {
    console.log("The compiler is starting a new compilation...");

    compilation.plugin("optimize", function() {
      console.log("The compilation is starting to optimize files...");
    });
  });

  compiler.plugin("emit", function(compilation, callback) {
    console.log("The compilation is going to emit files...");
    callback();
  });
};

module.exports = MyPlugin;

需要实现什么功能,可以按照这个标准去开发自己的插件。

React开发

使用webpack搭建好开发环境后,我们就可以开始着手开发react了。开始之前,我们还是要优先完成开发环境的配置和搭建。

react使用的语法是jsx,现在还新增了对es6的支持。为了可以高效开发,我们需要使用webpack的loader功能,将jsx或es6使用语法糖转义成浏览器可以识别的标准JavaScript语法。

下面将继续在前文webpack的基础上继续说明如何开发react。

安装必要的依赖工具

react的基础工具包:

$ npm install react --save-dev

react的dom组件:

$ npm install react react-dom --save-dev

在前面介绍webpack的时候已经介绍了加载器的概念,这里需要额外安装babel用于对react的jsx风格的编码进行解析,babel除了jsx外还可以解析es6等。安装babel:

$ npm install babel-loader

安装babel-loader之后\node_modules目录中会额外多安装一个babel-core,这是babel的核心包。

有了babel,我们还需要安装编码转换规则,用于解析jsx、es6等等。

$ npm install babel-preset-es2015 babel-preset-react --save-dev

除了babel提供的es6和jsx,webpack还可以使用各种loader来转换编码,比如coffeescript等。想要什么就去google找吧。

完善本地开发环境命令

前面的案例使用 webpack-dev-server 来热部署本地开发环境提升开发效率。但是每次都靠长长的命令行启动和停止太过于繁琐。我们可以利用npm的package.json配置脚本运行来统一管理脚本命令:

{
  "name": "demo2-react",
  "version": "1.0.0",
  "description": "react demo",
  "main": "index.js",
  "scripts":{
    "dev": "webpack-dev-server --progress --colors --inline" //配置运行命令
  },
  //more
}

添加了scripts后,我们今后只需要运行

$ npm run dev

即可使用配置好的命令行参数启动本地开发环境服务器。

终于可以开始码农的核心工作了

(demo代码存放在:https://github.com/chkui/react-demo。下载后用 npm install 下载npm依赖即可使用)

前面准备了这么久,就是为了随后我们可以快乐的编码。首先我们按照下面这个结构创建工程结构:

/root
--/dev
----/js
------/index
--------/comps
----------component1.jsx
----------main.jsx
--------index.js
----/style
------/index
--------index.css
----index.html

然后根据工程的结构修改我们的webpack.config.js:

/**
 * Created by Administrator on 2016/11/17.
 */
var path = require('path');
module.exports = {
    entry: ['./dev/js/index/comps/main.jsx'],//定义要引入的js文件
    output: {
        path: __dirname,
        filename: './dev/js/index/index.js' //定义要输出的js文件
    },
    module: {
        loaders: [{
            test: /\.js[x]?$/,
            exclude: /(node_modules|bower_components)/,
            loader: 'babel-loader',
            query: {
                presets: ['es2015','react']
            }
        }, {
            test: /\.css$/,
            loader: 'style!css'
        }, {
            test: /\.(png|jpg)$/,
            loader: 'url?limit=25000' //只解析小于25000字节的图片
        }]
    }
};

和前面介绍webpack的例子相比,这里的配置文件新增了了一个babel-loader的配置。

test后的正则表达式表示对所有的js或者jsx文件进行解析;

exclude表示不解析npm安装目录下和bower安装目录下的文件;

loader表示使用的解析工具;

query表示扩展参数,这里的'es2015'和'react'表示启用babel-preset-es2015和bable-preset-react解析规则。这里需要注意的是解析的优先级的倒序的,即会先解析‘react’。

然后我们添加编码内容(所有的例子都分别实现了jsx规范和es2015规范):

index.html:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
    <div id="comp"></div>
    <script src="/dev/js/index/index.js"></script>
</body>
</html>

main.jsx:

/**
 * Created by chkui on 2016/11/17.
 */

//jsx
/*
var React = require('react');
var ReactDOM = require('react-dom');
var Comp1 = require('./component1.jsx');
require('../../../style/index/index.css');

ReactDOM.render(
    <div className="main">
        react jsx demo:
        <Comp1 />
    </div>,
    document.getElementById('comp')
);
*/

//es2015
import React from 'react';
import ReactDOM from 'react-dom';
import Comp1 from './component1.jsx' /*切记,大写是变量小写是标签*/
import style from '../../../style/index/index.css'

ReactDOM.render(
    <div className="main">
        react es2015 demo:
        <Comp1 />
    </div>
    ,
    document.getElementById('comp')
);

component1.jsx:

/**
 * Created by Administrator on 2016/11/17.
 */

//jsx
/*
var React = require('react');
var comp1 = React.createClass({
    render: function () {
        return (
          <div className = "index">
            hello react!
          </div>
        );
    }
});
module.exports = comp1;
*/

//es6
import React from "react"
class Comp1 extends React.Component{
    //构造函数
    constructor(...args){
        super(...args);
    }
    //覆盖父类的渲染方法
    render() {
        return (
            <div className = "index">
                hello react!
            </div>
        );
    }
}
export default Comp1;

编码完毕之后,我们使用我们设定好的脚本运行我们的本地开发环境:

$ npm run dev

启动时,所有的文本都会被读取到内存中,我们可以根据输出来聊天到底添加了哪些依赖的文件。启动完成后,浏览器上输入 http://localhost:8080/dev/index.html 或 http://localhost:8080/webpack-dev-server/dev/index.html 即可看到我们用react开发的页面。此时修改js或css文件,编辑效果都会立刻呈现在浏览器上。

React浏览器调试工具

Facebook提供了基于chrome的页面调试工具,可以看到所有react组件及其效果。

工具安装:

  1. 首先最重要的是——翻墙-_-。不翻墙chrome的网上商店就别想了。
  2. 然后在chrome网店搜索“React Developer Tool”。
  3. 找到后添加到chrome。

添加完成后可以发现在chrome中增加了react的图标。

React 搭建开发环境

然后在demo页面按F12打开开发人员工具,会发现多了一个React栏目。选择这个栏目后,会显示出React组件的效果。

React 搭建开发环境

用云栖社区APP,舒服~

【云栖快讯】诚邀你用自己的技术能力来用心回答每一个问题,通过回答传承技术知识、经验、心得,问答专家期待你加入!  详情请点击

网友评论