Grails应用中WebApplicationInitializer的onStartup方法未被调用问题

我碰到过不少开发者遇到这个情况，大概率是没摸清楚Grails不同版本的启动机制，或者踩了几个容易忽略的小坑。咱们一步步来排查：

先搞清楚你的Grails版本 #

Grails 2.x和3+的启动逻辑差异很大，这是核心前提：

如果是Grails 3+（基于Spring Boot） #

这时候WebApplicationInitializer是可以被自动识别的，但你可能犯了这几个错误：

1. 给初始化类加了@Configuration注解——这是大忌！
   WebApplicationInitializer是Servlet容器启动时直接加载的，不属于Spring管理的Bean。加了@Configuration会让Spring把它当成配置类处理，反而跳过了Servlet容器的初始化逻辑。赶紧把这个注解删掉！

2. 类的位置不对
   这个初始化类必须放在src/main/java目录下（不是grails-app下），只有这样Servlet容器的类加载器才能在启动时扫描到它。

3. 正确的实现示例
   写一个简单的实现类，不要加任何Spring注解：

   import org.springframework.web.WebApplicationInitializer;
   import javax.servlet.ServletContext;
   import javax.servlet.ServletException;
   
   public class AppInitializer implements WebApplicationInitializer {
       @Override
       public void onStartup(ServletContext servletContext) throws ServletException {
           // 设置激活的配置文件
           servletContext.setInitParameter("spring.profiles.active", "dev");
           // 其他初始化逻辑...
       }
   }
   

   Grails 3+启动时会自动检测这个类并执行onStartup方法。

如果是Grails 2.x #

Grails 2.x有自己的启动流程，WebApplicationInitializer不会被自动识别，不推荐用这种方式设置配置文件，更简单的替代方案：

1. 直接在Config.groovy中配置
   这是最省心的方式：

   grails.spring.profiles.active = "dev"
   

2. 通过BootStrap.groovy动态设置
   如果需要在启动时动态决定配置文件，可以用BootStrap：

   import org.springframework.core.env.ConfigurableEnvironment
   
   class BootStrap {
       ConfigurableEnvironment environment
   
       def init = { servletContext ->
           // 动态设置激活的配置文件
           environment.activeProfiles = ["dev", "test"]
       }
   }
   

3. 非要用WebApplicationInitializer？（不推荐）
   你需要手动创建web-app/WEB-INF/web.xml，把初始化类注册进去，但这样可能和Grails自身的配置冲突：

   <listener>
       <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
   </listener>
   <context-param>
       <param-name>contextClass</param-name>
       <param-value>org.springframework.web.context.support.AnnotationConfigWebApplicationContext</param-value>
   </context-param>
   <context-param>
       <param-name>contextConfigLocation</param-name>
       <param-value>com.yourpackage.YourInitializer</param-value>
   </context-param>
   

最后排查几个常见问题 #

• 检查项目编译后的classpath：确保你的初始化类已经被编译到build/classes/main目录下。
• 查看启动日志：搜索是否有WebApplicationInitializer相关的加载日志，或者有没有类找不到、初始化失败的报错信息。
• 依赖冲突：确保spring-web的版本和Grails兼容（Grails项目默认已经处理好了，但如果手动改了依赖可能出问题）。

内容的提问来源于stack exchange，提问作者ivish