【RAP】Unmanaged BOの実装 (1) #SAP

はじめに

RAP(ABAP RESTful Application Programming Model)には、ManagedとUnmanagedという2種類のBOがあります。ManagedはCRUD処理やトランザクションバッファとのやりとりがフレームワークによって提供され、Unmagedはそれらの処理を全て自前で実装する必要があります。

Managed, Unmanagedについては以下の記事で説明しています。

これまで何回かにわたりManaged BOでできることを紹介してきましたが、今回はUnmanaged BOはどうやって実装するかについて書きたいと思います。ADTのRAP GeneratorはManaged BOに対応していない（2022/1月現在）ので、Andre Fischer氏のRAP Generatorを使うことにします。
Unmanagedの実装はステップが多いので、この記事ではRAP Generatorを使い骨組みを生成するところまで実施します。

後続の記事

シナリオ

これまでの記事でも使ってきた、PersonとFamilyMemberという2つのエンティティを持つBOを実装します。
キーはPersonについてはLate Numbering、~~FamilyMemberはEarly Numbering~~で採番します。
2022/2/16 訂正：子のキーに親のキーが含まれていると両方Late Numberingにする必要があるため、全てLate Numberingで実装します。

環境

BTP ABAP Envoronmentのトライアル版を使用します。

Andre Fischer氏のRAP GeneratorはGitリポジトリからインストールして使いますが、クラウド版とオンプレ版でブランチが分かれているので使用する環境に合ったブランチを選択してください。BTP ABAP Environmentのトライアル版には、すでにRAP Generatorがインストールされています。

手順

テーブルを作成
RAP Generatorで使用するJSONファイルを準備
RAP Generator用のワンタイムで使うクラスを作成
BOを生成
プレビューを見る

1. テーブルを作成

以下のテーブルを作成します。クライアントは'mandt'ではなく'client'にしないとGeneratorでエラーが出ます。

Person

@EndUserText.label : 'Unmanaged Person'
@AbapCatalog.enhancement.category : #NOT_EXTENSIBLE
@AbapCatalog.tableCategory : #TRANSPARENT
@AbapCatalog.deliveryClass : #A
@AbapCatalog.dataMaintenance : #RESTRICTED
define table zperson_u {
  key cient            : abap.clnt not null;
  key person_id         : ze_person_id not null;
  first_name            : ze_firstname;
  last_name             : ze_lastname;
  email                 : ze_email120;
  birthday              : ze_birthday;
  status                : ze_status;
  created_by            : abp_creation_user;
  created_at            : abp_creation_tstmpl;
  last_changed_by       : abp_locinst_lastchange_user;
  local_last_changed_at : abp_locinst_lastchange_tstmpl;
  last_changed_at       : abp_lastchange_tstmpl;

}

FamilyMember

@EndUserText.label : 'Unmanaged Family Member'
@AbapCatalog.enhancement.category : #NOT_EXTENSIBLE
@AbapCatalog.tableCategory : #TRANSPARENT
@AbapCatalog.deliveryClass : #A
@AbapCatalog.dataMaintenance : #RESTRICTED
define table zfamilymember_u {
  key cient       : abap.clnt not null;
  @AbapCatalog.foreignKey.label : 'Person'
  @AbapCatalog.foreignKey.screenCheck : false
  key person_id   : ze_person_id not null
    with foreign key [0..*,1] zperson_u
      where person_id = zfamilymember_u.person_id;
  key member_id   : ze_member_id not null;
  firstname       : ze_firstname;
  lastname        : ze_lastname;
  last_changed_at : abp_lastchange_tstmpl;

}

2.RAP Generatorで使用するJSONファイルを準備

Andre Fischer氏のRAP Generatorでは、JSONファイルで設定を作成しそれをABAPクラスに読み込ませてRAPオブジェクトを生成します。
設定方法についてはこちらに説明があります。今回は以下のような設定ファイルを作成しました。

