# web-socket

**Repository Path**: xia17/web-socket

## Basic Information

- **Project Name**: web-socket
- **Description**: 一个存储WebSocket的Session的容器
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-06-02
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# web-socket

#### 介绍
一个存储WebSocket的Session的容器

#### 软件架构
使用 springboot 框架 以及fastjson序列化


#### 安装教程

1. pom文件添加fashjson的依赖
2. 将项目中的 annotation 、 api 、config 、model 四个包导入到你的项目
3. 直接使用即可
注意：在导成war 放入到tomcat服务器运行时 需要将 config.WebSocketConfig中的 serverEndpointExporter（） 方法注释掉。

#### 使用说明

1. 首先创建一个pojo类，继承 model.SessionBean 然后实现Equals和hashCode方法 可以直接使用IDE直接生成,如果使用lombok插件的话直接@Data就行。在需要用于判断重复的字段上加入 @OnlyAttribute 注解。
2. 创建Socjet类 ， 声明一个属性如 
    /**
     * 存储SocketSession，以及数据
     */
    public static WsSessionList<DemoSession> sessionList =  new AloneSessionList<>();
3. 在open 方法时 将Session加入容器 ，close 方法时 从容器中移除。


#### Demo 简单聊天室 示例 
实例在项目中Demo 有完整代码。
1、首先创建DemoSession，他有一个唯一属性 username 用来标识谁发的信息 ，以及是否已经进入聊天室。
    代码 demo.socket.model.DemoSession 
2、创建Socket 类 AloneSocket 
    代码 demo.socket.AloneSockt 
3、创建一个MessageController 用于发送消息 
    代码 demo.controller.MessageController 

演示效果启动后访问 localhost:8080/index