什麼是 OData entity type 的 key？

最權威的定義，來自 OData [官網](https://www.odata.org/documentation/odata-version-2-0/overview/)：

![在這裡插入圖片描述](https://img-blog.csdnimg.cn/c18d50bb0df6415fa48c07819e75dcb0.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5rGq5a2Q54aZ,size_20,color_FFFFFF,t_70,g_se,x_16#pic_center)

OData EDM 模型的核心概念是實體 entities 和關聯即 associations. Entities 是 OData 模型描述物件的實體型別（例如，客戶、員工等）的例項，它們是結構化記錄，由name 和強型別屬性組成，並帶有一個 key.

Complex Types(複雜型別)是結構化型別，也由屬性列表組成，但沒有 key，因此只能作為包含實體的屬性或作為臨時值存在,而無法單獨存在。

OData Complex Types 同 ABAP DDIC 裡的 Structure 非常類似。

Entity key 由單個或者多個 OData entities 屬性組成（例如，CustomerId 或 OrderId），用於**唯一**標識實體型別例項並允許實體型別例項參與關係的基本概念。

透過具體的例子來說明。

下面是 Northwind OData metadata url：

https://services.odata.org/v2/Northwind/Northwind.svc/$metadata

![在這裡插入圖片描述](https://img-blog.csdnimg.cn/bf8809069a9f4690be7a53e3dd6cb11e.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5rGq5a2Q54aZ,size_20,color_FFFFFF,t_70,g_se,x_16#pic_center)

從結果列表看出，有一個 EntityType，名稱為 Category，Key 為 CategoryID.

要檢視系統所有的 category，先要找到 Entity Type Category 對應的 entitySet：

![在這裡插入圖片描述](https://img-blog.csdnimg.cn/a71e04c239944e748383dc6504bee0f5.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5rGq5a2Q54aZ,size_20,color_FFFFFF,t_70,g_se,x_16#pic_center)

在 metadata 里根據關鍵字 entityset 搜尋，然後就能找到 Category 對應的 EntitySet 名稱為 Categories.

然後把 Categories 拼接到 url 尾部，得到系統所有的 Categories：

https://services.odata.org/v2/Northwind/Northwind.svc/Categories?$format=json

總共 8 條資料：

![在這裡插入圖片描述](https://img-blog.csdnimg.cn/5f77416c894b4e26bc3e00ffd755d3c8.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5rGq5a2Q54aZ,size_17,color_FFFFFF,t_70,g_se,x_16#pic_center)

![在這裡插入圖片描述](https://img-blog.csdnimg.cn/403718af899e433681f6513baa726967.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5rGq5a2Q54aZ,size_20,color_FFFFFF,t_70,g_se,x_16#pic_center)

我們可以傳入 CategoryID，根據這個 key 來查詢對應的 Category 資料：

https://services.odata.org/v2/Northwind/Northwind.svc/Categories(3)?$format=json

![在這裡插入圖片描述](https://img-blog.csdnimg.cn/099c50af45cc4d60b3087c94aba75517.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5rGq5a2Q54aZ,size_20,color_FFFFFF,t_70,g_se,x_16#pic_center)

根據 key 訪問單條 entity 的語法：EntitySet 名稱+(key值)

![在這裡插入圖片描述](https://img-blog.csdnimg.cn/aa56a2b5c43f4162a8a0ea2434df82b7.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5rGq5a2Q54aZ,size_20,color_FFFFFF,t_70,g_se,x_16#pic_center)

除了 key 之外，OData 不支援透過 entity 其他屬性放到小括號裡的語法來查詢。

試圖查詢 CategoryName 為 Confections 的 Category 例項，語法錯誤：

![在這裡插入圖片描述](https://img-blog.csdnimg.cn/5db5e9bcdfd84e3e8e3e050be2282de5.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5rGq5a2Q54aZ,size_20,color_FFFFFF,t_70,g_se,x_16#pic_center)

對於根據非 key 屬性查詢的需求，使用 OData $filter 操作：

https://services.odata.org/v2/Northwind/Northwind.svc/Categories?$filter=CategoryName eq 'Confections'

![在這裡插入圖片描述](https://img-blog.csdnimg.cn/4286a7f3dbee4b20b5f95b8e9170017b.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5rGq5a2Q54aZ,size_20,color_FFFFFF,t_70,g_se,x_16#pic_center)

OData metadata 定義中，entity type key 的作用是什麼

相關文章