{"id":23062202,"url":"https://github.com/dotnet9/codewf.eventbus.socket","last_synced_at":"2025-07-26T21:32:22.917Z","repository":{"id":250341506,"uuid":"834145321","full_name":"dotnet9/CodeWF.EventBus.Socket","owner":"dotnet9","description":"Distributed event bus implemented using Socket, independent of third-party MQ.","archived":false,"fork":false,"pushed_at":"2025-07-20T00:52:40.000Z","size":779,"stargazers_count":25,"open_issues_count":1,"forks_count":6,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-20T02:57:27.930Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dotnet9.png","metadata":{"files":{"readme":"README-zh_CN.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-07-26T14:12:15.000Z","updated_at":"2025-07-20T00:52:44.000Z","dependencies_parsed_at":"2024-08-02T18:16:22.575Z","dependency_job_id":"9bc10f6b-6e28-4dc6-b32e-5fffcee8faf5","html_url":"https://github.com/dotnet9/CodeWF.EventBus.Socket","commit_stats":null,"previous_names":["dotnet9/codewf.eventbus.socket"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/dotnet9/CodeWF.EventBus.Socket","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotnet9%2FCodeWF.EventBus.Socket","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotnet9%2FCodeWF.EventBus.Socket/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotnet9%2FCodeWF.EventBus.Socket/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotnet9%2FCodeWF.EventBus.Socket/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dotnet9","download_url":"https://codeload.github.com/dotnet9/CodeWF.EventBus.Socket/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotnet9%2FCodeWF.EventBus.Socket/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267242542,"owners_count":24058768,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-26T02:00:08.937Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-16T03:25:04.138Z","updated_at":"2025-07-26T21:32:22.900Z","avatar_url":"https://github.com/dotnet9.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CodeWF.EventBus.Socket\n\n简体中文 | [English](README.md)\n\n**使用Socket实现的分布式事件总线，支持CQRS，不依赖第三方MQ。**\n\n`CodeWF.EventBus.Socket` 是一个轻量级的、基于Socket的分布式事件总线系统，旨在简化分布式架构中的事件通信。它允许进程之间通过发布/订阅模式进行通信，无需依赖外部消息队列服务。\n\n**Command**\n\n![Command](doc/imgs/command.png)\n\n**Query**\n\n![Query](doc/imgs/query.png)\n\n## 特性\n\n- **轻量级**：不依赖任何外部MQ服务，减少了系统复杂性和依赖。\n\n- **高性能**：基于Socket的直接通信，提供低延迟、高吞吐量的消息传递。\n\n- **灵活性**：支持自定义事件类型和消息处理器，易于集成到现有系统中。\n\n- **可扩展性**：支持多客户端连接，适用于分布式系统环境。\n\n## 通信协议\n\n通过` TCP` 协议进行数据交互，协议包结构如下：\n\n![0.0.8@2x](doc/imgs/0.0.8@2x.png)\n\n## 安装\n\n通过`NuGet`包管理器安装`CodeWF.EventBus.Socket`：\n\n```bash\nInstall-Package CodeWF.EventBus.Socket\n```\n\n## 服务端使用\n\n### 运行事件服务\n\n在服务端代码中，创建并启动`EventServer`实例以监听客户端连接和事件：\n\n```csharp\nusing CodeWF.EventBus.Socket;\n\n// 创建事件服务器实例\nIEventServer eventServer = new EventServer();\n\n// 启动事件服务器，监听指定IP和端口\neventServer.Start(\"127.0.0.1\", 9100);\n```\n\n### 停止事件服务\n\n当不再需要事件服务时，调用`Stop`方法以优雅地关闭服务器：\n\n```csharp\neventServer.Stop();\n```\n\n## 客户端使用\n\n### 连接事件服务\n\n在客户端代码中，创建`EventClient`实例并连接到事件服务器：\n\n```csharp\nusing CodeWF.EventBus.Socket;\n\n// 创建事件客户端实例\nIEventClient eventClient = new EventClient();\n\n// 连接到事件服务器，使用eventClient.ConnectStatus检查连接状态\neventClient.Connect(\"127.0.0.1\", 9100));\n```\n\n### 订阅事件\n\n订阅特定类型的事件，并指定事件处理函数：\n\n```csharp\neventClient.Subscribe\u003cNewEmailCommand\u003e(\"event.email.new\", ReceiveNewEmailCommand);\n\nprivate void ReceiveNewEmail(NewEmailCommand command)\n{\n    // 处理新邮件通知\n    Console.WriteLine($\"收到新邮件，主题是{message.Subject}\");\n}\n```\n\n### 发布命令(Command)\n\n发布事件到指定的主题，供已订阅的客户端处理：\n\n```csharp\n// 发布新邮件通知事件\neventClient.Publish(\"event.email.new\", new NewEmailCommand { Subject = \"恭喜您中Github一等奖\", Content = \"我们很开心，您在2024年7月...\", SendTime = new DateTime(2024, 7, 27) });\n```\n\n### 查询(Query)\n\n查询指定主题，需要有接收查询端订阅相同的主题（即生产者），收到请求后，再以相同的主题发布查询结果：\n\n```csharp\neventClient.Subscribe\u003cEmailQuery\u003e(\"event.email.query\", ReceiveEmailQuery);\n\nprivate void ReceiveEmailQuery(EmailQuery query)\n{\n    // 执行查询请求，准备查询结果\n    var response = new EmailQueryResponse { Emails = EmailManager.QueryEmail(request.Subject) };\n    \n    // 以相同的主题，发布查询结果\n    if (_eventClient!.Publish(\"event.email.query\", response,\n        out var errorMessage))\n    {\n        Logger.Info($\"Response query result: {response}\");\n    }\n    else\n    {\n        Logger.Error($\"Response query failed: {errorMessage}\");\n    }\n}\n```\n\n其他端可使用相同的主题查询（即消费者）：\n\n```csharp\nvar response = _eventClient!.Query\u003cEmailQuery, EmailQueryResponse\u003e(\"event.email.query\",\n    new EmailQuery() { Subject = \"Account\" },\n    out var errorMessage);\nif (string.IsNullOrWhiteSpace(errorMessage) \u0026\u0026 response != null)\n{\n    Logger.Info($\"Query event.email.query, result: {response}\");\n}\nelse\n{\n    Logger.Error(\n        $\"Query event.email.query failed: [{errorMessage}]\");\n}\n```\n\n\n\n### 取消订阅事件\n\n不再需要接收某类事件时，可以取消订阅：\n\n```csharp\neventClient.Unsubscribe\u003cNewEmailNotification\u003e(\"event.email.new\", ReceiveNewEmail);\n```\n\n### 断开事件服务\n\n完成事件处理或需要断开与服务器的连接时，调用`Disconnect`方法：\n\n```csharp\neventClient.Disconnect();\nConsole.WriteLine(\"断开与事件服务的连接\");\n```\n\n## 注意事项\n\n- 确保服务端和客户端使用的地址和端口号一致，并且端口未被其他服务占用。\n- 在生产环境中，服务端应配置为监听公共IP地址或适当的网络接口。\n- 考虑到网络异常和服务重启等情况，客户端可能需要实现重连逻辑。\n- 根据实际需求，可以扩展`EventServer`和`EventClient`类以支持更复杂的功能，如消息加密、认证授权等。","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdotnet9%2Fcodewf.eventbus.socket","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdotnet9%2Fcodewf.eventbus.socket","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdotnet9%2Fcodewf.eventbus.socket/lists"}