GraphQL과 Apollo 아홉번째 이야기 - Java + Spring Boot에서 GraphQL 사용해 보기 - 실습 환경 구성

 

 

카카오페이 | 마음 놓고 금융하다

 

 

 

자바 ORM 표준 JPA 프로그래밍:스프링 데이터 예제 프로젝트로 배우는 전자정부 표준 데이터베이

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."

 

 

🗂 목차

✅ GraphQL과 Apollo 첫번째 이야기 - 개념 익히기
✅ GraphQL과 Apollo 두번째 이야기 - REST API란?
✅ GraphQL과 Apollo 세번째 이야기 - GraphQL의 정보 주고 받는 방식
✅ GraphQL과 Apollo 네번째 이야기 - Apollo란?
✅ GraphQL과 Apollo 다섯번째 이야기 - GraphQL을 간단하게 구현해 보아요 😀
✅ GraphQL과 Apollo 여섯번째 이야기 - GraphQL Module화에 대해 알아보아요 😀
✅ GraphQL과 Apollo 일곱번째 이야기 - GraphQL Data Type에 대해 알아보아요 😀
✅ GraphQL과 Apollo 여덟번째 이야기 - GraphQL Union과 Interface 그리고 인자와 인풋 타입에 대해 알아보아요 😀
✅ GraphQL과 Apollo 아홉번째 이야기 - Java + Spring Boot에서 GraphQL 사용해 보기 - 실습 환경 구성
✅ GraphQL과 Apollo 열번째 이야기 - Java + Spring Boot에서 GraphQL 사용해 보기 - 실습 해보기
✅ GraphQL과 Apollo 열 한번째 이야기 - TypeScript + Nest.js에서 GraphQL 사용해 보기 - 실습 환경 구성
✅ GraphQL과 Apollo 열 두번째 이야기 - TypeScript + Nest.js에서 GraphQL 사용해 보기 - 실습 환경 테스트
✅ GraphQL과 Apollo 열 세번째 이야기 - TypeScript + Nest에서 GraphQL 사용해 보기 - 실습 해보기
✅ GraphQL과 Apollo 열 네번째 이야기 - React와 Apollo Client
✅ GraphQL과 Apollo 열다섯번째 이야기 - React와 Apollo Client - Query와 Mutation 사용하여 웹 페이지 만들기
✅ GraphQL과 Apollo 열 여섯번째 이야기 - Kotlin + Spring Boot에서 GraphQL 사용해 보기 - 실습 환경 구성
✅ GraphQL과 Apollo 열 일곱번째 이야기 - Kotlin + Spring Boot에서 GraphQL 사용해 보기 - 실습 해보기

🤔 내가 만난 문제

⚠️ [Nest.js] TypeORM Table 관계가 맺어졌을 때, Seeding (feat. Migration)
⚠️ [Spring Boot 3.0] Could not resolve org.springframework.boot:spring-boot-gradle-plugin
⚠️ [Spring Boot 3] Spring Doc(Swagger) White Label Error

📋 부록

🔍 [Nest.js] 초기 환경 구성 (feat. TypeORM, QueryBuilder, GraphQL, Apollo)
🔍 [SOLID][Nest.js][Java + Spring] Interface를 활용한 결합도 분리 (Interface를 이용한 Dependency Injection - DI)

 

 

 

GitHub - junyharang-coding-study/GraphQL-Study: GraphQL을 공부하고, 실습한 코드에요 😀

 

 

 

🚀 GraphQL과 Apollo 아홉번째 이야기

    🔽 Java + Spring Boot 에서 GraphQL 사용해 보기 - 실습 환경 구성

        📦 개요

이 전까지 글은 모두 얄코님의 인프런 강의를 들으면서 정리하고, 또 추가적으로 주니가 경험한 내용이나, 아는 것을 덧붙혀서 정리하는 내용이였어요.

