기본 콘텐츠로 건너뛰기

REST Web Service에서 Projection 기능 활용

REST Web Service에서 Projection을 이용한 웹 인터페이스 유연성 확보하기.

Projection 기능이란?

  프로젝터와 같이 실제하는 물체를 보고 싶은 형태로 볼 수 있게 도와주는 기능을 말한다. 좀 더 쉽게 말하면 실제하는 물체란 필름을 말하는 것이고, 보고 싶은 형태란 70인치 화면으로 보여주는 것을 말한다. 설정에 따라 30인치 화면으로 볼 수도 있다.
  즉, Projection 기능이 있다면 상황에 맞는 화면 크기로 보여 줄 수 있는 것이다.
[프로젝터]

웹 인터페이스 설계의 어려움

  웹서버를 개발하는 개발자 입장에서 하나의 인터페이스라도 만드는 일은 쉽지 않다. 그렇기 때문에 웹 인터페이스의 개수를 줄이려고 노력하는 것이 일반적이다. 그러기 위해서는 좀 더 일반적인(General) 형태의 인터페이스로 설계하는 수밖에 없다. 그러나 아이러니하게도 사용자(인터페이스를 사용하는 다른 개발자) 입장에서는 이런 일반적인 인터페이스를 쓰기란 여간 어려운게 아니다.

클라이언트마다 필요한 데이터가 다르다.

 REST 웹서비스에서는 리소스에 해당하는 데이터를 다음과 같이 JSON 형식의 Response로 전달해준다. 예를 들어 다음과 같이 상품 정보를 보내주는 RESR API가 있다고 해보자.

GET /api/furniture/item/123334333

위의 REST API를 이용하여 다음과 같은 데이터를 받을 수 있다.

{
      "item_id" : 1233343333,
      "name" : "chair",
      "category" : "furniture",
      "price" : 56000,
      "seller" : "Makers",
      "description" : "Good Chair"
}

 그러나 문제가 있다. 모든 클라이언트가 위의 모든 데이터를 필요로 할거라고 생각했지만, 실제로는 어떤 클라이언트는 "item_id"와 "name", "price"만 필요로 할 뿐이라고 한다. 나머지는 불필요한 데이터이다. 궂이 웹서비스로 가져올 필요도 없는 부분이다. 이런 클라이언트가 많은 경우 새로운 인터페이스를 만들어줘야 할까?

Projection 기능을 활용하자.

  웹서비스에서 쓰이는 프로젝션 기능을 활용해보자. Projection 기능이란, 앞서 말한 프로젝터의 기능과 같다. 실제하는 데이터가 있고, 그 데이터를 사용자가 보고 싶은 크기로 줄였다가 늘렸다가 하는 것을 도와주는 것이다.  데이터의 필드(JSON Tag)를 선택적으로 보여줄 수 있게 해준다.

  클라이언트에서 원하는 데이터가 다음과 같이 3가지라고 해보자.

  • 아이템 ID
  • 이름
  • 가격
   웹서비스 결과로 다음과 같은 결과가 오는 것이 최선일 것이다.


{
      "item_id" : 1233343333,
      "name" : "chair",
      "price" : 56000
}

 다음 장에서 Spring Data의 Projection 기능을 이용하여 이를 쉽게 해결하는 방법은 볼 것이다.

Goto "Spring Data Projection"

댓글

이 블로그의 인기 게시물

DrJava 설치 방법

  보통 Java를 사용하여 프로젝트를 만들때, Eclipse라는 IDE(Integrated Development Environment)를 사용합니다. 그러나 Java를 처음 배우려는 사람들에게 복잡한 프로젝트까지 커버할 수 있는 Eclipse는 다양한 환경 설정, 복잡한 UI가 어렵게 느껴질 수 있습니다. 이런 사람들을 위해서  DrJava를 추천합니다.   DrJava 란?    LIDE(Lightweight IDE)라고 할 수 있습니다. 기본적으로 자바를 학습하려는 사람들을 위해  디자인되었습니다. 직관적인 인터페이스를 제공하고, line by line으로 자바 코드를 실행할 수 있는 interactive console을 제공합니다. 설치 순서 1. jdk 설치 2. DrJava 설치   2-1.   http://drjava.sourceforge.net 사이트에 접속   2-2. Current Stable Release 에서 본인의 환경에 맞는 App 다운로드   2-3. 만약 다음과 같은 경고창을 보았을 경우 java jdk나 jre가 제대로 설치 되었는지 확인 3. 설치 완료 후 실행 4. 다음과 같이  DrJava가 실행된다.

Spring Data Projection 기능 활용

Projection Spring Data REST에서는 Projection 기능을 제공하고 있습니다. Spring Data란?   Data Access Layer에 대한 추상화 기능을 제공하는 프레임워크입니다. 간단히 설명하자면 기존에는 Database에 데이터를 저장하고 읽어오기 위해서는 Database의 종류, 스키마를 고려하여 SQL Query를 사용해서 데이터를 저장하고 읽어왔습니다. 그러나 Spring Data를 이용하게 되면 이 과정을 ORM을 사용하여 함수를 사용하여 쉽게 처리할 수 있습니다. ORM(Object Relational Mapping)란?   데이터베이스가 테이블, 필드간 상관 관계를 통해 도메인 데이터를 표현하였다고 한다면,  ORM은 Object, 클래스 간의 상관 관계를 통해 도메인 데이터를 표현하는 것을 말합니다. 다음의 링크는 Spring Data REST Documentation 중에서 Projection 부분입니다.               8. Projections and Excerpts 그러나 실제 "Projection" 기능을 사용하는데는 한가지 문제점이 있습니다. 레거시 웹서비스를 쓰고 있다거나, Spring Data  REST를 이용하지 않는다면 "Projection" 기능을 활용하는 것이 힘들다는 것입니다. Spring Data REST의 경우 데이터  Response Type이 json-hal 타입만을 지원하기 때문입니다. JSON-HAL 타입으로 경우 웹서비스 제공 입장에서 최선의 선택일 수 있습니다. 그러나 실제 프로젝트에서는 이를 쓰려는 클라이언트가 없을 경우 사용할 수 없게 될 것입니다. 그렇다면 Projection 기능만을 사용할 수 있는 방법이 없을까요? 있습니다. ProjectionFactory 를 직접 사용하는 것입니다. 다음과 같이 Spr...