react-use-websocket 项目使用教程

1. 项目的目录结构及介绍

react-use-websocket 项目的目录结构如下：

react-use-websocket/
├── dist/
│   ├── index.d.ts
│   ├── index.js
│   └── index.js.map
├── examples/
│   ├── basic/
│   │   ├── public/
│   │   ├── src/
│   │   │   ├── App.js
│   │   │   ├── index.js
│   │   │   └── ...
│   │   ├── package.json
│   │   └── ...
│   └── ...
├── src/
│   ├── index.ts
│   ├── use-websocket.ts
│   └── ...
├── .gitignore
├── .npmignore
├── LICENSE
├── package.json
├── README.md
└── tsconfig.json

目录结构介绍

• dist/: 包含编译后的文件，如 index.d.ts, index.js, 和 index.js.map。
• examples/: 包含示例项目，如 basic/ 目录下的基本示例。
• src/: 包含源代码文件，如 index.ts 和 use-websocket.ts。
• .gitignore: Git 忽略文件列表。
• .npmignore: npm 忽略文件列表。
• LICENSE: 项目许可证。
• package.json: 项目配置文件，包含依赖和脚本。
• README.md: 项目说明文档。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件主要位于 examples/basic/src/ 目录下：

• index.js: 项目的入口文件，负责渲染 App 组件。

import React from 'react';
import ReactDOM from 'react-dom';
import App from './App';

ReactDOM.render(<App />, document.getElementById('root'));

• App.js: 主应用组件，包含 WebSocket 连接的示例代码。

import React from 'react';
import useWebSocket from 'react-use-websocket';

const App = () => {
  const [sendMessage, lastMessage] = useWebSocket('wss://example.com/ws', {
    onOpen: () => console.log('WebSocket connection opened'),
    onClose: () => console.log('WebSocket connection closed'),
    onError: (event) => console.error('WebSocket error:', event),
    onMessage: (event) => console.log('Received message:', event.data),
  });

  const handleClick = () => {
    sendMessage('Hello WebSocket');
  };

  return (
    <div>
      <button onClick={handleClick}>Send Message</button>
      <p>Last Message: {lastMessage ? lastMessage.data : 'None'}</p>
    </div>
  );
};

export default App;

3. 项目的配置文件介绍

项目的配置文件主要包括 package.json 和 tsconfig.json。

package.json

package.json 文件包含了项目的依赖、脚本和其他配置信息。

{
  "name": "react-use-websocket",
  "version": "1.0.0",
  "description": "React hook for WebSocket",
  "main": "dist/index.js",
  "types": "dist/index.d.ts",
  "scripts": {
    "build": "tsc",
    "start": "react-scripts start",
    "test": "react-scripts test",
    "eject": "react-scripts eject"
  },
  "dependencies": {
    "react": "^17.0.2",
    "react-dom": "^17.0.2",
    "react-scripts": "4.0.3"
  },
  "devDependencies": {
    "typescript": "^4.1.2"
  },
  "author": "Rob Taussig",
  "license": "MIT"
}

tsconfig.json

tsconfig.json 文件包含了 TypeScript 编译器的配置信息。

{