SAP Cloud SDK for JavaScriptを使ってみる （1）概要

6617 ワード
SAP NestJS JavaScript BTP JavaScript テキストリンク

はじめに

SAP Cloud SDKとは、SAP BTP上で動くアプリケーションを開発するためのライブラリやツールのセットです。私はこれまであまり使う機会がなかったのですが、CAPとの使い分けなども気になったので調べてみました。
以下の予定で、SAP Cloud SDKを使ってみてわかったことをまとめたいと思います。

SAP Cloud SDKにはJava版とJavaScript版があります。Java版とJavaScript版ではJava版の方が機能が多く、新しい機能も先に実装される傾向にあります。
参考：Feature Matrix
私にJavaのスキルがないため、この記事ではJavaScript版を対象とします。

SAP Cloud SDKの特徴

SAP Cloud SDKで提供されるものは、大きく3つに分けられます（以下の図を参照）。土台となるのはBTPへの接続を提供するConnectivityの部分です。Connectivityは、BTP上に登録されたDestinationの取得や、認証などを（開発者が意識しなくてもいいように）裏で行ってくれます。Connectivitiyを利用することで可能になるのがODataサービスやOpen APIへの接続です。SAP Cloud SDKでは、事前定義されたクライアントライブラリ、またはジェネレーターを使用して生成したライブラリを使用して簡単にODataサービスやREST APIにアクセスすることができます。

OData ClientやOpen API Clientを使用する利点

ODataサービスやREST APIへは、SAP Cloud SDKのライブラリを使わず直接アクセスすることもできます。このときの問題点は、エンティティやプロパティを正確に指定しないと実行時にエラーになってしまうことです。
SAP Cloud SDKはODataサービスやREST APIを利用するためのTypeScriptで書かれたライブラリを提供します。このライブラリを使用してODataサービスやREST APIにアクセスすることで、コーディング時に型のチェックが可能になります。また、TypeScriptを使用することによりオートコンプリートやスペルミスのチェックも可能になります。

SAP Cloud SDKの用途

SAP Cloud SDKはBTPへの接続や、ODataサービスやREST APIへの接続を簡単にするというのが利点です。一方、SAP Cloud SDKで開発したサービス自体もHTTPリクエストを受け、結果を返すというAPIの働きをします。
このことから、以下の用途が考えられます。

①バックエンドへのプロキシとなるサービスの開発
SAP Cloud SDKで開発したサービスで、バックエンドへのアクセスを中継します。
元のAPIよりも項目を絞って簡素にしたり、バリデーションや代入など独自のロジックを追加したりすることができます。また、複数のサービスへのアクセスを一か所にまとめることで、サービスを使用するアプリ側からどのバックエンドに接続しているかを意識しなくて済みます。

フロントエンドをUI5で実装する場合、SAP Cloud SDK作成されるサービスはODataではなく（$metadataを持たない）REST APIになるため、以下のような点に留意が必要です。

  • Fiori elementsやSmart Controlが使えない
  • コントロールにデータを直接バインドすることができない（データを取得してからJSONオブジェクトをバインドする必要がある）

また、フロントエンドアプリを置かずにSAP Cloud SDK作ったサービス自体直接呼んで使うこともできます（webhookとして使用したり、workflowやintegration flowの中から呼ぶなど）。

②CAPのイベントハンドラの中で利用
CAPのイベントハンドラの中でSAP Cloud SDKのライブラリを使ってバックエンドにアクセスします。この方法については以下のブログで紹介されています。
Part 2: How to build an extension application for SAP S/4HANA Cloud using CAP, SAP Cloud SDK and SAP Fiori elements
CAPの場合、ODataとして公開されるのでUI5からの利用も簡単です。Fiori elementsやSmart Controlを使いたい場合はこちらの方法となるでしょう。

SAP Cloud SDK for Java Scriptのプロジェクト構成

SAP Cloud SDK for Java Scriptは、NestJSをベースとしたプロジェクト構成になっています。以下の枠で囲った部分がNestJSで生成される部分、それ以外がSAP Cloud SDK独自の部分です。
独自の部分としてはCloud Foundryにデプロイするための設定やCI/CDのための設定などがあります。

サービスの実装はsrcフォルダの中で行います。NestJSのフレームワークに従い、Module、 Controller、Serviceの3つのファイルを使用します。

Module、Controller、Serviceの関係は以下のようになっています。リクエストに対するルーティングを行うControllerと、Controllerから呼ばれるService、それらを束ねるModuleが1セットになっています。

app始まりのデフォルトで作られるファイルは基本的に触らず、以下のように目的ごとにModuleを作ってそれをapp.module.tsに追加していく形になります。なお、spec.tsとつくファイルはテストで使用するものです。
サービスの開発手順については次回説明します。

プロジェクトの生成方法

現状、SAP Cloud SDKのプロジェクトの生成はSAP Cloud SDK CLIを使用して行います。
「現状」というのは、実はCLIはdeprecateされたとなっており、別の手段が今後提供されるものと思われます。

ドキュメントを見ても代替手段についてはまだ記載がないので、この記事ではCLIを使います。

CLIのインストール

npm install -g @sap-cloud-sdk/cli

プロジェクトの生成

sap-cloud-sdk init

リファレンス