하지만, 강의에 사용되는 실습 환경은 JavaScript와 Node.js를 사용하는 csv File을 이용한 Mock Database(데이터베이스)를 사용하는 정말 개념만 익히는 실습이였기 때문에 따로 실습과 테스트를 진행해보려고 해요.

실습은 Java와 Spring Boot 환경과 TypeScript와 Nest.js를 이용해서 구성해 보고 실습해 보려고 해요. 

 

 

 

 

 

 

    🔽  환경 구성

        📦 Java + Spring Boot (자프링)

자프링에서는 Spring for GraphQL을 사용해 보려고 해요.

🔍 graphql-java / graphql-java-spring
🔍 graphql-java-kickstart / graphql-spring-boot
🔍 Netflix / dgs-framwork

스프링 진영에서는 위와 같이 GraphQL을 이용하기 위한 3가지 대표적 Library(라이브러리) / 프레임워크(framwork)가 준비 되어 있고, 이 중 하나를 선택하여 스프링 측에서 GraphQL을 사용할 수 있도록 구성한 것으로 보여요.

뿌리가 되는 프로젝트는 graphql-java / graphql-java-spring 이 프로젝트로 모든 프로젝트가 이걸 기반으로 개발 되었다고 해요. 또한, Spring for GraphQL은 공식적으로 graphql-java의 후속 프로젝트라고 소개하고 있어요.

위에 있는 프로젝트들을 이용하여 GraphQL을 개발하면 이 전까지 공부했듯이 Resolver를 개발하고, 별도의 설정 등을 해주어야 했지만, Spring for GraphQL은 graphql-java의 단순 후속 프로젝트 뿐 아니라, graphql-java 개발팀이 개발을 하였기 때문에 스프링 측에서 추구하는 방향답게 추가 코드 없이 MVC 개발하듯 개발할 수 있게 만들어 두었어요.

        📦 실습 환경

🔍 JDK 11
🔍 Spring Boot 2.7.17 (Spring for GraphQL은 Spring Boot 2.7.0 이상 지원)
🔍 Embedded H2 DBMS(In-Memory)
🔍 JPA & QueryDsl
🔍 InteliJ (2023.2.5 Ultimate)

 

 

        📦 초기 구성

최초 인텔리제이에서 위와 같이 프로젝트 탭에서 새 프로젝트를 눌러 프로젝트를 만들어 줄게요.

그리고 Spring Initializr에서 위와 같이 프로젝트를 구성해 주었어요.
참고로 Comunity 버전을 쓰시는 분은 위 내용이 없을 거에요.

https://start.spring.io/

위 사이트에서 프로젝트를 구성하고, 내려 받으면 됩니다.

초기 종속성은 위의 것들을 사용해서 실습해 보려고 해요.

생성을 눌러 프로젝트를 만들어 줄게요.

build.bradle

반응형

dependencies {
    compileOnly 'org.projectlombok:lombok'
    annotationProcessor 'org.projectlombok:lombok'
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    implementation 'org.springframework.boot:spring-boot-starter-graphql'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    runtimeOnly 'com.h2database:h2'
    runtimeOnly 'com.mysql:mysql-connector-j'
    runtimeOnly 'org.mariadb.jdbc:mariadb-java-client'
    testCompileOnly 'org.projectlombok:lombok'
    testAnnotationProcessor 'org.projectlombok:lombok'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
    testImplementation 'org.springframework:spring-webflux'
    testImplementation 'org.springframework.graphql:spring-graphql-test'
}

위와 같이 열심히 Setting 중인 걸 확인할 수 있어요.

Spring for GraphQL은 JPA 환경에서 쉽게 사용할 수 있도록 지원해주고 있다고 해요.
그리고, WebFlux 환경에서도 사용할 수 있어요.

주니는 Web MVC 기반으로 실습해 볼거에요.

최초 프로젝트 Root(최상위) Directory(디렉터리) 안에 아래와 같이 파일을 만들어 주어야 해요.

 

