状态消息

ABAP RESTful 应用程序编程模型 › 学习 › 业务对象 › 消息 › 通用消息实施 › 状态消息

状态消息查看业务对象实例及其值。

状态消息

注意

状态消息必须始终绑定到业务对象实体,并且无法分配到 %OTHER 组件。不得在投影级别添加的操作或函数中定义状态消息。如果在投影中发出状态消息,则会导致短转储。

注意

如果在公开的 RAP OData 服务的上下文中触发回滚,则业务对象的状态将返回到执行请求之前的状态。由于状态消息始终反映持久化实体的当前状态,因此在初始请求之后和回滚之前触发的状态消息对于持久实体无效。因此,框架将此时间范围内触发的状态消息转换为转换消息,然后将其分配到相应 MODIFY 请求的 REPORTED 结构。

如果在非 RAP 场景中通过 EML 使用业务对象,并在 CheckBeforeSave 阶段取消 SAVE,则业务对象将保持其状态并保留状态消息。

状态消息查看业务对象实例及其值。对于具有草稿功能的业务对象,它们将一直保留,直到导致消息的状态发生更改并且在托管场景中,消息会进行缓冲,直到会话结束。验证和确定中的消息(属于草稿场景中的确定操作或准备操作的一部分)通常可视为状态消息。验证通常会检查业务对象值是否存在不一致,从而反映业务对象状态,而确定会触发业务对象状态的更改。根据您的场景,状态消息可能会转换为转换消息。

示例

如果验证返回有关字段中错误值的错误消息,则会保留状态消息,直到更改值并再次触发保存序列。

建议仅在以下情况下使用状态消息:

  • 具有草稿功能的业务对象:分配给 PREPARE 的确定和验证或确定操作

  • 非托管业务对象:在保存代码退出之前完成/检查

  • 托管场景:保存时确定/验证

%state_area 组件

当 %state_area 组件使用 REPORTED 结构中的字符串填充时,状态消息将如此定义。关于命名,建议选择一个名称,用于唯一标识消息源自的条件。例如,如果验证检查用户输入的 CustomerID 是否与存储在客户表中的客户一致,则 %state_area 'Invalid_Customer' 有助于描述验证失败的条件。或者,您可以选择抛出消息的操作的名称,即 %state_area。此值在 UI 上不显示,也不包含在 OData 元数据中 - %state_area 仅用于清除相应消息表中的状态消息。

因此,您需要为要检查的每个唯一条件定义 %state_area,并希望能够使 的消息失效。

子实体的 %path 组件

必须为根实体的所有子实体填充 %path 组件,以将子实体显式映射到父项。对于根的直接子项,%path 组件使用主键和草稿标识将子实体映射到特定父实例。在以下示例中,草稿 parent (%is_braft) 通过实例键值映射到 child 草稿:

 %path       = VALUE #( <root>-%is_draft   = <child>-%is_draft
                        <root>-<key>       = <child>-<parent_key_in_child_entity> )

对于由三个实体组成的业务对象,第二个子实体将映射到直接父实体以及业务对象的根。%path 组件允许在运行时在实体之间进行有效映射。

    %path       = VALUE #( <root>-%is_draft   = <child_2>-%is_draft
                           <root>-<key>       = <child_2>-<root_key_in_child2_entity>
                           <parent>-%is_draft = <child_2>-%is_draft
                           <parent>-<key>     = <child_2>-<parent_key_in_child2_entity> )

有关特定实施示例,请参阅示例实施:validateBookingDate(预订)。

使状态消息无效

如果在同一实例上多次触发同一请求,则必须使状态消息失效,以便不会持续将消息添加到 REPORTED 结构。在一个语句中只能使属于同一 %state_area 的消息无效。每个唯一的 %state_area 需要单独失效。使用以下语法使被管理业务对象上下文中的状态消息无效:

APPEND VALUE #( %tky        = instance-%tky
                %state_area = 'state_area' ) TO REPORTED-BUSINESS_OBJECT_ENTITY.

对于具有 %tky 组件的实例,%state_area 组件将使添加到 REPORTED 结构中具有相同状态区域属性的所有消息无效。由于未定义 %msg,因此框架将从消息表中移除事先随相应 %state_area 添加的所有 %msg:

*Clear state area for instance
APPEND VALUE #( key  	  = instance-key
                %state_area = if_abap_behv=>state_area_all ) TO REPORTED-BUSINESS_OBJECT_ENTITY.

通用消息实施:状态消息

填充 %state_area 组件后,消息将被解释为状态消息。以下通用实施是状态消息,其中包含两个分配到业务对象实体的目标字段,将一个字段作为消息变量传递:

APPEND VALUE #(
      %tky   = instance-%tky

      %msg   = NEW message_exception(
                    textid                =  message_exception=>message_exception_constant
                    severity              =  if_abap_behv_message=>severity-severity
                    message_variable      =  instance-field )
      %element-field1                     =  if_abap_behv=>mk-on
      %element-field2                     =  if_abap_behv=>mk-on
      %element-_association               =  if_abap_behv=>mk-on
      %op-%create                         =  if_abap_behv=>mk-on
      %op-%action-action1                 =  if_abap_behv=>mk-on
      %state_area                         =  'state_area'
      %path                               =  VALUE #( <root>-%is_draft = <child>-%is_draft
                                                      <root>-<key>     = <child-<parent_key_in_child_entity> )) TO reported-business_object_entity.

有关状态消息在 UI 上的显示方式以及更具体的实施示例的详细信息,请参阅 UI 上的状态消息。

有关具有状态和转换消息的示例实施,请参阅为具有草稿功能的示例业务对象创建消息异常类和公开消息。

读取操作中的状态消息

读取操作(包括功能)不会导致业务对象状态发生任何更改,而只是返回数据。因此,读取或函数实施无法发出新的状态消息。

在 OData V4 中,结果类型为实体的函数返回包括相应状态消息在内的相应实体。在 OData V2 中,返回不含状态消息的实体作为缺省行为。

有关消息在 EML 中的行为方式的详细信息,请参阅 EML(实体操作语言)中的消息行为。

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

← UI 上的未绑定和绑定转换消息 · UI 上的状态消息 →