{
    "$schema": "https://raw.githubusercontent.com/SAP-samples/cloud-abap-rap/main/json_schemas/RAPGenerator-schema-all.json",
    "namespace": "Z",
    "dataSourceType": "table",
    "implementationtype": "unmanaged_semantic",
    "bindingType": "odata_v4_ui",
    "package": "ZYASU2112_2",
    "draftenabled": true,
    "prefix": "",
    "suffix": "_u",
    "hierarchy": {
        "entityName": "Person",
        "dataSource": "zperson_u",
        "objectId": "person_id",
        "etagMaster": "local_last_changed_at",
        "totalEtag": "last_changed_at",
        "children": [
            {
                "entityName": "FamilyMember",
                "dataSource": "zfamilymember_u",
                "objectId": "member_id",
                "etagMaster": "local_last_changed_at"
            }
        ]
    }
}

ポイントは、implementationTypeにunmanaged_semanticを指定するところです。現状3つのimplementationTypeがサポートされています。

managed_uuid：uuid（内部採番）をキーとするManaged BOを生成
managed_semantic：外部採番のキーを持つManaged BOを生成
unmanaged_semantic：Unmanaged BOを生成

prefix, suffixは既存のオブジェクトと名前がかぶらないようにするために設定することができます。

3. RAP Generator用のワンタイムで使うクラスを作成

以下のようなクラスを作成します。このあとメソッドget_json_stringに用意したJSONオブジェクトを貼り付けます。
※クラスの定義はGitHubよりコピー

CLASS zcl_rap_generator_console_01 DEFINITION
  PUBLIC
  INHERITING FROM cl_xco_cp_adt_simple_classrun
  FINAL
  CREATE PUBLIC .

  PUBLIC SECTION.
  PROTECTED SECTION.
    METHODS main REDEFINITION.
    METHODS get_json_string
      RETURNING VALUE(json_string) TYPE string.  
  PRIVATE SECTION.
ENDCLASS.



CLASS zcl_rap_generator_console_01 IMPLEMENTATION.
  METHOD main.
    TRY.
        DATA(json_string) = get_json_string(  ).
        DATA(rap_generator) = /dmo/cl_rap_generator=>create_for_cloud_development( json_string ).

        DATA(framework_messages) = rap_generator->generate_bo( ).
        IF rap_generator->exception_occured( ).
          out->write( |Caution: Exception occured | ) .
          out->write( |Check repository objects of RAP BO { rap_generator->get_rap_bo_name(  ) }.| ) .
        ELSE.
          out->write( |RAP BO { rap_generator->get_rap_bo_name(  ) }  generated successfully| ) .
        ENDIF.
        out->write( |Messages from framework:| ) .
        LOOP AT framework_messages INTO DATA(framework_message).
          out->write( framework_message ).
        ENDLOOP.
      CATCH /dmo/cx_rap_generator INTO DATA(rap_generator_exception).
        out->write( 'RAP Generator has raised the following exception:' ) .
        out->write( rap_generator_exception->get_text(  ) ).
    ENDTRY.
  ENDMETHOD.

  METHOD get_json_string.
    json_string = '{ "Info" : "to be replaced with your JSON string" }' . "ここにJSONを貼り付け
  ENDMETHOD.
ENDCLASS.

JSONを貼り付ける前に、Eclipseの設定を確認しておきます。
Window>PreferenceからSource Code Editorの設定を開き、"Wrap and escape text when pasting into string literal"にチェックがついていることを確認します（ついていなければ設定）。

json_string =''の状態にして、シングルクォート（''）の間にJSONを貼り付けます。

  METHOD get_json_string.
    json_string = '' . "ここにJSONを貼り付け
  ENDMETHOD.

