Zum Hauptinhalt springen

Best Practices und Empfehlungen

Dieser Abschnitt liefert Best Practices und Empfehlungen für die Erstellung von Construction Kits.

Allgemeine Richtlinien​

Namenskonventionen​

  • PascalCase verwenden: Verwenden Sie PascalCase für die Benennung von Construction Kits, Entitäten und Eigenschaften. PascalCase ist eine Namenskonvention, bei der der erste Buchstabe jedes Wortes in einem zusammengesetzten Wort großgeschrieben wird.
  • Substantive im Singular verwenden: Verwenden Sie Substantive im Singular für die Benennung von Entitäten. Verwenden Sie beispielsweise Product anstelle von Products.
  • Verben für Aktionen verwenden: Verwenden Sie Verben für die Benennung von Aktionen. Verwenden Sie beispielsweise CreateProduct anstelle von ProductCreation.
  • Präfixe für verwandte Typen verwenden: Verwenden Sie Präfixe für verwandte Entitäten. Verwenden Sie beispielsweise ProductCategory anstelle von Category.
  • Präfixe für Enums verwenden: Verwenden Sie Präfixe für Enums. Verwenden Sie beispielsweise ProductStatus anstelle von Status.

Struktur von Construction Kits​

  • Anliegen trennen: Trennen Sie Anliegen, indem Sie separate Construction Kit Libraries für unterschiedliche Funktionalitäten erstellen. Erstellen Sie beispielsweise separate Construction Kits für Produktverwaltung, Bestellverwaltung und Benutzerverwaltung.
  • Ordner und Dateien verwenden: Verwenden Sie Ordner, um Construction-Kit-Elemente zu organisieren. Ordner helfen dabei, Construction-Kit-Elemente zu organisieren, und erleichtern die Navigation durch das Construction Kit.
  • Versionierung und Versionskontrollsysteme verwenden: Verwenden Sie Versionierung, um Änderungen in Construction Kits zu verwalten. Versionierung hilft dabei, Änderungen nachzuverfolgen und die Abwärtskompatibilität zu wahren. Verwenden Sie Versionskontrollsysteme wie Git, um Construction Kit Libraries zu verwalten.
  • Kommentare verwenden: Verwenden Sie Kommentare, um Construction-Kit-Elemente zu dokumentieren. Kommentare helfen dabei, den Zweck und die Verwendung von Construction-Kit-Elementen zu verstehen.
  • Vererbung verwenden: Verwenden Sie Vererbung, um gemeinsame Eigenschaften und Verhaltensweisen zu definieren. Vererbung hilft dabei, gemeinsame Eigenschaften und Verhaltensweisen zu definieren, die über verschiedene Construction-Kit-Elemente hinweg wiederverwendet werden können.
  • Enums verwenden: Verwenden Sie Enums, um vordefinierte Werte zu definieren. Enums helfen dabei, vordefinierte Werte zu definieren, die als Optionen für Eigenschaften verwendet werden können.
  • Anpassungserweiterungen verwenden: Verwenden Sie Anpassungserweiterungen, um vordefinierte Werte für Enums zu erweitern. Anpassungserweiterungen helfen dabei, vordefinierte Werte zu erweitern, ohne die ursprüngliche Definition zu verändern.
  • Bibliotheken wiederverwenden: Verwenden Sie Bibliotheken wieder, um Duplikate zu vermeiden. Die Wiederverwendung von Bibliotheken hilft, Duplikate zu vermeiden und Konsistenz über Construction Kits hinweg zu wahren.

Neue Construction Kit Libraries entwerfen

Wir beginnen den Entwurf eines neuen Construction Kits üblicherweise mit Hilfe von Design-Tools wie Draw.io, Miro, Lucidchart oder Microsoft Visio. Die Design-Tools helfen dabei, die Struktur, Beziehungen und Elemente des Construction Kits zu visualisieren.

Versuchen Sie, den folgenden Schritten zu folgen:

  • Entitäten identifizieren: Identifizieren Sie Entitäten, die reale Objekte oder Konzepte repräsentieren. Entitäten sind die Bausteine von Construction Kits und repräsentieren reale Objekte oder Konzepte.
  • Eigenschaften definieren: Definieren Sie Eigenschaften für Entitäten. Eigenschaften repräsentieren Attribute oder Merkmale von Entitäten.
  • Beziehungen definieren: Definieren Sie Beziehungen zwischen Entitäten. Beziehungen repräsentieren Assoziationen oder Verbindungen zwischen Entitäten.
  • Bibliotheken identifizieren: Identifizieren Sie bestehende Construction Kit Libraries, die wiederverwendet werden können. Die Wiederverwendung bestehender Bibliotheken hilft, Duplikate zu vermeiden und Konsistenz über Construction Kits hinweg zu wahren.