우측 상단 GraphQL 플러그인 설치를 눌러 설치 진행

 

.graphqlconfig

{
"name": "Graphql-Example",
"schemaPath": "src/main/resources/graphql/schema.graphqls",
"extensions": {}
}

위와 같이 GraphQL 설정 파일을 만들어 주었어요.
이 파일은 이 전에 공부했었던 GraphQL Schema(스키마) 및 관련 설정 정보를 정의하는데 사용하는 파일이에요.

즉, GraphQL 스키마의 위치 및 프로젝트에 대한 추가적인 설정을 하는데 이용되는 것이에요.

그럼 속성들을 알아볼게요.

∙ name: GraphQL 설정 이름으로 위에서는 "Graphql-Example"로 지정. 이름은 일반적으로 프로젝트 또는 Application(애플리케이션)의 이름과 관련.

∙ schemaPath: GraphQL 스키마 파일 경로 지정. 이 경로는 프로젝트 안에서 GraphQL 스키마 파일 위치 지정.

∙ extensions: 추가적 설정 지정을 위한 속성이며, 필요에 따라 추가적인 GraphQL 설정을 포함시킬 수 있음.

 

이번에는 데이터베이스를 구성해 볼건데, 주니는 임베이드 H2 DB의 In-Memory Mode를 사용해보려고 해요. 종속성은 프로젝트 구성 시 Spring Initalizr에서 추가했어요.

application.yml

위와 같이 application.yml에 등록해 주면 H2 DB를 굳이 설치하지 않아도 테스트 용으로 알맞게 사용할 수 있어요.

spring:
  datasource:
    driver-class-name: org.h2.Driver
    url: jdbc:h2:mem:{DB 이름}
    username: sa
    password:

만약 application.yml 을 사용한다면 위와 같이 작성해주면 되고,

spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.url=jdbc:h2:mem:{DB 이름}
spring.datasource.username=sa
spring.datasource.password=

properties는 위와 같이 작성해 주면 돼요.


일단 여기까지 설정하고, 서버를 기동 시켜 보면

위와 같이 정상적으로 기동 되는 걸 확인할 수 있어요.

http://localhost:8080/h2-console

그럼 위와 같이 H2-console에 접근 할 수 있어요.

위와 같이 설정하고, 연결을 하면 Embedded H2 DB를 In-memory Mode로 사용할 수 있어요.

/src/main/resources/init/database

Mock Data(데이터)를 만들기 위해 위와 같이 Directory(디렉터리)를 만들어 주었어요.

/src/main/resources/init/database

그리고 위와 같이 data.sql과 schema.sql을 만들어 주었어요.


schema.sql은 말 그대로 미리 DB와 Table 구조를 정의하는 곳이고,
data.sql은 Table에 미리 넣어둘 데이터를 정의하는 곳이에요.

얄코님의 강의에서 사용된 csv File(파일) 기반으로 구조와 데이터를 넣어둘게요.

equipments.csv

 

schema.sql

 

data.sql

teams.csv

schema.sql

data.sql

peoples.csv

 

schema.sql

 

data.sql

roles.csv

 

schema.sql

 

data.sql

softwares.csv

 

schema.sql

 

data.sql

supplies.csv

 

schema.sql

 

data.sql

위와 같이 schema.sql과 data.sql을 만든 뒤 서버를 구동 시키면

select * from equipment

 

select * from people

위와 같이 H2 DBMS에 Mock 데이터가 잘 입력된 걸 확인할 수 있어요.

 

 

이제 다시 GraphQL 사용을 위한 설정을 해 볼게요.

application.yml

728x90

  graphql:
    graphiql:
      enabled: true
      printer:
        enable: true

위와 같이 내용을 추가해 주었어요.

