SAPUI5: Verwaltung manueller CRUD-Operationen mit dem OData-Modell

Ein Handbuch zur Ausführung asynchroner Lese-, Erstellungs-, Aktualisierungs- und Löschanforderungen aus der Controller-Schicht mit Callback-Mechanismen, außerhalb der automatischen UI-Binding-Architektur.

Obwohl in der SAPUI5-Architektur im Allgemeinen deklarative Smart Components und Binding-Strukturen zur Anzeige von Daten auf dem Bildschirm bevorzugt werden, erfordert die Geschäftslogik oft, dass wir Backend-Methoden in operativen Prozessen (z. B. Genehmigungsschaltflächen, Massendatenmanipulationen) manuell auslösen. In diesem Leitfaden behandeln wir die End-to-End-Integrationsvorlage für die Prozesse des Lesens, Erstellens, Aktualisierens und Löschens von Daten (CRUD) über die v2.ODataModel API in den JavaScript- und ABAP-Gateway-Schichten.

💡 Regeln für die asynchrone OData-Verwaltung

Kontextverwaltung (Context Management): Aufgrund der asynchronen Natur von Anfragen muss eine geeignete Kontextverwaltungsmethode gewählt werden, um auf die eigenen Methoden des Controller-Objekts oder auf View-Elemente (`this`) innerhalb der success und error Callback-Funktionsblöcke zuzugreifen. Zu diesem Zweck kann die Verwendung von .bind(this), ES6+ Pfeilfunktionen (Arrow Functions) oder das var that = this; Muster bevorzugt werden.
Batch ($batch)-Verhalten: Das Bündeln mehrerer HTTP-Anfragen in einem einzigen Netzwerkaufruf an den Server optimiert die Netzwerkleistung. Daher sollte die Verwaltung von $batch je nach Szenario geplant und dort aktiv gehalten werden, wo eine sequenzielle transaktionale Integrität erforderlich ist.
HTTP-Update-Methoden (PUT vs. MERGE): Die im Backend ausgelöste HTTP-Methode, wenn die update() Funktion des OData-Modells aufgerufen wird (PUT, das das gesamte Objekt überschreibt, oder MERGE, das nur das geänderte Feld aktualisiert), hängt von der defaultUpdateMethod Konfiguration in der Manifest-Datei oder der Modelldefinition ab.

⚙️ OData-Backend-Service-Konfiguration (CRUD)

Standardoperationsvorlagen für die Product-Entitätsstruktur, die in den Backend-Klassen (DPC_EXT) im SAP Gateway Service Builder (SEGW) neu definiert wurden und vollständige Datenbankstatusprüfungen (sy-subrc) enthalten.

0. ABAP DPC_EXT-Schicht - Erstellung (CREATE_ENTITY)

  METHOD productset_create_entity.
    DATA: ls_data TYPE zcl_my_prod_mpc=>ts_product.

    " Read incoming JSON/XML payload from frontend entry point
    io_data_provider->read_entry_data( IMPORTING es_data = ls_data ).

    " Execute database insert operation (Ensure duplicate key checks in custom logic)
    INSERT zprod_table FROM @ls_data.
    IF sy-subrc = 0.
      er_entity = ls_data. " Return created record back to frontend context
    ELSE.
      " Raise exception if serialization or database insert fails
      DATA(lo_msg) = me->/iwbep/if_mgw_conv_srv_runtime~get_message_container( ).
      lo_msg->add_message( iv_msgty = 'E' iv_text = 'Product replication failed due to duplicate key.' ).
      RAISE EXCEPTION TYPE /iwbep/cx_mgw_busi_exception EXPORTING message_container = lo_msg.
    ENDIF.
  ENDMETHOD.

