[RAP] SAP RAP에서 CDS부터 OData/Fiori까지 흐름 정리

SAP RAP 개발을 처음 접하면 CDS View, Behavior Definition, Service Definition, Service Binding이 각각 왜 필요한지 헷갈리기 쉽다.

가장 단순하게 정리하면 다음과 같다.

CDS
= 어떤 데이터를 보여줄 것인가?

Behavior
= 그 데이터로 무엇을 할 수 있게 할 것인가?

Service Definition
= 어떤 CDS / Business Object를 외부 서비스에 공개할 것인가?

Service Binding
= 어떤 방식(OData V2/V4, UI/Web API 등)으로 공개할 것인가?

Fiori Elements
= 공개된 OData와 Metadata를 이용해 어떤 UI를 보여줄 것인가?

1. 전체 흐름

대표적인 RAP 애플리케이션 구조는 다음과 같다.

Database Table
      ↓
CDS View Entity
  ZI_xxx / ZR_xxx
      ↓
Behavior Definition
      ↓
Projection View
    ZC_xxx
      ↓
Projection Behavior
      ↓
Service Definition
    ZUI_xxx
      ↓
Service Binding
  OData V4 - UI
      ↓
OData Endpoint
      ↓
Fiori Elements

조회 전용 서비스라면 Behavior 계층이 없을 수도 있다.

Table
  ↓
CDS
  ↓
Projection
  ↓
Service Definition
  ↓
Service Binding
  ↓
OData

반대로 등록/수정/삭제 또는 Action이 필요한 RAP Business Object라면 Behavior Definition이 함께 사용된다.


2. 각 객체의 역할

객체 역할
Database Table 실제 데이터를 저장
CDS View Entity 데이터 모델과 조회 구조를 정의
Behavior Definition Create / Update / Delete / Action 등의 동작 정의
Projection View 특정 서비스나 UI에 노출할 데이터 범위를 정의
Projection Behavior 외부에 허용할 Behavior 범위를 정의
Service Definition 어떤 CDS Entity를 서비스에 포함할지 정의
Service Binding 서비스 종류와 프로토콜을 결정하고 실제 Runtime Service로 노출
Fiori Elements OData Metadata와 UI Annotation을 이용해 UI 구성

3. CDS View는 무엇을 하는가?

CDS View는 단순한 DB View라기보다 애플리케이션에서 사용할 데이터 모델을 정의하는 계층이라고 보는 것이 좋다.

예를 들어 수강 정보를 가지고 있다고 하자.

ZEDU_ENROLL

테이블에는 실제 데이터가 저장되어 있다.

그 위에 CDS를 만든다.

define root view entity ZR_EDU_ENROLL
  as select from zedu_enroll
{
    key enroll_id as EnrollId,
        emp_id    as EmpId,
        course_id as CourseId,
        status    as Status
}

여기에서 데이터 구조, Association, Semantic Annotation 등의 모델을 정의한다.

즉,

Database Table
= 데이터를 저장

CDS View
= 애플리케이션에서 사용할 데이터 모델 정의

라고 이해하면 된다.


4. Behavior Definition은 무엇을 하는가?

CDS가 데이터의 모습을 정의한다면 Behavior는 데이터가 할 수 있는 동작을 정의한다.

예를 들어 다음과 같은 동작을 설정할 수 있다.

Create
Update
Delete
Action
Validation
Determination
Authorization
Lock
Draft

예:

managed implementation in class zbp_r_edu_enroll unique;

define behavior for ZR_EDU_ENROLL
{
  create;
  update;
  delete;

  action set_completed result [1] $self;
}

따라서 다음처럼 기억하면 된다.

CDS
= Data

Behavior
= Action / Transaction

5. Projection View는 왜 만드는가?

내부 CDS의 모든 필드와 기능을 외부 서비스에서 그대로 노출할 필요는 없다.

그래서 외부 소비 목적에 맞는 Projection Layer를 만든다.

예:

define root view entity ZC_EDU_ENROLL
  provider contract transactional_query
  as projection on ZR_EDU_ENROLL
{
    key EnrollId,
        EmpId,
        CourseId,
        Status
}

