JAR hell

Poll without page-refresh

	del.icio.us
	Digg
	Furl
	Reddit
	Rojo
	Add to OnlyWire

The Java Classloader is a part of the Java Runtime Environment that dynamically loads Java classes into the Java Virtual Machine^[1]. Usually classes are only loaded on demand. The Java run time system does not need to know about files and file systems because of class loaders. Delegation is an important concept to understand when learning about class loaders.

A software library is a collection of more or less related object code. In the Java language, libraries are typically packaged in Jar files. Libraries can contain various different sorts of objects, the most important type of object contained in a Jar file is a Java class. A class can be thought of as a named unit of code. The class loader is responsible for locating libraries, reading their contents, and loading the classes contained within the libraries. This loading is typically done "on demand", in that it does not occur until the class is actually used by the program. A class with a given name can only be loaded once by a given classloader.

1 Class loading process
2 User-defined class loaders
3 Class Loaders in J2EE
4 JAR hell
5 See also
6 References
7 External links

Class loading process

The classloading process is fairly complicated, and is the subject of much confusion in software deployment and development. Java programs may make use of external or third party libraries (that is, libraries written and provided by someone other than the author of the program) or may itself be composed, at least in part, by a number of libraries.

Each Java class must be loaded by a class loader. When the JVM is started, three class loaders are used^[2] ^[3]:

Bootstrap class loader
Extensions class loader
System class loader

The bootstrap class loader loads the core Java libraries, i.e. core.jar, server.jar etc. in the <JAVA_HOME>/lib directory. This class loader, which is part of the core JVM, is written in native code.

The extensions class loader loads the code in the extensions directories (<JAVA_HOME>/lib/ext or any other directory specified by the java.ext.dirs system property). It is implemented by the sun.misc.Launcher$ExtClassLoader class.

The system class loader loads code found on java.class.path, which maps to the system CLASSPATH variable. This is implemented by the sun.misc.Launcher$AppClassLoader class.

User-defined class loaders

By default, all user classes are loaded by the default system class loader, but it is possible to replace it by a user-defined ClassLoader (which defaults to the original root system class loader), and even to chain class loaders as desired.

This makes it possible (for example):

to load or unload classes at runtime (for example to load libraries dynamically at runtime, even from a HTTP resource). This is an important feature for:
- implementing scripting languages,
- using bean builders,
- allowing user-defined extensibility
- allowing multiple namespaces to communicate. This is one of the foundations of CORBA / RMI protocols, for example.
to change the way the bytecode is loaded (for example, it is possible to use encrypted Java class bytecode^[4]).
to modify the loaded bytecode (for example, for load-time weaving of aspects when using Aspect Oriented Programming).

Class Loaders in J2EE

J2EE application servers typically load classes from a deployed EAR archive by a tree of Classloaders, isolating the application from other applications, but sharing classes between deployed modules. So-called "servlet containers" are typically implemented in terms of multiple classloaders^[5]^[6]

JAR hell

JAR hell is a term similar to DLL hell used^{[citation needed]} to describe all the various ways in which the classloading process can end up not working.

One case is when a developer or deployer of a Java application has accidentally made two different versions of a library available to the system. This is not considered an error by the system. Rather, the system will load classes from one or the other library. A developer who thinks he has replaced a library with a new version, but who has instead simply added the new library to the list of available libraries, may be surprised to see the application still behaving as though the old library is in use which, of course, it may well be.

Another version of the problem arises when two libraries (or a library and the application) require different versions of the same third library. If both versions of the third library use the same class names, there is no way to load both versions of the third library with the same classloader.

The most complex JAR hell problems arise in circumstances that take advantage of the full complexity of the classloading system. A Java program is not required to use only a single "flat" classloader, but instead may be composed of several (or, in fact, an indefinite number of) nested, cooperating classloaders. The interactions between classloaders is too complex to be fully described here. It is sufficient to say that classes loaded by different classloaders may interact in ways which may not be fully comprehended by the developer, leading to inexplicable errors or bugs^{[citation needed]}.

To remedy the JAR hell problems a Java Community Process - JCP 277 has been initiated. The resolution - Java Module System - intends to introduce a new distribution format, modules versioning scheme and a common modules repository (similar in purpose to Microsoft .NET's Global Assembly Cache).