如何在嵌入式 Tomcat 中正确集成 Weld 实现 CDI 依赖注入

本文详解在嵌入式 tomcat(如 tomcat 10.1.5)中启用 weld cdi 的关键配置缺失——`ctx.setresources(webresourceroot)`,并提供完整可运行的初始化代码、常见错误分析及最佳实践。

在嵌入式 Tomcat 中集成 Weld 实现 Java EE / Jakarta EE 风格的 CDI(Contexts and Dependency Injection)时,一个极易被忽略但至关重要的步骤是:显式为 Context 设置 WebResourceRoot 实例。若遗漏 ctx.setResources(webResourceRoot),Weld 将无法正确扫描类路径、加载 beans.xml、发现 CDI Bean,最终导致所有 @Inject 字段为 null,且通过 JNDI 查找 BeanManag

er(如 java:comp/env/BeanManager)时抛出 WELD-001300: Unable to locate BeanManager 异常。

该问题的根本原因在于:嵌入式 Tomcat 不会自动将 WebResourceRoot 关联到 Context,而 Weld(尤其是 weld-servlet-core)严重依赖此资源根来定位 WEB-INF/classes、WEB-INF/lib/*.jar 及 WEB-INF/beans.xml。对比日志即可印证——正常部署时 Weld 会调用 TomcatContainer.initialize()(识别真实 Tomcat 容器),而嵌入式场景下却回退至通用 WeldServletLifecycle.initialize(),说明容器环境未被正确识别,根源正是资源根未注册。

✅ 正确初始化代码(关键修复已高亮):

Tomcat tomcat = new Tomcat();
tomcat.setPort(8080);
String webappDirLocation = "src/main/webapp/";
Context ctx = tomcat.addWebapp("/", new File(webappDirLocation).getAbsolutePath());

// 配置自定义 classes 目录(如 build/classes/java/main)
File additionWebInfClasses = new File("build/classes/java/main/");
WebResourceRoot webResourceRoot = new StandardRoot(ctx);
webResourceRoot.addPreResources(
    new DirResourceSet(webResourceRoot, "/WEB-INF/classes", 
                       additionWebInfClasses.getAbsolutePath(), "/")
);

// ✅ 【关键修复】必须显式设置 resources,否则 Weld 无法定位类与 beans.xml
ctx.setResources(webResourceRoot);

// 启用 JNDI(Weld 需要)
tomcat.enableNaming();

// 注册 Weld 监听器(确保早于其他 listener)
ctx.addApplicationListener("org.jboss.weld.environment.servlet.Listener");

// 启动
tomcat.start();
tomcat.getServer().await();

? 补充必要配置:

  • WEB-INF/beans.xml:即使为空,也必须存在(CDI 规范要求),内容建议:
    
    
  • WEB-INF/web.xml(可选但推荐):声明 BeanManager JNDI 资源引用:
    
        BeanManager
        javax.enterprise.inject.spi.BeanManager
    
  • 依赖版本兼容性:确认 weld-servlet-core:5.1.0.Final 与 Tomcat 10+(Jakarta EE 9+)匹配;若使用 Tomcat 9,请降级至 weld-servlet-core:4.x 并适配 javax.* 包名。

⚠️ 注意事项:

  • tomcat.enableNaming() 必须在 addWebapp() 之后、start() 之前调用;
  • Listener 类必须使用全限定名字符串注册(如 "org.jboss.weld.environment.servlet.Listener"),避免类加载时机问题;
  • 若使用 Gradle,确保 build/classes/java/main/ 在启动前已编译完成(可添加 classes 任务依赖);
  • 建议启用 Weld 日志(logging.level.org.jboss.weld=DEBUG)验证 BeanManager 是否成功绑定至 JNDI。

总结:嵌入式 Tomcat + Weld 的核心陷阱在于资源根未显式挂载。ctx.setResources(...) 不仅是技术必需,更是 Weld 容器感知机制的触发开关。补上这一行,即可让 @Inject 正常工作,JNDI 查找 BeanManager 成功返回,真正实现轻量级、可测试的 CDI 应用启动。