WAR共享的容器级版本化库

时间:2014-09-17 18:36:36

标签: java tomcat classloader servlet-container

在Java servlet容器中(最好是Tomcat,但如果可以在不同的容器中完成,那么就这么说)我希望理论上可行的东西。我的问题是,是否存在支持它的工具,以及是否存在哪些工具(或者我应该进一步研究哪些名称)。

这是我的问题:在一个servlet容器中,我想运行大量不同的WAR文件。它们共享一些大型公共库(例如Spring)。乍一看,我有两个不可接受的选择:

  1. 在每个WAR文件中包含大型库(例如Spring)。这是不可接受的,因为它会加载大量的Spring副本,耗尽服务器上的内存。

  2. 将大型库放在容器类路径中。现在所有WAR文件共享一个库实例(好)。但这是不可接受的,因为我无法在不升级所有WAR文件的情况下升级Spring版本,并且这样的大变化很难在不可能的情况下进行。

  3. 但从理论上讲,还有一种方法可行:

    1. 大型库的每个版本放入容器级类路径中。做一些容器级魔法,以便每个WAR文件声明它希望使用哪个版本,并且它将在其类路径中找到它。
    2. "魔法"必须在容器级别完成(我认为),因为这只能通过使用不同的类加载器加载库的每个版本,然后调整每个WAR文件可见的类加载器来实现。

      那么,你有没有听说过这样做?如果是这样,怎么样?或者告诉我它叫什么,这样我就可以进一步研究。

3 个答案:

答案 0 :(得分:5)

关于Tomcat,对于第7版,您可以使用VirtualWebappLocader,如此

<Context>
    <Loader className="org.apache.catalina.loader.VirtualWebappLoader"
            virtualClasspath="/usr/shared/lib/spring-3/*.jar,/usr/shared/classes" />
</Context>

对于第8版,应使用Pre- & Post- Resources

<Context>
    <Resources>
        <PostResources className="org.apache.catalina.webresources.DirResourceSet"
                       base="/usr/shared/lib/spring-3" webAppMount="/WEB-INF/lib" />
        <PostResources className="org.apache.catalina.webresources.DirResourceSet"
                       base="/usr/shared/classes" webAppMount="/WEB-INF/classes" />
    </Resources>
</Context>

不要忘记将相应的context.xml放入您的webapp的META-INF中。

For the jetty以及其他容器可以使用相同的技术。 唯一的区别在于如何为webapp指定额外的classpath元素。


<强>更新 上面的示例不共享加载的类,但想法是相同的 - 使用自定义类加载器。这是一个非常难看的样本,它也试图在取消部署期间阻止类加载器泄漏。


SharedWebappLoader

package com.foo.bar;

import org.apache.catalina.LifecycleException;
import org.apache.catalina.loader.WebappLoader;

public class SharedWebappLoader extends WebappLoader {

    private String pathID;
    private String pathConfig;

    static final ThreadLocal<ClassLoaderFactory> classLoaderFactory = new ThreadLocal<>();

    public SharedWebappLoader() {
        this(null);
    }

    public SharedWebappLoader(ClassLoader parent) {
        super(parent);
        setLoaderClass(SharedWebappClassLoader.class.getName());
    }

    public String getPathID() {
        return pathID;
    }

    public void setPathID(String pathID) {
        this.pathID = pathID;
    }

    public String getPathConfig() {
        return pathConfig;
    }

    public void setPathConfig(String pathConfig) {
        this.pathConfig = pathConfig;
    }

    @Override
    protected void startInternal() throws LifecycleException {
        classLoaderFactory.set(new ClassLoaderFactory(pathConfig, pathID));
        try {
            super.startInternal();
        } finally {
            classLoaderFactory.remove();
        }
    }

}

SharedWebappClassLoader

package com.foo.bar;

import org.apache.catalina.LifecycleException;
import org.apache.catalina.loader.ResourceEntry;
import org.apache.catalina.loader.WebappClassLoader;

import java.net.URL;

public class SharedWebappClassLoader extends WebappClassLoader {

    public SharedWebappClassLoader(ClassLoader parent) {
        super(SharedWebappLoader.classLoaderFactory.get().create(parent));
    }

    @Override
    protected ResourceEntry findResourceInternal(String name, String path) {
        ResourceEntry entry = super.findResourceInternal(name, path);
        if(entry == null) {
            URL url = parent.getResource(name);
            if (url == null) {
                return null;
            }

            entry = new ResourceEntry();
            entry.source = url;
            entry.codeBase = entry.source;
        }
        return entry;
    }

