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를 직접 사용하는 것입니다. 다음과 같이 Spring + Gradle을 사용하여 테스트 프로젝트를 만들어보겠습니다.

Gradle Build Script

먼저 다음과 같이 Gradle build 스크립트를 작성하여 기본적인 프로젝트를 생성합니다.

buildscript {
 ext {
  springBootVersion = '1.4.0.M1'
 }
 repositories {
  mavenCentral()
  maven { url "https://repo.spring.io/snapshot" }
  maven { url "https://repo.spring.io/milestone" }
 }
 dependencies {
  classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}") 
 }
}

apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'spring-boot'
apply plugin: 'idea'

jar {
 baseName = 'sprisngdata'
 version = '0.0.1-SNAPSHOT'
}
sourceCompatibility = 1.8
targetCompatibility = 1.8

repositories {
 mavenCentral()
 maven { url "https://repo.spring.io/snapshot" }
 maven { url "https://repo.spring.io/milestone" }
}


dependencies {
    compile("org.springframework.boot:spring-boot-starter")
    compile("org.springframework.boot:spring-boot-starter-data-rest")
    compile("org.springframework.boot:spring-boot-starter-data-jpa")
    compile("com.h2database:h2")
    compile("org.projectlombok:lombok:1.16.8")

    testCompile('com.jayway.restassured:rest-assured:2.9.0')
    testCompile('org.springframework.boot:spring-boot-starter-test')
}


eclipse {
 classpath {
   containers.remove('org.eclipse.jdt.launching.JRE_CONTAINER')
   containers 'org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8'
 }
}

task wrapper(type: Wrapper) {
 gradleVersion = '2.9'
}

ProjectionFactory

여기서 중요한 것은 "Projection" 기능을 사용할 수 있도록 Factory Bean을 생성하는 것입니다. Bean 생성은 다음과 같이 간단히 합니다.

package com.ryanjin.example;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.projection.SpelAwareProxyProjectionFactory;

/**
 * Created by Donghyun Ryan Jin [https://github.com/atinjin]
 * spring_data_projection on 2016. 4. 8..
 */
@Configuration
public class FactoryConfig {
    @Bean
    public SpelAwareProxyProjectionFactory projectionFactory() {
        return new SpelAwareProxyProjectionFactory();
    }
}

실제 ProjectionFactory를 사용하기 위해서 Domain 모델 클래스와 해당 모델을 projection할 인터페이스 클래스를 작성합니다.

Domain Model Class

ShoppingItem.class

package com.ryanjin.example;

import lombok.Data;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;

/**
 * Created by Donghyun Ryan Jin [https://github.com/atinjin]
 * spring_data_projection on 2016. 4. 4..
 */
@Entity
@Data
public class ShoppingItem {
    @Id
    @GeneratedValue
    private int id;
    private String name;
    private String description;
    private String category;
    private int price;
    private String seller;
}

Projection Interface

OnlyItemName.class

package com.ryanjin.example;

/**
 * Created by Donghyun Ryan Jin [https://github.com/atinjin]
 * spring_data_projection on 2016. 4. 8..
 */
public interface OnlyItemName {
    String getName();
}

이제 웹서비스 인터페이스에서 Projection을 통해 ShoppingItem 정보 중에서 사용자가 원하는 "name" 만을 웹서비스 Response로 내보내는 것입니다.

RestController

package com.ryanjin.example;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.projection.ProjectionFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * Created by Donghyun Ryan Jin [https://github.com/atinjin]
 * spring_data_projection on 2016. 4. 8..
 */
@RestController
public class ItemController {
    @Autowired
    private ItemRepository itemRepository;
    @Autowired
    private ProjectionFactory projectionFactory;

    @RequestMapping("/item-names")
    public Page<OnlyItemName> getItems(Pageable pageable) {
        Page<ShoppingItem> items = itemRepository.findAll(pageable);

        return items.map(item -> projectionFactory.createProjection(OnlyItemName.class, item));
    }

}

모두 끝났습니다. "/item" 웹서비스에서 ShoppingItem의 모든 정보를 내보내주었다면, "/item-names"라는 웹서비스는 "name" 정보만을 내보내줄 수 있습니다. 우리가 원하는 기능을 충분히 할 수 있게 되었습니다.

같은 도메인 정보를 이용하여 다양한 종류의 웹인터페이스를 생성할 수 있게 된 것입니다. 용도, 사용자의 요구에 맞게 Response JSON의 데이터를 만들어낼 수 있게 되었습니다.

실제 예제 소스 코드는 Github에서 확인해볼 수 있습니다.

https://github.com/atinjin/spring_data_projection

Like a hacker

이 블로그 검색