Allgemeine Wiederverwendungsaspekte einbinden

Sehen wir uns nun an, wie die Definition von Entitäten mithilfe sogenannter Aspekte um neue Elemente erweitert werden kann.

Sehen Sie sich das Video an, um mehr über CDS-Aspekte zu erfahren.

In dieser Lektion lernen wir die extend Richtlinie kennen. Wir werden die annotate Richtlinie später in einer anderen Lektion diskutieren.

Mit der Richtlinie extend können Sie kundenspezifische Felder zu vorhandenen Definitionen hinzufügen, wie in der folgenden Abbildung dargestellt:

Im Beispiel wird das Element someAdditionalField der Domänenentität Authors hinzugefügt. Dadurch wird dieses Feld auch der generierten Datenbanktabelle hinzugefügt.

Mit der extend -Direktive können auch Metadaten wie Annotationen zu vorhandenen Definitionen hinzugefügt oder vorhandene Metadaten überschrieben werden.

Typeigenschaften können auch über extendfestgelegt werden. Beispielsweise kann die Länge eines vorhandenen Elements vom Typ String erhöht werden.

Sie können extend mit vordefinierten Aspekten verwenden, um dieselben Erweiterungen auf mehrere Ziele anzuwenden, wie in der folgenden Abbildung dargestellt:

Das Beispiel zeigt einen benannten Aspekt ManagedObject, der die beiden Elemente createdAt und createdBy definiert. Sowohl die Dokumentenmappenentität als auch die Autorenentität werden über diesen benannten Aspekt um diese Felder erweitert.

Eine benannte Erweiterung kann alles enthalten, z.B. Felder, Typen oder Entitäten.

Sie können benannte Aspekte auch als Includes in einer vererbungsartigen Syntax verwenden. Mit dieser Syntax können Sie eine Definition um mehrere benannte Aspekte gleichzeitig erweitern. In der folgenden Abbildung wird die Entität Autoren um die beiden genannten Aspekte ManagedObject und AnotherAspect erweitert.

Includes sind syntaktischer Zucker. Das gezeigte Beispiel ist äquivalent zur Verwendung einer Abfolge von extends wie folgt:

1234567
entity Authors {}
extend Authors with ManagedObject;
extend Authors with AnotherAspect;
extend Authors with {
  key ID : UUID;
  ...
}

CDS wird mit einem vorkonfigurierten Modell @sap/cds/common ausgeliefert, das allgemeine Typen und Aspekte zur Wiederverwendung bereitstellt.

Es wird empfohlen, dass alle Anwendungen die allgemeinen Typen und Aspekte verwenden, die über @sap/cds/common bereitgestellt werden. Auf diese Weise können Sie von Best Practices profitieren, die aus echten Geschäftsanwendungen gelernt wurden.

Im folgenden Abschnitt werden die beiden Aspekte cuid und managed aus @sap/cds/common näher betrachtet. Später werden wir auch den CodeList Aspekt und die Country und Currency Typen aus diesem Modell diskutieren.

Der cuid Aspekt ist eine praktische Verknüpfung, mit der Sie Ihren Entitätsdefinitionen kanonische, universell eindeutige Primärschlüssel hinzufügen können.

Der managed Aspekt kann verwendet werden, um die vier Felder createdAt, createdBy, modifiedAt und modifiedBy einer Entität hinzuzufügen. Diese Felder werden verwendet, um nachzuverfolgen, wer wann Datensätze angelegt und aktualisiert hat.

Mit diesem Aspekt können Sie die relevanten datensatzbezogenen Verwaltungsinformationen speichern und Ihr Core Domain Model dennoch sauber und verständlich halten.

Die Felder createdBy und modifiedBy haben den Datentyp User, bei dem es sich um einen gemeinsamen Wiederverwendungstyp aus @sap/cds/common handelt.

Die im Aspekt verwendeten Annotationen @cds.on.insert und @cds.on.update bezeichnen Elemente, die beim Einfügen und Aktualisieren automatisch von den generischen Behandlern gefüllt werden.

Die in diesen Annotationen verwendeten Pseudovariablen werden wie folgt aufgelöst:

• $now wird durch die aktuelle Serverzeit (in UTC) ersetzt
• $user ist die ID des aktuellen Benutzers, die von der Authentifizierungs-Middleware empfangen wurde.

Um Aspekte aus dem @sap/cds/common Modell verwenden zu können, müssen Sie diese über die Direktive using importieren. In der folgenden Abbildung erfolgt dies beispielsweise für die allgemeinen Wiederverwendungsaspekte cuid und managed über die ES6-ähnliche Dekonstruktorvariante von using.

Die beiden importierten Aspekte werden als Includes im Beispiel verwendet, um die Entität Autoren um die entsprechenden Felder zu erweitern. Ohne die beiden vordefinierten Aspekte wäre die folgende Definition der Entität Autoren erforderlich, um das gleiche Ergebnis wie in dem mit nativen Mitteln gezeigten Beispiel zu erzielen:

123456789101112
entity Authors {
  key ID: UUID;
      createdAt   : Timestamp @cds.on.insert: $now;
      createdBy   : User      @cds.on.insert: $user;
      modifiedAt  : Timestamp @cds.on.insert: $now  @cds.on.update: $now;
      modifiedBy  : User      @cds.on.insert: $user @cds.on.update: $user;
      name        : String(100);
      dateOfBirth : Date;
      dateOfDeath : Date;
      books       : Association to many Books
                        on books.author = $self;
}

Sehen Sie sich das Video an, um zu erfahren, wie Sie vordefinierte Aspekte verwenden.