• 长连接组件

    组件编码 hzero-starter-websocket

    一、简介

    1.1 概述

    hzero-starter-websocket 长连接组件，支持前端websocket和sock-js两种连接方式，用于后端的主动消息推送。

    1.2 组件坐标

    <dependency>
    <groupId>org.hzero.starter</groupId>
    <artifactId>hzero-starter-websocket</artifactId>
    <version>${hzero.starter.version}</version>
</dependency>

    1.3 特性

    二、使用指南

    2.1 配置

    hzero:
  websocket:
    # websocket方式连接路径
    websocket: /websocket
    # sock-js连接路径
    sockJs: /sock-js
    # oauth地址
    oauthUrl: http://dev.hzero.org:8080/oauth/api/user
    # redis库
    redisDb: 1

    以上均为默认配置

    2.2 前端连接

    前端连接需要在路径上拼接参数access_token，用于获取用户信息

    2.3 使用说明

    后端发送消息

    @Autowired
private SocketSendHelper socketSendHelper;

    SocketSendHelper提供了三个消息发送的方法：

    **需要注意的是：**HZERO的长连接是默认建立的，在HZERO的系统架构下，无需自行依赖本组件。boot-message组件提供了上述三个方法用于消息推送。
    key为消息类型的唯一key，作为会话标识，HZERO的前端会根据key进行消息下发，所以key必须是全局唯一的。message为消息内容，一般为json字符串。

    三、版本更新日志