SpringBoot - 整合WebSocket时@ServerEndpoint修饰的类属性注入为null问题

  • 前言
  • 一. 问题复现
  • 1.1 原因分析
  • 二. 问题解决


前言

最近在做一个直播弹幕系统，前期准备先用WebSocket来试试水。我们都知道，使用WebSocket只需要给对应的类加上注解@ServerEndpoint即可。这个类中我还引用了一个MQ的服务类，结果调用的时候发现NPE。因此写下本篇文章做个记录。

springboot项目注入对象都是空指针_加载

一. 问题复现

1.我们建立一个WebSocket链接，后端感知到了链接建立（@OnOpen注解）之后，通过originMessageSender发送一条消息出去。

springboot项目注入对象都是空指针_websocket_02


相关代码如下：

springboot项目注入对象都是空指针_属性注入_03

但是代码跑到这里却发现originMessageSender这个对象为null，那么这段代码执行的时候自然而然的就是NPE异常了。

springboot项目注入对象都是空指针_websocket_04


如图：

springboot项目注入对象都是空指针_spring boot_05

为什么会发生这种情况呢？我们来分析下。

1.1 原因分析

首先我们来从@Autowired和Bean的属性注入角度来看。

  1. 容器启动的时候，会将每个单例的Bean加载到容器当中。
  2. 单例Bean的加载有三个步骤。实例化、依赖注入、初始化。而@Autowired的作用就体现于依赖注入当中。
  3. 我们BulletScreenService类中，通过@Autowired对OriginMessageSender进行自动装配。其实他是成功的，假设我们这时候装配的对象是sender1。

接着我们再来从WebSocket的角度来看：

  1. 我们每建立一个WebSocket链接，都会产生一个新的对象，也就是被@ServerEndpoint修饰的对象。
  2. 也就是说WebSocket是一个多例的对象而非单例。 也就是说，当建立链接之后创建的BulletScreenService实例对象和容器启动的时候，加载到容器当中的BulletScreenServiceBean已经不是一个东西了。
  3. 那么为什么通过@Autowired注入的对象是null呢？因为@Autowired注解注入对象是在启动的时候就把对象注入，而不是在使用A对象时才把A需要的B对象注入到A中的。

因此我们每建立一个WebSocket链接，按照上面的写法，我们是无法注入OriginMessageSender的。

二. 问题解决

既然给对象注入属性不可行，那么我们换位思考，给类属性注入不就好了嘛？修改如下。

原本代码：

@Autowired
private OriginMessageSender originMessageSender;

修改后代码：

private static OriginMessageSender originMessageSender;
@Autowired
private void setOriginMessageSender(OriginMessageSender originMessageSender) {
    BulletScreenService.originMessageSender = originMessageSender;
}

那么在容器启动的时候，就会加载这段代码，然后将originMessageSender实例赋值给静态变量。（我们知道静态变量属于类，而不是实例对象）

springboot项目注入对象都是空指针_spring boot_06


那么同样的，当我们客户端建立起和服务端的WebSocket链接，发送消息的时候：这里就不再是Null了。

springboot项目注入对象都是空指针_加载_07