Tomcat中部署Micronaut WAR包时执行启动代码的方法求助

问题描述 #

我需要找到在Tomcat中以Servlet方式运行Micronaut时，读取并使用Tomcat的context.xml的正确启动代码写法。之前尝试创建实现ApplicationEventListener<ServerStartupEvent>的@Singleton类，但编译成WAR包部署到Tomcat后，这段代码并未执行；换成@Context注解也没用。查文档得知MicronautServletInitializer会注册DefaultMicronautServlet，但这个类是硬编码实现的，无法用@Replace替换成自定义Bean。想确认是否需要特殊配置才能触发应用事件？

编辑：以下代码同样无法生效：

package com.mypackage.api;

import io.micronaut.context.event.ApplicationEventListener;
import io.micronaut.context.event.StartupEvent;
import jakarta.inject.Singleton;

@Singleton
//@Context // 加不加都不执行
public class SystemUtilsConfig implements ApplicationEventListener<StartupEvent> {
    @Override
    //@EventListener // 加不加都不执行
    //@Async // 加不加都不执行
    public void onApplicationEvent(StartupEvent startupEvent) {
        System.out.println("=====SystemUtilsConfig.onApplicationEvent======");
    }
}

可行解决方案 #

1. 直接使用ServletContextListener（推荐） #

WAR部署到Tomcat时，Servlet容器的生命周期事件优先级高于Micronaut内部事件，实现ServletContextListener能确保在应用启动时拿到ServletContext，进而读取context.xml的配置：

package com.mypackage.api;

import jakarta.servlet.ServletContext;
import jakarta.servlet.ServletContextEvent;
import jakarta.servlet.ServletContextListener;
import jakarta.servlet.annotation.WebListener;

@WebListener
public class ContextConfigListener implements ServletContextListener {

    @Override
    public void contextInitialized(ServletContextEvent sce) {
        ServletContext context = sce.getServletContext();
        // 读取context.xml中的初始化参数
        String customParam = context.getInitParameter("your-config-key");
        // 读取context.xml中的资源配置（比如数据源）
        Object dataSource = context.getAttribute("java:comp/env/jdbc/yourDataSource");
        System.out.println("=====成功读取context.xml配置======");
    }

    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        // 应用销毁时的资源清理逻辑
    }
}

2. 通过Micronaut的Bean事件获取ServletContext #

如果偏好使用Micronaut的Bean机制，可以实现BeanCreatedEventListener来监听ServletContext的创建事件：

package com.mypackage.api;

import io.micronaut.context.annotation.Context;
import io.micronaut.context.annotation.Requires;
import io.micronaut.context.event.BeanCreatedEvent;
import io.micronaut.context.event.BeanCreatedEventListener;
import jakarta.servlet.ServletContext;

@Context
@Requires(classes = ServletContext.class)
public class ContextConfigProcessor implements BeanCreatedEventListener<ServletContext> {

    @Override
    public ServletContext onCreated(BeanCreatedEvent<ServletContext> event) {
        ServletContext servletContext = event.getBean();
        // 读取context.xml配置
        String configValue = servletContext.getInitParameter("custom-config");
        System.out.println("=====通过Micronaut Bean事件读取context.xml======");
        return servletContext;
    }
}

3. 检查WAR打包配置 #

确保构建脚本中正确配置了Micronaut的WAR打包：

• Gradle配置：

plugins {
    id "io.micronaut.application" version "4.x.x"
    id "war"
}

micronaut {
    runtime "tomcat"
    // 其他项目配置
}

• Maven配置：

<packaging>war</packaging>
<properties>
    <micronaut.runtime>tomcat</micronaut.runtime>
</properties>

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