RAP 副作用

ABAP RESTful 应用程序编程模型 › 学习 › 业务对象 › RAP 业务对象供应 › RAP 业务对象行为 › RAP 副作用

副作用用于重新加载数据、权限或消息或触发器,以根据已启用草稿的业务对象的 UI 场景中的数据更改确定操作。

关于 RAP 副作用

副作用在基于已启用草稿的业务对象的 UI 场景中很有用,使 Fiori 元素 UI 了解已定义字段的数据更改需要重新计算其他数据值、权限或消息。

由于启用草稿的场景使用无状态通信模式,因此 UI 不会触发重新加载每个用户输入的所有业务对象相关属性。如果最终用户在编辑模式下仅更改某些字段(即草稿业务对象实例上的字段),则用户始终无法期望用户界面上显示数据的数据一致性。换句话说,UI 用户更改草稿实例的数据时,不一定显示所有字段的 READ 请求。如果没有 RAP 副作用,这可能会导致草稿实例中显示的数据不一致,例如,基于其他字段计算数据时。

RAP 副作用可解决此问题。它们定义字段和其他业务对象特征之间的相关性,以触发受影响属性的重新加载。特别是,RAP 的副作用很有效,因为没有完全重新加载所有业务对象属性,而是仅重新加载受特定用户输入影响的属性。

示例

差旅业务对象中的总价格根据不同的价格计算,例如预订费、航班价格和补充价格。如果 UI 用户更改了预订费,则需要重新计算总价格。如果用户不直接保存草稿业务对象实例,则不会触发通常用于重新计算总金额的建模确定,并且不会直接更改总金额字段中 UI 上的数据。这意味着,用户仍会看到旧的总金额,这是不一致,可通过 RAP 副作用避免。由于 RAP 副作用,应用程序开发人员定义总金额与其他金额字段之间的相关性,这会在每当 UI 用户更改其中一个金额字段时触发重新加载以获取重新计算金额。

有关此类 RAP 副作用实施的详细描述,请参阅开发 RAP 副作用。

RAP 副作用在 RAP 行为定义中定义。该定义在 RAP 服务的 OData 元数据中引发附加注释。根据这些注释,UI 触发定义的确定操作、重新加载和发送相应属性的 READ 请求。与行为定义中定义的其他行为一样,RAP 副作用必须重复用于每个投影行为定义和接口。重用 RAP 副作用的语法是 use side effects。

您还可以使用 Fiori 工具通过 UI 项目添加 UI 注释,但通过 RAP 副作用,作为应用程序开发人员,您可以影响后端实施中的 UI 行为。

此外,还可以定义业务事件以在 RAP 业务对象中触发 RAP 副作用。有关详细信息,请参阅事件驱动的 RAP 副作用。

RAP 负面影响类型

可以在以下 RAP BO 属性的基本行为定义中定义副作用:

  • *字段:*每当在 UI 上更改定义的字段时,都会触发 RAP 副作用并重新加载定义的目标。

    side effects { field MyField affects Targets }

  • *操作:*无论何时在 UI 上执行操作,都会触发 RAP 副作用并重新加载定义的目标。

    side effects { action MyAction affects Targets }

  • *确定操作:*无论何时更改定义的源,都会触发确定操作并重新加载定义的目标。

    side effects { determine action MyDetermineAction executed on Sources affects Targets }

  • *自身:*每当修改为 RAP 副作用定义的实体时,都会重新加载定义的目标。此类型不能影响实体本身(的字段)。

    side effects { $self affects Targets }

  • *事件:*每当应用服务器引发定义的事件时,都会触发 RAP 副作用并重新加载定义的目标。

    side effects { event MyEvent affects Targets } 有关详细信息,请参阅事件驱动的 RAP 副作用。

目标

以下业务对象属性可用作 RAP 副作用目标:

  • *field:*触发 RAP 副作用时会重新加载指定的字段 field MyField。可以指定一个或多个字段作为 RAP 副作用目标。通配符 field * 重新加载同一实体实例的所有字段。您还可以使用其他实体实例中的字段作为目标。必须通过关联路径 _assoc.Myfield 对其进行定义。

  • *permissions:*触发 RAP 副作用时将重新加载指定属性的功能和权限控制。您可以指定 的权限

    • 字段:permissions(field MyField),

    • 操作:permissions(action MyAction) 和

    • 用于标准操作:permissions (create|update|delete)。

    您还可以通过关联路径指定关联实体元素和操作的权限:

    • 字段和操作:permissions ( _assoc.{field|action} )

    • 操作:permissions ( {create|update|delete} _assoc )

  • *$self:*已重新加载自有实体。

  • *entity:*触发 RAP 副作用时会重新加载指定的关联实体:entity _MyAssoc。如果将关联定义为 RAP 副作用的源,则会为 OData V4 中的 CREATE、UPDATE 和 DELETE 操作触发 RAP 副作用,但仅针对 OData V2 中的 CREATE 和 DELETE 操作触发。只能为实体本身子实体的目标定义关联作为源。无法使用父实体作为源来定义对子实体的 RAP 副作用。

  • *messages:*触发 RAP 副作用时将重新加载 reported 中存储的所有消息。

    限制

    作为 RAP 副作用目标的消息仅适用于 OData V4。

一种 RAP 副作用可能会影响多个目标。还必须枚举确定目标类型的说明符。

示例

side effects { field MyField affects field Field1, field Field2, action Action1, action Action2 ... }

确定操作的源

以下业务对象属性可用作 RAP 副作用中的确定操作源。

  • field:更改指定字段时触发确定操作:field MyField。您可以指定一个或多个字段作为确定操作源。

    备注

    通过使用多个字段作为确定操作 RAP 副作用的源,会将这些字段隐式视为字段组。仅当光标在更改至少一个源字段组后设置在源字段组之外时,才会触发 RAP 副作用。

    您还可以将其他实体实例中的字段用作源。必须通过关联路径进行定义:_assoc.Myfield。

  • *$self:*只要更改自有实体实例上的任何内容(字段、创建子项、删除子项),就会触发确定操作。

  • *entity:*只要更改指定实体上的任何内容(字段、创建、删除),就会触发确定操作:entity_assoc。