Java Graphql Client 구현

이번에 일하다가 Graphql을 사용해야 할 일이 생겼었다.

Graphql이라는걸 이번에 처음들었는데 FaceBook에서 개발한 어플리케이션 쿼리 언어란다.

 

애플리케이션 쿼리 언어가 뭔진 난 잘 모르겠고 그냥 API 사용을 위한 문법으로 이해했다.

Graphql의 소개 중 가장 이해가 쉬웠던 내용은 Rest API의 단점을 보완한다는 내용이였다.

 

Rest API 써본 사람은 알겠지만 서버 측으로 응답받은 데이터 중 내가 실제로 사용하는 데이터보다

사용하지 않는 데이터까지 응답받는 경우가 있다.

 

Graphql의 경우 위 부분을 보완한 장점을 가지고있다.

문장 중 내가 필요로하는 데이터를 명시해주면 명시한 데이터만 응답받을 수 있다.

이 부분으로 확실히 괜히 필요하지 않은 데이터로 인한 리소스 낭비는 없을 것으로 보인다.

이게 Graphql의 장점 중 가장 기억나고 와닿았던 내용이다.

 

그 외 장점도 여러가지지만 단점도 꽤 여러가지 있는 것으로 알고있다.

자세한 내용은 구글에서 "Graphql 장단점"을 검색해보자

 

이제 Graphql Client를 Java로 어떻게 구현하는지를 기록하겠다.

참고로 Graphql Server는 아직은 구현 할 일이 없을 것 같아 따로 공부하지 않았다.

 

Graphql 문법은 대충 아래와 같이 생겼다.

query($code: ID!) {
    country(code: $code) {
        name
        capital
        currency
    }
}

 

위 예제는 굉장히 간단한 예제이고 좀 복잡하게 생긴건 아래와 같다.

(Shopify에서 제공하는 Graphql mutation)

mutation PaymentSessionResolve($id: ID!, $authorizationExpiresAt: DateTime) {
  paymentSessionResolve(id: $id, authorizationExpiresAt: $authorizationExpiresAt) {
    paymentSession {
      id
      status {
        code
      }
      nextAction {
        action
        context {
          ... on PaymentSessionActionsRedirect {
            redirectUrl
          }
        }
      }
    }
    userErrors {
      field
      message
    }
  }
}

public class GraphqlRequestBody {
 
    private String query;
    private Map<String, Object> variables;
    
    public String getQuery() {
        return query;
    }
    public void setQuery(String query) {
        this.query = query;
    }
    public Map<String, Object> getVariables() {
        return variables;
    }
    public void setVariables(Map<String, Object> variables) {
        this.variables = variables;
    }
}

 

객체에 query와 variables를 세팅하고 API Request까지 하는 내용은 아래와 같다.

    @Test
    void testGraphql() throws Exception {
        
        GraphqlRequestBody requestBody = new GraphqlRequestBody();
        requestBody.setQuery(getGraphqlQuery("/static/country.graphql"));
        requestBody.setVariables(new HashMap<String, Object>());
        requestBody.getVariables().put("code", "KR");
        
        String parameter = new ObjectMapper().writeValueAsString(requestBody);
        System.out.println("Request Parameter : " + new ObjectMapper().writerWithDefaultPrettyPrinter().writeValueAsString(requestBody));
        
        Utils utils = new Utils();
        URI uri = new URI("https://countries.trevorblades.com");
        Map<String, String> headers = new HashMap<String, String>();
        headers.put("Content-Type", "application/json");
        
        List<String> responseList = utils.sendRequest(uri, headers, parameter, "POST");
        
        System.out.println("response : " + responseList.get(0));
        System.out.println("response : " + responseList.get(1));
    }

 

결과 : 

Request Parameter : {
  "query" : "query($code: ID!) {\r\n\tcountry(code: $code) {\r\n\t\tname\r\n\t\tcapital\r\n\t\tcurrency\r\n\t}\r\n}",
  "variables" : {
    "code" : "KR"
  }
}
 
response : 200
response : {"data":{"country":{"name":"South Korea","capital":"Seoul","currency":"KRW"}}}

 

 

여기까지 읽고 궁금 할수도 있는 내용들 : 

1. 테스트에 사용한 URI("https://countries.trevorblades.com") 이거 뭐니?
2. country.graphql 파일 가져오는 메소드 getGraphqlQuery 이거 뭐니?
3. Json 아닌거 같은데 왜 Content-type이 application/json 이니?
4. 왜 Http Method가 POST니?
5. 통신에 사용한 utils.sendRequest 이거 뭐니?

 

설명 : 

1. 테스트에 사용한 URI("https://countries.trevorblades.com") 공개 Countries Graphql API이다.

위 공개 API를 통해 Graphql을 경험해볼 수 있다.

좀 더 자세한 내용은 "Graphql Playground"를 검색해보면 될 듯?

 

2. Method getGraphqlQuery는 그냥 파일 읽어오는 메소드다.

여러분의 좀 더 편안한 복붙을 위해 아래 기록하겠다.

    public String getGraphqlQuery(String fileName) throws Exception {
        
        InputStream is = getClass().getResourceAsStream("/static/country.graphql");
        ByteArrayOutputStream result = new ByteArrayOutputStream();
        byte[] buffer = new byte[1024];
        for (int length; (length = is.read(buffer)) != -1;) {
            result.write(buffer, 0, length);
        }
        
        return result.toString();
    }