위 내용을 분석해 보면 graphipql enable을 허용하면 localhost:8080/h2-console과 같이 localhost:8080/graphiql을 통해 Query Test가 가능한 서비스를 이용할 수 있어요.

이 전에 공부했던 Apollo의 Playground를 이용하기 위한 설정이라고 생각하면 좋을 거 같아요.

또한, 이 방법 말고, 인텔리제이의 GraphQL Plugin(플러그인)을 설치해서 인텔리제이에서도 직접 테스트가 가능하고, Postman을 이용하는 방법도 있어요.

printer enable을 허용해준 것은 jpa의 show-sql이 출력될 때, GraphQL Query 내용도 출력되게 하기 위함이에요.

 

 

 

 

 

🚀 코드 구현

    🔽  Equipment

        📦 Entity

실습을 위한 Entity를 만들어 볼게요.

얄코님의 강의를 들으면서 공부했을 때, Equipment, people, team, supply를 주로 사용했는데,
주니도 이것에 초점을 맞춰 실습을 해보려 해요.

글에서는 Equipment만 작성하고, 나머지는 Git Hub에서 소스코드를 봐주시면 좋을 거 같아요.

https://github.com/junyharang-coding-study/GraphQL-Study/tree/master/graphql-test

Equipment.java

 

Equipment.java

Equipment Entity를 위와 같이 만들어 주었어요.

        📦 EquipmentResolver

이번에는 Resolver(리졸버) Code를 만들어 볼게요.
Resolver(리졸버)는 REST API로 구현했다면 Controller라고 명명했을거에요.

EquipmentResolver.java

 

EquipmentResolver.java

 
27 ~ 31번째 줄은 Create 즉, 내용을 저장하기 위한 Router(라우터)에요.

여기서 주목해야 할 것은 @Argument("input")이에요.
이 내용은 GraphQL Query의 input 이라는 이름의 인자에 해당하는 값으로
EquipmentRequestDto라는 객체를 받게 해 주었어요.

위 작업을 처리할 때 위와 같이 쿼리를 날려주게 되는데, 이 때, GraphQL Schema(스키마)에서 해당 뮤테이션이나, 쿼리에 전달되는 인자의 이름을 지정할 때 사용하게 돼요. 여기서 Input은 GraphQL 쿼리에서 사용되는 변수 이름이에요.

GraphQL에서는 일반적으로 뮤테이션의 입력값을 객체 형태로 전달하게 되는데, 이 때 해당 객체를 특정한 이름으로 명명하게 돼요. 이렇게 명명된 객체는 GraphQL 쿼리에서 사용되는 Variable(변수) 역할을 하게 돼죠.

쿼리를 던질 대 사용되는 쿼리문을 분석해 주면 saveForEquipment 뮤테이션은 EquipmentRequestDto 객체를 입력 받게 되고, 이 객체는 input이라는 변수명으로 정의된 것을 확인할 수 있어요. 이렇게 변수명을 지정할 때, Java Code에서 해당 변수를 받아오기 위해 @Argument를 사용하여 이름을 명시해 주어야 해요.

