웹사이트 검색

GraphQL과 Java를 결합하여 유연하고 현대적인 API 구축


REST API를 사용하여 데이터를 검색할 때 데이터 부족 및 초과 가져오기를 방지하세요.

지난 몇 년 동안 개발자들은 API를 통해 비즈니스 기능을 노출하기 위해 HTTP를 통한 RESTful 웹 서비스를 사용해 왔습니다. REST API는 서버 기반 고정 데이터 응답을 사용합니다. 즉, 개발자(클라이언트)가 응답 결과를 확인할 수 없습니다. 대신 서버는 모든 데이터를 클라이언트로 다시 전송하는데, 이를 오버페치라고 합니다. 개발자(클라이언트)는 클라이언트가 필요한 데이터를 얻을 때까지 첫 번째 호출 이후 여러 REST API를 호출해야 하며, 이로 인해 under-fetching이 발생합니다.

새로운 마이크로서비스를 만들기 위해 이러한 REST API를 사용하는 개발자는 비즈니스 로직과 함께 데이터를 검색할 때 초과 가져오기 및 부족 가져오기를 최소화하는 방법을 찾고 있었습니다.

GraphQL은 클라이언트 측에서 이러한 오버헤드를 방지하고 대신 REST API에 필요한 정확한 데이터를 검색하기 위해 클라이언트 중심 쿼리 언어 및 런타임을 제공합니다. GraphQL이 나왔을 때 많은 개발자들은 이것이 기존 REST API 사양을 대체할 수 있다고 생각했습니다. 그러나 그것은 대체가 아니라 대안이다.

이 문서에서는 Quarkus 애플리케이션을 사용하여 GraphQL 서비스를 사용하는 방법을 설명합니다. Quarkus는 Java 애플리케이션 작성을 위한 Kubernetes 기반 프레임워크입니다. 이전에 Quarkus 애플리케이션을 만든 적이 없다면 계속하기 전에 VS Code에서 Quarkus를 사용하여 Java 작성을 읽어보세요.

Quarkus 프로젝트에 GraphQL 확장 추가

터미널에 다음을 입력하여 기존 Quarkus Maven 프로젝트에 Quarkus 확장 smallrye-graphql을 추가하는 것부터 시작하세요(또는 Visual Studio Code에서 Quarkus 도구를 사용할 수도 있습니다).

$ mvn quarkus:add-extension -Dextensions="graphql"

터미널에 다음이 표시되어야 합니다.

✅ Extension io.quarkus:quarkus-smallrye-graphql has been installed
[INFO] ---------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ---------------------------------------------------------------------
[INFO] Total time:  9.833 s
[INFO] Finished at: 2020-07-29T22:00:28-04:00
[INFO] ---------------------------------------------------------------------

GraphQL API에 대한 엔터티 및 서비스 추가

이 예에서는 영화에 대한 데이터를 쿼리하는 두 개의 엔터티 Java 클래스를 만듭니다. 최종 사용자가 검색할 수 있는 가능한 데이터(예: 개체, 필드, 관계) 집합인 GraphQL 스키마를 나타내려면 Film 및 Hero라고 부릅니다.

public class Film {
    private String title;
    private Integer episodeID;
    private String director;
    private LocalDate releaseDate;

   // Getter & Setter methods here
   ...
}


public class Hero {


    private String name;
    private String surname;
    private Double height;
    private Integer mass;
    private Boolean darkSide;
    private LightSaber lightSaber;
    private List<Integer> episodeIds = new ArrayList<>();

   // Getter & Setter methods here
   ...
}

enum LightSaber {
    RED, BLUE, GREEN
}

CDI 빈을 사용하여 GraphQL API 생성

CDI(컨텍스트 및 종속성 주입) Bean 클래스(예: GalaxyService.java의 매개변수를 사용하여 Film 및 Hero 데이터를 검색하는 몇 가지 메서드를 구현합니다. >). 몇 가지 예시 데이터를 생성합니다.

