Using with Java

This article describes how to use Apollo Kotlin in Java projects.

Use the Java codegen

Apollo Kotlin generates Kotlin code by default, but you can configure it to use the Java codegen instead:

build.gradle[.kts]

1
apollo {
2
  service("service") {
3
    generateKotlinModels.set(false)
4
  }
5
}

The default runtime for Apollo Kotlin, apollo-runtime, exposes a coroutines / Flow-based API that isn't well suited to be consumed from Java. That is why a specific runtime, apollo-runtime-java is available to use Apollo Kotlin from Java. To use it, add a dependency on this runtime instead of the default one:

build.gradle[.kts]

1
dependencies {
2
  // ...
3

4
  // Use apollo-runtime-java instead of apollo-runtime
5
  implementation("com.apollographql.apollo3:apollo-runtime-java:4.0.0-beta.5")
6
}

The Java runtime has a callbacks based API. This snippet demonstrates initializing and using an ApolloClient in Java:

1
import com.apollographql.apollo3.runtime.java.ApolloClient;
2
// (...)
3

4
ApolloClient client = ApolloClient.Builder builder = new ApolloClient.Builder()
5
  .serverUrl("http://localhost:4000/graphql")
6
  .build();
7

8
// Use enqueue to execute a query asynchronously
9
apolloClient.query(new GetRandomQuery()).enqueue(response -> {
10
  if (response.data != null) {
11
    // No errors
12
    System.out.println(response.data);
13
  } else {
14
    // Errors
15
    if (response.exception instanceof ApolloGraphQLException) {
16
      // GraphQL errors
17
      System.out.println(((ApolloGraphQLException) response.exception).getErrors().get(0));
18
    } else {
19
      // Network error
20
      response.exception.printStackTrace();
21
    }
22
  }
23
});

Note that as of now, the Java runtime doesn't support the Http or Normalized caches.

Cancelling requests

euqueue returns an ApolloDisposable that can be used to cancel the request:

1
ApolloDisposable disposable = apolloClient.subscription(new MyQuery()).enqueue(response -> ...)
2
// ...
3
disposable.dispose();

RxJava extensions

If your project uses RxJava, you can use Apollo's RxJava extensions with the Java runtime.

Using aliases

Kotlin native