踩坑篇之WebSocket实现类中无法使用@Autowired注入对象

大家好&＃xff0c;我是小简&＃xff0c;今天我又大意了&＃xff0c;在WebSocket这个类上踩坑了。

接下来我讲讲我踩坑的经历吧&＃xff01;

package cn.donglifeng.shop.socket.endpoin;import cn.donglifeng.shop.common.context.SpringBeanContext;
import cn.donglifeng.shop.common.redis.RedisUtil;
import cn.donglifeng.shop.socket.config.WebSocketConfiguration;
import cn.donglifeng.shop.socket.util.WebSocketEndpointTool;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;import javax.annotation.Resource;
import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.util.concurrent.atomic.AtomicInteger;/*** &＃64;author JanYork* &＃64;date 2023/3/14 11:36* &＃64;description WebSocket服务端点*/
&＃64;ServerEndpoint(value &＃61; "/websocket/{uid}",configurator &＃61; WebSocketConfiguration.class)
&＃64;Component
&＃64;Slf4j
public class WebSocketEndpoint {&＃64;Resourcepublic RedisUtil redisUtil;/*** 连接建立成功调用的方法** &＃64;param session 可选的参数。session为与某个客户端的连接会话&＃xff0c;需要通过它来给客户端发送数据* &＃64;param uid 用户id*/&＃64;OnOpenpublic void onOpen(Session session, &＃64;PathParam("uid") String uid) {try {redisUtil.socketOnline(Long.parseLong(uid));} catch (Exception e) {e.printStackTrace();}}/*** 收到客户端消息后调用的方法*/&＃64;OnMessagepublic void onMessage(String message) {if (StringUtils.hasLength(message)) {//TODO 业务逻辑} else {}}/*** 连接错误调用的方法** &＃64;param error 错误信息*/&＃64;OnErrorpublic void onError(Throwable error) {error.printStackTrace();}/*** 连接关闭调用的方法** &＃64;param session 会话* &＃64;param uid 用户id*/&＃64;OnClosepublic void onClose(Session session, &＃64;PathParam("uid") String uid) {}/*** &＃64;return 在线人数*/public AtomicInteger getOnlineCount() {return new AtomicInteger(redisUtil.countSocketOnline().intValue());}
}


上面是一个很简单的WebSocket端点服务类。

我打算使用Redis的Bitmap来做连接人数统计。

空指针&＃xff1f;

&＃64;Resource
public RedisUtil redisUtil;


我直接注入我封装的Redis工具类&＃xff0c;然后自信满满的开始测试。

结果…

&＃xff1f;&＃xff1f;&＃xff1f;

居然空指针&＃xff1f;&＃xff1f;&＃xff1f;什么情况&＃xff1f;

我是百思难得其解呀&＃xff0c;因为这个类本身也是一个Bean&＃xff0c;使用了&＃64;Component注解。

寻找答案

我开始使用万能的浏览器搜索。

于是在一番搜寻后&＃xff0c;在CSDN东拼西凑&＃xff0c;综合找到以下答案&＃xff1a;

首先&＃xff0c;使用了&＃64;ServerEndpoint注解的类中使用&＃64;Resource或&＃64;Autowired注入都会失败&＃xff0c;并且报出空指针异常。

原因是WebSocket服务是线程安全的&＃xff0c;那么当我们去发起一个ws连接时&＃xff0c;就会创建一个端点对象。

那么问题就在这了&＃xff0c;根据CSDN上的说明&＃xff0c;WebSocket服务是多对象的&＃xff0c;不是单例的。

而我们的Spring的Bean默认就是单例的&＃xff0c;在非单例类中注入一个单例的Bean是冲突的。

而且我虽然使用&＃64;Component注解了这个类&＃xff0c;但是WebSocket的端点仍然不是单例的&＃xff0c;这个是必须的&＃xff0c;端点服务不可能单例。

来自CSDN&＃xff1a;

&＃64;Autowired注解注入对象是在启动的时候就把对象注入&＃xff0c;而不是在使用A对象时才把A需要的B对象注入到A中。
而WebSocket在刚刚有说到&＃xff0c;有连接时才实例化对象&＃xff0c;而且有多个连接就有多个。

如何解决&＃xff1f;

知道原因还不好解决吗&＃xff1f;我们开发的适合&＃xff0c;基本上很常见的遇到要在非Bean的类中使用Bean&＃xff0c;因为不被Spring容器所管理的类中是无法注入Bean对象的&＃xff0c;所以我们需要去使用一个上下文类&＃xff0c;在一开始就将Spring中所有的Bean静态化到上下文类中。

如何实现&＃xff1f;

定义一个类&＃xff0c;实现ApplicationContextAware接口&＃xff1a;

public class SpringBeanContext implements ApplicationContextAware


不过需要注意的是&＃xff01;这个类也必须要是Bean&＃xff0c;不如无法获取到Spring的ApplicationContext。

&＃64;Component
public class SpringBeanContext implements ApplicationContextAware {private static ApplicationContext context;&＃64;Overridepublic void setApplicationContext(&＃64;NonNull ApplicationContext applicationContext) throws BeansException {context &＃61; applicationContext;}
}


重写他的setApplicationContext方法&＃xff0c;将ApplicationContext赋值给本类静态的属性。

此时&＃xff0c;当我们启动程序&＃xff0c;Spring中的Bean对象就全部会被context获取到。

然后我们还需要写从上下文中获取Bean的方法&＃xff0c;我就直接丢代码了&＃xff1a;

package cn.donglifeng.shop.common.context;import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.lang.NonNull;
import org.springframework.stereotype.Component;/*** &＃64;author JanYork* &＃64;date 2023/3/8 9:33* &＃64;description SpringBean上下文*/
&＃64;Component
public class SpringBeanContext implements ApplicationContextAware {private static ApplicationContext context;&＃64;Overridepublic void setApplicationContext(&＃64;NonNull ApplicationContext applicationContext) throws BeansException {context &＃61; applicationContext;}/*** 获取上下文** &＃64;return 上下文对象*/public static ApplicationContext getContext() {return context;}/*** 根据beanName获取bean** &＃64;param beanName bean名称* &＃64;return bean对象*/public Object getBean(String beanName) {return context.getBean(beanName);}/*** 根据beanName和类型获取bean** &＃64;param beanName bean名称* &＃64;param clazz bean类型* &＃64;param bean类型* &＃64;return bean对象*/public <T> T getBean(String beanName, Class<T> clazz) {return context.getBean(beanName, clazz);}/*** 根据类型获取bean** &＃64;param clazz bean类型* &＃64;param bean类型* &＃64;return bean对象*/public <T> T getBean(Class<T> clazz) {return context.getBean(clazz);}
}


解决效果

/*** 连接建立成功调用的方法** &＃64;param session 可选的参数。session为与某个客户端的连接会话&＃xff0c;需要通过它来给客户端发送数据* &＃64;param uid 用户id*/&＃64;OnOpenpublic void onOpen(Session session, &＃64;PathParam("uid") String uid) {try {RedisUtil bean &＃61; SpringBeanContext.getContext().getBean(RedisUtil.class);bean.socketCache(uid, session);} catch (Exception e) {e.printStackTrace();}}


这里我通过上下文类去获取到Bean对象&＃xff0c;然后测试连接成功了。

扩展知识

注意&＃xff01;我这里有坑&＃xff0c;别踩着了&＃xff0c;我测试的适合数据还是写入失败了&＃xff0c;我这里是想将Socket的Session丢到Redis里面实现分布式环境对象共享(小小的尝试)。

bean.socketCache(uid, session);


显然是不行的&＃xff0c;序列化会报错&＃xff0c;因为&＃xff1a;

看他的源码&＃xff0c;他没有去实现Serializable接口&＃xff0c;是不能被序列化的&＃xff01;

好了&＃xff0c;此文结束&＃xff0c;下一篇小简来讲将分布式环境下WebSocket的同步问题吧&＃xff01;