com.mobaijun.websocket.WebSocketAutoConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of websocket-spring-boot-starter Show documentation
spring boot's web socket component simplifies web socket operations
There is a newer version: 3.0.10
Show newest version
/*
 * Copyright (C) 2022 [www.mobaijun.com]
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.mobaijun.websocket;

import com.mobaijun.websocket.config.SockJsServiceConfigurer;
import com.mobaijun.websocket.configuration.LocalMessageDistributorConfig;
import com.mobaijun.websocket.configuration.RedisMessageDistributorConfig;
import com.mobaijun.websocket.configuration.RocketMqMessageDistributorConfig;
import com.mobaijun.websocket.configuration.WebSocketHandlerConfig;
import com.mobaijun.websocket.handler.JsonMessageHandler;
import com.mobaijun.websocket.handler.PingJsonMessageHandler;
import com.mobaijun.websocket.hodler.JsonMessageHandlerInitializer;
import com.mobaijun.websocket.message.JsonWebSocketMessage;
import com.mobaijun.websocket.properties.WebSocketProperties;
import java.util.List;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Import;
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.SockJsServiceRegistration;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistration;
import org.springframework.web.socket.server.HandshakeInterceptor;

/**
 * Description: websocket自动配置
 * Author: [mobaijun]
 * Date: [2024/8/23 9:25]
 * IntelliJ IDEA Version: [IntelliJ IDEA 2023.1.4]
 */
@EnableWebSocket
@AutoConfiguration
@RequiredArgsConstructor
@EnableConfigurationProperties(WebSocketProperties.class)
@Import({WebSocketHandlerConfig.class, LocalMessageDistributorConfig.class, RedisMessageDistributorConfig.class,
        RocketMqMessageDistributorConfig.class})
public class WebSocketAutoConfiguration {

    /**
     * websocket 配置属性
     */
    private final WebSocketProperties webSocketProperties;

    /**
     * websocket 处理器
     *
     * @param handshakeInterceptor    握手拦截器
     * @param webSocketHandler        消息处理器
     * @param sockJsServiceConfigurer socket 服务配置器
     * @return 配置器
     */
    @Bean
    @ConditionalOnMissingBean
    public WebSocketConfigurer webSocketConfigurer(List handshakeInterceptor,
                                                   WebSocketHandler webSocketHandler,
                                                   @Autowired(required = false) SockJsServiceConfigurer sockJsServiceConfigurer) {
        return registry -> {
            WebSocketHandlerRegistration registration = registry
                    .addHandler(webSocketHandler, this.webSocketProperties.getPath())
                    .addInterceptors(handshakeInterceptor.toArray(new HandshakeInterceptor[0]));

            String[] allowedOrigins = this.webSocketProperties.getAllowedOrigins();
            if (allowedOrigins != null && allowedOrigins.length > 0) {
                registration.setAllowedOrigins(allowedOrigins);
            }

            String[] allowedOriginPatterns = this.webSocketProperties.getAllowedOriginPatterns();
            if (allowedOriginPatterns != null && allowedOriginPatterns.length > 0) {
                registration.setAllowedOriginPatterns(allowedOriginPatterns);
            }

            if (this.webSocketProperties.isWithSockjs()) {
                SockJsServiceRegistration sockJsServiceRegistration = registration.withSockJS();
                if (sockJsServiceConfigurer != null) {
                    sockJsServiceConfigurer.config(sockJsServiceRegistration);
                }
            }
        };
    }

    /**
     * 心跳处理器
     *
     * @return PingJsonMessageHandler
     */
    @Bean
    @ConditionalOnProperty(prefix = WebSocketProperties.PREFIX, name = "heartbeat", havingValue = "true",
            matchIfMissing = true)
    public PingJsonMessageHandler pingJsonMessageHandler() {
        return new PingJsonMessageHandler();
    }

    /**
     * 注册 JsonMessageHandlerInitializer 收集所有的 json 类型消息处理器
     *
     * @param jsonMessageHandlerList json 类型消息处理器
     * @return JsonMessageHandlerInitializer
     */
    @Bean
    @ConditionalOnMissingBean
    public JsonMessageHandlerInitializer jsonMessageHandlerInitializer(
            List> jsonMessageHandlerList) {
        return new JsonMessageHandlerInitializer(jsonMessageHandlerList);
    }
}