public GalaxyService() {

   Film aNewHope = new Film();
   aNewHope.setTitle("A New Hope");
   aNewHope.setReleaseDate(LocalDate.of(1977, Month.MAY, 25));
   aNewHope.setEpisodeID(4);
   aNewHope.setDirector("George Lucas");
   films.add(aNewHope);
   ...

   Hero luke = new Hero();
   luke.setName("Luke");
   luke.setSurname("Skywalker");
   luke.setHeight(1.7);
   luke.setMass(73);
   luke.setLightSaber(LightSaber.GREEN);
   luke.setDarkSide(false);
   luke.getEpisodeIds().addAll(Arrays.asList(4, 5, 6));
   heroes.add(luke);
   ...

public List<Film> getAllFilms() {
   return films;
}

이제 GraphQL API 클래스(예: FilmResource.java)를 생성하여 CDI Bean을 삽입합니다.

@GraphQLApi 
public class FilmResource {

    @Inject
    GalaxyService service;

    @Query("allFilms") 
    @Description("Get all Films from a galaxy far far away") 
    public List<Film> getAllFilms() {
        return service.getAllFilms();
    }
}

@GraphQLApi 주석을 사용하면 GraphQL 엔드포인트에 CDI Bean(예: GalaxyService)을 사용할 수 있습니다. @Query 주석을 사용하면 특정 이름(예: allFilms)으로 쿼리할 수 있는 메서드(예: getAllFilms)를 만들 수 있습니다.

GraphQL 인터페이스인 GraphiQL의 UI에 액세스

Quarkus smallrye-graphql 확장 프로그램을 사용하면 Quarkus 애플리케이션을 실행할 때 GraphiQL 도구를 사용하여 GraphQL API와 쉽게 상호작용할 수 있습니다. Quarkus의 개발 모드(mvn quarkus:dev)를 사용하여 애플리케이션을 시작한 후 다음 엔드포인트를 사용하여 GraphiQL 사용자 인터페이스(UI)에 액세스합니다.

 --/ __ \/ / / / _ | / _ \/ //_/ / / / __/ 
 -/ /_/ / /_/ / __ |/ , _/ ,< / /_/ /\ \   
--\___\_\____/_/ |_/_/|_/_/|_|\____/___/   
2020-07-29 22:25:18,324 WARN  [io.sma.graphql] (Quarkus Main Thread) SRGQL010000: Schema is null, or it has no operations. Not bootstrapping SmallRye GraphQL
2020-07-29 22:25:18,552 INFO  [io.quarkus] (Quarkus Main Thread) quarkus-getting-started 1.0.0-SNAPSHOT on JVM (powered by Quarkus x.xx.x.) started in 1.246s. Listening on: http://0.0.0.0:8080
2020-07-29 22:25:18,553 INFO  [io.quarkus] (Quarkus Main Thread) Profile dev activated. Live Coding activated.
2020-07-29 22:25:18,553 INFO  [io.quarkus] (Quarkus Main Thread) Installed features: [cdi, resteasy, smallrye-graphql]

Quarkus 런타임이 시작되면 http://localhost:8080/graphql-ui/를 사용하여 GraphiQL의 UI에 로컬로 액세스합니다.

당신은 볼 수 있습니다 :

(다니엘 오, CC BY-SA 4.0)

GraphQL API 쿼리

다음을 사용하여 GraphiQL을 쿼리해 보세요.

query allFilms {
  allFilms {
    title
    director
    releaseDate
    episodeID
  }
}

재생 버튼을 클릭하면 다음이 표시됩니다.

(다니엘 오, CC BY-SA 4.0)

새 클라이언트 애플리케이션에 title 및 episodeID 데이터가 필요하지만 불필요한 데이터(예: < 코드>디렉터, 출시일). 다음을 사용하여 GraphiQL을 다시 쿼리해 보세요.

query allFilms {
  allFilms {
    title
    episodeID
  }
}

당신은 볼 수 있습니다 :

(다니엘 오, CC BY-SA 4.0)

다음 단계

GraphQL은 계속해서 인기를 얻고 있으며 Java와 원활하게 통합됩니다. 더 많은 학습 방법을 찾고 있다면 GraphQL API를 통해 비즈니스 요구 사항에 맞게 쿼리 데이터를 변경해 보세요. 이 방법에 대한 전체 Java 코드는 GitHub 저장소에서 사용할 수 있습니다.

관련기사: