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

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

2024-12-29 06:07:20作者:劳婵绚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的订阅。

4. 项目安装方式

项目的安装方式已在“1. 安装指南”中详细说明,您可以使用go get命令来安装pubsub库:

go get github.com/cskr/pubsub/v2

以上是关于pubsub库的简要技术文档,希望对您有所帮助。

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8