如何配置嵌入式Tomcat使其类加载器加载CATALINA_HOME/lib下的类

首先要明确：嵌入式Tomcat和独立部署的Tomcat类加载逻辑不一样——独立Tomcat靠启动脚本自动加载CATALINA_HOME/lib下的jar，但嵌入式Tomcat是通过代码启动的，默认不会自动识别CATALINA_HOME环境变量指向的lib目录，得手动配置类加载路径。

具体解决步骤 #

1. 手动将CATALINA_HOME/lib添加到嵌入式Tomcat的类加载器 #

在初始化嵌入式Tomcat的代码中，获取CATALINA_HOME路径，然后将该路径下的lib目录添加到Tomcat的类加载器仓库中。示例代码：

// 获取CATALINA_HOME环境变量
String catalinaHome = System.getenv("CATALINA_HOME");
if (catalinaHome == null) {
    // 也可以显式指定路径，比如从配置文件读取
    catalinaHome = "/path/to/your/catalina/home";
}
File libDir = new File(catalinaHome, "lib");

// 获取Tomcat的common类加载器
ClassLoader commonLoader = tomcat.getHost().getParentClassLoader();
if (commonLoader instanceof URLClassLoader) {
    URLClassLoader urlClassLoader = (URLClassLoader) commonLoader;
    // 将lib目录下的所有jar添加到类加载器
    for (File jar : libDir.listFiles((dir, name) -> name.endsWith(".jar"))) {
        URL jarUrl = jar.toURI().toURL();
        // 反射调用addURL方法（因为URLClassLoader的addURL是protected的）
        Method addUrlMethod = URLClassLoader.class.getDeclaredMethod("addURL", URL.class);
        addUrlMethod.setAccessible(true);
        addUrlMethod.invoke(urlClassLoader, jarUrl);
    }
}

或者，如果你只想给当前Web应用添加这个依赖目录，可以配置WebappLoader：

WebappLoader webappLoader = new WebappLoader(commonLoader);
webappLoader.addRepository(libDir.toURI().toURL().toString());
tomcat.getHost().getChildren()[0].setLoader(webappLoader);

2. 确保CATALINA_HOME环境变量正确传递 #

如果是通过IDE启动嵌入式Tomcat，需要在运行配置中手动添加CATALINA_HOME环境变量；如果是命令行启动，要确保启动前该环境变量已正确设置。也可以在代码中显式设置：

System.setProperty("catalina.home", "/path/to/your/catalina/home");

3. 替代方案：直接指定依赖目录（不依赖CATALINA_HOME） #

如果不想依赖CATALINA_HOME，可以直接在代码中指定分离后的lib目录路径，比如你Maven构建生成的${project.build.directory}/lib：

File externalLibDir = new File(System.getProperty("user.dir"), "target/lib");
WebappLoader webappLoader = new WebappLoader();
webappLoader.addRepository(externalLibDir.toURI().toURL().toString());
tomcat.getHost().findChild("/your-webapp").setLoader(webappLoader);

为什么默认找不到类？ #

Tomcat文档里说的common类加载器加载CATALINA_HOME/lib，是针对独立部署的Tomcat而言的——独立Tomcat的启动脚本会把这个目录加入类加载路径。但嵌入式Tomcat是完全通过代码控制的，默认不会自动扫描这个目录，必须手动配置才能让类加载器找到这些jar。

不需要自定义类加载器，通过上述配置嵌入式Tomcat的类加载器仓库即可解决问题。

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