WEB-INF/classes/ vs WEB-INF/lib/*.jar in classpath priority?

If you put classes into WEB-INF/classes, they have priority before the jars in WEB-INF/lib. I have sometimes used this for debugging purposes. See also here.


Tomcat has several documents on the class loader:

  • high-level: The Loader Component (https://tomcat.apache.org/tomcat-5.5-doc/config/loader.html)
  • details: Class Loader HOW-TO (https://tomcat.apache.org/tomcat-5.5-doc/class-loader-howto.html)

Quote from http://tomcat.apache.org/tomcat-5.5-doc/class-loader-howto.html:
(line breaks added for readability)

As mentioned above, the web application class loader diverges from the default Java 2 delegation model (in accordance with the recommendations in the Servlet Specification, version 2.3, section 9.7.2 Web Application Classloader).

When a request to load a class from the web application's WebappX class loader is processed, this class loader will look in the local repositories first, instead of delegating before looking.
There are exceptions. Classes which are part of the JRE base classes cannot be overriden. For some classes (such as the XML parser components in J2SE 1.4+), the J2SE 1.4 endorsed feature can be used (see the common classloader definition above).

Last, any JAR containing servlet API classes will be ignored by the classloader.

All other class loaders in Tomcat 5 follow the usual delegation pattern.

Therefore, from the perspective of a web application, class or resource loading looks in the following repositories, in this order:

  • Bootstrap classes of your JVM
  • System class loader classes (described above)
  • /WEB-INF/classes of your web application
  • /WEB-INF/lib/*.jar of your web application
  • $CATALINA_HOME/common/classes
  • $CATALINA_HOME/common/endorsed/*.jar
  • $CATALINA_HOME/common/i18n/*.jar
  • $CATALINA_HOME/common/lib/*.jar
  • $CATALINA_BASE/shared/classes
  • $CATALINA_BASE/shared/lib/*.jar

So WEB-INF/classes is searched first before WEB-INF/lib.

Tags:

Tomcat

Aspectj