创建 CDS 自定义实体

ABAP RESTful 应用程序编程模型 › 开发 › 开发应用程序 › 通过访问远程服务开发 UI 服务 › 使用 CDS 自定义实体进行数据建模 › 创建 CDS 自定义实体

自定义实体用于手动实施运行时的数据模型。

上下文

此服务使用场景部分从远程服务检索数据,部分从本地数据库表检索数据。在自定义实体中,定义元素并键入要在本地 OData 服务中使用的元素。数据源上的自定义实体不附带 select。用于检索数据的逻辑的实施在实体注释中引用的 ABAP 类中实施。

有关更多信息,请参阅非托管查询。

创建 CDS 自定义实体

过程

  1. 在 ABAP 项目中,选择项目浏览器中的相关包节点。打开上下文菜单并选择 导航路径开始 新建 下一导航步骤 其他... 下一导航步骤 核心数据服务 下一导航步骤 数据定义导航路径结束 以启动创建向导。

  2. 输入向导的必要信息以创建 CDS 自定义实体。选择定义含参数的自定义实体作为模板。

    为 CDS 自定义实体创建新的数据定义,并将其添加到相应包节点的核心数据服务文件夹。在我们的场景中,自定义实体的名称为 /DMO/R_TRAVEL_SCM_TP。

  3. 删除 with parameters 语句。当前场景中不需要参数。

结果

与 CDS 视图不同,自定义实体没有 select 语句从数据源检索数据。自定义实体的运行时必须在相关的 ABAP 类中实施,该类必须使用注释 @ObjectModel.query.implementedBy 进行引用。

后续步骤

现在,可以在编辑器中定义元素。至少一个元素必须是 key。还需要在注释 @ObjectModel.query.implementedBy 中确定查询实施的类。

在 CDS 自定义实体中定义数据模型

上下文

如场景描述中所述,新 OData 服务的数据部分从远程系统检索,部分从本地数据库中获取。因此,要开发的服务的数据模型由远程数据模型和本地数据库表中的字段组成。此外,数据模型需要包括根据上述源计算的瞬态字段。

备注

某些字段在远程数据模型中以骆驼拼写法定义。但是,服务使用模型对生成的代理类中的这些字段使用下划线,因为 ABAP 不区分大小写。为避免生成的数据模型的字段名称需要映射到自定义实体的字段名称,您需要在自定义实体中使用已生成数据模型中的字段名称。此示例场景通过远程字段 Memo 显示如何实施此类字段名称映射。此字段在自定义实体 中命名为 Description。

过程

  1. 如果尚未执行此操作,请在编辑器中打开 CDS 自定义实体的新数据定义。

  2. 根据代理类 /DMO/CL_TRAVEL_SCM 中包含的类型 tys_travel_type 的定义定义新差旅服务的数据模型。自定义实体中不包括组件 value_controls、agency_name、status_text、customer_name 和 sap_messages。对于 etag 处理,定义考虑本地数据库表更改的专用 CalculatedEtag 字段。

  3. 包括 /DMO/TRVL_SCM_DC 中的附加折扣字段。

    discountpct : abap.dec( 3, 1 );
    
  4. 为临时字段添加元素,用于计算含折扣的总价格。

    totalpricewithdiscount : abap.dec(17,3);
    
  5. 为计算的 eTag 添加元素。

    calculatedetag : abap.sstring( 1024 );
    
  6. 使用相应的注释定义金额和货币字段之间的语义关系。

    @Semantics.amount.currencyCode: 'currency_code'
    

结果

以下代码块显示具有正确类型和语义注释的自定义实体元素。

@EndUserText.label: 'CE for Service Consumption Scenario'
define custom entity /DMO/R_TRAVEL_SCM_TP
{
  key travel_id               : abap.numc( 8 );
      agency_id               : abap.numc( 6 );
      customer_id             : abap.numc( 6 );
      begin_date              : abap.dats;
      end_date                : abap.dats;
      @Semantics.amount.currencyCode: 'currency_code'
      booking_fee             : abap.dec( 17, 3 );
      @Semantics.amount.currencyCode: 'currency_code'
      total_price             : abap.dec( 17, 3 );
      currency_code           : abap.cuky( 5 );
      description             : abap.char( 1024 ); //renamed element
      status                  : abap.char( 1 );
      last_changed_at         : timestampl;
      discountpct             : abap.dec( 3, 1 );
      @Semantics.amount.currencyCode: 'currency_code'
      totalpricewithdiscount  : abap.dec(17,3);
      calculatedetag          : abap.sstring( 1024 );
}

后续步骤

创建实施接口 IF_RAP_QUERY_PROVIDER 的 ABAP 类。需要在实体注释 @ObjectModel.query.implementedBy 中引用此类。

创建查询实施类

上下文

必须手动实施 CDS 自定义实体的运行时。因此,它需要实施接口 IF_RAP_QUERY_PROVIDER 的 select 方法的 ABAP 类来处理客户端的查询请求。此类由自定义实体 引用,专用于实施 OData 客户端数据请求。

过程

  1. 在项目浏览器中,选择相关包节点,打开上下文菜单,然后选择 导航路径开始New 下一导航步骤 ABAP Class导航路径结束 启动创建向导。

  2. 按照创建向导的步骤操作并输入必要的信息。在示例场景中,我们为查询实施类选择名称 /DMO/CL_R_TRAVELTP_SCM_QUERY。

    完成向导后,将显示最初生成的源代码并可供编辑。

  3. 实施查询提供程序接口 select 的 IF_RAP_QUERY_PROVIDER 方法。

    只有在查询实施类中实施接口 IF_RAP_QUERY_PROVIDER 的 select 方法后,才能激活自定义实体。

    CLASS /dmo/cl_r_traveltp_scm_query DEFINITION
      PUBLIC
      FINAL
      CREATE PUBLIC .
    
      PUBLIC SECTION.
    
        INTERFACES if_rap_query_provider .
      PROTECTED SECTION.
      PRIVATE SECTION.
    ENDCLASS.
    
    CLASS /dmo/cl_r_traveltp_scm_query IMPLEMENTATION.
    
      METHOD if_rap_query_provider~select.
      ENDMETHOD.
    ENDCLASS.
    
  4. 在自定义实体 /DMO/R_TRAVEL_SCM_TP 中,添加实体注释 @ObjectModel.query.implementedBy 并引用新创建的查询实施类 /DMO/CL_R_TRAVELTP_SCM_QUERY。

    对 ABAP 类的引用必须以 ABAP: 开头。

    @ObjectModel.query.implementedBy:'ABAP:/DMO/CL_R_TRAVELTP_SCM_QUERY'
    @EndUserText.label: 'CE for Service Consumption Scenario'
    define custom entity /DMO/R_TRAVEL_SCM_TP
    { ...
    
  5. 激活自定义实体 /DMO/R_TRAVEL_SCM_TP。

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

← 使用 CDS 自定义实体进行数据建模 · 在 CDS 自定义实体中定义数据模型 →