自定义功能

可以自定义各种部分，这里只是给一个例子。 具体代码可见phecda-server-ws。

和websocket 的区别

内置的websocket支持本质是将其视为一种rpc,并不支持完整的websocket功能，如服务端调用客户端

假设需要自定义websocket功能，那么需要自行处理以下部分：

1. 控制器
2. 适配器
3. 代码生成器
4. 请求适配器

并不一定要全部, 如果需要使用自定义的http/rpc框架，只要写适配器，别的不需要

控制器

Controller是作为http的控制器，Rpc是作为微服务的控制器，那么假设要支持websocket，也需要一个专门的控制器将其暴露出来

可以这么设计

@WS()
class a {
  @On()
  add(@Arg() data: any) {
    console.log(data)
  }
}

适配器

控制器完成后，还需要将ps的模块接入ws,需要一个bind函数

如果是对原有框架的增强，那么就是bind，如果原有框架不太方便用加强（比如bullmq）,那么就是create

具体实现看源码

代码生成器

生成代码

const data = await Factory([TestWs], {
  generators: [new WSGenerator()],
})

配置文件

需要更改配置文件的resolve，使重定向

{
  "source": "wss",
  "importer": "ws",
  "path": ".ps/ws.js"
}

请求适配器

具体实现看源码

import { createClient } from 'phecda-client-ws'

const ws = new WebSocket('ws://localhost:3001')
const client = createClient(
  ws,
  {
    test: TestWs,
  },
  {
    test(data) {
      console.log(data)
    },
  }
)

ws.onopen = () => {
  console.log('open!')
  client.test.add({ name: 'ws' })
}

最终效果

创建控制器

// test.ws.ts
import { Arg, Ctx } from 'phecda-server'
import { On, Ws, type WsContext } from 'phecda-server-ws'

@Ws()
export class TestWs {
  @Ctx
  context: WsContext

  @On
  add(@Arg data: { name: string }) {
    this.context.broadcast('test', data)// emit test event
  }
}

启动服务，添加适配器、生成器

// main.ts
import { WSGenerator, bind } from 'phecda-server-ws'
import { Factory } from 'phecda-server'
import { WebSocketServer } from 'ws'
import { TestWs } from './test.ws'

const data = await Factory([TestWs], {
  generators: [new WSGenerator()],
})
const server = new WebSocketServer({ port: 3001 })

bind(server, data)

更改 ps.config

{
  "resolve": [
    {
      "source": "ws",
      "importer": "client",
      "path": ".ps/ws.js"
    }
  ],

  "moduleFile": ["ws"]
}

使用请求适配器，进行客户端调用

import { createClient } from 'phecda-client-ws'
import { TestWs } from '../server/test.ws' // it will redirect to .ps/ws.js
const ws = new WebSocket('ws://localhost:3001')
const client = createClient(
  ws,
  {
    test: TestWs,
  },
  {
    test(data) {
      console.log(data) // server emit 'test' event
    },
  }
)

ws.onopen = () => {
  console.log('open!')
}

client.test.add({ name: 'ws' })// invoke 'add' on TestController