练练手吧! TS + React 小项目(01 建立项目)

有两种通用初始化方案

咱们能够经过两种方式建立项目:手动配置和使用脚手架;手动配置为了对项目的配置有一个基本了解,以后的开发仍是 基于脚手架开展css

手动配置

建立 基本的 ts 环境

安装 react 及其声明文件

npm i react react-dom
复制代码
npm i -D @types/react @types/react-dom
复制代码

修改配置项

TypeScript 具备三种 JSX 模式:preservereactreact-native。 这些模式只在代码生成阶段起做用 - 类型检查并不受影响。html

  • preserve 模式下生成代码中会保留 JSX 以供后续的转换操做使用(好比:Babel)。 另外,输出文件会带有 .jsx 扩展名。
  • react 模式会生成 React.createElement,在使用前不须要再进行转换操做了,输出文件的扩展名为.js
  • react-native 至关于 preserve,它也保留了全部的 JSX,可是输出文件的扩展名是.js
模式 输入 输出 输出文件扩展名
preserve <div /> <div /> .jsx
react <div /> React.createElement("div") .js
react-native <div /> <div /> .js
// tsconfig.json
{
  "compilerOptions": {
    "jsx": "react"
  }
}
复制代码

修改入口文件配置

src/index.ts 修改文件拓展名 src/index.tsxnode

// webpack.base.config.js
module.exports = {
  entry: "./src/index.tsx",
  ...
};
复制代码
// package.json
{
  ...
  "main": "./src/index.tsx"
}
复制代码

调试一下,看看行不行

// src/components/demo/Hello.tsx

import React from "react";

interface Greeting {
  name: string;
}

const Hello = (props: Greeting) => <h1>hello {props.name}</h1>;

export default Hello;
复制代码
// src/index.tsx

import React from "react";
import ReactDOM from "react-dom";
import Hello from "./components/demo/Hello";

ReactDOM.render(
  <Hello name="typescript" />,
  document.querySelectorAll(".app")[0]
);
复制代码

npm start 后,在 http://localhost:8080/ 能够看到 hello typescript 就 ok 。react

优化 webpack 打包

由于 react 库体积是很大的,通常状况将库文件和业务文件拆分为两个文件,从而充分利用浏览器的缓存。webpack

修改一下 webpack 配置:ios

// webpack.base.config.js
module.exports = {
  // 为入口文件单独提供一个名称
  entry: {
    app: "./src/index.tsx",
  },
  // 修改输出文件名,[文件名].[8位哈希: 为了防缓存加的版本号]
  output: { 
    filename: "[name].[chunkhash:8].js" 
    // ...
  },
  ...
  optimization: {
    // webpack4 提供了新的拆包方式
    splitChunks: {
      // 默认抽离出 node_modules 打包成单独文件
      chunks: "all",
    },
  },
};
复制代码

npm run build 后,获得 dist(生产环境下):git

// mode=production
--dist
  |--935.e5091ef8.js // 库代码
  |--935.e5091ef8.js.LICENSE.txt // 注释
  |--app.ec1f4b01.js // 业务代码
  |--index.html
复制代码

--mode=development--mode=production 生成结果会不同。web

Webpack 5 默认压缩代码工具为 terser-webpack-plugin,无需安装,默认使用,会将注释提取到单独的 LICENSE 文件中。不想要 LICENSE 文件的 戳 这个配置ajax

使用脚手架

一行命令定乾坤

npx create-react-app ts-react-app --template typescript
复制代码

解读命令:基于 typescript 建立一个叫 ts-react-appreact 工程。typescript

PS: 不少文章里写到这命令npx create-react-app xxx --typescript,如今已经失效了,但用它的建立过程并不会报错,并成果建立一个不包含 Typescript 的默认 React 工程。--template typescript 是新的有效参数。

npx 只是安装到临时目录,使用完后自动删除;这样能够避免全局安装,每次使用( create-react-app 脚手架)都是最新的版本。