1. ABAP DPC_EXT-Schicht - Aktualisierung & Löschung (UPDATE / DELETE)

  METHOD productset_update_entity.
    DATA: ls_data TYPE zcl_my_prod_mpc=>ts_product,
          ls_keys TYPE zcl_my_prod_mpc=>ts_product.

    " Get key identifiers and updated business attributes
    io_tech_request_context->get_converted_keys( IMPORTING es_key_values = ls_keys ).
    io_data_provider->read_entry_data( IMPORTING es_data = ls_data ).

    UPDATE zprod_table 
       SET price = @ls_data-price 
       WHERE product_id = @ls_keys-product_id.

    IF sy-subrc <> 0.
      DATA(lo_msg) = me->/iwbep/if_mgw_conv_srv_runtime~get_message_container( ).
      lo_msg->add_message( iv_msgty = 'E' iv_text = 'Unable to update product. Target record not found.' ).
      RAISE EXCEPTION TYPE /iwbep/cx_mgw_busi_exception EXPORTING message_container = lo_msg.
    ENDIF.
  ENDMETHOD.

  METHOD productset_delete_entity.
    DATA: ls_keys TYPE zcl_my_prod_mpc=>ts_product.

    " Retrieve key predicates from technical navigation context
    io_tech_request_context->get_converted_keys( IMPORTING es_key_values = ls_keys ).

    DELETE FROM zprod_table WHERE product_id = @ls_keys-product_id.

    IF sy-subrc <> 0.
      DATA(lo_msg) = me->/iwbep/if_mgw_conv_srv_runtime~get_message_container( ).
      lo_msg->add_message( iv_msgty = 'E' iv_text = 'Unable to delete product. Target record not found.' ).
      RAISE EXCEPTION TYPE /iwbep/cx_mgw_busi_exception EXPORTING message_container = lo_msg.
    ENDIF.
  ENDMETHOD.

💻 Referenz zur Frontend-Controller-Anwendung

2. Manuelle JavaScript-Serviceaufrufe (Product.controller.js)

Asynchrones Auslösen von OData v2-Methoden aus der JavaScript-Schicht unter Verwendung von ES6-Pfeilfunktionen und standardmäßiger Callback-Verwaltung.

sap.ui.define([
    "sap/ui/core/mvc/Controller",
    "sap/m/MessageToast",
    "sap/m/MessageBox"
], function (Controller, MessageToast, MessageBox) {
    "use strict";

    return Controller.extend("ui5.app.controller.Product", {

        onInit: function () {
            this.oODataModel = this.getOwnerComponent().getModel();
        },

        // 1. READ (Query / GetEntitySet - HTTP GET)
        onFetchProducts: function () {
            var oLocalModel = this.getView().getModel("localData");

            this.oODataModel.read("/ProductSet", {
                urlParameters: { "$top": 10 },
                success: (oData) => {
                    // Arrow function automatically preserves the controller context (this)
                    oLocalModel.setProperty("/items", oData.results);
                    MessageToast.show("Products loaded successfully.");
                },
                error: function (oError) {
                    MessageBox.error("Read operation terminated.");
                }
            });
        },

        // 2. CREATE (POST_ENTITY - HTTP POST)
        onProductCreate: function () {
            var oPayload = {
                ProductId: "PROD-999",
                Description: "Enterprise Wireless Mouse",
                Price: "45.00"
            };

            this.oODataModel.create("/ProductSet", oPayload, {
                success: function (oData) {
                    MessageBox.success("Product created successfully with ID: " + oData.ProductId);
                },
                error: function (oError) {
                    MessageBox.error("Creation service rejected the payload.");
                }
            });
        },

        // 3. UPDATE (UPDATE_ENTITY - HTTP PUT / MERGE)
        onProductUpdate: function (sProductId, sNewPrice) {
            var sPath = this.oODataModel.createKey("/ProductSet", {
                ProductId: sProductId
            });

            var oUpdatePayload = {
                Price: sNewPrice
            };

            this.oODataModel.update(sPath, oUpdatePayload, {
                success: function () {
                    MessageToast.show("Product updated successfully.");
                },
                error: function (oError) {
                    MessageBox.error("Update validation failure.");
                }
            });
        },

        // 4. REMOVE (DELETE_ENTITY - HTTP DELETE)
        onProductDelete: function (sProductId) {
            var sPath = this.oODataModel.createKey("/ProductSet", {
                ProductId: sProductId
            });

            this.oODataModel.remove(sPath, {
                success: function () {
                    MessageToast.show("Product deleted successfully.");
                },
                error: function (oError) {
                    MessageBox.error("Deletion lifecycle locked.");
                }
            });
        }
    });
});

Verpassen Sie nicht den neuen Code in der Bibliothek!

Abonnieren Sie den Newsletter, um sofort über wöchentlich aktualisierte SAPUI5/Fiori-Unternehmenskomponenten, Leistungstipps und Architekturentwürfe informiert zu werden.