예를 들어 내부 모델에 다음 필드가 있다고 해도,

EnrollId
EmpId
CourseId
Status
CreatedBy
CreatedAt
ChangedBy
ChangedAt
InternalFlag

UI에서는 일부만 사용할 수 있다.

EnrollId
EmpId
CourseId
Status

즉,

ZR / ZI
= 내부 데이터 모델

ZC
= 소비자(UI/API)가 사용할 모델

이라고 이해하면 편하다.


6. Service Definition은 왜 만드는가?

Service Definition의 역할은 어떤 CDS Entity를 하나의 Business Service에 포함할 것인지 정의하는 것이다.

예:

define service ZUI_EDU_ENROLL {
    expose ZC_EDU_ENROLL as Enrollment;
}

의미는 다음과 같다.

ZC_EDU_ENROLL을

Enrollment라는 이름으로

이 서비스에 공개하겠다.

중요한 점은 Service Definition만 만든다고 OData URL이 바로 생성되는 것은 아니라는 것이다.

Service Definition은

무엇을 서비스로 공개할 것인가?

를 정의하는 단계이다.


7. Service Binding은 왜 만드는가?

Service Binding에서는 Service Definition을 실제 통신 프로토콜 및 서비스 유형과 연결한다.

예를 들어 다음과 같이 선택할 수 있다.

OData V4 - UI
OData V4 - Web API
OData V2 - UI
...

따라서 역할을 비교하면 다음과 같다.

Service Definition
= 무엇을 공개할 것인가?

Service Binding
= 어떤 방식으로 공개할 것인가?

Service Binding을 생성하고 활성화하면 실제 OData Runtime Service가 만들어지고 Endpoint를 통해 접근할 수 있다.

예:

/sap/opu/odata4/...

8. Service Binding은 Fiori 전용인가?

아니다.

Service Binding의 목적은 Fiori 화면 자체를 만드는 것이 아니라 Business Service를 특정 프로토콜과 서비스 유형으로 노출하는 것이다.

예를 들어 OData 서비스를 만들면 소비자는 여러 종류가 될 수 있다.

                  ┌─ Fiori Elements
                  │
Service Binding ──┼─ JavaScript / Web App
                  │
                  ├─ Java / Spring
                  │
                  └─ Postman / 외부 시스템

다만 OData V4 - UI로 Binding하고 CDS에 UI Annotation을 정의하면 Fiori Elements와 매우 자연스럽게 연결된다.

예:

@UI.lineItem: [{ position: 10 }]
EmpId;

@UI.lineItem: [{ position: 20 }]
CourseId;

Fiori Elements는 OData의 Metadata 및 Annotation 정보를 이용해 List Report, Object Page 등의 UI를 구성할 수 있다.


9. ZI / ZR / ZC / ZUI 네이밍 규칙

여기서 중요한 점은 Z는 Customer Namespace를 의미하고, 뒤의 문자는 객체 역할을 구분하기 위한 Naming Convention이라는 것이다.

SAP의 공식 예제에서도 다음과 같은 Prefix를 사용한다.

I_ = Interface View
R_ = Base / Root CDS View Entity
C_ = Consumption / Projection View

Customer Namespace에서는 앞에 Z를 붙여 다음과 같이 사용하는 경우가 많다.

ZI_
ZR_
ZC_

단, 프로젝트마다 Naming Convention은 다를 수 있으며 특히 ZUI_와 Service Binding 이름은 SAP가 강제하는 절대 규칙은 아니다.


ZI_ : Interface View

예:

ZI_PRODUCT
ZI_EMPLOYEE
ZI_COURSE

의미:

Z  = Customer Object
I  = Interface

주로 DB Table 위에서 재사용 가능한 데이터 모델을 만드는 데 사용한다.

Table
  ↓
ZI_xxx

예:

define view entity ZI_EDU_COURSE
  as select from zedu_course
{
    key course_id as CourseId,
        course_nm as CourseName
}

일반적으로 여러 CDS나 서비스에서 공통으로 사용할 데이터 모델이라면 ZI_를 사용하는 식으로 구분할 수 있다.


ZR_ : Root / Base RAP View

예:

ZR_EDU_ENROLL
ZR_SALES_ORDER
ZR_EMPLOYEE

의미:

Z  = Customer Object
R  = Root / Base RAP Entity 관례

RAP Business Object의 Root Entity로 사용하는 CDS에 많이 사용한다.

Table
  ↓
ZR_xxx
  ↓
Behavior Definition

예:

define root view entity ZR_EDU_ENROLL
  as select from zedu_enroll
{
    key enroll_id as EnrollId,
        emp_id    as EmpId,
        status    as Status
}

그리고 Behavior Definition도 Root Entity 이름과 연결된다.

ZR_EDU_ENROLL
     ↕
Behavior Definition

SAP RAP 공식 예제에서도 R_ Prefix를 Base CDS View Entity에 사용하는 Naming Convention을 제공한다.


10. ZI와 ZR은 무슨 차이인가?

처음 보면 가장 헷갈리는 부분이다.

간단하게 구분하면 다음과 같다.

ZI
= 재사용 가능한 Interface 데이터 모델

ZR
= RAP Business Object의 Base / Root Entity

ZC
= 실제 소비자가 사용할 Projection

예를 들어:

ZEDU_COURSE
     ↓
ZI_EDU_COURSE
     ↓
다른 CDS에서 재사용

와 같이 사용할 수 있다.

반면 트랜잭션 RAP BO라면:

ZEDU_ENROLL
     ↓
ZR_EDU_ENROLL
     ↓
Behavior Definition
     ↓
ZC_EDU_ENROLL

같은 형태가 자연스럽다.

프로젝트에 따라 모든 Interface CDS를 ZI_로 통일하는 경우도 있으므로, ZI와 ZR을 동시에 반드시 만들어야 하는 것은 아니다.


11. ZC_ : Consumption / Projection View

예:

ZC_EDU_ENROLL
ZC_SALES_ORDER
ZC_EMPLOYEE

의미:

Z  = Customer Object
C  = Consumption

서비스나 UI에서 소비할 모델을 정의한다.

일반적인 RAP 흐름은:

ZR_EDU_ENROLL
       ↓
ZC_EDU_ENROLL

이다.

define root view entity ZC_EDU_ENROLL
  as projection on ZR_EDU_ENROLL
{
    key EnrollId,
        EmpId,
        CourseId,
        Status
}

즉:

ZR
= 내부 Business Object

ZC
= 외부 Consumer용 Projection

으로 생각하면 된다.


12. ZUI_ : UI / Business Service용 이름

예:

ZUI_EDU_ENROLL
ZUI_SALES_ORDER

ZUI_는 주로 UI용 Business Service나 Service Definition을 구분하기 위해 사용하는 프로젝트 Naming Convention으로 볼 수 있다.

예:

define service ZUI_EDU_ENROLL {
    expose ZC_EDU_ENROLL as Enrollment;
}

이 경우:

ZUI_EDU_ENROLL
= Service Definition

처럼 사용할 수 있다.

다만 ZUI_는 ZI_, ZR_, ZC_처럼 CDS 계층 자체를 의미하는 고정 Prefix라고 보면 안 된다.

프로젝트에 따라 다음처럼 이름을 만들 수도 있다.

ZUI_EDU_ENROLL
ZSRV_EDU_ENROLL
ZAPI_EDU_ENROLL

따라서 팀의 Naming Convention에 맞추는 것이 중요하다.


13. Service Binding 네이밍

Service Binding도 프로젝트별 Convention을 사용한다.

예를 들어 Service Definition이:

ZUI_EDU_ENROLL

이라면 OData V4 UI Binding을 다음처럼 구분할 수 있다.

ZUI_EDU_ENROLL_O4

또는:

ZUI_EDU_ENROLL_V4
ZUI_EDU_ENROLL_UI

처럼 사용할 수 있다.

중요한 것은 이름 자체보다 Service Definition과 Binding의 역할을 구분할 수 있게 일관된 규칙을 유지하는 것이다.


14. 전체 네이밍 예시

교육 수강관리 프로그램을 예로 들면 다음과 같이 구성할 수 있다.

