ServletConfigAware 空指针问题排查指南

1. 核心原因分析

• 时机问题：ServletConfigAware 的 setServletConfig() 方法在 Bean 初始化阶段被调用。若在其他生命周期（如构造函数、@PostConstruct）中过早使用 ServletConfig 对象，会导致空指针。
• 容器未就绪：非 Web 环境（如单元测试）或容器未完成初始化时，ServletConfig 尚未注入。
• 作用域错误：非 singleton 作用域的 Bean 可能无法正确接收注入。

2. 源码层面排查路径

(1) 检查注入时机

public class MyService implements ServletConfigAware {
    private ServletConfig config;  // 正确：通过接口注入
    
    public MyService() {
        // 错误：构造函数中 config 尚未注入！
        config.getInitParameter("key");  // 空指针
    }
    
    @Override
    public void setServletConfig(ServletConfig config) {
        this.config = config;  // Spring 在此注入
    }
    
    @PostConstruct
    public void init() {
        // 风险：若其他 Bean 依赖此方法，可能早于 setServletConfig
        config.getServletContext();  // 可能空指针
    }
}

修复方案：将 ServletConfig 的使用移至业务方法中，确保在注入完成后调用。

(2) 确认容器初始化流程 Spring 处理流程：

1. ContextLoaderListener 初始化 WebApplicationContext
2. DispatcherServlet 初始化时创建 ServletConfig
3. ServletContextAwareProcessor 处理 ServletConfigAware 回调

   // 源码片段：org.springframework.web.context.support.ServletContextAwareProcessor
   private void invokeAwareInterfaces(Object bean) {
       if (bean instanceof ServletConfigAware) {
           ((ServletConfigAware) bean).setServletConfig(this.servletConfig);
       }
   }
   

关键点：若在 DispatcherServlet 初始化前访问 ServletConfig，必然为空。

(3) 作用域验证

@Bean
@Scope("prototype")  // 错误：多例 Bean 可能无法接收 Aware 注入
public MyBean myBean() {
    return new MyBean();
}

解决方案：改为 singleton 作用域。

3. 解决方案

(1) 延迟使用策略

public void execute() {
    // 业务方法中安全使用
    String param = config.getInitParameter("param");
}

(2) 依赖注入替代

@Autowired  // 更安全的依赖注入方式
private ServletContext servletContext;

(3) 单元测试模拟

@Test
public void testConfig() {
    MyService service = new MyService();
    // 模拟注入
    service.setServletConfig(new MockServletConfig());
    service.execute();  // 安全测试
}

4. 常见错误场景

5. 深度排查工具

• 断点位置：
  • ServletContextAwareProcessor.invokeAwareInterfaces()
  • AbstractAutowireCapableBeanFactory.initializeBean()
• 日志配置：

  <logger name="org.springframework.web" level="DEBUG"/>
  

总结：空指针本质是生命周期错位问题。通过源码分析可知，Spring 在容器初始化后期才注入 ServletConfig，任何提前使用的操作都会导致失败。遵循 "注入完成后再使用" 原则可彻底解决。