筆者前一篇文章 [SAP Fiori 註解 @ObjectModel.readOnly 工作原理解析](https://xie.infoq.cn/article/b29e713783f82e4fe466f5878)，介紹了 SAP Fiori 程式設計模型裡 `@ObjectModel.readOnly` 註解的工作原理。SAP Fiori 註解，是 ABAP Programming Model for SAP Fiori 的重要概念之一。

所謂註解(annotation)，Java 和 JavaScript 開發人員一定不會陌生。

類似的，CDS 註解允許 ABAP 開發人員，將 ABAP 和特定於元件的後設資料新增到任何CDS實體的原始碼中。

根據一致性和註解有效性的評估實現細節，SAP CDS view 的註解分為以下兩類:

- ABAP 註解：由 ABAP 執行時環境評估。

- Component 註解：由相關的 SAP 框架進行評估。

開發人員可以在後設資料擴充套件中使用註解，為CDS檢視定義特定於客戶的後設資料，而無需修改SAP 釋出的標準 CDS 實體本身。使用後設資料擴充套件時，可以覆蓋資料定義中定義的特定註釋值，或向實體新增額外的註釋值。

註解可以新增在 CDS view 上或者 view field 上，下面是一個例子：

```sql
@AbapCatalog.sqlViewName: 'CUSTOMER'
@AccessControl.authorizationCheck: #NOT_REQUIRED
@Metadata.allowExtensions: true
DEFINE VIEW cust_book_view_entity 
     AS SELECT FROM scustom
     JOIN sbook 
     ON scustom.id = sbook.customid
     {   
	@EndUserText.label: 'Customer ID'
	scustom.id,
	@EndUserText.label: 'Customer Name'
           scustom.name,
	@EndUserText.label: 'Customer Booking ID'
           sbook.bookid
     }
```

本文繼續探討另一個 註解 `@OData.publish` 的工作原理。

在SAP官網的ABAP Programming Model for SAP Fiori的幫助文件裡，在OData Annotations目錄下有對這個註解的[介紹](https://help.sap.com/viewer/cc0c305d2fab47bd808adcad3ca7ee9d/1709%20000/en-US/ccdb054e4ecf4573829d4ba258cafa72.html)。

![](https://img-blog.csdnimg.cn/img_convert/24c432205d83eb29581e67da692f06e7.png)

一旦加上了這個註解的CDS view啟用時，會自動生成一個OData服務。

![](https://img-blog.csdnimg.cn/img_convert/c3ed93275eedd49d29dac5dfd2b07d10.png)

這個 OData 服務是如何自動生成的？這就是本文所要分享的內容。

SAP Fiori 程式設計模型支援一種新的 OData 服務的暴露方式，這種 OData 服務的模型定義，和執行時，基於 Service Adaptation Description Language 簡稱 SADL.

下面是一個例子：

```sql
 @AbapCatalog.sqlViewName: 'SQL_VIEW_SAMPLE'
 ...
 @OData.publish: true
 define view CDS_VIEW_NAME as select from 
           ...
 }
```
使用 SAP ABAP Development Tool，開啟 CDS 檢視原始碼編輯頁面，將 OData 註解新增到 CDS 檢視之後，就可以觸發整個DDL 源的啟用。ABAP開發工具將啟用請求委託給 SADL 框架。SADL 生成若干個 SAP Gateway 構件(Artifacts)，這些構件儲存在應用伺服器 AS ABAP 的後端，是SAP Gateway hub系統中啟用和執行 OData 服務所必需的。

![](https://img-blog.csdnimg.cn/img_convert/3117924768377bd304e3aa7f29083ee9.png)

以上是透過 CDS view 暴露 OData 服務的理論知識。

假設我們對加了這個註解的CDS view啟用後自動生成的OData服務的明細一無所知，從何處開始入手進行研究呢？

我建立了一個名為 `zjerrytest20160311` 的 view，然後加上這個註解，啟用。根據我的經驗，按照SAP慣例，自動生成的OData服務的名稱應該也會包含0311這個字串。

![](https://img-blog.csdnimg.cn/img_convert/f159b00a5a770e22d9ac55e8adce5851.png)

啟用之後，我試著用0311作為關鍵字在OData服務的註冊事務碼/IWFND/MAINT_SERVICE裡搜尋，果然搜到了對應生成的OData服務：

![](https://img-blog.csdnimg.cn/img_convert/46465ac5ec3a15952a6cd3ee71f77d0a.png)

在筆者之前的文章 [ABAP 程式語言中 Class(類) 的設計原理剖析](https://xie.infoq.cn/article/e2a3563e2a393c37237efce10) 曾經提到ABAP Netweaver的登錄檔 TADIR，按照0311進行查詢，發現CDS view啟用之後，除了OData服務本身，還自動生成了下列這些物件：

![](https://img-blog.csdnimg.cn/img_convert/6d82833144939bf7461593dc088fbc7d.png)

- IWMO: SAP Gateway Business Suite Enablement對應的模型
- IWSV: SAP Gateway Business Suite Enablement對應的服務
- CLAS: OData服務的實現類ZCL_ZJERRYTEST20160311

做個實驗，當我把OData.publish的值設定為false，再次啟用，發現型別為IWMO和IWSV的物件從登錄檔TADIR中消失了，這再次印證了二者是註解OData.publish設定為true之後啟用CDS view生成的。

![](https://img-blog.csdnimg.cn/img_convert/5bbaddf4f7cf01a7586fcbcabc030569.png)

那麼如何研究CDS view啟用時，這兩個物件的自動生成邏輯呢？

開啟事物碼 ST05，進入跟蹤模式，啟用CDS view，在資料庫跟蹤結果裡果然發現了將自動生成的物件名稱插入到登錄檔TADIR的OPEN SQL語句。

![](https://img-blog.csdnimg.cn/img_convert/220d045f791959247e8fc0ebfcaf1edb.png)

在ABAP裡，在插入資料庫表的OPEN SQL語句之前，必定有待插入資料的生成邏輯。
點選ST05裡藍色的眼鏡圖示，自動跳轉到OPEN SQL語句裡。設定斷點，啟用CDS view，斷點觸發：

![image](https://img-blog.csdnimg.cn/img_convert/a7878a8c55f42973c740b0dd15d889ac.png)

從當前的呼叫棧往外追溯，發現在第21個呼叫棧幀，正是自動生成OData服務的地方：

![](https://img-blog.csdnimg.cn/img_convert/fa6329c61d0d15d9a93f131b2db9f54b.png)

CL_WB_DDLS_SECOBJ_HNDLR_SINGLE->IF_DDIC_WB_DDLS_SECOBJ_HANDLER~ON_ACTIVATION
這個方法首先根據delta_state判斷出需要刪除，新增或者更新的物件清單，分別儲存在下圖12到14行三個輸出引數裡。

![](https://img-blog.csdnimg.cn/img_convert/d0b8cae5b7630f7c2dae20a740e7813d.png)

舉個例子，當我在一個已經啟用過後的CDS view原始碼裡新增@OData.publish:true的註解，然後啟用，此時該註解對於的EDIT_STATE為N(New), 而其他的註解因為沒有任何變化，被標記為U(Unchanged).

![](https://img-blog.csdnimg.cn/img_convert/65d3e9d7234ed0325a576d9c3694b8df.png)

此處會根據EDIT_STATE的值，進入對應的分支。

![](https://img-blog.csdnimg.cn/img_convert/bf3e90d6d638307e78d195fa8e32a073.png)

EDIT_STATE值為N的分支，則執行OData服務的建立，透過CL_SADL_GTK_ODATA_SERVICE_GEN完成，字尾GEN代表Generation.

![](https://img-blog.csdnimg.cn/img_convert/a5f72c9ae710166ca3a44f1999c8ce21.png)

從偵錯程式裡能看出，名稱為ZJERRYTEST20160311的OData服務透過create_via_exposure方法被建立。
完整的呼叫棧：

![image](https://img-blog.csdnimg.cn/img_convert/eb0713547ddf8c76bd900d6b567c1011.png)

本文其實也是另一個具體的例子，在不瞭解一段邏輯(無論框架層面或者應用層面)的情況下，如何使用ST05這個工具來找到設定斷點的程式碼位置，從而找到問題分析的突破口。

# 總結

本文從一個開發人員的視角，深入介紹了 SAP Fiori 註解 @OData.publish 的工作原理。同時也展示瞭如何透過事物碼 ST05，自行定位到 ABAP 框架自動生成 OData 服務資源的準確程式碼位置。

SAP Fiori @OData.publish 註解的工作原理解析

相關文章