Create React App 是一个官方支持的建立 React 单页应用程序的方法,它提供了一个零配置的现代构建设置。

目录结构

对工程按咱们的需求进行一下改造:

|--public // 该目录下的内容 会被拷贝到 最终生成的项目的 根目录下
    |--index.html // 首页模版,全部构建后的脚本都会被注入到这里(必需)
    |--favicon.ico // 静态文件(图标、字体..),对静态文件的引用方式:如 href="%PUBLIC_URL%/favicon.ico"
|--src // 项目源码
    |--components
        |--demo
            |--Hello.tsx
    |--index.tsx // 整个工程的入口文件
    |--react-app-env.d.ts
|--.gitignore
|--config-overrides.js
|--package.json
|--README.md
|--tsconfig.json
|--yarn.lock
复制代码

咱们在 package.json 中并看不到 WebpackBabel 等工具。 其实它们是预先配置好而且隐藏的,它们都被封装到了 react-scripts 中。

咱们要加装的包

// package.json
{
  ...
  // 替换脚本 react-scripts -> react-app-rewired
  "scripts": {
    "start": "react-app-rewired start",
    "build": "react-app-rewired build",
    "test": "react-app-rewired test"
  },

  "dependencies": {
    ...
    "antd": "^4.15.3", // UI 组件库
    "axios": "^0.21.1", // 发送 ajax 请求
    "react-router-dom": "^5.2.0" // 路由
  },

  "devDependencies": {
    "@types/react-router-dom": "^5.1.7",
    "babel-plugin-import": "^1.13.3", // 实现 antd 的按需加载
    "customize-cra": "^1.0.0", // 看下面
    "http-proxy-middleware": "^1.3.0", // 把请求代理转发到其余服务器的中间件
    "http-server": "^0.12.3", // 简单的零配置命令行http服务器。
    "react-app-rewired": "^2.1.8"
  }
}
复制代码

若是项目须要单独配置或者覆盖原始 webpack 配置,该怎么办?

  • 方法一:使用 npm run eject 命令将 webpack.config.js 暴露出来。而后在该配置文件中进行修改。但这是极端且不推荐的,缘由有二:
    • 该命令是不可逆的。一旦执行了此命令 webpack.config.js 文件就永久的暴露出来。
    • 若是只是修改一个很小的配置项。是否是有点大动干戈了?
  • 方法二(推荐):利用 customize-crareact-app-rewired 经过 config-overrides.js 文件覆盖原配置项。

如何搭建一个 mock-server ?

http-proxy-middleware 是把请求代理转发到其余服务器的中间件。http-server 是简单的零配置命令行 http 服务器。它能够帮助咱们开启本地服务器,方便局域网共享。这二者配合能够搭建一个 mock-server

覆盖原配置项

// config-overrides.js

const { override, fixBabelImports } = require("customize-cra");

module.exports = override(
  fixBabelImports("import", {
    // antd 按需加载
    libraryName: "antd",
    libraryDirectory: "es",
    style: "css",
  })
);
复制代码

src/components/demo/Hello.ts

import React from "react";
import { Button } from "antd";

interface Greeting {
  name: string;
}

const Hello = (props: Greeting) => <Button>hello {props.name}</Button>;

export default Hello;
复制代码

src/index.tsx

import React from "react";
import ReactDOM from "react-dom";
import Hello from "./components/demo/Hello";

ReactDOM.render(
  <Hello name="typescript。" />,
  document.querySelectorAll(".app")[0]
);
复制代码

首页模版

  • public/index.html
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>TypeScript In Action</title>
    <link rel="icon" href="%PUBLIC_URL%/favicon.ico" type="image/x-icon" />
  </head>
  <body>
    <div class="app"></div>
  </body>
</html>
复制代码

it's ok!

yarn start
复制代码

ts-react.png

React & TS 系列

相关文章
相关标签/搜索