정리하면 Java Code에서 @Argument("input)은 GraphQL에서 전달되는 input 변수를 EquipmentRequestDto 객체로 받기 위해 사용된 Annotation(어노테이션)이에요. 이를 통해 GraphQL 쿼리에서 정의한 변수와 Java Code에서의 Method(메서드) 인자를 Mapping(매핑)할 수 있답니다.


36 ~ 44번째 줄 getEqupmentList()는 목록 조회 시 검색과 Paging 처리를 할 수 있도록 구현한 라우터에요.

@Argument는 REST API로 컨트롤러 구현 시 사용하는 @RequestBody, @RequestParam과 같이 인수 값을 지정할 때 사용하는 Annotaion(어노테이션)이에요.

즉, GraphQL Query 인수 정의 때 사용하는데, 각각의 Method(메서드) Parameter(파라미터)는 GraphQL Query에서 전달된 매개 변수에 Mapping(매핑) 되게 된답니다.

 

EquipmentResolver.java

46 ~ 49번째 줄은 상세 조회를 위한 메서드에요.
ID 값을 인자로 받아 해당 값에 상세한 내용을 조회하기 위한 메서드에요.

51 ~ 54번째 줄은 수정 작업을 위한 메서드에요.
수정을 위한 DTO 객체를 받아 처리 될 수 있게 만들어 주었어요.

 

 

        📦 EquipmentService & EquipmentServiceImpl

EquipmentService.java

EquipmentService.java

EquipmentServiceImpl.java

EquipmentServiceImpl.java

saveForEquipment()를 분석해 보면 최초 매개 변수로 전달된 DTO 객체가 Null인지 확인하고,
Null이면 204 Error를 내보내도록 처리해 주었어요.

만약 Null이 아니라면 JPA의 save()를 이용하여 DTO 객체를 Entity 객체로 변환 시켜 전달하여 데이터베이스에 저장하고, 저장된 ID를 반환되도록 처리해 주었어요.

참고로 DefaultResponse는 반환값을 하나의 객체로 묶어 전달하는데, Http Status Code와 Message 그리고, 반환 객체를 전달하기 위한 객체이고, Paging 처리 결과값도 전달할 수 있는 객체에요.

EquipmentServiceImpl.java

getEquipmentList()는 목록 조회 시 검색 기능과 Paging 처리를 함께할 수 있도록 만든 메서드에요.

page는 조회 대상 Page 번호이고, size는 한 Page에 담을 요소 개수에요.
그리고, 나머지 인자값들은 검색을 위해 사용할 값들이에요.

52 ~ 57번째 줄까지 분석해 보면 QueryDsl을 통해 검색 기능 즉, 동적 쿼리를 처리해 주는데, 이 때, 검색을 위해 담긴 각각의 매개 변수를 EquipmentSearchRequestDto 객체에 넣어 전달해 주고, Paging 처리를 위한 객체를 처리한 뒤 그 객체를 인자로 전달해 주고 있어요.

그렇게 한 뒤 59번째 줄에 QueryDsl을 이용하여 조회된 객체에 값이 있는지 확인하고, 없다면 값을 못 찾았다는 내용을 전달하고, 있다면 Page 객체로 묶인 객체를 List로 변환 하고, 그 List 객체가 비어 있지 않으면 반환 해주고, 또 비어 있다면 값을 못 찾았다는 내용을 전달해 주는 것이에요.

Page 객체를 그대로 반환해 버리면 

query.graphqls

 

schema.graphqls

위와 같이 Root Query type과 반환 객체를 정의해 주었는데, DefaultListResponse에 String, Int, Boolean 외에 내용을 넣으면 문제가 생겨 버려서 List로 변환해서 DefaultListRespone Type 4번째 줄처럼 반환되게 하기 위해서 List로 변환해 준 것이에요.

EquipmentResolverImpl.java

getEquipment()는 ID를 입력 받아 해당 내용을 상세 조회하는 메서드에요.
JPQL을 이용하여 ID를 데이터베이스에서 조회하고, 해당하는 Entity객체를 받은 뒤 Null Safety처리를 위해 Optional<>로 감싸주고, 해당 값이 Null이 아니라면 ResponseDTO로 변환하여 반환해주고, Null이라면 값을 찾지 못했다고 반환하게 처리해 주었어요.

EquipmentResolverImpl.java

updateEquipment()는 수정을 위한 메서드로 수정 처리를 위한 값을 담은 DTO 객체에 담긴 ID값을 데이터베이스에서 조회하여 해당 내용이 존재하는지 확인하고, getEquipment()를 호출하게 돼요.

EquipmentResolverImpl.java

이 메서드는 최초 데이터베이스에서 조회된 객체가 Null인지를 확인하고, Null이라면 Null을 반환하고, Null이 아니라면 수정을 위해 Client(클라이언트)에서 전달한 값들이 들어 있는지 확인하고, 들어 있는 것은 update()를 사용하여 Entity에 값을 Update 한 뒤 Entity를 반환하게 해 주었어요.

EquipmentResolverImpl.java

그런 뒤 위에서 Null을 전달하는 로직이 있기 때문에 다시 Null Check를 해 주고, Null이면 수정 대상을 못 찾았다고 반환해주고, Null이 아니면 JPA의 save()를 통해 Update 쿼리가 처리되게 한 뒤 해당 값의 ID를 반환할 수 있도록 처리해 주었어요.

EquipmentResolverImpl.java

마지막으로 삭제를 담당하는 deleteEquipment()에요.

역시 클라이언트에서 전달된 ID를 데이터베이스에서 조회하고, 그 값이 존재한다면 JPA deleteByID()를 이용하여 삭제를 해 준 뒤 해당 메서드는 반환 값이 Void이기 때문에 클라이언트가 전달한 ID를 그대로 반환할 수 있도록 처리해 주었어요.

데이터베이스 조회 시 해당 값이 존재하지 않는다면 해당 데이터를 찾지 못했다고 반환하게 처리해 주었어요.

 

 

 

        📦 EquipmentRepository

EquipmentRepository.java

findAllByStringId()는 상세 조회를 처리하기 위한 메서드인데, 애초에 데이터베이스에 ID가 Long과 같은 정수가 아니라 문자열이기 때문에 JPQL을 통해 처리 될 수 있도록 만들어 준 것이에요.


이제 QueryDsl을 이용한 동적 쿼리 처리를 어떻게 했는지 알아볼게요.

EquipmentQueryDslRepository.java

 

EquipmentQueryDslRepository.java

최초 findBySearchAndPaging()은 목록 조회 시 검색과 Paging 처리를 모두 할 수 있도록 만들어진 메서드에요.

26번째 줄은 JPAQueryFactory를 주입 받아 Member Variable(멤버 변수)로 저장하는데, 이것은 QueryDsl을 사용하여 동적 쿼리를 작성하기 위해 사용하기 위함이에요.

해당 메서드는 검색 조건을 갖은 DTO와 Paging 정보를 담은 Pageable을 인자로 받는걸 알 수 있어요.

그런 뒤 JPAQueryFactory를 사용하여 QueryDsl 쿼리를 만들어 주는데, Projections.constructor()를 사용하여 조회된 결과를 EquipmentResponseDto로 매핑되게 처리해 주었어요.

그리고, from(equipment)를 이용하여 equipment Entiry를 기준으로 쿼리가 작성될 수 있게 해 주었어요.

where 조건을 이용하여 검색 조건을 지정해 주었는데, eqEquipmentId(), eqUsedBy(), eqNewOrUsed()를 각각 호출하여 해당 조건을 검색할 수 있도록 처리해 주었어요.

EquipmentQueryDslRepository.java

위 메서드들은 Field(필드)에 대한 동적인 조건을 처리하기 위한 메서드에요.
전달 된 인수 값이 비어 있다면 Null을 반환하고, 그렇지 않으면 equipment.<해당 변수>.eq(해당 변수)를 반환하게 했어요.
이 때 BooleanExpression Type을 반환하고, 이는 QueryDsl에서 사용되는 조건을 나타내게 해요.

이렇게 해서 동적 조건 생성 메서드들을 각각 만들어주고, 검색 조건이 주어진 경우에만 해당 필드에 대한 조건을 생성하고, 그렇지 않은 경우 Null을 반환하여 해당 조건이 검색되지 않도록 처리해 준 것이에요.

EquipmentQueryDslRepository.java

다시 이 부분을 계속 분석해 볼게요.

41번째 줄에 orderBy()를 통해 ID를 기준으로 내림차순 정렬로 처리해 주었어요.

그런 뒤 44번째 줄에 PagingProcessUtil.queryDslPagingProcessing()을 통해 QueryDsl을 사용한 Paging 처리를 수행하게 해 주었어요.

그리고 그 모든 내용들은 PageImpl로 감싸 Spring Data JPA의 Page 객체에 담아 반환하게 처리해 준 것이에요.

PagingProcessUtil.queryDslPagingProcessing

위 코드는 QueryDsl을 사용하여 생성한 쿼리에 대해 Paging 처리를 위한 Utility 메서드에요.

해당 메서드는 제네릭 메서드 (<T>)인 것을 알 수 있는데, 제네릭 타입을 사용하여 어떤 타입의 QueryDsl 결과를 다루더라도 유연하게 처리를 할 수 있도록 만들어 준 것이에요.

즉, 여러 목록 조회 로직이 만들어 질텐데, 공통 부분으로 Paging 처리에 대한 메서드를 따로 만든거에요.

JPAQuery<T> query 인자값은 QueryDsl을 이용하여 만들어진 SQL Query문이라고 생각하면 돼요.
Pageable 인자값을 Srping Data JPA에서 제공하는 Paging 정보를 담고 있는 객체에요.

31번째 줄에 결과를 담을 List를 초기화 해 주었어요.

그런 뒤 33번째 줄에 쿼리 결과 (데이터베이스에서 조회된 결과물) 개수가 2개 이상인 경우에만 Paging 처리를 하기 위해 분기문을 작성해 주었어요.

이렇게 하지 않으면 검색 결과가 하나일 때 아무 값도 반환 받지 못하는 문제가 발생하기 때문이에요.

34 ~ 36번째 줄은 Paging 처리를 수행하고, 결과를 List로 담도록 해 주는 부분이에요.

하지만, 2보다 작다면 즉, 결과가 1개라면 Paging 처리를 하지 않고, 그대로 결과값을 List에 넣어준 것이에요.
왜냐하면 반환값은 List이기 때문에 List로 담아줘야 하기 때문이에요.

그리고 나서 해당 List를 반환해 주는 로직이에요.

이렇게 Paging 처리를 수행할지 여부를 쿼리 결과의 개수 기반으로 결정하고, 결과가 1개인 경우에는 Paging 처리를 생략하여 최적화된 동작을 할 수 있도록 주니가 고안한 메서드에요.

 

 

 

 

    🔽 graphqls(Schema)

        📦 schema.graphqls

resources/graphql/schema.graphqls

 

 

 

 

 

        📦 query.graphqls

resources/graphql/query.graphqls

 

 

 

        📦 mutation.graphqls

resources/graphql/mutation.graphqls

 

 

 

        📦 equipment.graphqls

resources/graphql/equipment/equipment.graphqls

위와 같이 GraphQL 스키마를 구성해 주었어요.

 

 

 

    🔽 잘 만들었나? 🤔

        📦 Eequipment CRUD Test

만들어진 로직을 이용하여 CRUD Test를 진행해 볼게요.

http://localhost:8080/graphiql

위와 같이 Apollo Playgroud와 같은 서비스를 Spring For GraphQL도 제공하는데 이름이 Graphiql 같아요.
참고로 이 친구는 로직이 구현되어야 올라와요.

로직이 구현되지 않은 상태에서 application.yml에 설정만 해 주었다고 해서 URL을 입력하면 White Error만 나올거에요.
주니는 그래서 굉장히 당황했거든요.

graphiql -&nbsp;findBygetEquipmentListSeachEquipmentIdAndPaging

query findBygetEquipmentListSeachEquipmentIdAndPaging {
  getEquipmentList(
    equipmentId: "machanical keyboard",
    page: 1,
    size: 3
  ) {
    statusCode,
    message,
    data,
    pagination
  }
}

ID값은 고유한데, ID를 검색했고, Paging 처리를 위해 현재 Page 위치 값(page)와
해당 Page에 출력될 요소 개수(size)를 전달해 주었어요.

위에서 QueryDsl을 이용해서 검색 결과가 하나일 경우 Paging 처리를 하지 않고, SQL Query를 날리게 만든 로직이 있었는데, 해당 로직이 없었다면 위에 data는 data:[] 이런식으로 반환 되었을 것이에요.

왜냐하면 데이터베이스의 SQL문으로 offset과 limit 절 처리가 이뤄졌는데, 값은 하나밖에 없기 때문이에요.

물론 Limit 절에 값을 1로 주거나 하면 되겠지만, 실제 서비스에서 클라이언트 측은 해당 데이터가 몇 개가 있는지 모르는데, 이걸 1개를 전달한다가 말이 될까?가 주니의 고민이였기 때문에 위와 같이 처리해 준 것이에요.

graphiql -&nbsp;findeBygetEquipmentListPaging

 

graphiql -&nbsp;findeBygetEquipmentListPaging

query findeBygetEquipmentListPaging {
  getEquipmentList(
    page: 1,
    size: 3
  ) {
    statusCode,
    message,
    data,
    pagination
  }
}

위의 쿼리는 검색은 하지 않고, Paging 처리를 위한 값만 던졌을 때에요.

graphiql findBygetEquipmentListSeachUsedByAndPaging

위에 내용은 usedBy 필드 검색할 때를 테스트 해 보았어요.

graphiql findBygetEquipmentListSeachNewOrUsedAndPaging

query findBygetEquipmentListSeachNewOrUsedAndPaging {
  getEquipmentList(
    newOrUsed: "used"
    page: 1,
    size: 3
  ) {
    statusCode,
    message,
    data,
    pagination
  }
}

graphiql findBygetEquipmentListSeachAllFieldAndPaging

query findBygetEquipmentListSeachAllFieldAndPaging {
  getEquipmentList(
    equipmentId: "machanical keyboard",
    usedBy: "developer",
    newOrUsed: "used"
    page: 1,
    size: 3
  ) {
    statusCode,
    message,
    data,
    pagination
  }
}

graphiql saveForEquipment

mutation saveForEquipment {
  saveForEquipment(input: {
      equipmentId: "MacBook",
      usedBy: "developer",
      count: 100,
      newOrUsed: "new"
    }) {
    statusCode,
    message,
    data
  }
}

 

위의 내용은 Equipment의 값을 입력하는 쿼리에요.

graphiql -&nbsp;updateEquipment

mutation updateEquipment {
  updateEquipment(input: {
      equipmentId: "MacBook",
      usedBy: "developer",
      count: 150
      newOrUsed: "new"
    }) {
    statusCode,
    message,
    data
  }
}

위에서 입력했던 값의 count 필드를 100에서 150으로 변경하는 쿼리에요.

graphiql -&nbsp;deleteEquipment

mutation deleteEquipment {
  deleteEquipment(equipmentId: "MacBook") {
    statusCode,
    message,
    data
  }
}

그리고 만들었던 값을 삭제하는 쿼리에요.


이렇게 모두 정상적으로 처리되는 걸 확인할 수 있어요.

Equipment 외에 다른 것들은 Git Hub 소스 코드를 참고해 주세요.

https://github.com/junyharang-coding-study/GraphQL-Study/tree/master/graphql-test


이제 강의에서 배웠던 실습을 진행해 볼게요.

 

 

 

 

GraphQL과 타입스크립트로 개발하는 웹 서비스:설계부터 개발·배포까지 따라 하며 완성하는 웹 풀

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."

 

 

GitHub - junyharang-coding-study/GraphQL-Study: GraphQL을 공부하고, 실습한 코드에요 😀

 

 

 

 

 

🧐 참고 자료

Spring for GraphQL

 

 

 

카카오페이 | 마음 놓고 금융하다