com.healthy.common.websocket.WebSocketProperties Maven / Gradle / Ivy
package com.healthy.common.websocket;
import com.healthy.common.websocket.handler.ConcurrentWebSocketSessionOptions;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.NestedConfigurationProperty;
/**
* WebSocketProperties
*
* @author xm.z
*/
@Data
@ConfigurationProperties(WebSocketProperties.PREFIX)
public class WebSocketProperties {
public static final String PREFIX = "websocket";
/**
* 路径: 无参:/ws 单参:/ws/{test} 多参:/ws/{test1}/{test2} query:/ws?uid=1&name=test
*/
private String path = "/ws";
/**
* 允许跨域的源
*/
private String[] allowedOrigins;
/**
* 允许跨域来源的匹配规则
*/
private String[] allowedOriginPatterns = new String[] { "*" };
/**
* 是否支持部分消息
*/
private boolean supportPartialMessages = false;
/**
* 心跳处理
*/
private boolean heartbeat = true;
/**
* 是否开启对session的映射记录
*/
private boolean mapSession = true;
/**
* 是否开启 sockJs 支持
*/
private boolean withSockjs = false;
/**
* 多线程发送相关配置
*/
@NestedConfigurationProperty
private ConcurrentWebSocketSessionOptions concurrent = new ConcurrentWebSocketSessionOptions();
/**
* 消息分发器：local | redis，默认 local, 如果自定义的话，可以配置为其他任意值
*/
private MessageDistributorTypeEnum messageDistributor = MessageDistributorTypeEnum.LOCAL;
/**
* 消息分发器类型，用于解决集群场景下的消息跨节点推送问题
*/
enum MessageDistributorTypeEnum {
/**
* 本地缓存，不做跨节点分发
*/
LOCAL,
/**
* redis，利用 redis pub/sub 处理
*/
REDIS,
/**
* 自定义，用户自己实现一个 MessageDistributor
*/
CUSTOM
}
}