GraphQL 사용법 및 장점 소개

 

 

GraphQL 소개

GraphQL은 데이터 API를 위한 쿼리 언어이자 서버 사이드 런타임으로, 페이스북에서 개발한 것입니다. 이 기술은 클라이언트와 서버 간에 효율적으로 데이터를 주고받는 것을 목표로 하며, 복잡한 데이터 구조를 유연하게 다룰 수 있도록 돕습니다. GraphQL은 특정한 데이터베이스나 저장 엔진에 구애받지 않으며, 오히려 기존의 데이터와 코드에 통합되어 동작합니다.

REST API와 GraphQL의 차이

전통적인 REST API는 URL 경로를 통해 데이터를 전송하며, 각 요청에 대해 다양한 HTTP 메서드를 사용합니다. 예를 들어, 특정 사용자 정보를 요청할 때, 여러 엔드포인트를 사용해야 합니다. 반면, GraphQL은 단일 엔드포인트만을 사용하며, 요청하는 쿼리에 따라 필요한 데이터만을 반환합니다. 이는 Over-fetching과 Under-fetching 문제를 해결하는 데 도움을 줍니다.

• Over-fetching: 요청한 데이터보다 더 많은 데이터가 반환되는 현상
• Under-fetching: 하나의 요청으로 충분한 데이터를 받지 못하는 현상

GraphQL의 장점

GraphQL의 주요 이점은 클라이언트가 필요한 데이터만 선택하여 요청할 수 있다는 점입니다. 이는 응답의 크기를 줄이고, 네트워크 자원을 절약할 수 있도록 해줍니다. 그 외에도 다음과 같은 장점이 있습니다:

• 여러 데이터 요청을 통합하여 HTTP 요청 수를 줄일 수 있습니다.
• 프론트엔드와 백엔드 간의 의존성을 줄여 개발 효율성을 높일 수 있습니다.
• API의 버전 관리를 간소화할 수 있습니다.

GraphQL 사용법

이제 GraphQL을 실제로 사용하기 위한 기본 설정 방법을 알아보겠습니다. Spring Boot를 활용해 GraphQL을 구현하는 방법을 살펴보겠습니다.

 

환경 설정

먼저, Spring Boot 프로젝트에서 필요한 라이브러리를 build.gradle 파일에 추가합니다. 아래와 같이 의존성을 설정해 주세요:

dependencies {

implementation 'com.graphql-java-kickstart:graphql-spring-boot-starter:11.0.0'

runtimeOnly 'com.graphql-java-kickstart:graphiql-spring-boot-starter:11.0.0'

implementation 'com.graphql-java-kickstart:playground-spring-boot-starter:11.0.0'

testImplementation 'com.graphql-java-kickstart:graphql-spring-boot-starter-test:11.0.0'

}

application.properties 설정

다음으로, application.properties 파일에 GraphQL 관련 설정을 추가합니다:

 

graphql.servlet.mapping=/graphql

graphql.tools.schema-location-pattern=**/*.graphqls

graphql.servlet.cors-enabled=true

graphql.servlet.max-query-depth=100

graphql.servlet.exception-handlers-enabled=true

스키마 정의

이제 GraphQL 스키마를 정의해야 합니다. 스키마는 데이터 타입 및 입력 타입을 규정하여 API의 구조를 설정합니다. 예를 들어, 아래와 같은 쿼리와 뮤테이션을 정의할 수 있습니다:

type Query {

getAllActors: [Actor],

getActorById(id: Int): Actor

}

type Mutation {

updateAddress(id: Int, address: String): Actor

updateAddressByInputObject(input: AddressInput): Actor

}

type Actor {

actorId: ID!,

firstName: String,

lastName: String,

dob: String,

address: String,

filmId: Int,

film: Film

}

type Film {

filmId: ID!,

name: String,

regDt: String

}

input AddressInput {

actorId: Int,

address: String

}

구성 요소 생성

이제 필요한 도메인, 리졸버, 서비스, 레포지토리 클래스를 작성해야 합니다. 예를 들어, Actor 엔티티는 다음과 같이 구성될 수 있습니다:

@Entity

@Table(name="ACTOR")

@Getter

@Setter

public class Actor {

@Id

@GeneratedValue(strategy = GenerationType.AUTO)

@Column(name = "ACTOR_ID")

private Integer actorId;

@Column(name = "FIRST_NAME")

private String firstName;

@Column(name = "LAST_NAME")

private String lastName;

@Column(name = "DOB")

private LocalDate dob;

@Column(name = "ADDRESS")

private String address;

@Column(name = "FILM_ID")

private Integer filmId;

}

결론

GraphQL은 REST API의 한계를 극복하고, 클라이언트가 필요한 데이터만을 선택적으로 요청할 수 있는 강력한 도구입니다. 데이터 조작을 위한 간결한 쿼리 언어를 제공하며, 효율적인 데이터 전송과 관리를 통해 개발자에게 더 큰 유연성과 생산성을 제공합니다. 하지만 모든 상황에서 GraphQL이 최선의 선택은 아닙니다. 따라서 특정 프로젝트의 요구사항과 환경을 고려하여 적절한 API 방식을 선택하는 것이 중요합니다.

 

LG헬로비전 고객센터 전화번호 정보

 

자주 묻는 질문 FAQ

GraphQL이란 무엇인가요?

GraphQL은 페이스북에서 개발한 데이터 API를 위한 쿼리 언어입니다. 클라이언트와 서버 간의 데이터 전송을 효율적으로 해결하며, 복잡한 데이터 구조를 유연하게 처리하는 데 도움을 줍니다.

GraphQL의 주요 장점은 무엇인가요?

GraphQL은 사용자가 필요한 데이터만 요청하여 응답 크기를 줄일 수 있는 장점이 있습니다. 이를 통해 네트워크 자원을 절약하고 다양한 데이터 요청을 하나의 호출로 통합할 수 있어 개발 효율성을 높입니다.