META-INF/services in JAR with Gradle

Question

I wanted to build a plugin module that can be loaded with a ServiceLoader. This requires adding a file to the META-INF/services directory, that is named after the service interface and that contains the qualifying path to the class that implements it. Then you can load these services by calling ServiceLoader.load().

Here is an example:

Say we want to provide a plugin interface called org.example.plugins.PluginService. We then provide an implementation of this service in the class org.example.plugins.impl.ExamplePlugin.

If we want to have some sort of plugin mechanism, we could create a JAR file, that contains the implementation. This JAR file must also contain the file META-INF/services/org.example.plugins.PluginService. This file must contain one line

org.example.plugins.impl.ExamplePlugin

to enable the ServiceLoader to find the implementation. If that JAR file is in the build path, you can load the plugin by calling

Iterator<PluginService> it = ServiceLoader.load(PluginService.class).iterator();

That iterator will give you access too all plugins that are found by the ServiceLoader.

For some reason Gradle doesn't include files into the META-INF directory by default. Is there a way to let the resulting JAR contain such a file?

I already found the method metaInf in class Jar. But I don't know groovy good enough to find the solution on my own.

Are you sure? Works fine for me. Where exactly do you place this file and how do your `build.gradle` look? — axtavt, Nov 06 '12 at 16:09
There's a `META-INF` directory in the main source folder `src/main/java`. There's nothing special with the build script. It's almost a standard one, containing some additional dependencies and some custom repositories. — pvorb, Nov 06 '12 at 18:55

axtavt · Accepted Answer · 2012-11-06T19:40:29.260

55

You place META-INF/services/org.example.plugins.PluginService in src/main/java, but it's not a source, it's a resource file, therefore it should be placed in resources folder according to Maven directory layout convention, that is

src/main/resources/META-INF/services/org.example.plugins.PluginService

In this case everything should work out of the box.

edited Nov 06 '12 at 19:40

answered Nov 06 '12 at 19:23

axtavt

239,438
41
511
482

score 7 · Answer 2 · edited May 23 '17 at 12:25

7

Meanwhile I found a solution to my problem in a (somewhat) similar Question.

Adding the following to the gradle.build file, resolves my problem

jar {
  from ('./src/main/java') {
    include 'META-INF/services/org.example.plugins.PluginService'
  }
}

Now the JAR file looks as expected

.
|- org
|  `- example
|     `- plugins
|        `- impl
|           `- ExamplePlugin.class
`- META-INF
   |- MANIFEST.MF
   `- services
      `- org.example.plugins.PluginService

edited May 23 '17 at 12:25

Community

1
1

answered Nov 06 '12 at 19:10

pvorb

7,157
7
47
74

I won't accept my own answer for now, because I think it's only a workaround. Like @axtavt stated above, it should work without these lines in the `build.gradle`. – pvorb Nov 06 '12 at 19:13

score 2 · Answer 3 · answered Apr 26 '16 at 14:24

If you happen to inherit some ant based legacy code that does not follow the maven conventions, the following may help.

Define your source sets to match the legacy structure, and include a line like this:

include 'META-INF/services/**'

In your source sets. This pattern is generic and will pick up all your meta inf services.

Full example below.

sourceSets {
    main {
        java {
            srcDir 'src'
            exclude '**/Test*.java'
        }
        resources {
            srcDir 'src'
            include '**/*.xml'
            include 'META-INF/services/**'
        }
    }
    test {
        java {
            srcDir 'src'
            include '**/Test*.java'

        }
        resources { srcDir 'resources' }
    }
}

score 1 · Answer 4 · answered Aug 21 '18 at 03:15

1

Hi Can try this: https://plugins.gradle.org/plugin/com.github.harbby.gradle.serviceloader

Usage

serviceLoader {
    serviceInterface 'org.example.plugins.PluginService'
    serviceInterface 'org.example.plugins.PluginService2'
}

answered Aug 21 '18 at 03:15

ideal

131
1
4

score 0 · Answer 5 · answered Jul 16 '13 at 07:29

0

Hopefully they will implement this in the jar task just like ant does. Somebody already worked on it: http://fgaliegue.blogspot.fr/2013/06/gradle-serviceloader-support.html

answered Jul 16 '13 at 07:29

gyorgyabraham

2,550
1
28
46

META-INF/services in JAR with Gradle

5 Answers5

Linked