구분 예시
Database Table ZEDU_ENROLL
Interface CDS ZI_EDU_ENROLL
RAP Root CDS ZR_EDU_ENROLL
Behavior Definition ZR_EDU_ENROLL
Behavior Implementation ZBP_R_EDU_ENROLL
Projection CDS ZC_EDU_ENROLL
Projection Behavior ZC_EDU_ENROLL
Service Definition ZUI_EDU_ENROLL
Service Binding ZUI_EDU_ENROLL_O4
OData Entity Enrollment

모든 프로젝트에서 ZI와 ZR을 동시에 만드는 것은 아니다.

예를 들어 단순 RAP BO라면 아래 정도로도 충분하다.

ZEDU_ENROLL
      ↓
ZR_EDU_ENROLL
      ↓
Behavior Definition
      ↓
ZC_EDU_ENROLL
      ↓
Projection Behavior
      ↓
ZUI_EDU_ENROLL
      ↓
ZUI_EDU_ENROLL_O4

15. 최종 흐름 한 번에 보기

┌───────────────────────────────┐
│        ZEDU_ENROLL            │
│        Database Table         │
└──────────────┬────────────────┘
               │
               ▼
┌───────────────────────────────┐
│       ZR_EDU_ENROLL           │
│       Root CDS Entity         │
│                               │
│  데이터 모델 / Association    │
└──────────────┬────────────────┘
               │
               │ Behavior
               ▼
┌───────────────────────────────┐
│      Behavior Definition      │
│                               │
│ Create / Update / Delete      │
│ Action / Validation 등        │
└──────────────┬────────────────┘
               │
               ▼
┌───────────────────────────────┐
│       ZC_EDU_ENROLL           │
│       Projection View         │
│                               │
│ 외부에 보여줄 데이터 선택     │
└──────────────┬────────────────┘
               │
               ▼
┌───────────────────────────────┐
│      ZUI_EDU_ENROLL           │
│      Service Definition       │
│                               │
│ 어떤 Entity를 공개할지 정의   │
└──────────────┬────────────────┘
               │
               ▼
┌───────────────────────────────┐
│    ZUI_EDU_ENROLL_O4          │
│      Service Binding          │
│                               │
│ OData V4 - UI                 │
└──────────────┬────────────────┘
               │
               ▼
┌───────────────────────────────┐
│        OData Endpoint         │
└──────────────┬────────────────┘
               │
       ┌───────┴─────────┐
       ▼                 ▼
 Fiori Elements      External App
                    Spring / JS 등

16. 이것만 기억하면 된다

Table
= 실제 데이터를 저장

ZI / ZR
= 내부 데이터 모델을 정의

Behavior
= 데이터가 수행할 수 있는 동작을 정의

ZC
= 외부에서 사용할 데이터와 기능을 Projection

Service Definition
= 무엇을 서비스로 공개할지 정의

Service Binding
= 어떤 프로토콜과 서비스 유형으로 공개할지 정의

OData
= 실제 Consumer와 데이터를 주고받는 통신 인터페이스

Fiori Elements
= OData Metadata와 Annotation을 이용해 UI 구성

특히 헷갈리기 쉬운 두 개만 다시 정리하면:

Service Definition
≠ OData Endpoint 자체

Service Binding
= Service Definition을 OData 등의 프로토콜에 연결하여 실제 서비스로 노출

그리고:

Service Binding
≠ Fiori UI 자체

OData V4 - UI Binding
→ Fiori Elements에서 소비하기 좋은 UI Service를 제공

라고 이해하면 된다.


참고

  • SAP Help Portal - Naming Conventions for Development Objects
  • SAP Help Portal - Creating a Service Definition and a Service Binding
  • SAP Help Portal - Service Binding
  • SAP Help Portal - ABAP RESTful Application Programming Model

네이밍 Prefix는 프로젝트 및 조직의 개발 표준에 따라 달라질 수 있다. 특히 ZUI_, Service Definition, Service Binding 이름은 팀 내 규칙을 정해 일관되게 사용하는 것이 중요하다.


Profile picture

@shyun_im

COMMENTS

댓글

GitHub 계정으로 로그인하면 댓글을 남길 수 있습니다.

댓글을 불러오는 중입니다.