Spring项目使用@EnableWebSocket注解时如何正常加载application.yml配置文件

问题根因 #

@EnableWebSocket注解直接标注在Spring Boot启动类上时，会触发WebSocket相关配置类的优先加载，干扰Spring Boot默认的配置文件扫描、解析链路，部分场景下还会覆盖Web环境的自动配置逻辑，最终导致application.yml无法被正常读取。

解决方案 #

方案1：拆分独立WebSocket配置类（优先推荐） #

不要将@EnableWebSocket直接加在启动类上，单独创建配置类承载WebSocket相关逻辑：

• 第一步：移除启动类上的@EnableWebSocket注解
• 第二步：新增独立配置类，示例代码如下：

import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;

@Configuration
@EnableWebSocket
public class CustomWebSocketConfig implements WebSocketConfigurer {
    // 注册自定义WebSocket处理器、拦截器
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        // 替换为实际业务的处理器、路径、跨域规则
        registry.addHandler(customWsHandler(), "/ws/connect")
                .setAllowedOrigins("*")
                .addInterceptors(new CustomWsInterceptor());
    }

    // 自定义WebSocket处理器Bean定义
    public CustomWsHandler customWsHandler() {
        return new CustomWsHandler();
    }
}

该方案完全不改动启动类的默认加载逻辑，既兼容Spring Boot原生配置文件加载流程，也可以正常支持ws/wss协议访问。

方案2：显式指定配置文件加载路径 #

如果暂时不想调整代码结构，可通过启动参数强制指定配置文件路径：

• Jar包部署启动时添加参数：java -jar your-service.jar --spring.config.location=classpath:/application.yml
• IDE本地运行时，在启动配置的程序参数栏添加--spring.config.location=classpath:/application.yml

方案3：调整启动类注解顺序 #

如果必须将@EnableWebSocket放在启动类上，可调整注解顺序并主动开启配置属性扫描：

@SpringBootApplication
@EnableConfigurationProperties
@EnableWebSocket
public class YourApplicationStarter {
    public static void main(String[] args) {
        SpringApplication.run(YourApplicationStarter.class, args);
    }
}

效果验证 #

服务启动后，打印任意application.yml中定义的配置项（如Eureka注册地址、服务端口）确认读取正常，同时测试WebSocket连接可正常建立即可。

内容的提问来源于stack exchange，提问作者Dipisha jain