When to use ServiceLoader?

I came across the documentation of ServiceLoader and am unclear as to what use cases it suits.

ServiceLoader

When would one use ServiceLoader?

ServiceLoader

4 Answers
4

You use ServiceLoader when you want your program to have a “plugin” functionality. When you want to allow people to customize your application by adding jar files to the classpath which contain implementations of a specific subset of functionality, you can use a ServiceLoader to look for those implementations in the classpath.

ServiceLoader is itself an implementation of the jar SPI specification, which has been around for a long time. (I believe it was introduced in Java 1.3.)

Java SE already uses it for exactly that purpose in a lot of places, including:

classLoader.getResources("/META-INF/services/" + spiClass.getName())

ServiceLoader is Java's light weight alternative to a full blown IoC container such as Spring, Guice, etc. It has far less bells and whistles than those frameworks, but works well for basic use cases when you just want to find what classes implement an interface.

ServiceLoader

Most application servers will have some usages of ServiceLoader you can see in practice:

https://github.com/apache/tomee/search?q=ServiceLoader&unscoped_q=ServiceLoader

https://github.com/apache/tomcat/search?q=ServiceLoader&unscoped_q=ServiceLoader

https://github.com/wildfly/wildfly/search?q=ServiceLoader&unscoped_q=ServiceLoader

Are you familiar with the principle "Inversion of Control"?

Java implemented it by ServiceLoader. The class is designed to locate implementation classes of an interface on the classpath. You pass in a service interface, you get an implementation(s) of that service.

ServiceLoader

You might find a good practical example here.

P.S: Even though it's an out-of-the-box solution and a quite simple tool, I think it's outdated and not flexible enough compared to the Spring IoC Container and Google Guice.

When I hear something about ServiceLoader, I start to think about JDBC. This technology loads jdbc driver classes from classpath, which it can find. It let us not write Class.forName before using jdbc.

ServiceLoader

Class.forName

I am sure many examples of using ServiceLoader, except JDBC exist

ServiceLoader

Thanks for contributing an answer to Stack Overflow!

But avoid …

To learn more, see our tips on writing great answers.

Required, but never shown

Required, but never shown

By clicking "Post Your Answer", you acknowledge that you have read our updated terms of service, privacy policy and cookie policy, and that your continued use of the website is subject to these policies.