Bilibili-live-ws 项目使用教程

Bilibili-live-ws 项目使用教程

bilibili-live-ws Bilibili live WebSocket/tcp API 项目地址: https://gitcode.com/gh_mirrors/bi/bilibili-live-ws

1. 项目目录结构及介绍

Bilibili-live-ws 项目是一个用于与 Bilibili 直播 WebSocket/TCP API 交互的 Node.js 库。以下是项目的目录结构及文件介绍：

bilibili-live-ws/
├── .github/              # GitHub 相关的配置文件
├── .gitattributes        # Git 属性配置文件
├── .gitignore            # Git 忽略文件配置
├── .npmignore            # npm 忽略文件配置
├── .nycrc                # nyc（代码覆盖率工具）配置文件
├── LICENSE               # MIT 许可证文件
├── README.md             # 项目说明文件
├── browser.ts            # 浏览器环境下使用的 TypeScript 文件
├── index.ts              # 项目入口 TypeScript 文件
├── package-lock.json     # npm 包版本锁定文件
├── package.json          # npm 包配置文件
├── tsconfig.json         # TypeScript 配置文件
├── src/                  # 源代码目录
│   └── ...               # 源代码文件
└── test/                 # 测试代码目录
    └── ...               # 测试代码文件

• .github/：包含 GitHub 工作流程和代码 Conduct 规范等文件。
• .gitattributes：定义如何处理特定的文件类型。
• .gitignore：指定 Git 忽略跟踪的文件和目录。
• .npmignore：指定 npm 包发布时忽略的文件和目录。
• .nycrc：配置代码覆盖率检查工具 nyc 的参数。
• LICENSE：项目使用的 MIT 许可证。
• README.md：项目说明文档，包含项目介绍、安装、使用方法和贡献指南。
• browser.ts：为浏览器环境提供的 TypeScript 文件，由于本项目主要用于 Node.js 环境，此文件通常不使用。
• index.ts：项目入口文件，定义了库的主要功能和接口。
• package-lock.json：记录了项目的依赖关系和精确的版本号，用于保证环境的稳定性。
• package.json：定义了项目的元数据、依赖项和脚本。
• tsconfig.json：TypeScript 配置文件，指定了编译选项和项目引用。
• src/：源代码目录，包含了实现项目功能的代码。
• test/：测试代码目录，包含了项目单元测试和集成测试的代码。

2. 项目的启动文件介绍

项目的启动文件是 index.ts。以下是启动文件的简单介绍：

// index.ts

// 导入必要的模块
import { LiveWS, LiveTCP } from './src';

// 创建一个 WebSocket 连接实例
const live = new LiveWS(roomid);

// 监听连接打开事件
live.on('open', () => {
  console.log('Connection is established');
});

// 监听直播间消息事件
live.on('msg', (data) => {
  console.log(data);
});

// 发送心跳包保持连接
live.heartbeat();

// 关闭连接
// live.close();

在 index.ts 文件中，我们首先导入 LiveWS 或 LiveTCP 类，然后创建一个实例，并设置各种事件监听器来处理打开连接、接收消息和心跳包等操作。

3. 项目的配置文件介绍

本项目的主要配置文件是 package.json，以下是配置文件的一些基本介绍：

{
  "name": "bilibili-live-ws",
  "version": "1.0.0",
  "description": "Bilibili live WebSocket/tcp API",
  "main": "index.js",
  "scripts": {
    "start": "ts-node index.ts",
    "test": "jest"
  },
  "dependencies": {
    "ws": "^3.3.5"
  },
  "devDependencies": {
    "@types/node": "^14.0.27",
    "jest": "^26.6.3",
    "ts-node": "^10.4.0",
    "typescript": "^4.5.4"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/simon300000/bilibili-live-ws.git"
  },
  "author": "simon300000",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/simon300000/bilibili-live-ws/issues"
  },
  "homepage": "https://github.com/simon300000/bilibili-live-ws#readme"
}

在 package.json 文件中，我们定义了项目名称、版本、描述、入口文件、脚本、依赖项、开发依赖项、仓库信息、作者、许可证、问题跟踪 URL 和项目主页。

• scripts：定义了项目的启动脚本和测试脚本。例如，"start": "ts-node index.ts" 定义了使用 ts-node 运行 index.ts 文件的命令，这样我们就可以直接运行 TypeScript 代码而不需要先编译。
• dependencies：列出了项目运行所依赖的包，例如 ws 是用于 WebSocket 连接的 Node.js 库。
• devDependencies：列出了项目开发过程中使用的包，例如 ts-node 用于运行 TypeScript 代码，jest 用于单元测试。

bilibili-live-ws Bilibili live WebSocket/tcp API 项目地址: https://gitcode.com/gh_mirrors/bi/bilibili-live-ws