    @Override
    public void stop() throws LifecycleException {
        ClassLoaderFactory.removeLoader(parent);
    }
}

ClassLoaderFactory

package com.foo.bar;

import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;

public class ClassLoaderFactory {

    private static final class ConfigKey {
        private final String pathConfig;
        private final String pathID;
        private ConfigKey(String pathConfig, String pathID) {
            this.pathConfig = pathConfig;
            this.pathID = pathID;
        }
        @Override
        public boolean equals(Object o) {
            if (this == o) return true;
            if (o == null || getClass() != o.getClass()) return false;

            ConfigKey configKey = (ConfigKey) o;

            if (pathConfig != null ? !pathConfig.equals(configKey.pathConfig) : configKey.pathConfig != null)
                return false;
            if (pathID != null ? !pathID.equals(configKey.pathID) : configKey.pathID != null) return false;

            return true;
        }

        @Override
        public int hashCode() {
            int result = pathConfig != null ? pathConfig.hashCode() : 0;
            result = 31 * result + (pathID != null ? pathID.hashCode() : 0);
            return result;
        }
    }

    private static final Map<ConfigKey, ClassLoader> loaders = new HashMap<>();
    private static final Map<ClassLoader, ConfigKey> revLoaders = new HashMap<>();
    private static final Map<ClassLoader, Integer> usages = new HashMap<>();

    private final ConfigKey key;

    public ClassLoaderFactory(String pathConfig, String pathID) {
        this.key = new ConfigKey(pathConfig, pathID);
    }

    public ClassLoader create(ClassLoader parent) {
        synchronized (loaders) {
            ClassLoader loader = loaders.get(key);
            if(loader != null) {
                Integer usageCount = usages.get(loader);
                usages.put(loader, ++usageCount);
                return loader;
            }

            Properties props = new Properties();
            try (InputStream is = new BufferedInputStream(new FileInputStream(key.pathConfig))) {
                props.load(is);
            } catch (IOException e) {
                throw new RuntimeException(e);
            }

            String libsStr = props.getProperty(key.pathID);
            String[] libs = libsStr.split(File.pathSeparator);
            URL[] urls = new URL[libs.length];
            try {
                for(int i = 0, len = libs.length; i < len; i++) {
                    urls[i] = new URL(libs[i]);
                }
            } catch (MalformedURLException e) {
                throw new RuntimeException(e);
            }

            loader = new URLClassLoader(urls, parent);
            loaders.put(key, loader);
            revLoaders.put(loader, key);
            usages.put(loader, 1);

            return loader;
        }
    }

    public static void removeLoader(ClassLoader parent) {
        synchronized (loaders) {
            Integer val = usages.get(parent);
            if(val > 1) {
                usages.put(parent, --val);
            } else {
                usages.remove(parent);
                ConfigKey key = revLoaders.remove(parent);
                loaders.remove(key);
            }
        }
    }

}

第一个应用程序的context.xml

<Context>
    <Loader className="com.foo.bar.SharedWebappLoader"
            pathConfig="${catalina.base}/conf/shared.properties"
            pathID="commons_2_1"/>
</Context>

第二个应用程序的context.xml

<Context>
    <Loader className="com.foo.bar.SharedWebappLoader"
            pathConfig="${catalina.base}/conf/shared.properties"
            pathID="commons_2_6"/>
</Context>

$ TOMCAT_HOME / CONF / shared.properties

commons_2_1=file:/home/xxx/.m2/repository/commons-lang/commons-lang/2.1/commons-lang-2.1.jar
commons_2_6=file:/home/xxx/.m2/repository/commons-lang/commons-lang/2.6/commons-lang-2.6.jar

答案 1 :(得分:1)

我能够为Tomcat实现这个(在Tomcat 7.0.52上测试)。我的解决方案涉及实现WebAppLoader的自定义版本,该版本扩展了标准Tomcat的WebAppLoader。借助此解决方案,您可以将自定义类加载器传递给每个Web应用程序的加载类。

要利用这个新的加载器,您需要为每个应用程序声明它(在每个war中放置的Context.xml文件或Tomcat的server.xml文件中)。此加载器需要一个额外的自定义参数 webappName ,稍后将其传递给LibrariesStorage类,以确定哪个库应该由哪个应用程序使用。

    <Context  path="/pl-app" >
        <Loader className="web.DynamicWebappLoader" webappName="pl-app"/>
    </Context>      
    <Context  path="/my-webapp" >
        <Loader className="web.DynamicWebappLoader" webappName="myApplication2"/>
    </Context>

