# single-websocket-api

**Repository Path**: liu-ling-feng-yu/single-websocket-api

## Basic Information

- **Project Name**: single-websocket-api
- **Description**: 基于springboot+websocket+redis发布订阅实现消息即时通讯
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-02-02
- **Last Updated**: 2025-06-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 集群化消息服务解决方案

v1.0.0 | 2024-01-31

## 项目概述

集群化消息服务解决方案是一种用于处理大量消息的高可用、高性能的解决方案。它采用集群化技术，通过将多个消息服务节点组成一个集群，共同分担消息处理负载，从而实现负载均衡和容错处理。集群化消息服务解决方案具有以下特点：

1. 高可用性：通过集群化部署，每个节点都可以独立地处理消息，当某个节点发生故障时，其他节点可以继续提供服务，保证整体的高可用性。
2. 高性能：集群化消息服务解决方案采用并行处理技术，将大量消息分散到各个节点上进行处理，从而显著提高整体的处理性能。
3. 扩展性：随着业务规模的扩大，可以方便地增加或减少节点数量，从而实现服务能力的灵活扩展。
4. 易用性：提供简单易用的API接口，方便开发人员进行集成和使用。
5. 安全性：支持多种身份验证和授权机制，确保消息的安全传输和处理。

---

## 架构图

<img height="100%" src="https://resource.liulingfengyu.cn/img/open-source/集群化消息服务架构图.jpg" width="800"/>

## 使用说明

### 服务端通过API接口推送消息给客户端

#### 调用方式

```
POST http://127.0.0.1/websocket/sendMessage
```

### 请求参数

| 属性         | 类型     | 必填 | 说明     |
|------------|--------|----|--------|
| userIdList | String | √  | 用户id集合 |
| type       | String | √  | 消息类型   |
| message    | String | √  | 其他信息   |

### 返回参数

| 属性   | 类型      | 说明                |
|------|---------|-------------------|
| code | int     | 状态码 200-成功; 其他-失败 |
| msg  | String  | 信息                |
| data | T       | 数据                |
| ok   | boolean | 状态                |

## 客户端推送消息

### 连接websocket或发送消息

> 发送消息给服务端，消息格式为

```json
{
  "userIdList": [
    "用户id"
  ],
  "type": "类型",
  "message": "你要发送的消息"
}
```

## 接收消息

> 接收服务端消息，，消息格式为

```json
{
  "type": "类型",
  "message": "你要发送的消息"
}
```

---

## 作者信息

Author：刘凌枫羽

邮箱：1305156911@qq.com

Blog：[刘凌枫羽博客](https://blog.csdn.net/qq_38036909?type=blog)

公众号

[![](https://resource.liulingfengyu.cn/img/公众号二维码.jpg)](https://mp.weixin.qq.com/s?__biz=MzkxNDI2OTM0Nw==&mid=2247483737&idx=1&sn=a5aa94d2577f961eaa6249b9857430a3&chksm=c171b495f6063d83cb3a5469205a326eab01194803926cc4f7e4e42737bf61e6b42ea39983cc#rd)

---

官网地址：https://www.liulingfengyu.cn/