貼り付けたあとは以下のようになります。

  METHOD get_json_string.
    json_string = '{' && |\r\n|  &&
                  '    "$schema": "https://raw.githubusercontent.com/SAP-samples/cloud-abap-rap/main/json_schemas/RAPGenerator-schema-all.json",' && |\r\n|  &&
                  '    "namespace": "Z",' && |\r\n|  &&
                  '    "dataSourceType": "table",' && |\r\n|  &&
                  '    "implementationtype": "unmanaged_semantic",' && |\r\n|  &&
                  '    "bindingType": "odata_v4_ui",' && |\r\n|  &&
                  '    "package": "ZYASU2112_2",' && |\r\n|  &&
                  '    "draftenabled": true,' && |\r\n|  &&
                  '    "prefix": "",' && |\r\n|  &&
                  '    "suffix": "",' && |\r\n|  &&
                  '    "hierarchy": {' && |\r\n|  &&
                  '        "entityName": "Person",' && |\r\n|  &&
                  '        "dataSource": "zperson_u",' && |\r\n|  &&
                  '        "objectId": "person_id",' && |\r\n|  &&
                  '        "etagMaster": "local_last_changed_at",' && |\r\n|  &&
                  '        "totalEtag": "last_changed_at",' && |\r\n|  &&
                  '        "children": [' && |\r\n|  &&
                  '            {' && |\r\n|  &&
                  '                "entityName": "FamilyMember",' && |\r\n|  &&
                  '                "dataSource": "zfamilymember_u",' && |\r\n|  &&
                  '                "objectId": "member_id",' && |\r\n|  &&
                  '                "etagMaster": "local_last_changed_at"' && |\r\n|  &&
                  '            }' && |\r\n|  &&
                  '        ]' && |\r\n|  &&
                  '    }' && |\r\n|  &&
                  '}' . 
  ENDMETHOD.

貼り付け後、クラスを有効化します。

4. BOを生成

ソースコードを右クリックし、Run As>ABAP Application (Console)をクリックして実行します。

うまくいけば、RAP BO xxxx generated successfullyというメッセージがコンソールに表示されます。ワーニングが出ていますが無視します。

生成されたオブジェクトの一部を見てみます。

Behavior Definiiton

Behavior Definitionを見ると、まだimplementation classの定義がありません。

Source Code Libraryのフォルダを見ると、エンティティに対応したクラスが生成されていました。これらのクラスをBehavior Definitionとひもづける必要がありますが、これは次回実施することにします。

Service Binding

Service BindingができているのででPublishします。

5. プレビューを見る

Service BindingからPersonを選択してPreviewをクリックします。

List Reprotの画面が表示されます。

Createをクリックし、項目を入力していくと、フッタのツールバーに"Saving draft..."と表示されます。

保存せずに前画面の戻ってもドラフトデータは保存されています。Unmanagedでもドラフトは自動的に保存してくれるようです。

ドラフト画面で"Ceate"ボタンを押すと、Object createdというメッセージが表示されますが、保存処理を実装していないのでデータは消えてしまいます。

次回はBehavior Implementationを実装し、データが保存されるようにします。

参考

How to use the RAP Generator

Appendix:生成されたオブジェクト

以下に生成されたオブジェクトを載せておきます。

CDS View

ZI_PERSON_U

@AccessControl.authorizationCheck: #CHECK
@Metadata.allowExtensions: true
@EndUserText.label: 'CDS View forPerson'
define root view entity ZI_PERSON_U
  as select from ZPERSON_U
  composition [0..*] of ZI_FamilyMember_u as _FamilyMember
{
  key PERSON_ID as PersonID,
  FIRST_NAME as FirstName,
  LAST_NAME as LastName,
  EMAIL as Email,
  BIRTHDAY as Birthday,
  STATUS as Status,
  @Semantics.user.createdBy: true
  CREATED_BY as CreatedBy,
  @Semantics.systemDateTime.createdAt: true
  CREATED_AT as CreatedAt,
  @Semantics.user.lastChangedBy: true
  LAST_CHANGED_BY as LastChangedBy,
  @Semantics.systemDateTime.localInstanceLastChangedAt: true
  LOCAL_LAST_CHANGED_AT as LocalLastChangedAt,
  @Semantics.systemDateTime.lastChangedAt: true
  LAST_CHANGED_AT as LastChangedAt,
  _FamilyMember

}

ZI_FAMILYMEMBER_U

@AccessControl.authorizationCheck: #CHECK
@Metadata.allowExtensions: true
@EndUserText.label: 'CDS View forFamilyMember'
define view entity ZI_FAMILYMEMBER_U
  as select from ZFAMILYMEMBER_U
  association to parent ZI_Person_u as _Person on $projection.PersonID = _Person.PersonID
{
  key PERSON_ID as PersonID,
  key MEMBER_ID as MemberID,
  FIRSTNAME as Firstname,
  LASTNAME as Lastname,
  @Semantics.systemDateTime.lastChangedAt: true
  LAST_CHANGED_AT as LastChangedAt,
  _Person

}

