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

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

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

初始化项目结构

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

  1. mkdir proj
  2. cd proj

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

  1. proj/
  2. ├─ dist/
  3. └─ src/
  4.    └─ components/

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

下面来创建基本结构：

  1. mkdir src
  2. cd src
  3. mkdir components
  4. cd ..

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

初始化工程

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

  1. npm init -y

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

安装依赖

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

  1. npm install --save-dev webpack webpack-cli

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

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

  1. npm install --save react react-dom
  2. npm install --save-dev @types/react @types/react-dom

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

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

  1. 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文件，添加以下内容：

  1. {
  2.     "compilerOptions": {
  3.         "outDir": "./dist/",
  4.         "sourceMap": true,
  5.         "noImplicitAny": true,
  6.         "module": "commonjs",
  7.         "target": "es6",
  8.         "jsx": "react"
  9.     }
  10. }

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

写些代码

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

  1. import * as React from "react";
  3. export interface HelloProps { compiler: string; framework: string; }
  5. export const Hello = (props: HelloProps) => <h1>Hello from {props.compiler} and {props.framework}!</h1>;

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

  1. import * as React from "react";
  3. export interface HelloProps { compiler: string; framework: string; }
  5. // 'HelloProps' describes the shape of props.
  6. // State is never set so we use the '{}' type.
  7. export class Hello extends React.Component<HelloProps, {}> {
  8.     render() {
  9.         return <h1>Hello from {this.props.compiler} and {this.props.framework}!</h1>;
  10.     }
  11. }

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

  1. import * as React from "react";
  2. import * as ReactDOM from "react-dom";
  4. import { Hello } from "./components/Hello";
  6. ReactDOM.render(
  7.     <Hello compiler="TypeScript" framework="React" />,
  8.     document.getElementById("example")
  9. );

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

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

  1. <!DOCTYPE html>
  2. <html>
  3.     <head>
  4.         <meta charset="UTF-8" />
  5.         <title>Hello React!</title>
  6.     </head>
  7.     <body>
  8.         <div id="example"></div>
  10.         <!-- Dependencies -->
  11.         <script src="./node_modules/react/umd/react.development.js"></script>
  12.         <script src="./node_modules/react-dom/umd/react-dom.development.js"></script>
  14.         <!-- Main -->
  15.         <script src="./dist/main.js"></script>
  16.     </body>
  17. </html>

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

创建一个webpack配置文件

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

  1. module.exports = {
  2.     mode: "production",
  4.     // Enable sourcemaps for debugging webpack's output.
  5.     devtool: "source-map",
  7.     resolve: {
  8.         // Add '.ts' and '.tsx' as resolvable extensions.
  9.         extensions: [".ts", ".tsx"]
  10.     },
  12.     module: {
  13.         rules: [
  14.             {
  15.                 test: /\.ts(x?)$/,
  16.                 exclude: /node_modules/,
  17.                 use: [
  18.                     {
  19.                         loader: "ts-loader"
  20.                     }
  21.                 ]
  22.             },
  23.             // All output '.js' files will have any sourcemaps re-processed by 'source-map-loader'.
  24.             {
  25.                 enforce: "pre",
  26.                 test: /\.js$/,
  27.                 loader: "source-map-loader"
  28.             }
  29.         ]
  30.     },
  32.     // When importing a module whose path matches one of the following, just
  33.     // assume a corresponding global variable exists and use that instead.
  34.     // This is important because it allows us to avoid bundling all of our
  35.     // dependencies, which allows browsers to cache those libraries between builds.
  36.     externals: {
  37.         "react": "React",
  38.         "react-dom": "ReactDOM"
  39.     }
  40. };

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

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

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

整合在一起

执行：

  1. npx webpack

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