Cursor rule

1---
2description: 即时通讯(Socket)
3globs: 
4---
5# 即时通讯(Socket)
6 
7`cool-admin`即时通讯功能基于[Socket.io(v4)](https://socket.io/docs/v4)开发，[midwayjs 官方 Socket.io 文档](http://midwayjs.org/docs/extensions/socketio)
8 
9## 配置
10 
11`configuration.ts`
12 
13```ts
14import * as socketio from "@midwayjs/socketio";
15 
16@Configuration({
17  imports: [
18    // socketio http://www.midwayjs.org/docs/extensions/socketio
19    socketio,
20  ],
21  importConfigs: [join(__dirname, "./config")],
22})
23export class ContainerLifeCycle {
24  @App()
25  app: koa.Application;
26 
27  async onReady() {}
28}
29```
30 
31## 配置`config/config.default.ts`
32 
33需要配置 redis 适配器，让进程之间能够进行通讯
34 
35```ts
36import { CoolConfig, MODETYPE } from "@cool-midway/core";
37import { MidwayConfig } from "@midwayjs/core";
38import * as fsStore from "@cool-midway/cache-manager-fs-hash";
39import { createAdapter } from "@socket.io/redis-adapter";
40// @ts-ignore
41import Redis from "ioredis";
42 
43const redis = {
44  host: "127.0.0.1",
45  port: 6379,
46  password: "",
47  db: 0,
48};
49 
50const pubClient = new Redis(redis);
51const subClient = pubClient.duplicate();
52 
53export default {
54  // ...
55  // socketio
56  socketIO: {
57    upgrades: ["websocket"], // 可升级的协议
58    adapter: createAdapter(pubClient, subClient),
59  },
60} as MidwayConfig;
61```
62 
63## 服务端
64 
65```ts
66import {
67  WSController,
68  OnWSConnection,
69  Inject,
70  OnWSMessage,
71} from "@midwayjs/core";
72import { Context } from "@midwayjs/socketio";
73/**
74 * 测试
75 */
76@WSController("/")
77export class HelloController {
78  @Inject()
79  ctx: Context;
80 
81  // 客户端连接
82  @OnWSConnection()
83  async onConnectionMethod() {
84    console.log("on client connect", this.ctx.id);
85    console.log("参数", this.ctx.handshake.query);
86    this.ctx.emit("data", "连接成功");
87  }
88 
89  // 消息事件
90  @OnWSMessage("myEvent")
91  async gotMessage(data) {
92    console.log("on data got", this.ctx.id, data);
93  }
94}
95```
96 
97## 客户端
98 
99```ts
100const io = require("socket.io-client");
101 
102const socket = io("http://127.0.0.1:8001", {
103  auth: {
104    token: "xxx",
105  },
106});
107 
108socket.on("data", (msg) => {
109  console.log("服务端消息", msg);
110});
111```
112 
113## 注意事项
114 
115如果部署为多线程的，为了让进程之间能够进行通讯，需要配置 redis 适配器，[配置方式](http://midwayjs.org/docs/extensions/socketio#%E9%85%8D%E7%BD%AE-redis-%E9%80%82%E9%85%8D%E5%99%A8)
116 
117```ts
118// src/config/config.default
119import { createRedisAdapter } from "@midwayjs/socketio";
120 
121export default {
122  // ...
123  socketIO: {
124    adapter: createRedisAdapter({ host: "127.0.0.1", port: 6379 }),
125  },
126};
127```
128