定义完成后,您需要将此DynamicWebappLoader安装到Tomcat。为此,请将所有已复制的类复制到Tomcat的 lib 目录(因此您应该具有以下文件[tomcat dir] /lib/web/DynamicWebappLoader.class, [tomcat dir] / lib / web / LibrariesStorage。 class,[tomcat dir] /lib/web/LibraryAndVersion.class,[tomcat dir] /lib/web/WebAppAwareClassLoader.class)。

您还需要下载xbean-classloader-4.0.jar并将其放在Tomcat的lib目录中(因此您应该有[tomcat dir] /lib/xbean-classloader-4.0.jar。注意:xbean- classloader提供了classloader(org.apache.xbean.classloader.JarFileClassLoader)的特殊实现,允许在运行时加载所需的jar。

主要技巧在LibraryStorgeClass中完成(完整实现在最后)。它存储每个应用程序(由 webappName 定义)和允许加载此应用程序的库之间的映射。在当前实现中,这是硬编码的,但是这可以被重写以动态生成每个应用程序所需的库列表。每个库都有自己的JarFileClassLoader实例,它确保每个库只加载一次(库和它的类加载器之间的映射存储在 static 字段&#34; libraryToClassLoader&#34;中,所以这个映射对于每个Web应用程序都是相同的,因为该字段的静态特性)

class LibrariesStorage {
    private static final String JARS_DIR = "D:/temp/idea_temp_proj2_/some_jars";

  private static Map<LibraryAndVersion, JarFileClassLoader> libraryToClassLoader = new HashMap<>();

  private static Map<String, List<LibraryAndVersion>> webappLibraries = new HashMap<>();

  static {
    try {
      addLibrary("commons-lang3", "3.3.2", "commons-lang3-3.3.2.jar"); // instead of this lines add some intelligent directory scanner which will detect all jars and their versions in JAR_DIR
      addLibrary("commons-lang3", "3.3.1", "commons-lang3-3.3.1.jar");
      addLibrary("commons-lang3", "3.3.0", "commons-lang3-3.3.0.jar");

      mapApplicationToLibrary("pl-app", "commons-lang3", "3.3.2"); // instead of manually mapping application to library version, some more intelligent code should be here (for example you can scann Web-Inf/lib of each application and detect needed jars

      mapApplicationToLibrary("myApplication2", "commons-lang3", "3.3.0");

     (...)    
 } 

在上面的例子中,假设在包含所有jar(在这里由JARS_DIR定义)的目录中,我们只有 一个commons-lang3-3.3.2.jar文件。这意味着由&#34; pl-app&#34; name(名称来自Context.xml中的标签中的webappName属性,如上所述)将能够从commons-lang jar加载类。由&#34; myApplication2&#34;标识的应用程序此时将获得ClassNotFoundException,因为它只能访问commons-lang3-3.3.0.jar,但此文件不存在于JARS_DIR目录中。

在此全面实施:

package web;

import org.apache.catalina.loader.WebappLoader;
import org.apache.xbean.classloader.JarFileClassLoader;
import java.io.File;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;


public class DynamicWebappLoader extends WebappLoader {
  private String webappName;
  private WebAppAwareClassLoader webAppAwareClassLoader;

  public static final ThreadLocal lastCreatedClassLoader = new ThreadLocal();

  public DynamicWebappLoader() {
    super(new WebAppAwareClassLoader(Thread.currentThread().getContextClassLoader()));

    webAppAwareClassLoader = (WebAppAwareClassLoader) lastCreatedClassLoader.get(); // unfortunately I did not find better solution to access new instance of WebAppAwareClassLoader created in previous line so I passed it via thread local
    lastCreatedClassLoader.remove();

  }

  // (this method is called by Tomcat because of Loader attribute in Context.xml - <Context> <Loader className="..." webappName="myApplication2"/> )
  public void setWebappName(String name) {
    System.out.println("Setting webapp name: " + name);
    this.webappName = name;
    webAppAwareClassLoader.setWebAppName(name); // pass web app name to ClassLoader 
  }


}


class WebAppAwareClassLoader extends ClassLoader {
  private String webAppName;

  public WebAppAwareClassLoader(ClassLoader parent) {
    super(parent);
    DynamicWebappLoader.lastCreatedClassLoader.set(this); // store newly created instance in ThreadLocal .. did not find better way to access the reference later in code
  }

  @Override
  public Class<?> loadClass(String className) throws ClassNotFoundException {
    System.out.println("Load class: " + className + " for webapp: " + webAppName);
    try {
      return LibrariesStorage.loadClassForWebapp(webAppName, className);
    } catch (ClassNotFoundException e) {
      System.out.println("JarFileClassLoader did not find class: " + className + " " + e.getMessage());
      return super.loadClass(className);
    }

  }

  public void setWebAppName(String webAppName) {
    this.webAppName = webAppName;
  }
}

class LibrariesStorage {
  private static final String JARS_DIR = "D:/temp/idea_temp_proj2_/some_jars";

  private static Map<LibraryAndVersion, JarFileClassLoader> libraryToClassLoader = new HashMap<>();

  private static Map<String, List<LibraryAndVersion>> webappLibraries = new HashMap<>();

  static {
    try {
      addLibrary("commons-lang3", "3.3.2", "commons-lang3-3.3.2.jar"); // instead of this lines add some intelligent directory scanner which will detect all jars and their versions in JAR_DIR
      addLibrary("commons-lang3", "3.3.1", "commons-lang3-3.3.1.jar");
      addLibrary("commons-lang3", "3.3.0", "commons-lang3-3.3.0.jar");

      mapApplicationToLibrary("pl-app", "commons-lang3", "3.3.2"); // instead of manually mapping application to library version, some more intelligent code should be here (for example you can scann Web-Inf/lib of each application and detect needed jars
      mapApplicationToLibrary("myApplication2", "commons-lang3", "3.3.0");

    } catch (MalformedURLException e) {
      throw new RuntimeException(e.getMessage(), e);
    }

  }

  private static void mapApplicationToLibrary(String applicationName, String libraryName, String libraryVersion) {
    LibraryAndVersion libraryAndVersion = new LibraryAndVersion(libraryName, libraryVersion);
    if (!webappLibraries.containsKey(applicationName)) {
      webappLibraries.put(applicationName, new ArrayList<LibraryAndVersion>());
    }
    webappLibraries.get(applicationName).add(libraryAndVersion);
  }

  private static void addLibrary(String libraryName, String libraryVersion, String filename)
                          throws MalformedURLException {
    LibraryAndVersion libraryAndVersion = new LibraryAndVersion(libraryName, libraryVersion);
    URL libraryLocation = new File(JARS_DIR + File.separator + filename).toURI().toURL();

    libraryToClassLoader.put(libraryAndVersion,
      new JarFileClassLoader("JarFileClassLoader for lib: " + libraryAndVersion,
        new URL[] { libraryLocation }));
  }

  private LibrariesStorage() {
  }


  public static Class<?> loadClassForWebapp(String webappName, String className) throws ClassNotFoundException {
    System.out.println("Loading class: " + className + " for web application: " + webappName);

    List<LibraryAndVersion> webappLibraries = LibrariesStorage.webappLibraries.get(webappName);
    for (LibraryAndVersion libraryAndVersion : webappLibraries) {
      JarFileClassLoader libraryClassLoader = libraryToClassLoader.get(libraryAndVersion);

      try {
        return libraryClassLoader.loadClass(className); // ok current lib contained class to load
      } catch (ClassNotFoundException e) {
        // ok.. continue in loop... try to load the class from classloader connected to next library
      }
    }

    throw new ClassNotFoundException("Class " + className + " was not found in any jar connected to webapp: " +
      webappLibraries);

  }

}


class LibraryAndVersion {
  private final String name;
  private final String version;

  LibraryAndVersion(String name, String version) {
    this.name = name;
    this.version = version;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if ((o == null) || (getClass() != o.getClass())) {
      return false;
    }

    LibraryAndVersion that = (LibraryAndVersion) o;

    if ((name != null) ? (!name.equals(that.name)) : (that.name != null)) {
      return false;
    }
    if ((version != null) ? (!version.equals(that.version)) : (that.version != null)) {
      return false;
    }

    return true;
  }

  @Override
  public int hashCode() {
    int result = (name != null) ? name.hashCode() : 0;
    result = (31 * result) + ((version != null) ? version.hashCode() : 0);
    return result;
  }

  @Override
  public String toString() {
    return "LibraryAndVersion{" +
      "name='" + name + '\'' +
      ", version='" + version + '\'' +
      '}';
  }
}

答案 2 :(得分:1)

JBoss有一个名为Modules的框架来解决这个问题。您可以使用其版本保存共享库,并从war文件中引用它。

我不知道它是否适用于Tomcat,但它可以作为Wildfly的魅力。