Projection View

ZC_PERSON_U

@AccessControl.authorizationCheck: #CHECK
@Metadata.allowExtensions: true
@EndUserText.label: 'Projection View forPerson'
@ObjectModel.semanticKey: [ 'PersonID' ]
@Search.searchable: true
define root view entity ZC_PERSON_U
  as projection on ZI_Person_u
{
  @Search.defaultSearchElement: true
  @Search.fuzzinessThreshold: 0.90 
  key PersonID,
  FirstName,
  LastName,
  Email,
  Birthday,
  Status,
  CreatedBy,
  CreatedAt,
  LastChangedBy,
  LocalLastChangedAt,
  LastChangedAt,
  _FamilyMember : redirected to composition child ZC_FamilyMember_u

}

ZC_FAMILYMEMBER_U

@AccessControl.authorizationCheck: #CHECK
@Metadata.allowExtensions: true
@EndUserText.label: 'Projection View forFamilyMember'
@ObjectModel.semanticKey: [ 'MemberID' ]
@Search.searchable: true
define view entity ZC_FAMILYMEMBER_U
  as projection on ZI_FamilyMember_u
{
  @Search.defaultSearchElement: true
  @Search.fuzzinessThreshold: 0.90 
  key PersonID,
  @Search.defaultSearchElement: true
  @Search.fuzzinessThreshold: 0.90 
  key MemberID,
  Firstname,
  Lastname,
  LastChangedAt,
  _Person : redirected to parent ZC_Person_u

}

Behavior Definition

ZI_PERSON_U

unmanaged;
with draft;

define behavior for ZI_PERSON_U alias Person
implementation in class ZBP_I_Person_u unique
draft table ZPERSON00D_U
etag master LocalLastChangedAt
lock master total etag LastChangedAt

{
  field ( readonly )
   PersonID;


  create;
  update;
  delete;

  draft action Edit;
  draft action Activate;
  draft action Discard;
  draft action Resume;
  draft determine action Prepare;

  mapping for ZPERSON_U control ZSPerson_X_u
  {
    PersonID = PERSON_ID;
    FirstName = FIRST_NAME;
    LastName = LAST_NAME;
    Email = EMAIL;
    Birthday = BIRTHDAY;
    Status = STATUS;
    CreatedBy = CREATED_BY;
    CreatedAt = CREATED_AT;
    LastChangedBy = LAST_CHANGED_BY;
    LocalLastChangedAt = LOCAL_LAST_CHANGED_AT;
    LastChangedAt = LAST_CHANGED_AT;
  }

  association _FamilyMember { create; with draft; }
}

define behavior for ZI_FAMILYMEMBER_U alias FamilyMember
implementation in class ZBP_I_FamilyMember_u unique
draft table ZFAMILYMEMB00D_U
etag dependent by _Person
lock dependent by _Person

{
  field ( readonly )
   PersonID,
   MemberID;


  update;
  delete;

  mapping for ZFAMILYMEMBER_U control ZSFamilyMember_X_u
  {
    PersonID = PERSON_ID;
    MemberID = MEMBER_ID;
    Firstname = FIRSTNAME;
    Lastname = LASTNAME;
    LastChangedAt = LAST_CHANGED_AT;
  }

  association _Person { with draft; }
}

Behavior Projection

ZC_PERSON_U

projection;
use draft;

define behavior for ZC_PERSON_U alias Person

{
  use create;
  use update;
  use delete;

  use action Edit;
  use action Activate;
  use action Discard;
  use action Resume;
  use action Prepare;

  use association _FamilyMember { create; with draft; }
}

define behavior for ZC_FAMILYMEMBER_U alias FamilyMember

{
  use update;
  use delete;

  use association _Person { with draft; }
}

Service Definition

ZPERSON_U

define service ZPERSON_U {
  expose ZC_PERSON_U as Person;
  expose ZC_FAMILYMEMBER_U as FamilyMember;
}

Behavior Inplementation

ZBP_I_PERSON_U（グローバルクラス）

class ZBP_I_PERSON_U definition
  public
  abstract
  final
  for behavior of ZI_PERSON_U .

