在管理的业务对象中自动绘制主键值

ABAP RESTful 应用程序编程模型 › 开发 › 开发单个业务对象功能 › 编号 › 在管理的业务对象中自动绘制主键值

在具有 UUID 键值的被管理场景中,可由托管运行时框架自动生成主键字段的值。

上下文

可以为管理的业务对象自动生成主键字段的值。所谓管理的内部提前编号在业务对象的行为定义中定义。CREATE 操作期间,托管运行时框架自动为定义的关键字段提取 UUID。新建的业务对象实例在 CREATE 操作后可立即唯一识别,并在保存序列期间使用给定键值保存。

更多信息,请参见 编号 。

前提条件

  • 主键字段具有 ABAP 类型 raw(16) (UUID)。

  • RAP 业务对象的实施类型为 managed。

有关在行为定义中为主键字段定义托管提前编号的语法的详细信息,请参阅 CDS BDL - 字段编号(ABAP 关键字文档)

如果希望仅在内部填充关键字段,则关键字段必须为只读。如果未将关键字段设置为只读,则键值也可以由使用者提供。但是,此可选外部编号的用例很少见,因为消费者填充 UUID 值并不常见。

示例

以下简化的业务对象举例说明了让框架为托管业务对象生成 UUID 键值的用例。

  1. 数据库表 /dmo/travel_uuid

    数据模型的基础是类似于 /DMO/travel 的数据库表(包含在 ABAP 航班参考场景中)。要演示管理的编号,我们需要 UUID 类型为 (raw(16)) 的关键字段。

    @EndUserText.label : 'Flight Reference Scenario: Managing Travels'
    @AbapCatalog.enhancementCategory : #NOT_EXTENSIBLE
    @AbapCatalog.tableCategory : #TRANSPARENT
    @AbapCatalog.deliveryClass : #A
    @AbapCatalog.dataMaintenance : #LIMITED
    define table /dmo/travel_uuid {
      key client      : abap.clnt not null;
      key travel_uuid : sysuuid_x16 not null;
      travel_id       : /dmo/travel_id;
      agency_id       : /dmo/agency_id;
      customer_id     : /dmo/customer_id;
      begin_date      : /dmo/begin_date;
      end_date        : /dmo/end_date;
      @Semantics.amount.currencyCode : '/dmo/travel_uuid.currency_code'
      booking_fee     : /dmo/booking_fee;
      @Semantics.amount.currencyCode : '/dmo/travel_uuid.currency_code'
      total_price     : /dmo/total_price;
      currency_code   : /dmo/currency_code;
      description     : /dmo/description;
      overall_status  : /dmo/overall_status;
      created_by      : syuname;
      created_at      : timestampl;
      last_changed_by : syuname;
      last_changed_at : timestampl;
    }
    
  2. CDS 根视图 /DMO/I_TRAVEL_UUID

    简化差旅场景的数据模型在类似于 /DMO/I_TRAVEL_M 的 CDS 视图中定义。UUID 场景中的区别在于 UUID 键值字段为必填字段。除 UUID 关键字段外,差旅 CDS 视图还定义了分配附加语义标识符的非关键字段 travel_id。此语义键值不是场景中的键值元素。它仅用作附加、更简单的标识符,使用者更易于读取。此字段的值通过行为池中的确定进行分配。 展开以下代码示例以查看源代码

    示例代码

    @AbapCatalog.sqlViewName: '/dmo/itraveluuid'
    @AbapCatalog.compiler.compareFilter: true
    @AbapCatalog.preserveKey: true
    @AccessControl.authorizationCheck: #NOT_REQUIRED
    @EndUserText.label: 'Root View with Travel UUID'
    
    define view /dmo/i_travel_uuid as select from /dmo/travel_uuid
    
    { ///dmo/travel_uuid
      key travel_uuid,
      travel_id,
      agency_id,
      customer_id,
      begin_date,
      end_date,
      @Semantics.amount.currencyCode: 'currency_code'
      booking_fee,
      @Semantics.amount.currencyCode: 'currency_code'
      total_price,
      @semantics.currencyCode: true
      currency_code,
      description,
      overall_status,
    
      @Semantics.user.createdBy: true
      created_by,
      @Semantics.systemDateTime.createdAt: true
      created_at,
      @Semantics.user.lastChangedBy: true
      last_changed_by,
      @Semantics.systemDateTime.lastChangedAt: true
      last_changed_at
    }
    
  3. 行为定义 /DMO/I_TRAVEL_UUID

    对于根 CDS 视图 /DMO/I_TRAVEL_UUID,以下行为定义为 UUID 键值字段 travel_uuid 定义托管编号。

    键值 UUID 字段定义为 read only。未将关键字段设置为 read only 会导致可选的外部编号,消费者也可以在其中手动设置值。

    在此场景中,我们希望通过确定设置附加标识符 travel_id 的值。因此,此字段也设置为只读。

    展开以下代码示例以查看源代码

    示例代码

    managed;
    
    define behavior for /dmo/i_travel_uuid alias Travel
    implementation in class /dmo/bp_i_travel_uuid unique
    persistent table /DMO/TRAVEL_UUID
    lock master
    etag master last_changed_at
    {
      field ( read only, numbering : managed ) travel_uuid;
      field ( read only ) travel_id;
      create;
      update;
      delete;
    //** optional determination to determine the travel ID
      determination CreateKeys on modify { create; }
    }
    
  4. 可选:确定确定语义差旅标识符的值

    travel_id 字段的值通过确定进行分配。这样,使用者就不必手动输入语义标识符。它在 CREATE 上分配。

    确定在行为定义中定义,并在行为池中实施。更多信息,请参见 确定 。

    对于实施,获取新的差旅标识并在新创建的实例上执行 EML modify 以将新的差旅标识分配到实例。为确保确定结果在同一情况下执行两次时不会更改,我们必须确保仅当差旅标识字段为初始字段时才分配新的差旅标识。

    备注

    要确保一个差旅标识仅分配一次,可以使用编号范围对象。

    以下代码示例未显示如何获取此新差旅 ID。仅由 get_number 的方法调用建议。

    展开以下代码示例以查看源代码

    示例代码

    CLASS lhc_Travel_UUID DEFINITION INHERITING FROM cl_abap_behavior_handler.
      PRIVATE SECTION.
    
        METHODS CreateKeys FOR DETERMINATION Travel~CreateKeys
          IMPORTING keys FOR Travel.
    ENDCLASS.
    
    CLASS lhc_Travel IMPLEMENTATION.
    
      METHOD CreateKeys.
    
        " Read entity to check if travel id is initial
        READ ENTITIES OF zmv_i_travel_uuid IN LOCAL MODE
        ENTITY travel
          FIELDS (  travel_id )
          WITH CORRESPONDING #( keys )
        RESULT   DATA(lt_travel_result).
    
        " only modify entities where no travel_id is given
        DELETE lt_travel_result WHERE travel_id IS NOT INITIAL.
    
        LOOP AT lt_travel_result ASSIGNING FIELD-SYMBOL(<fs_travel>).
          " get a new travel ID
          DATA(lv_travel_id_new) = get_number(  ).
          <fs_travel>-travel_id = lv_travel_id_new.
        ENDLOOP.
    
        MODIFY ENTITIES OF zmv_i_travel_uuid IN LOCAL MODE
          ENTITY travel
          UPDATE FROM VALUE #( FOR travel IN lt_travel_result
                             (   travel_uuid = travel-%key-travel_uuid
                                 travel_id   = travel-travel_id
                        %control-travel_id   = if_abap_behv=>mk-on )  ).
      ENDMETHOD.
    ENDCLASS.
    
  5. UI 预览

    下图显示对 UUID 键值字段使用托管编号时创建新的差旅实例,以及在 CREATE 上分配语义标识符的确定。

    要使此示例按如下所示运行,必须将 UI 注释添加到 CDS 视图中的元素。

    备注

    用于自动绘制主键字段的 UUID 值的示例场景高度简化。差旅场景的基本重要元素(例如 eTag 或 BO 投影)留在一边,以关注管理的早期编号原则。

    UUID 场景中的管理编号