常规 RAP 业务对象实施合同

ABAP RESTful 应用程序编程模型 › 学习 › 业务对象 › RAP 业务对象最佳实践 › RAP 业务对象合同 › 常规 RAP 业务对象实施合同

本主题介绍适用于 RAP 业务对象的所有行为实施方法的常规规则。

每个 RAP 业务对象都提供一个类型化 API,业务对象提供者和使用者可以使用该 API 进行通信。RAP 框架提供专用方法以实施 RAP 业务对象的行为。RAP 运行时框架确保 RAP 业务对象的稳定性和一致性,因此期望在专用处理器和节省程序方法中进行特定实施。因此,有些语句与这些 RAP 实施方法的预定义功能不一致,因此被禁止。

一般规则

范围

禁止的语句

所有 RAP 处理器方法中的禁止 ABAP 语句

  • EML COMMIT ENTITIES

  • EML ROLLBACK ENTITIES

  • COMMIT WORK

  • ROLLBACK WORK

  • SUBMIT AND RETURN

  • 任何与 SCREEN- / SAP GUI 相关的语句,例如
    • CALL SCREEN

    • SET SCREEN

    • MESSAGE

    • CALL DIALOG

    • CALL TRANSACTION

只读 RAP 处理器方法中的禁止 ABAP 语句

  • EML MODIFY ENTITIES

禁止所有 RAP 保护方法中的 ABAP 语句

  • SUBMIT AND RETURN

延迟保存阶段中的禁止 ABAP 语句(ADJUST_NUMBERS、SAVE)

  • CALL FUNCTION function IN UPDATE TASK

  • CALL FUNCTION IN BACKGROUND UNIT

有关详细的处理器限制清单,请参阅 RAP 处理器和保存器方法中的限制。

导入参数

RAP 处理程序和保护程序类的导入参数不同。某些方法需要完整的实例数据集,而其他方法根本不对 实例进行操作。但是,存在这些导入参数的通用组件。

实例绑定操作

实例绑定操作的实施方法始终导入实例标识符,以标识要执行操作的实例。实例标识符可以是 %tky 或 %cid_ref。如果事务缓冲区上可以有多个版本可用,则两个实例标识符都需要派生类型组件(例如 %is_draft 或 %pid)来唯一标识实例。虽然 %tky 包含这些组件,但它们必须伴随 %cid_ref 进行参考操作。

静态操作

静态(非实例绑定)方法的实施方法不会导入实例的标识符。相反,必须导入内容标识符 %cid 作为特定实例上的操作标识符。

输入标识符

作为导入参数的实例标识符或内容标识符的标识组件在下文中称为输入标识符。

下表概述了导入参数组件的规则和指南。

导入参数组件

预期提供者实施

%tky

建议对所有实施方法使用事务代码 %tky。其中包含实际关键字段,以及根据场景唯一标识特定实体实例所需的其他组件。

在草稿场景中,事务键值包含草稿标识 %is_draft 用于区分草稿实例和缓冲区上的活动实例。

内容标识符 %cid

对于在使用时需要内容标识符的操作,必须始终在响应结构中反映 %cid,即使在交互阶段将 %cid 替换为实例标识符。

导入的内容标识符在一个修改请求的所有操作中始终唯一。RAP 运行时引擎在调用 RAP 处理器方法之前对此进行检查。

%cid_ref

派生类型组件 %cid_ref 用于引用同一 LUW 中先前操作中用 %cid 标识的实例的操作。

组件 %cid_ref 始终引用同一请求中的内容标识符。

在启用草稿的业务对象中,组件 %is_draft 必须始终与参考内容标识符的实例相对应。只有 %cid_ref 和 is_draft 的组合可以明确标识草稿业务对象的实例。

对于使用 %cid_ref 标识新实例的操作,必须始终在响应结构中反映 %cid_ref,即使 RAP 运行时引擎在交互阶段将 %cid_ref 替换为实例标识符。如果在单独的处理器方法中实施创建操作和参考操作,则属于这种情况。

在针对参考运算(使用 failed)返回 %cid_ref 的处理器方法中,实施在 failed-%cid 中返回 %cid_ref,在 failed-%tky 中返回 %tky。

