以前看了一下 TypeScript 的知识,可是一直没有上手,最近开始结合 React 和 TypeScript 一块儿尝试了一下,感觉仍是很好的,因此写一下笔记。css
环境配置没有参考其余东西,就是看了下 Webpack 和 TypeScript 的官方文档,使用 Webpack 进行构建仍是比较简单的。html
建立一个项目目录,而后切换当前目录到项目目录下:node
$ mkdir tsc && cd ./tsc
而后使用 npm 初始化项目:react
$ npm init -y
而后建立一些项目文件:webpack
$ mkdir build src $ touch build/webpack.base.conf.js build/webpack.dev.conf.js build/webpack.prod.conf.js index.html src/index.tsx tsconfig.json
接下来,就能够安装一些依赖了:es6
$ npm i webpack webpack-cli webpack-merge webpack-dev-server -D $ npm i html-webpack-plugin clean-webpack-plugin typescript ts-loader style-loader css-loader @types/react @types/react-dom -D $ npm i react react-dom -S
能够注意到咱们没有安装 babel 转译器,若是咱们只写 .ts
或者 .tsx
文件,能够不安装 babel。若是要转译处理 .js
文件的话,仍是要使用到 babel。web
咱们先写基础配置:typescript
webpack.base.conf.js
****npm
const path = require('path'); const htmlWebpackPlugin = require('html-webpack-plugin'); const cleanWebpackPlugin = require('clean-webpack-plugin'); module.exports = { entry: path.resolve(__dirname, '../src/index.tsx'), output: { filename: '[name].[hash].js' }, resolve: { extensions: ['*', '.js', '.json', '.ts', '.tsx'] }, module: { rules: [ { test: /\.tsx?$/, use: 'ts-loader', exclude: /node_modules/ }, { test: /\.css$/, use: ['style-loader', 'css-loader'] } ] }, plugins: [ new htmlWebpackPlugin({ inject: true, template: path.resolve(__dirname, '../index.html') }), new cleanWebpackPlugin(['dist']) ] };
而后能够构造开发环境下的配置文件:编程
webpack.dev.conf.js
****
const merge = require('webpack-merge'); const path = require('path'); const baseConfig = require('./webpack.base.conf'); module.exports = merge(baseConfig, { mode: 'development', devtool: 'source-map', devServer: { port: 9999, open: true, contentBase: path.resolve(__dirname, '../dist') } });
而后添加 npm 脚本到 package.json
中:
"scripts": { "test": "echo \"Error: no test specified\" && exit 1", "dev": "webpack-dev-server --config ./build/webpack.dev.conf.js" }
而后添加咱们的 ts 配置到 tsconfig.json
:
{ "compilerOptions": { "outDir": "./dist/", // 打包输出目录 "noImplicitAny": true, // 默认必须为变量指定类型 "module": "es6", // 使用 ESM 模块化方案 "target": "es5", // 代码编译成 ES 5 "jsx": "react", // 开启 JSX,使用 react 方式编译,若是要使用 babel 编译,那就将 jsx 设置为 ‘preserve’ "allowJs": true, // 容许编译 js 代码 "sourceMap": true, // 编译后同时产出 map 文件 "removeComments": true // 移除注释 } }
更多的配置项解释,参考:翻译 | 开始使用 TypeScript 和 React。
写完了之后咱们就能够添加内容到咱们的开发文件中了:
index.html
****
<!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>Document</title> </head> <body> <div id="root"></div> </body> </html>
src/index.tsx
****
import * as React from 'react'; import * as ReactDOM from 'react-dom'; ReactDOM.render( <h1>Hello TSX!</h1>, document.getElementById('root') as HTMLElement );
能够注意到引入 React 和 ReactDOM 的方式和以前有一些不一样。
另外因为 TypeScript 的强制转换符 <>
和 JSX 的元素相冲突,因此使用 as
做为强制转换符。
运行 npm run dev
,能够查看效果。
使用 TypeScript 之后,项目配置要稍微简单一点。配置好开发环境之后,就能够写代码啦!
我以一个 Header 组件为例,效果以下:
新建一个 Header.tsx
文件和一个 Header.css
文件到 src/components
下。
因为头部栏的标题文字应该是能够修改的,而后右边的 menu 应该是能够自定义的,因此这些数据应该均可以经过 props 传入咱们的 Header 组件。
写咱们的 Header 组件:
// Header.tsx // 引入 React import * as React from 'react'; // 引入咱们的组件样式 import './Header.css'; // 定义的接口,用于规范 Header 组件的 props,向外界公开, // 便于在其余组件中引用时实现这个接口,减小错误 export interface HeaderProps { title: string; // 必须给定 title,一个 string 类型的值 menus?: MenuItemProps[]; // menus 是可选属性,是一个符合 MenuItemProps 接口规范的对象的数组 height?: string; // 问号都表明可选项 bgColor?: string; } // 这个接口定义了 MenuItem 组件的 props 规范,同时也定义了 // HeaderProps 中 menus 数组的元素的规范 interface MenuItemProps { name: string; // 给定 menu 的名称 href: string; // 给定 menu 要跳转的连接 } // 定义了 Header 组件的 state 的规范 interface HeaderState { isVisible: boolean // 表明 Header 组件是否可见 } // Header 组件 // 注意 React.Component 后面的泛型,就是咱们上方定义的接口,它们分别制定了组件的 props 和 state 的规范 class Header extends React.Component<HeaderProps, HeaderState> { // 指定组件实例的 state,必须符合 HeaderState 的规范 state = { isVisible: true } render() { const { title, menus = [], height = '50px', bgColor = 'lightblue' } = this.props; // 从 props 获取值,其中可选项都有默认值 const style = { height, backgroundColor: bgColor }; // 构造 Header 内联样式 return this.state.isVisible ? <div style={style} className="header"> <span>{title}</span> <div className="header-menus"> { menus.map(item => <MenuItem {...item}/>) } </div> </div> : null; } } // MenuItem 组件 // state 的规范是一个 object,未指定具体接口类型 class MenuItem extends React.Component<MenuItemProps, object> { render() { const { name, href } = this.props; return <a className="header-menu-item" href={href} key={href}> {name} </a> } } // 最后向外部暴露 Header 组件 export default Header;
能够看到 TypeScript 结合 React 其实很好用,尤为在规范 props 的时候很好用,可以避免不少编程时候的错误。而 IDE 的提示可以更加地方便咱们开发。写起来何止舒服,简直舒服啊~
而后在 Header.css
写一下咱们的样式:
html, body, div { margin: 0; padding: 0; font-size: 16px; } .header { font-size: 1.5rem; line-height: 1rem; padding: 1rem; box-sizing: border-box; position: relative; } .header-menus { position: absolute; right: 1rem; top: 50%; transform: translateY(-50%); } .header-menu-item { margin: 0 .5rem; }
这里仅仅是作个示例,排版没有在乎太多的通用性,你们看看就好~
而后咱们就能够在 index.tsx
中使用咱们的 Header 组件了:
import * as React from 'react'; import * as ReactDOM from 'react-dom'; import Header, { HeaderProps } from './components/Header'; // 引入接口规范和组件 // 构造 Header 组件的 props,必须符合 HeaderProps 接口规范。 // 在写的过程当中 IDE 也能给咱们不少的提示,方便了开发 const headerProps: HeaderProps = { title: 'Hello TSX!', menus: [{ name: 'menu1', href: 'https://www.zhongdeming.fun' }, { name: 'menu2', href: 'https://www.baidu.com' }], bgColor: 'lightyellow' }; ReactDOM.render( <Header {...headerProps}/>, document.getElementById('root') as HTMLElement );
这样一个组件就写完了,能够感觉到 TypeScript 确实可以加速咱们的开发,减小开发中的错误。
下面是一些利用 TypeScript 开发的时候 IDE 给出的提示的截图: