JPMS + SERVICE PROVIDER MODULE + GRADLE, how to get the provider(s).

Question

0.00/5 (No votes)

See more:

Why is this syntax not working as expected? it compile and can run, however it did not give me the expected result

Java

ServiceLoader<ServiceMod> sl = ServiceLoader.load(ServiceMod.class);
for(ServiceMod sm : sl)
    System.out.printf("status: %d\r%n", sm.getStat());

It did not give me any response and it looks like an empty list.

The overview structure of the given project is shown below; it includes the build script, modular system, and synopsis src-code/brief syntax.
I have these multi-module project; driver-mod, provider-mod, & service-mod

DIRECTORIES

[DIR-TREE]
└───driver-mod
    │
    ├───build.gradle.kts
    ├───settings.gradle.kts
    │
    ├───provider-mod
    │   ├───build.gradle.kts
    │   └───src/**/
    │       ├───module-info.java
    │       └───com/mod/provider
    │           ├───ProviderModOnee.java
    │           └───ProviderModTwo.java
    │
    ├───service-mod
    │   ├───build.gradle.kts
    │   └───src/**/
    │       ├───module-info.java
    │       └───com/mod/service/ServiceMod.java
    │
    └───src/**/
        ├───module-info.java
        └───com/mod/driver/DriverMod.java

And this is the illustration/diagram of the my SERVICE PROVIDER MODULE looks like.

──────> requires
======> exports
----------->uses
++++++> provides

    _______________[ nope | optional ]________
    |                                         |
    |                                         V
driver-mod ──────> service-mod <────── provider-mod
driver-mod <====== service-mod ======> provider-mod
driver-mod -----------> service-mod <++++++ provider-mod

driver-mod/src/.../module-info.java

module driver.mod {
    requires service.mod;
    uses com.mod.service.ServiceMod;
}

service-mod/src/.../module-info.java

module service.mod {
    exports com.mod.service;
}

provider-mod/src/.../module-info.java

module provider.mod {
    requires service.mod;
    provides com.mod.service.ServiceMod with 
        com.mod.provider.ProviderModOne,
        com.mod.provider.ProviderModTwo;
}

In Gradle build tool/script

driver-mod/settings.gradle.kts

rootProject.name = "driver-mod"
include(":service-mod")
include(":provider-mod")

driver-mod/gradle.build.kts

dependencies {
    implementation(project(":service-mod"))
}

provider-mod/gradle.build.kts

dependencies {
    implementation(project(":service-mod"))
}

What I have tried:

driver-mod/src/.../com/mod/driver/DriverMod.java

public class DriverMod {
    public static void main(String[] args) {
        ServiceLoader<ServiceMod> sl = ServiceLoader.load(ServiceMod.class);
        for(ServiceMod sm : sl)
             System.out.printf("status: %d\r%n", sm.getStat());
    }
}

service-mod/src/.../com/mod/service/ServiceMod.java

public interface ServiceMod {
    public abstract int getStat();
}

provider-mod/src/.../com/mod/provider/...

public class ProviderModOne implements ServiceMod{
    @Override
    public int getStat() {
        return 1;
    }
}

public class ProviderModTwo implements ServiceMod{
    @Override
    public int getStat() {
        return 2;
    }
}

Posted 28-Mar-22 22:37pm

Phoenix Liveon

Updated 26-May-22 18:50pm

v10

Add a Solution

Comments

Phoenix Liveon 29-Mar-22 4:42am

I also tried this one, but it did not work either.

java.util.List<servicemod> lsm = ServiceLoader.load(ServiceMod.class)
                .stream()
                .map(ServiceLoader.Provider::get)
                .collect(Collectors.toList());
for(ServiceMod sm : lsm)
     System.out.println(sm.getStat());

Phoenix Liveon 30-Mar-22 0:15am

Oh! The issue was that I needed the consumer to configure and add a dependency, which is the PROVIDER via "runtimeOnly" or "implementation.". in other words, the gradle build tool needed to know the PROVIDER, because we use this build tool/script to run our project.

1 solution

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Phoenix Liveon · Accepted Answer · 2022-03-29T18:56:00

The issues were caused by a lack of specification in our build tool/dependencies script's configuration, which we need to add/configure via "runtimeOnly" or "implementation," So then we can tell our build tool that before running/executing or building, we need to first add those dependencies, in this case the "provider-mod" project or artifact must be specified in the build script dependencies configuration to explicitly inform the build tool that it exist; see the code/syntax below;

driver-mod/build.gradle.kts

dependencies {
      implementation(project(":service-mod"))
       
      //REM: add this dependency via; "runtimeOnly" or "implementation"
      runtimeOnly(project(":provider-mod"))
      //implementation(project(":provider-mod"))
}

Why? : use "runtimeOnly" config, because the consumer/"driver-mod" doesn't need "provider-mod" at compile time or we don't want to create an instance/object of it inside of the consumer codes and also the "provider-mod" does not exports anything, hence why do we need to compile it, but we do need it at runtime because we require an artifact/jar of "provider-mod", the build tool will produce it as we run our project that how the gradle build tool works, there's an hierarchical execution;

Important: don't forget to include the following syntax at the same or consumer build script, as shown below:
This will notify/configure your build tool (gradle) and inform java/JVM, if any of your artifacts/project has/was "named-module", "automatic-module", or has a filename "module-info.class" then it will put/contained/inferred it to as a java named-module configuration. (basically it will put it to the "—module-path"), so that it will will do the correct execution, it will do the JPMS features. If we do not do this, it will by default insert it at the "classpath" container/thing, and then the Service Provider features or any JPMS features that must be inside of a "—module-path" will not work as expected to be.