Spring Boot 无法自动装配静态成员变量以及new出的对象,导致运行时出现空指针异常的解决方法。
问题:
在项目中使用 WebSocket
便于双向通信,在类 WebSocketServer
中进行了基础的配置后,在其内部封装了一些发送信息的方法,因此我希望它需要被外界调用。
WebSocketServer
中的部分代码:
/**
* websocket信息处理
*/
@Slf4j
@Component
@ServerEndpoint(value = "/ws/{sid}") //将类定义成一个WebSocket服务器端
public class WebSocketServer {
//存放会话对象
private static Map<String, Session> sessionMap = new HashMap();
......
/**
* 群发消息
*
* @param message 发送的消息
*/
public void sendToAllClient(String message) {
Collection<Session> sessions = sessionMap.values();
for (Session session : sessions) {
//服务器向客户端发送消息
try {
session.getBasicRemote().sendText(message);
} catch (IOException e) {
e.printStackTrace();
}
}s
}
......
}
因为此类已经添加了@Component
注解交付给Spring容器管理,所以我在我的工具类MyUtil
中通过@Autowired
注解自动注入,以便于使用。
MyUtil
工具中的部分代码:
@Component
public class MyUtil {
@Autowired //自动注入
private static WebSocketServer webSocketServer;
//使用服务
public static void useServer() {
//群发消息
webSocketServer.sendToAllClient("hello");
}
}
紧接着我们模拟使用场景,在 SpringText
下进行使用测试。看看会怎么样
@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
class XXXServerApplicationTests {
@Test
public void autowiredText() {
MyUtil.useServer();
}
}
很好,很快完美的报错,null指针异常。
原因:
这个原因是 Spring Boot 不会自动装配静态的成员(这个看上面的结果应该也能看出来,因为静态的成员一般是不允许实体对象所调用的,所以Spring所管理的bean对象无法通过对象.set的方法去自动注入bean)。
其实在我后面寻找解决方案的时候发现,Spring Boot 也不会自动装配新new出来的对象(因为新new出来的对象都不是spring容器所管理的,所以肯定也不能完成自动装配,但是一般人也不会像我这样new出来使用吧哈)。
解决方法:
既然 Spring Boot 不会自动装配,那就只能通过最原始的方法,即通过获取ApplicationContext
对象获取spring 的 bean 对象。
具体实现方法是实现一个类,该类实现ApplicationContextAware
接口,并且重写其setApplicationContext()
方法,以存储spring容器对象(目的就是为了获取ApplicationContext
并存储进此类中)。然后通过容器对象获取spring的bean;
具体代码如下:
package com.anyi.util;
import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.stereotype.Component;
import javax.annotation.Nonnull;
/**
* springContext ,实现接口,进行 springBean 的手动装配
*/
@Component
public class ManagementSpringBeans implements ApplicationContextAware {
/**
* 创建 ApplicationContext 保存spring容器对象
*/
private static ApplicationContext context;
/**
* 通过class文件获取对应的bean你
*
* @param requiredType 请求类的class文件
* @param <T> 请求bean的类
* @return 对应的bean
*/
public static <T> T getBean(Class<T> requiredType) {
//通过 类class 获取对象
return context.getBean(requiredType);
}
/**
* 重写方法获取spring的上下文对象
*
* @param applicationContext spring容器
* @throws BeansException beans异常
*/
@Override
public void setApplicationContext(@Nonnull ApplicationContext applicationContext) throws BeansException {
//存储spring容器对象
ManagementSpringBeans.context = applicationContext;
}
}
实现完成这个 ManagementSpringBeans
后,以后要想注入bean的对象,就可以调用其内部的 getBean()
静态方法,传参对应的类的class就可获取对应的bean,手动装配。具体实现如下所示:
public class MyUtil {
private static WebSocketServer webSocketServer = ManagementSpringBeans.getBean(WebSocketServer.class);
public static void useServer() {
//群发消息
webSocketServer.sendToAllClient("hello");
}
}
@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
class XXXServerApplicationTests {
@Test
public void autowiredText() {
MyUtil.useServer();
}
}
成功 !
注意:使用这个方法当然很好,因为几乎可以在任何地方都能装配bean了。但是这个方案太自由了,可能会造成代码上的一些破坏。(就和原先的
goto
语句一样)所以虽然这是一个解决方法但是也不是那么的好。最后我还是使用原生的
springboot
自动装配来解决问题。当你在开发时使用这个方法进行手动装配的时候,可能是因为原始的设计布局有些问题。