WebSocket-TS 项目教程

1. 项目目录结构及介绍

WebSocket-TS 项目的目录结构如下：

websocket-ts/
├── src/
│   ├── server.ts
│   ├── client.ts
│   ├── config/
│   │   └── settings.ts
│   └── utils/
│       └── helpers.ts
├── dist/
├── node_modules/
├── package.json
├── tsconfig.json
└── README.md

目录结构介绍

• src/: 源代码目录，包含 TypeScript 源文件。
  • server.ts: WebSocket 服务器的主文件。
  • client.ts: WebSocket 客户端的主文件。
  • config/: 配置文件目录。
    • settings.ts: 项目的配置文件，包含端口、日志级别等配置。
  • utils/: 工具函数目录。
    • helpers.ts: 包含一些通用的辅助函数。
• dist/: 编译后的 JavaScript 文件目录。
• node_modules/: 项目依赖的第三方模块。
• package.json: 项目的依赖管理文件，包含项目的依赖和脚本。
• tsconfig.json: TypeScript 的配置文件，定义编译选项。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

server.ts

server.ts 是 WebSocket 服务器的主文件，负责启动 WebSocket 服务器并处理客户端连接。

import WebSocket from 'ws';
import { config } from './config/settings';

const wss = new WebSocket.Server({ port: config.port });

wss.on('connection', (ws: WebSocket) => {
  console.log('New client connected');

  ws.on('message', (message: string) => {
    console.log(`Received message: ${message}`);
    ws.send(`Server received your message: ${message}`);
  });

  ws.on('close', () => {
    console.log('Client disconnected');
  });
});

console.log(`WebSocket server is listening on port ${config.port}`);

client.ts

client.ts 是 WebSocket 客户端的主文件，负责连接到 WebSocket 服务器并发送消息。

import WebSocket from 'ws';
import { config } from './config/settings';

const ws = new WebSocket(`ws://localhost:${config.port}`);

ws.on('open', () => {
  console.log('Connected to server');
  ws.send('Hello, server!');
});

ws.on('message', (message: string) => {
  console.log(`Received message from server: ${message}`);
});

ws.on('close', () => {
  console.log('Disconnected from server');
});

3. 项目的配置文件介绍

config/settings.ts

settings.ts 是项目的配置文件，包含端口、日志级别等配置。

export const config = {
  port: 8080,
  logLevel: 'info',
  // 其他配置项...
};

配置文件的使用

在 server.ts 和 client.ts 中，通过导入 config 对象来使用配置文件中的设置。

import { config } from './config/settings';

const wss = new WebSocket.Server({ port: config.port });

通过这种方式，可以方便地管理和修改项目的配置。

---

以上是 WebSocket-TS 项目的教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用该项目。