Voorbeelden van algemene referentiearchitectuur

Dit onderwerp beschrijft gemeenschappelijke manieren om a globale verwijzingsarchitectuur (GRA) te organiserencodebasis. Hoewel de afzonderlijke pakkettenoptie de voorkeur heeft, vereisen sommige situaties één van de andere hieronder beschreven opties.

Definities

Optie 1: Afzonderlijke pakketten

Zie 🔗 beste praktijken van de het projectstructuur van 0} Composer voor vestiging deze methode.

De meest flexibele manier om pakketten van de Composer van GRA te beheren is door metapakketten. Metapakketten bevatten alleen een composer.json -bestand, dat andere pakketafhankelijkheden definieert. Creeer metapakketten gebruikend Privé Pakkettenbewaarplaatsen.

Hoofdproject 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"
    }
}

Elke module, taalpakket, thema en bibliotheek heeft een eigen Git-opslagruimte. Elke Git-opslagplaats synchroniseert automatisch met de Private Packagist-opslagplaats en genereert daar een pakket zolang er zich een composer.json -bestand in de hoofdmap van de Git-opslagplaats bevindt.

Opties 2: Bulkpakketten

Hieronder ziet u een voorbeeld van meerdere modules in één Composer-pakket.

Een bulkpakket kan alleen pakketten van hetzelfde type bevatten. Als u bijvoorbeeld meerdere pakketten hebt voor Adobe Commerce-modules, -thema's, -taalpakketten en -bibliotheken, moet u voor elk type afzonderlijke bulkpakketten maken.

De bestandsstructuur in de directory van de leverancier moet er als volgt uitzien. Controleer uw project echter om te zien wat in uw Git-opslagplaats moet worden opgenomen):

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

Het bestand composer.json moet er als volgt uitzien:

{
    "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"
        }
    }
}

Optie 3: Git splitsen

Deze architectuur gebruikt vier Git-opslagplaatsen om code op te slaan:

illustreert

Deze optie instellen:

Optie 4: Monorepo (aanbevolen)

Deze strategie bootst de manier na waarop de Magento Open Source Git-opslagplaats werkt.

Alle code wordt ontwikkeld en getest in één enkele bewaarplaats. Automatisering distileert pakketten van deze afzonderlijke opslagplaats, die op UAT- en productieomgevingen kan worden geïnstalleerd met behulp van Composer.

Met de optie Monorepo kunt u eenvoudig in één opslagplaats werken en tegelijkertijd de flexibiliteit bieden om instanties samen te stellen met pakketten.

Versioning en pakketdestillatie worden gedaan door automatisering, gebruikend Acties GitHub of Acties GitLab.

Zie de volgende bronnen voor meer informatie over deze automatisering:

Combineer geen strategieën

Het is niet aan te raden om een gecombineerde benadering te gebruiken met Composer voor GRA-pakketten en de map app/ voor merk- of regiopakketten.

U niet alleen krijgt alle voordelen maar ook alle nadelen van beide methodes. U moet een van de twee selecteren (Git of Composer) om optimaal te werken.

Oplossingen om te vermijden