非标准操作的建模参数

ABAP RESTful 应用程序编程模型 › 开发 › 开发单个业务对象功能 › 非标准操作的建模参数

本主题介绍如何在 ABAP 中建模参数并使用其表示。

参数使用

RAP 中的参数被理解为输入或输出参数,用于传输本质上不是业务对象数据模型一部分的值。您可以使用非标准操作(操作、函数、业务事件)的参数从输入参数中的操作使用者请求额外信息值。此信息必须由操作使用者提供,以便操作可以使用提供的值进行计算。对于操作和函数,参数也可用于返回结果。这作为输出参数实现。处理业务事件时,需要使用参数传递相关值以执行事件。

根据用例,您可以为非标准操作的平面或深度参数建模。使用平面参数,移交标量值或平面结构。通过深度参数,您可以使用嵌套结构或表类型的元素作为参数值。

有关操作的详细信息,请参阅操作。在 为差旅实体实施操作 中提供参数操作的示例。

有关函数的详细信息,请参阅函数。

有关业务事件的详细信息,请参阅业务事件。开发业务事件中提供了业务事件中的参数使用示例。

建模参数

必须正确键入参数的值。由于业务对象数据模型中未描述参数,因此不需要数据库对象来定义其数据模型。类型在 CDS 抽象实体中完成,该实体在 CDS 数据定义中定义。

有关抽象实体的详细信息,请参阅 ABAP CDS - 抽象实体(ABAP 关键字文档)。

扁平参数

扁平参数是不反映层次结构的参数。可以在抽象实体中定义。参数的每个值必须作为抽象实体中的元素正确键入。然后,非标准操作的实施导入扁平结构,您可以使用该结构作为常规扁平 ABAP 结构。

含扁平参数的非标准操作的定义不包括关键字 deep。

示例

含扁平参数的操作定义

*flat input parameter (flat structure)
action MyAction parameter /dmo/a_flat_param

*flat output parameter (nested structure)
action MyAction result [1] /dmo/a_flat_param

CDS 中的平面参数建模及其 ABAP 中的表示

与常规 CDS 视图实体一样,您可以在 UI 上为抽象实体中元素的可读表示设置标签、抬头或快速信息。此操作通过元素注释完成,请参阅 DEFINE ABSTRACT ENTITY, element_annot(ABAP 关键字文档)。

深度参数

深度参数是反映层次结构的参数,这意味着参数包含父子关系中的元素。它们在抽象实体的构成层次结构中定义。层次结构在 ABAP 中表示为基数为 [0..1] 或 [1] 的构成的嵌套结构。对于基数为 [0..*] 或 [1..*] 的成分,将其表示为嵌套表。

就像在数据库表示的数据模型中一样,组合关系必须在每个抽象实体中使用关键字 composition 或 association to parent 声明,以表示它们与其他构成组件的关系。此外,必须定义包含抽象实体构成层次结构的抽象行为定义,以构建抽象实体的层次结构派生类型。每个关联的抽象实体都必须包含在行为定义中,以及相关的关联。从根实体开始,从行为定义结构派生的类型包含所有实体字段以及每个构成的组件。对于基数为 [0..1] 或 [1] 的构成,此构成为结构;否则对于基数 [0..*] 或 [1..*],构成项为表。用于将此类抽象行为定义定义为层次结构模型的关键字是 with hierarchy。有关详细信息,请参阅 CDS BDL - CDS 抽象行为定义(ABAP 关键字文档)。

含深层参数的非标准操作的定义必须包含输入参数的关键字 deep 或 deep table。操作或函数的输出参数通过基数声明其结构或表类型。基数为 [1] 的深层结果参数表示结构,基数为 [1..*] 它们表示 ABAP 中的表。

示例

含深层参数的操作定义

*deep input parameter (nested structure)
action MyAction deep parameter /dmo/a_deep_param_root
*deep input parameter (nested table)
action MyAction deep table parameter /dmo/a_deep_param_root

*deep output parameter (nested structure)
action MyAction deep result [1] /dmo/a_deep_param_root
*deep output parameter (nested table)
action MyAction deep result [1..*] /dmo/a_deep_param_root

CDS 中的深度参数建模及其 ABAP 中的表示

只要派生类型匹配,就可以将抽象实体模型用于不同非标准操作的不同参数。

注意

同一抽象实体模型一次不能用作扁平参数,一次用作同一服务中的深度(表)参数。此类参数的派生类型不匹配,ABAP 中的表示将不明确。服务绑定中的错误消息阻止此类使用。

参数作为平面或深层参数的表示取决于其在非标准操作中的定义。如果关键字 deep 或 deep table 未在参数前使用,则即使抽象实体建模为构成层次结构,也会将参数表示为扁平参数。

记住

仅当参数在非标准操作中显式定义为深度时,才会在 ABAP 中表示为层次结构。例如,具有深度参数的操作的定义在行为定义中必须如下所示:

action myAction deep parameter myParam

具有深度表参数的操作定义必须如下所示:

action myAction deep table parameter myParam

可选和强制参数

缺省情况下,操作和功能的导入参数字段为隐式必填字段。即使使用者没有为操作(例如)提供任何值,也会将默认值(初始)传递到此操作。因此,使用者无法提供任何值。另一方面,对于操作的提供者,无法区分初始值和空值。

可选参数

为了将参数字段定义为可选字段,您可以在抽象行为定义中的实体级别使用附加项 with control:

abstract;
strict;
with hierarchy;

define behavior for /dmo/a_deep_param_root
with control
{
}

此子句将 %CONTROL 结构添加到参数的派生类型,并使 EML 使用者能够通过在调用操作时分别设置 %CONTROL 标志来选择是否要将参数字段值传递到操作。

* Pass a parameter field value
MODIFY ENTITIES OF MyBO
 ENTITY MyEntity
 EXECUTE MyAction
  FROM VALUE #( ( ...
  %param-myfield = myvalue
  %param-%control-myfield = if_abap_behv=>mk-on
  ) )
...
.

* Pass no parameter field (NULL) value
MODIFY ENTITIES OF MyBO
 ENTITY MyEntity
 EXECUTE MyAction

  FROM VALUE #( ( ...
  %param-%control-myfield = if_abap_behv=>mk-off

  ) )

...
.

必需参数

如果附加项 with control 用于抽象行为定义中的实体,则可以使用语法 field ( mandatory:execute ) 将其字段显式定义为必填字段。

...
define behavior for /dmo/a_deep_param_root
with control
{
  field ( mandatory:execute ) myfield;
}

这需要 EML 使用者传递此参数字段的值,并将相应的 %CONTROL 标志设置为 if_abap_behv=>mk-on,如上所示。%CONTROL 结构中没有此字段设置的 EML 请求会导致运行时错误。在 Fiori 元素 UI 上,如果没有为参数字段传递任何值,使用者会面临阻止执行操作的错误消息。

要将关联实体定义为必需,可以将类似语法用于相应关联:

...
define behavior for /dmo/a_deep_param_root
with control
{
  ...
  association ( mandatory:execute) _myassociation;
}

有关详细信息,请参阅 RAP - 字段特征、抽象 BDEF(ABAP 关键字文档)。

重新定义投影中的参数

在业务对象的基础层上为非标准操作(操作、函数或业务事件)定义的参数可以在其投影层(transactional_query 或 transactional_interface)上重新定义。为此,在操作或事件的投影行为定义中指定重新定义参数而不是基本参数。

// Base behavior definition
...
define behavior for /dmo/r_roottp
...
{
  ...
    action myaction deep parameter /dmo/a_myparam_base;
    }
// Projection behavior definition
...
define behavior for /dmo/c_roottp
...
{
  ...
   action myaction deep parameter /dmo/a_myparam_proj;
   }

投影层上的参数必须是基础层上相应参数的子集,这意味着它可以具有与基础层上的组件相同或更少的组件。在基础层上定义为必填的字段或关联必须是投影层上 参数的一部分。

投影层上的参数组件可以具有与基础层上的参数组件不同的名称。但是,它们的类型需要兼容。必须使用抽象行为定义投影中的相应映射指令,指定与基础层上相应组件的关系。这对于投影层参数的每个组件都是必要的,即使其名称与基础层不同。

// Abstract behavior definition of redefining parameter on projection layer
abstract;
...
with hierarchy;
define behavior for /dmo/a_myparam_proj
{
mapping for /dmo/a_myparam_base
{
field_on_projection = field_on_base;

}
}

只能根据其投影重新定义业务对象基础层中的参数。无法针对更多投影重新定义投影中的参数。

有关详细信息,请参阅 RAP - RedefinedParameter(ABAP 关键字文档)。

扩展 Deep 参数

可以扩展非标准操作的参数。用例可以是:

  • 通过在扩展中添加字段来扩展业务事件签名。

  • 通过在扩展中添加字段并丰富业务对象行为定义中使用的映射,扩展操作签名。

对于这两个用例,必须为可扩展性启用抽象行为定义。就像在使用关键字 extensible 的标准行为定义中一样,请参阅行为扩展的可扩展性启用。

RAP 服务中工序的公开和使用(含参数)

以下限制适用于使用深度参数公开操作:

OData V2 仅允许具有扁平参数的非标准操作。如果服务中包含具有深度参数的非标准操作,则服务绑定会显示错误消息。

OData 公开通常不支持以下类型:

  • 标量类型

  • 深度表参数

  • 深度参数作为函数的输入参数或输出参数。

缺省情况下,Fiori 元素 UI 无法表示层次结构。因此,这些 UI 无法使用深度参数。

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

← 使用大对象 · 工序的缺省输入参数 →