OData与SAP Annotation

偏执的太偏执、 2023-07-17 09:47 24阅读 0赞

# 1. 简介 #

在博客《[Odata基础概念详解][Odata]》中，介绍了OData中的各种基础概念。一个重要的概念就是Metadata Document (元结构文档)，在Metadata Document 中描述了OData的数据类型以及相关属性，例如属性的名称，属性的类型等等，这些信息属于OData基础的技术信息。

除了此类信息外，其实还可以通过**Annotation（注解）**的方式为OData添加更加丰富的描述信息，在Metatdata Document中，还可以添加下面几类Annotation -

1）**数据处理控制（Data Processing）**：描述哪些操作允许的

2）**显示控制（Display）**：描述UI的显示属性

3）**分析控制（Analytical）** ：用于指定属性的分析属性，例如是“dimention”还是“measure”

# 2. OData中的Annotation #

SAP的各种Fiori元素，其实就是一系列基于UI5的动态UI组件，这些组件都是通过Annotation这种方式进行驱动和控制的。

我们可以通过下面三种方式来为OData添加Annotation -

**1）在Entity Type定义中直接添加Annotation。**

可以看到在Medata Document中，对于Entiry Type 'Supplie' 中的各种Property, 通过Name，Type等属性为此Property指定了基本的技术属性；于此同时，还可以通过SAP的一系列Namespace例如label, creatable, updatable等一系列Annotation来丰富对于某一属性的控制。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25rR2F2aW5HdW8_size_16_color_FFFFFF_t_70][]

**2)  在Metadata document中单独创建Annotation声明**

在Metadata document中，除了将Annotation直接嵌入到Property的定义中，还可以通过<Annotation></Annotation>这种方式开辟单独的Annotation描述，进而控制某一Property的UI属性。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25rR2F2aW5HdW8_size_16_color_FFFFFF_t_70 1][]

**3）在Metadata外，创建单独的Annotation文件**

除了在OData的Metadata document中声明Annotation，在应用的开发过程中，我们可以为OData创建单独的Annotation File来控制OData的UI属性。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25rR2F2aW5HdW8_size_16_color_FFFFFF_t_70 2][]

在SAP WebIDE中可以通过Annotation Modelor或Code Editor两种方式来维护这种Local Annotation File。下图展示了Annotation Modelor的操作界面，通过这种图形化的操作，可以方便地对OData的UI属性进行控制。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25rR2F2aW5HdW8_size_16_color_FFFFFF_t_70 3][]

# 3. 小结 #

本文简介了OData与SAP Annotation的基本概念和应用场景，Annotation在SAP Fiori应用程序的开发应用十分广泛。

关于在OData中可以使用的SAP Namespace，可以进一步参照链接[http://www.sap.com/Protocols/SAPData][http_www.sap.com_Protocols_SAPData]，

关于Annotation在SAP Fiori元素中的使用方法，可以访问[SAP Fiori 的SAP Community][SAP Fiori _SAP Community]来查找更多相关的资料。

[Odata]: https://blog.csdn.net/nkGavinGuo/article/details/104347895
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25rR2F2aW5HdW8_size_16_color_FFFFFF_t_70]: /images/20230528/f1485243e2094a61b9314a9cd971ff9d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25rR2F2aW5HdW8_size_16_color_FFFFFF_t_70 1]: /images/20230528/48e1ea955aec4528a6fabb1576cc34b6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25rR2F2aW5HdW8_size_16_color_FFFFFF_t_70 2]: /images/20230528/a8dc1efb026745019f777066bac67889.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25rR2F2aW5HdW8_size_16_color_FFFFFF_t_70 3]: /images/20230528/85a3952b66ef4d87a4736ed48f623932.png
[http_www.sap.com_Protocols_SAPData]: http://www.sap.com/Protocols/SAPData
[SAP Fiori _SAP Community]: https://wiki.scn.sap.com/wiki/display/Fiori/Fiori+Elements

发表评论取消回复

表情：

评论列表（有 0 条评论，24人围观）

还没有评论，来说两句吧...

相关阅读

相关武装你的WEBAPI-OData与DTO

本文属于OData系列文章 Intro 前面写了很多有关OData使用的文章，很多读者会有疑问，直接将实体对象暴露给最终用户会不会有风险？$expand在默认配置的情况

约定不等于承诺〃/ 2024年03月17日 15:33/ 0 赞/ 107 阅读

相关 OData与SAP Annotation

1. 简介在博客《[Odata基础概念详解][Odata]》中，介绍了OData中的各种基础概念。一个重要的概念就是Metadata Document (元结构文档)，

偏执的太偏执、/ 2023年07月17日 09:47/ 0 赞/ 25 阅读

相关如何在SAP云平台ABAP编程环境里把CDS view暴露成OData服务

Jerry 2016年在学习SAP CDS view时，曾经写过一个CDS view的自学系列，其中有[一篇][Link 1]提到了一个很方便的注解： @OData.pub

痛定思痛。/ 2023年06月02日 12:58/ 0 赞/ 55 阅读

相关【转】OData的初步认识

What – OData是什么？ OData - Open Data Protocol，是一个设计和使用RESTful API的标准。REST本身只是一个构建web服务的思想

快来打我*/ 2023年01月09日 12:39/ 0 赞/ 360 阅读

相关【转】OData的初步认识

What – OData是什么？ OData - Open Data Protocol，是一个设计和使用RESTful API的标准。REST本身只是一个构建web服务的思想

小咪咪/ 2022年11月19日 09:51/ 0 赞/ 216 阅读

相关 mvc:annotation-driven 与context:annotation-config

文章转载自:[https://www.cnblogs.com/dreamroute/p/4493346.html][https_www.cnblogs.com_dreamrou

向右看齐/ 2022年05月24日 09:27/ 0 赞/ 205 阅读

相关如何启用SAP C4C OData Event Notification

当我们在试图使用SAP C4C OData事件通知这个功能时，如果遇到下列提示消息，说明这个功能在business configuration里没有开启： The OData

忘是亡心i/ 2022年05月16日 15:21/ 0 赞/ 189 阅读

相关 OData v3与WCF Data Services 5.x简介

本文来源于我在InfoQ中文站翻译的文章，原文地址是：http://www.infoq.com/cn/news/2013/01/OData3 如果使用.NET构建新

女爷i/ 2022年04月08日 12:11/ 0 赞/ 284 阅读

相关如何启用SAP C4C OData Event Notification

当我们在试图使用SAP C4C OData事件通知这个功能时，如果遇到下列提示消息，说明这个功能在business configuration里没有开启： The OData

矫情吗；*/ 2022年03月14日 12:52/ 0 赞/ 221 阅读

相关 annotation-driven,annotation-config,component-scan的区别与作用

<mvc:annotation-driven/> 相当于注册了DefaultAnnotationHandlerMapping和AnnotationMethodHand

喜欢ヅ旅行/ 2021年06月24日 14:00/ 0 赞/ 406 阅读