Vue.js

Appearance

On this page

React 与 webpack ​

这篇指南将会教你如何将 TypeScript 和React还有webpack结合在一起使用。

如果你正在做一个全新的工程，可以先阅读这篇React 快速上手指南。

否则，我们假设已经在使用Node.js和npm。

初始化项目结构 ​

让我们新建一个目录。 将会命名为proj，但是你可以改成任何你喜欢的名字。

text
mkdir proj
cd proj

我们会像下面的结构组织我们的工程：

text
proj/
├─ dist/
└─ src/
   └─ components/

TypeScript 文件会放在src文件夹里，通过 TypeScript 编译器编译，然后经 webpack 处理，最后生成一个main.js文件放在dist目录下。 我们自定义的组件将会放在src/components文件夹下。

下面来创建基本结构：

text
mkdir src
cd src
mkdir components
cd ..

Webpack 会帮助我们生成dist目录。

初始化工程 ​

现在把这个目录变成 npm 包。

text
npm init -y

它会使用默认值生成一个package.json文件。

安装依赖 ​

首先确保已经全局安装了 Webpack。

text
npm install --save-dev webpack webpack-cli

Webpack 这个工具可以将你的所有代码和可选择地将依赖捆绑成一个单独的.js文件。

现在我们添加 React 和 React-DOM 以及它们的声明文件到package.json文件里做为依赖：

text
npm install --save react react-dom
npm install --save-dev @types/react @types/react-dom

使用@types/前缀表示我们额外要获取 React 和 React-DOM 的声明文件。 通常当你导入像"react"这样的路径，它会查看react包； 然而，并不是所有的包都包含了声明文件，所以 TypeScript 还会查看@types/react包。 你会发现我们以后将不必在意这些。

接下来，我们要添加开发时依赖ts-loader和source-map-loader。

text
npm install --save-dev typescript ts-loader source-map-loader

这些依赖会让 TypeScript 和 webpack 在一起良好地工作。 ts-loader可以让 Webpack 使用 TypeScript 的标准配置文件tsconfig.json编译 TypeScript 代码。 source-map-loader 使用 TypeScript 输出的 sourcemap 文件来告诉 webpack 何时生成_自己的_sourcemaps。 这就允许你在调试最终生成的文件时就好像在调试 TypeScript 源码一样。

请注意，ts-loader并不是唯一的TypeScript加载器。

你还可以选择awesome-typescript-loader。 可以到这里查看它们之间的区别。

注意我们安装 TypeScript 为一个开发依赖。 我们还可以使用npm link typescript来链接 TypeScript 到一个全局拷贝，但这不是常见用法。

添加 TypeScript 配置文件 ​

我们想将 TypeScript 文件整合到一起 - 这包括我们写的源码和必要的声明文件。

我们需要创建一个tsconfig.json文件，它包含了输入文件列表以及编译选项。 在工程根目录下新建文件tsconfig.json文件，添加以下内容：

javascript
{
    "compilerOptions": {
        "outDir": "./dist/",
        "sourceMap": true,
        "noImplicitAny": true,
        "module": "commonjs",
        "target": "es6",
        "jsx": "react"
    }
}

你可以在这里了解更多关于tsconfig.json文件的说明。

写些代码 ​

下面使用 React 写一段 TypeScript 代码。 首先，在src/components目录下创建一个名为Hello.tsx的文件，代码如下：

typescript
import * as React from 'react';

export interface HelloProps {
  compiler: string;
  framework: string;
}

export const Hello = (props: HelloProps) => (
  <h1>
    Hello from {props.compiler} and {props.framework}!
  </h1>
);

注意这个例子使用了函数组件，我们可以让它更像一点类。

typescript
import * as React from 'react';

export interface HelloProps {
  compiler: string;
  framework: string;
}

// 'HelloProps' describes the shape of props.
// State is never set so we use the '{}' type.
export class Hello extends React.Component<HelloProps, {}> {
  render() {
    return (
      <h1>
        Hello from {this.props.compiler} and {this.props.framework}!
      </h1>
    );
  }
}

接下来，在src下创建index.tsx文件，源码如下：

typescript
import * as React from 'react';
import * as ReactDOM from 'react-dom';

import { Hello } from './components/Hello';

ReactDOM.render(
  <Hello compiler="TypeScript" framework="React" />,
  document.getElementById('example')
);

我们仅仅将Hello组件导入index.tsx。 注意，不同于"react"或"react-dom"，我们使用Hello.tsx的相对路径 - 这很重要。 如果不这样做，TypeScript 只会尝试在node_modules文件夹里查找。

我们还需要一个页面来显示Hello组件。 在根目录proj创建一个名为index.html的文件，如下：

markup
<!DOCTYPE html>
<html>
    <head>
        <meta charset="UTF-8" />
        <title>Hello React!</title>
    </head>
    <body>
        <div id="example"></div>

        <!-- Dependencies -->
        <script src="./node_modules/react/umd/react.development.js"></script>
        <script src="./node_modules/react-dom/umd/react-dom.development.js"></script>

        <!-- Main -->
        <script src="./dist/main.js"></script>
    </body>
</html>

需要注意一点我们是从node_modules引入的文件。 React 和 React-DOM 的 npm 包里包含了独立的.js文件，你可以在页面上引入它们，这里我们为了快捷就直接引用了。 可以随意地将它们拷贝到其它目录下，或者从 CDN 上引用。 Facebook 在 CND 上提供了一系列可用的 React 版本，你可以在这里查看更多内容。

创建一个 webpack 配置文件 ​

在工程根目录下创建一个webpack.config.js文件。

javascript
module.exports = {
  mode: 'production',

  // Enable sourcemaps for debugging webpack's output.
  devtool: 'source-map',

  resolve: {
    // Add '.ts' and '.tsx' as resolvable extensions.
    extensions: ['.ts', '.tsx'],
  },

  module: {
    rules: [
      {
        test: /\.ts(x?)$/,
        exclude: /node_modules/,
        use: [
          {
            loader: 'ts-loader',
          },
        ],
      },
      // All output '.js' files will have any sourcemaps re-processed by 'source-map-loader'.
      {
        enforce: 'pre',
        test: /\.js$/,
        loader: 'source-map-loader',
      },
    ],
  },

  // When importing a module whose path matches one of the following, just
  // assume a corresponding global variable exists and use that instead.
  // This is important because it allows us to avoid bundling all of our
  // dependencies, which allows browsers to cache those libraries between builds.
  externals: {
    react: 'React',
    'react-dom': 'ReactDOM',
  },
};

大家可能对externals字段有所疑惑。 我们想要避免把所有的 React 都放到一个文件里，因为会增加编译时间并且浏览器还能够缓存没有发生改变的库文件。

理想情况下，我们只需要在浏览器里引入 React 模块，但是大部分浏览器还没有支持模块。 因此大部分代码库会把自己包裹在一个单独的全局变量内，比如：jQuery或_。 这叫做“命名空间”模式，webpack 也允许我们继续使用通过这种方式写的代码库。 通过我们的设置"react": "React"，webpack 会神奇地将所有对"react"的导入转换成从React全局变量中加载。

你可以在这里了解更多如何配置 webpack。

整合在一起 ​

执行：

text
npx webpack

在浏览器里打开index.html，工程应该已经可以用了！ 你可以看到页面上显示着“Hello from TypeScript and React!”

Edit this page on GitHub