Erstellen Sie eine visuelle Darstellung der Struktur, Beziehungen und Elemente des neuen Construction Kits.

gefahr

Letztlich erstellen wir digitale Zwillinge. Es ist entscheidend, die Entwicklung auf einen konkreten Anwendungsfall zu stützen, um das Risiko von Over-Engineering zu vermeiden. Ein klar definierter Anwendungsfall stellt sicher, dass der digitale Zwilling darauf zugeschnitten ist, reale Probleme zu lösen und umsetzbare Erkenntnisse zu liefern, anstatt eine übermäßig komplexe oder generische Lösung zu sein. Durch die Fokussierung auf die praktische Anwendung werden Ressourcen effektiv eingesetzt, und der digitale Zwilling liefert maximalen Nutzen, indem er sich an Geschäftszielen und betrieblichen Anforderungen ausrichtet. Dieser Ansatz verhindert unnötige Komplexität und hält den digitalen Zwilling sowohl skalierbar als auch effizient.

Die nächsten Abschnitte beschreiben typische Anwendungsfälle, für die OctoMesh Construction Kits oder Funktionalität bereitstellt.

Lokalisierung und Klassifizierung​

In einer Data-Mesh-Architektur ist eine der entscheidenden Funktionalitäten die Lokalisierung und Klassifizierung von Daten anhand verschiedener Kriterien wie geografischer Standorte, funktionaler Bereiche und Produktperspektiven. Dies stellt sicher, dass Daten im Kontext ihrer Herkunft und ihres beabsichtigten Verwendungszwecks leicht auffindbar, zugänglich und verständlich sind. Durch die Organisation von Daten über diese Dimensionen hinweg ermöglicht das System eine effizientere Data Governance, fördert die funktionsübergreifende Zusammenarbeit und unterstützt einen dezentralen Ansatz für das Datenmanagement, der mit den Kernprinzipien von Data Mesh übereinstimmt.

OctoMesh stellt aus diesem Grund die Construction Kit Library Basic bereit, die die grundlegenden Elemente für Lokalisierung und Klassifizierung enthält. Die Construction Kit Library Basic umfasst die folgenden Elemente:

  • Tree: Repräsentiert eine hierarchische Struktur, die zur Organisation von Daten anhand geografischer Standorte, funktionaler Bereiche oder Produktperspektiven verwendet werden kann.
  • TreeNode: Repräsentiert einen Knoten in einer Baumstruktur, der zum Speichern von Daten oder Metadaten verwendet werden kann.
  • Asset: Repräsentiert ein digitales Asset, das innerhalb des Systems gespeichert und verwaltet werden kann. Ein Asset wird von TreeNode abgeleitet und erbt dessen Eigenschaften und Verhaltensweisen.

Lassen Sie uns die Struktur der Construction Kit Library Basic mit Hilfe eines Diagramms zeigen.

Es ist möglich, verschiedene Trees für die unterschiedlichen Lokalisierungs- und Klassifizierungszwecke zu definieren. Beispielsweise kann ein Tree zur Organisation von Daten anhand geografischer Standorte verwendet werden, ein anderer Tree zur Organisation von Daten anhand funktionaler Bereiche und ein weiterer Tree zur Organisation von Daten anhand von Produktperspektiven.

Ein Asset ist ein digitales Asset, das innerhalb des Systems gespeichert und verwaltet werden kann. Ein Asset wird von TreeNode abgeleitet und erbt dessen Eigenschaften und Verhaltensweisen. Ein Asset ist ein Kindelement eines bestimmten TreeNode und kann zu Lokalisierungs- und Klassifizierungszwecken mit mehreren TreeNodes assoziiert werden.

Es ist eine gute Praxis, die Entität Asset für bestimmte Anwendungsfälle zu spezialisieren. Sie können beispielsweise spezialisierte Entitäten wie Machine, Injection Molding Machine, Extrusion Machine, CNC Machine und Robotic Arm erstellen, die von Asset erben und spezifische Eigenschaften und Verhaltensweisen hinzufügen.

Mit der Erstellung von Bibliotheken beginnen​

Wir beginnen üblicherweise mit einer neuen Construction Kit Library, indem wir ein neues Projekt erstellen. Es gibt zwei Möglichkeiten, eine neue Construction Kit Library zu erstellen: mit Hilfe einer .NET-Projektvorlage oder mit Hilfe des Compilers, siehe Mit der Erstellung von Bibliotheken beginnen.