Beispiele für globale Referenzarchitekturen

Hier werden gängige Methoden zum Organisieren einer globalen Referenzarchitektur (GRA) -Codebasis beschrieben. Obwohl die Option separate packages bevorzugt wird, erfordern einige Situationen eine der anderen unten beschriebenen Optionen.

Definitionen

Option 1: Separate Pakete

Informationen zum Einrichten dieser Methode finden Sie unter Best Practices für die Composer-Projektstruktur .

Die flexibelste Methode zur Verwaltung von GRA Composer-Paketen besteht in Metapaketen. Metapakete enthalten nur eine composer.json -Datei, die andere Paketabhängigkeiten definiert. Erstellen Sie Metapakete mit Private Packagist -Repositorys.

Hauptprojekt composer.json

{
    "name": "example-client/region-1",
    "description": "Example Client Region 1",
    "type": "project",
    "require": {
        "magento/product-enterprise-edition": "2.3.5",
        "example-client/meta-region-1": "~1.0"
    },
    "minimum-stability": "dev",
    "prefer-stable": true,
    "repositories": [
        {"type": "composer", "url": "https://repo.packagist.com/example-client/"},
        {"packagist.org": false}
    ]
}

example-client/meta-region-1 composer.json

{
    "name": "example-client/meta-region-1",
    "description": "Region 1 meta package",
    "type": "metapackage",
    "require": {
        "example-client/meta-gra": "~1.0",
        "example-client/theme-frontend-region1",
        "example-client/language-es-es",
        "ingenico/ogone-client"
    }
}

example-client/meta-gra composer.json

{
    "name": "example-client/meta-gra",
    "description": "GRA meta package",
    "type": "metapackage",
    "require": {
        "geoip2/geoip2": "~2.0",
        "magento-services/module-stackify-logger": "~1.1",
        "example-client/sap-connector",
        "example-client/service-chat",
        "example-client/store-locator"
    }
}

Jedes Modul, Sprachpaket, Design und jede Bibliothek verfügt über ein eigenes Git-Repository. Jedes Git-Repository synchronisiert automatisch mit dem privaten Packagist-Repository und generiert dort ein Paket, solange sich im Stammverzeichnis des Git-Repositorys eine composer.json -Datei befindet.

Optionen 2: Massenpakete

Nachfolgend finden Sie ein Beispiel für mehrere Module in einem einzelnen Composer-Paket.

Ein Massenpaket kann nur Pakete desselben Typs enthalten. Wenn Sie beispielsweise mehrere Pakete für Adobe Commerce-Module, Designs, Sprachpakete und Bibliotheken haben, müssen Sie für jeden Typ separate Bulk-Pakete erstellen.

Die Dateistruktur im Verzeichnis "Anbieter"sollte wie im folgenden Beispiel aussehen. Prüfen Sie jedoch Ihr Projekt, um zu sehen, was in Ihrem Git-Repository enthalten sein sollte):

.
└── example-client/
    └── gra/
        └── src/
            ├── SapConnector/
            │   ├── etc/
            │   └── registration.php
            ├── ServiceChat/
            │   ├── etc/
            │   └── registration.php
            ├── StoreLocator/
            │   ├── etc/
            │   └── registration.php
            └── composer.json

Die Datei composer.json sollte wie folgt aussehen:

{
    "name": "example-client/gra",
    "description": "GRA Modules",
    "require": {
        "magento/magento-composer-installer": "*"
    },
    "type": "magento2-module",
    "autoload": {
        "files": [
            "src/SapConnector/registration.php",
            "src/ServiceChat/registration.php",
            "src/StoreLocator/registration.php"
        ],
        "psr-4": {
            "ExampleClient\\SapConnector\\": "src/SapConnector",
            "ExampleClient\\ServiceChat\\": "src/ServiceChat",
            "ExampleClient\\StoreLocator\\": "src/StoreLocator"
        }
    }
}

Option 3: Git teilen

Diese Architektur verwendet vier Git-Repositorys zum Speichern von Code:

So richten Sie diese Option ein:

Option 4: Monorepo (empfohlen)

Diese Strategie ahmt genau nach, wie das Magento Open Source-Git-Repository funktioniert.

Der gesamte Code wird in einem einzigen Repository entwickelt und getestet. Durch die Automatisierung werden Pakete aus diesem einzigen Repository entfernt, das mithilfe von Composer in UAT- und Produktionsumgebungen installiert werden kann.

Die monorepo -Option ermöglicht Ihnen die einfache Arbeit in einem einzelnen Repository und bietet gleichzeitig die Flexibilität, Instanzen mit Paketen zusammenzustellen.

Die Versionierung und Paketdestillation erfolgt durch Automatisierung, mithilfe von GitHub-Aktionen oder GitLab-Aktionen.

Weitere Informationen zu dieser Automatisierung finden Sie in den folgenden Ressourcen:

Strategien nicht mischen

Es ist nicht ratsam, einen kombinierten Ansatz mit Composer für GRA-Pakete und das Verzeichnis app/ für Marken- oder Regionspakete zu verwenden.

Sie erhalten nicht nur alle Vor, sondern auch alle Nachteile beider Methoden. Sie sollten das eine oder das andere auswählen (Git oder Composer), um optimal zu funktionieren.

Lösungen zur Vermeidung