如果在单独的处理器方法中实施创建操作(使用 %cid 的操作)和参考操作,则 RAP 运行时引擎会将确定的 %tky 导入到引用 %cid_ref-operation 中。

如果操作在一个处理器方法中实施,则实施会在创建操作中确定 %tky 并将其设置为参考操作的 failed-%tky。

响应参数

RAP 实施方法具有适用常规规则的通用响应模式。提供者使用这些预定义和类型化的响应结构,将有关已执行操作的信息返回给使用者。有关如何实施 RAP 处理程序和保护程序方法以及如何填充这些响应参数的准则和规则受此文档约束。下表包含通用响应参数及其组件的常规提供者信息和规则。

响应参数

响应参数

预期提供者实施

failed

failed 响应参数仅包含输入标识符的子集 (0 - n)。

组件 %fail 必须包含正确的失败原因。

以下失败原因可用:

失败原因

用法

not_found

对于实例操作处理器方法,如果请求的实例不存在。

locked

对于锁处理器方法 ,如果请求的实例已由其他用户锁定。

unauthorized

  • 如果权限处理器方法在 result 中返回 unauthorized,则由 RAP 运行时引擎设置。

  • 在修改非托管业务对象的处理器方法中(如果未在权限处理器方法中实施权限)。

disabled

  • 如果功能控制处理器方法针对 result 中的操作返回 disabled,则由 RAP 运行时引擎设置。

  • 在未托管业务对象的修改处理器方法中(如果未在功能控制处理器方法中实施功能控制)。

readonly

  • 如果功能控制处理器方法为 result 中的字段返回 disabled,则由 RAP 运行时引擎设置。

  • 在未托管业务对象的修改处理器方法中(如果未在功能控制处理器方法中实施功能控制)。

dependency

  • 如果带有 %cid 的相应操作失败,则由 RAP 运行时引擎为具有 %cid_ref 的相关操作设置。

  • 在目标实例的逐个关联处理器方法中(如果 CBA 在源实例上失败)。

conflict

仅由 RAP 运行时引擎设置。

unspecific

任何其他失败。

对于除 not_found 或 locked 以外的其他失败原因,必须提供 %op 中的失败操作。

例外:

没有为 提供操作
  • 实例工厂操作中的输出实例失败。

  • 在按关联创建操作中目标实例失败。

mapped

mapped 响应参数仅包含输入标识符的子集 (0 - n)。

mapped 响应参数不包含重复条目。

在相关实施方法中,不属于 mapped 的所有输入标识符都必须是 failed 的一部分。

如果 mapped 响应参数不相关,则将其留空。例如,在实例操作中。

reported

reported 响应参数始终可由实施填充以返回消息。

对于严重故障原因,提供严重性 error。

对于以下失败原因,必须填充 reported 响应参数:
  • unspecific

  • locked

  • unauthorized

  • disabled

  • readonly

  • dependency

必须始终填充组件 %op 以指示与消息相关的操作。

reported 响应参数包含输入标识符的子集 (0 - n)。

例外:

对于锁相关实体或权限相关实体的实体实例,报告结构中提供的实例标识符不是输入实例标识符。在这种情况下,报告的结构提供构成结构的每个实体实例的实例标识符,直到根。

reported 中的状态消息必须始终引用具有实例标识符的实例。它们无法引用内容标识符。

以下行为实施方法的响应中不允许状态消息:

  • 读取

  • 功能

  • 权限控制

  • 功能控制

  • 锁定

  • 预检查

  • 提前编号

  • 映射行为定义中新定义行为的任何行为实施。

result

result 响应参数始终包含输入标识符的子集 (o..n)。

result 响应参数不包含重复条目。

所有不属于 result 的输入标识符都必须是 failed 的一部分(如果结果基数大于或等于 1)。

输入标识符只能与结果基数的最高值一样频繁显示,除非输入中存在重复项。

result 响应参数必须至少包含所有请求的字段。其中可能包含其他内容。

来源:SAP Help Portal · 2025 FPS02 (Oct 2026) · 中文为 SAP 官方机器翻译

← RAP 业务对象合同 · 实施合同:读取 →