public section.
protected section.
private section.
ENDCLASS.



CLASS ZBP_I_PERSON_U IMPLEMENTATION.
ENDCLASS.

BP_I_FAMILYMEMBER_U（グローバルクラス）

class ZBP_I_FAMILYMEMBER_U definition
  public
  abstract
  final
  for behavior of ZI_PERSON_U .

public section.
protected section.
private section.
ENDCLASS.



CLASS ZBP_I_FAMILYMEMBER_U IMPLEMENTATION.
ENDCLASS.

ZBP_I_PERSON_U（ローカルクラス）

CLASS LHC_PERSON DEFINITION INHERITING FROM CL_ABAP_BEHAVIOR_HANDLER.
  PRIVATE SECTION.
    METHODS:
      CREATE FOR MODIFY
        IMPORTING
          ENTITIES FOR CREATE  Person,
      UPDATE FOR MODIFY
        IMPORTING
          ENTITIES FOR UPDATE  Person,
      DELETE FOR MODIFY
        IMPORTING
          KEYS FOR DELETE  Person,
      LOCK FOR LOCK
        IMPORTING
          KEYS FOR LOCK  Person,
      READ FOR READ
        IMPORTING
          KEYS FOR READ  Person
        RESULT result,
      CBA_FAMILYMEMBER FOR MODIFY
        IMPORTING
          ENTITIES_CBA FOR CREATE  Person\_FamilyMember,
      RBA_FAMILYMEMBER FOR READ
        IMPORTING
          KEYS_RBA FOR READ  Person\_FamilyMember
        FULL result_requested
        RESULT result
        LINK association_links.
ENDCLASS.

CLASS LHC_PERSON IMPLEMENTATION.
  METHOD CREATE.
  ENDMETHOD.
  METHOD UPDATE.
  ENDMETHOD.
  METHOD DELETE.
  ENDMETHOD.
  METHOD LOCK.
  ENDMETHOD.
  METHOD READ.
  ENDMETHOD.
  METHOD CBA_FAMILYMEMBER.
  ENDMETHOD.
  METHOD RBA_FAMILYMEMBER.
  ENDMETHOD.
ENDCLASS.
CLASS LCL_ZI_PERSON_U DEFINITION INHERITING FROM CL_ABAP_BEHAVIOR_SAVER.
  PROTECTED SECTION.
    METHODS:
      FINALIZE REDEFINITION,
      CHECK_BEFORE_SAVE REDEFINITION,
      SAVE REDEFINITION,
      CLEANUP REDEFINITION,
      CLEANUP_FINALIZE REDEFINITION.
ENDCLASS.

CLASS LCL_ZI_PERSON_U IMPLEMENTATION.
  METHOD FINALIZE.
  ENDMETHOD.
  METHOD CHECK_BEFORE_SAVE.
  ENDMETHOD.
  METHOD SAVE.
  ENDMETHOD.
  METHOD CLEANUP.
  ENDMETHOD.
  METHOD CLEANUP_FINALIZE.
  ENDMETHOD.
ENDCLASS.

ZBP_I_FAMILYMEMBER_U（ローカルクラス）

CLASS LHC_FAMILYMEMBER DEFINITION INHERITING FROM CL_ABAP_BEHAVIOR_HANDLER.
  PRIVATE SECTION.
    METHODS:
      UPDATE FOR MODIFY
        IMPORTING
          ENTITIES FOR UPDATE  FamilyMember,
      DELETE FOR MODIFY
        IMPORTING
          KEYS FOR DELETE  FamilyMember,
      READ FOR READ
        IMPORTING
          KEYS FOR READ  FamilyMember
        RESULT result,
      RBA_PERSON FOR READ
        IMPORTING
          KEYS_RBA FOR READ  FamilyMember\_Person
        FULL result_requested
        RESULT result
        LINK association_links.
ENDCLASS.

CLASS LHC_FAMILYMEMBER IMPLEMENTATION.
  METHOD UPDATE.
  ENDMETHOD.
  METHOD DELETE.
  ENDMETHOD.
  METHOD READ.
  ENDMETHOD.
  METHOD RBA_PERSON.
  ENDMETHOD.
ENDCLASS.