Spring Boot GraphQL WebSocket Client

Spring Boot provides a WebSocketClient Interface for WebSocket API calls, and Spring Boot GraphQL provides a WebSocketGraphQlClient Interface that is a wrapper around the WebSocketClient Interface.

There are multiple implementations available for WebSocketClient such as Reactor Netty, Tomcat, Jetty, Undertow ect.

package org.wesome.graphql.controllers;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.graphql.client.GraphQlClient;
import org.springframework.graphql.client.WebSocketGraphQlClient;
import org.springframework.graphql.data.method.annotation.SubscriptionMapping;
import org.springframework.stereotype.Controller;
import org.springframework.web.reactive.socket.client.ReactorNettyWebSocketClient;
import org.springframework.web.reactive.socket.client.WebSocketClient;
import org.wesome.graphql.entity.Apple;
import org.wesome.graphql.service.AppleService;
import reactor.core.publisher.Flux;

@Controller
public record AppleGraphQLController(@Autowired AppleService appleService, @Value("${graphql.apple.subscription}") String subscription) {

    @SubscriptionMapping("appleSubscribe")
    public Flux<Apple> appleSubscribe() {
        return appleService.findLatest();
    }

    @SubscriptionMapping("applesWebSocket")
    public Flux<Apple> applesWebSocket() {
        String url = "http://localhost:8080/graphql";
        WebSocketClient client = new ReactorNettyWebSocketClient();
        GraphQlClient graphQlClient = WebSocketGraphQlClient.builder(url, client).build();
        Flux<Apple> appleSubscribe = graphQlClient.document(subscription).retrieveSubscription("appleSubscribe").toEntity(Apple.class);
        return appleSubscribe;
    }
}

package org.wesome.graphql.data;
public enum AppleName {
    MACINTOSH("Macintosh"),
    FUJI("Fuji"),
    GALA("Gala"),
    JONAGOLD("Jonagold");
    private String appleName;
    AppleName(String appleName) {
        this.appleName = appleName;
    }
}

package org.wesome.graphql.entity;

public record Apple(int appleId, String appleName, Float price, Boolean available, String time) {
}

package org.wesome.graphql.service;

import org.wesome.graphql.entity.Apple;
import reactor.core.publisher.Flux;

public interface AppleService {
    Flux<Apple> findLatest();
}

package org.wesome.graphql.service;

import com.github.javafaker.Faker;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.wesome.graphql.data.AppleName;
import org.wesome.graphql.entity.Apple;
import reactor.core.publisher.Flux;

import java.time.Duration;
import java.time.LocalTime;
import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.IntStream;

@Service
public record AppleServiceImpl(@Autowired Faker faker) implements AppleService {
    @Override
    public Flux<Apple> findLatest() {
        List<Apple> collect = IntStream.rangeClosed(0, AppleName.values().length - 1).mapToObj(value -> new Apple(value, AppleName.values()[value].name(), Float.valueOf(value), faker.random().nextBoolean(), LocalTime.now().toString())).collect(Collectors.toList());
        return Flux.fromIterable(collect).delayElements(Duration.ofSeconds(2));
    }
}

package org.wesome.graphql;

import com.github.javafaker.Faker;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
public class GraphqlProjectApplication {
    public static void main(String[] args) {
        SpringApplication.run(GraphqlProjectApplication.class, args);
    }

    @Bean
    public Faker getFaker() {
        Faker faker = new Faker();
        return faker;
    }
}

\src\main\resources\graphql\schema.graphqls

# Apple Object
type Apple{
    # primary key of apple
    appleId:ID!
    # apple Name
    appleName:String
    # apple price
    price:Float
    # apple Availability
    available:Boolean
    # current time
    time:String
}

# Apple Query
type Query{
    # query to get all apples
    apples:[Apple]
}

# Apple Subscription
type Subscription {
    appleSubscribe:Apple
    applesWebSocket:Apple
}

\src\main\resources\application.properties

spring.graphql.graphiql.enabled=true
spring.graphql.websocket.path=/graphql
graphql.apple.subscription=subscription AppleSubscribe { appleSubscribe { appleId appleName price available time } }

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.1.5</version>
        <relativePath/>
    </parent>
    <groupId>org.wesome</groupId>
    <artifactId>spring-boot-graphql</artifactId>
    <version>0.0.1-snapshot</version>
    <name>spring-boot-graphql</name>
    <description>implementing graphql in spring boot</description>
    <properties>
        <java.version>17</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>com.github.javafaker</groupId>
            <artifactId>javafaker</artifactId>
            <version>1.0.2</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-graphql</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-websocket</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.graphql</groupId>
            <artifactId>spring-graphql-test</artifactId>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-webflux</artifactId>
        </dependency>
        <dependency>
            <groupId>io.projectreactor</groupId>
            <artifactId>reactor-test</artifactId>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

curl --location --request POST 'http://localhost:8080/graphql' \
--header 'Content-Type: application/json' \
--data '{"query":"subscription ApplesWebSocket {\r\n    applesWebSocket {\r\n        appleId\r\n        appleName\r\n        price\r\n        available\r\n        time\r\n    }\r\n}\r\n","variables":{}}'

GraphiQL

GraphQL provides an inbuild UserInterface GraphiQL, which can be accessed via http://localhost:8080/graphiql or access GraphQL via Postman, in the query section add the below query

subscription ApplesWebSocket {
    applesWebSocket {
        appleId
        appleName
        price
        available
        time
    }
}

Spring Boot GraphQL WebSocket Client

follow us on