pubsub简单多主题发布-订阅库技术文档

2024-12-29 15:04:12作者：劳婵绚Shirley

1. 安装指南

在开始使用pubsub库之前，您需要先安装它。安装过程非常简单，只需在命令行中运行以下命令：

go get github.com/cskr/pubsub/v2

这将自动下载并安装pubsub库及其依赖项。

2. 项目的使用说明

pubsub是一个简单的多主题发布-订阅库。它允许您创建多个主题，并为每个主题添加订阅者。当消息被发布到某个主题时，所有订阅该主题的订阅者都会接收到消息。

以下是一个简单的使用示例：

package main

import (
    "fmt"
    "github.com/cskr/pubsub/v2"
)

const topic = "topic"

func main() {
    ps := pubsub.New[string, string](0)
    ch := ps.Sub(topic)
    
    go func() {
        for {
            msg := "message"
            ps.Pub(msg, topic)
        }
    }()

    for i := 1; i < 5; i++ {
        if msg, ok := <-ch; ok {
            fmt.Printf("Received %s %d times\n", msg, i)
        } else {
            break
        }
    }

    ps.Unsub(ch, topic)
}

在上面的代码中，我们首先创建了一个PubSub实例，并为一个名为topic的主题添加了一个订阅者。然后，我们在一个goroutine中发布消息到该主题，并在主goroutine中接收这些消息。最后，我们取消订阅并退出程序。

3. 项目API使用文档

以下是pubsub库的主要API函数及其用途：

func New[T comparable, M any](capacity int) *PubSub[T, M]：创建一个新的PubSub实例。
func (ps *PubSub[T, M]) AddSub(ch chan M, topics ...T)：向指定的channel添加订阅。
func (ps *PubSub[T, M]) AddSubOnceEach(ch chan M, topics ...T)：向指定的channel添加一次性的订阅。
func (ps *PubSub[T, M]) Close(topics ...T)：关闭所有订阅了指定主题的channel。
func (ps *PubSub[T, M]) Pub(msg M, topics ...T)：将消息发布到所有订阅了指定主题的订阅者。
func (ps *PubSub[T, M]) Shutdown()：关闭所有订阅的channel并终止处理goroutine。
func (ps *PubSub[T, M]) Sub(topics ...T) chan M：返回一个channel，从中可以接收到发布到指定主题的消息。
func (ps *PubSub[T, M]) SubOnce(topics ...T) chan M：与Sub类似，但只接收订阅后的第一条消息。
func (ps *PubSub[T, M]) SubOnceEach(topics ...T) chan M：为每个主题返回一个channel，每个channel最多接收一条消息。
func (ps *PubSub[T, M]) TryPub(msg M, topics ...T)：如果主题有缓冲空间，则发布消息。
func (ps *PubSub[T, M]) Unsub(ch chan M, topics ...T)：取消指定channel的订阅。