websocket使用@Autowired、@Value获取值为null解决方法

本文讲述了在使用Spring框架时,由于WebSocket的多实例特性导致@Autowired和@Value注解无法正常工作的问题。作者通过分析问题原因,提出将注入对象设为静态类级别变量,并在方法上使用set方法初始化,从而解决注入null的问题。此解决方案适用于处理Spring单例与WebSocket多实例冲突的场景。

作为一名资深码农,原本以为闭着眼睛都可以用@Autowired、@Value轻松获取注入的对象,不料最近在写一个小工具时碰了一鼻子灰,先上代码:

@ServerEndpoint("/log")
@Component
public class LogWebSocketHandle {

    @Value("${wslog_commond}")//
    private  String wslog_commond1;

相信java 码农们再熟悉不过了,不过你不要高兴太早,取值时候一个null足以让你抓狂。

注意一个细节开头那段@ServerEndpoint表示这是一个websocket服务端类,根本原因在于:spring管理的都是单例(singleton)和 websocket (多对象)相冲突。websocket多用于客户端与服务端快速通信:聊天、实时输出日志等场景,这意味着每一个客户端请求服务端都会生成一个新的websocket实例,spring 仅仅针对@component、@controller注解完成单例模式管理任务(注意仅仅这一次、这一个对象赋值了)后续随着客户单端访问 websocket不断进行实例化(这些对象不是由spring管理的,所以启动过程并无法给后续的实际处理websocket会话的实例赋值)。不改变方法的话每个 websocket 对象的 注入对象值得都是 null。

了解了这点后,我们可以将要注入的对象设为类级别的变量,并通过在方法上使用@Autowired、@Value对变量进行初始化,进而使变量不为空:

//@Value("${wslog_commond}")千万不可打开这个注解
private static String wslog_commond;//static为关键

@Value("${wslog_commond}")
public void setWslog_commond(String wslog_commond) {

    LogWebSocketHandle.wslog_commond = wslog_commond;
}

总结:websocket与spring框架的@component、@controller无冲突,spring会按照原来规则实例化一个对象,只不过该对象在运行期间一直不会被使用,这就成了废物。将类的要注入属性改为静态类级别变量,通过第一次实例化调用set方法完成对类的变量赋值动作,变废为宝完成其使命。

本案例还是来自本人写的推docker送镜像到haobor工具,源码地址GitHub - kakahu2015/harbor-demo 

你提出的问题非常典型,是 Spring + WebSocket 开发中常见的一个坑:**为什么 `@Controller` 中的 `@Autowire` 能正常注入,而 WebSocket 类中的 `@Autowired` 却为 `null`?** --- ## 🔍 问题分析 ### ✅ Controller 中的 `@Autowired` 正常 ```java @Controller @RequestMapping("/") public class WebSocketController { @Autowired private JdbcTemplate jdbcTemplate; ``` - 这是一个标准的 Spring Bean。 - 被 Spring 容器管理,所有依赖注入都由 Spring 自动完成。 ✅ 所以这里的 `jdbcTemplate` 是可以正常注入的。 --- ### ❌ WebSocket 类中的 `@Autowired` 为 null ```java @Component @ServerEndpoint(value = "/test", configurator = WebSocketConfig.GetHttpSessionConfig.class) public class WebSocketServer { @Autowired private JdbcTemplate jdbcTemplate; ``` 虽然你加了 `@Component` 注解,看起来像是被 Spring 管理的 Bean,但: > **WebSocket 的生命周期不由 Spring 管理,而是由 Java WebSocket (JSR-356) 规范的容器(如 Tomcat)创建的。** 这意味着: - `WebSocketServer` 实例是由 WebSocket 容器创建的,不是 Spring 创建的。 - 因此,Spring 不会自动进行依赖注入(即使加上了 `@Component`)。 - 导致 `@Autowired` 注入失败,变量为 `null`。 --- ## ✅ 解决方案一:使用静态工具类获取 Spring Bean 这是最常见、最有效的解决方案。 ### 1. 创建一个 Spring 上下文工具类: ```java @Component public class SpringContextUtil implements ApplicationContextAware { private static ApplicationContext context; @Override public void setApplicationContext(ApplicationContext applicationContext) { context = applicationContext; } public static <T> T getBean(Class<T> beanClass) { return context.getBean(beanClass); } } ``` ### 2. 在 WebSocket 类中使用它: ```java @Component @ServerEndpoint(value = "/test", configurator = WebSocketConfig.GetHttpSessionConfig.class) public class WebSocketServer { private static final CopyOnWriteArrayList<Session> sessions = new CopyOnWriteArrayList<>(); private Session socketSession; private HttpSession httpSession; /** * 客户接入 * @param session 当前会话 * @param config 端点配置 */ @OnOpen public void onOpen(Session session, EndpointConfig config) { // 保存会话信息 socketSession = session; httpSession = (HttpSession) config.getUserProperties().get(HttpSession.class.getName()); sessions.add(session); sendToAll(String.format("%s,上线", httpSession.getAttribute("username"))); log.info("SessionId:{},建立连接", session.getId()); // 手动从 Spring 获取 jdbcTemplate JdbcTemplate jdbcTemplate = SpringContextUtil.getBean(JdbcTemplate.class); String sql = "INSERT INTO onlineuser (username) VALUES (?)"; jdbcTemplate.update(sql, httpSession.getAttribute("username")); System.out.println("成功加入数据库"); } // 其他方法... } ``` --- ## ✅ 解决方案二:使用 Spring 提供的 `ServerEndpointExporter` 确保你已经正确配置了这个 Bean: ```java @Bean public ServerEndpointExporter serverEndpointExporter() { return new ServerEndpointExporter(); } ``` 并且你的 WebSocket 类上必须加上: ```java @ServerEndpoint("/test") @Component ``` > ✅ 注意:有些时候即使这样做了,某些版本的 Spring Boot 可能仍无法注入,建议还是用上面的静态工具类更稳妥。 --- ## 🧪 补充说明:`@Component` 并不能保证注入成功 虽然你用了 `@Component`,但由于 WebSocket 对象是由 WebSocket 容器(Tomcat)创建的,而不是 Spring 创建的,所以即使标注为组件,也不能触发 Spring 的依赖注入机制。 --- ## ✅ 总结对比 | 方式 | 是否可行 | 原因 | |------|----------|------| | `@Autowired` 直接注入 | ❌ | WebSocket 类由容器创建,非 Spring 管理 | | 使用 `SpringContextUtil.getBean()` | ✅ | 主流做法,手动从上下文中取 Bean | | 配置 `ServerEndpointExporter` | ✅(部分场景) | Spring 提供支持,但有时不生效 | | 继承 `Endpoint` 并手动实现回调 | ✅(高级用法) | 更复杂,适合定制化开发 | --- ###
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

kakahu2015

只发干货,如果你觉得不干请别打

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值