Exempel på global referensarkitektur

I det här avsnittet beskrivs vanliga sätt att organisera en global referensarkitektur (GRA)-kodbas. Även om alternativet separata paket är att föredra, krävs ett av de andra alternativen som beskrivs nedan för vissa situationer.

Definitioner

Alternativ 1: Separata paket

Mer information om hur du konfigurerar den här metoden finns i Projektstruktur för disposition.

Det mest flexibla sättet att hantera GRA Composer-paket är genom metapaket. Metapaket innehåller endast en composer.json-fil, som definierar andra paketberoenden. Skapa metapaket med privata Packagist-databaser.

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

Varje modul, språkpaket, tema och bibliotek har en egen Git-databas. Varje Git-databas synkroniseras automatiskt med den privata paketeringsdatabasen och genererar ett paket där så länge det finns en composer.json-fil i Git-databasens rot.

Alternativ 2: Paket i grupp

Nedan visas ett exempel på flera moduler i ett enda Composer-paket.

Ett grupppaket kan bara innehålla paket av samma typ. Om du till exempel har flera paket för Adobe Commerce-moduler, teman, språkpaket och bibliotek måste du skapa separata grupppaket för varje typ.

Filstrukturen i leverantörskatalogen ska se ut som i följande exempel. Titta dock i ditt projekt för att se vad som ska ingå i din Git-databas):

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

Filen composer.json ska se ut så här:

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

Alternativ 3: Delad Git

Den här arkitekturen använder fyra Git-databaser för att lagra kod:

Så här konfigurerar du det här alternativet:

Alternativ 4: Monorepo (rekommenderas)

Denna strategi liknar i hög grad hur Magento Open Source Git-databasen fungerar.

All kod utvecklas och testas i en enda databas. Automatisering destillerar paket från denna enda databas, som kan installeras på UAT- och produktionsmiljöer med Composer.

Med monorepo-alternativet kan du enkelt arbeta i en enda databas, samtidigt som du får flexibiliteten att komponera instanser med paket.

Versionshantering och paketering sker genom automatisering med GitHub-åtgärder eller GitLab-åtgärder.

Mer information om den här automatiseringen finns i följande resurser:

Blanda inte strategier

Det är inte tillrådligt att använda en kombinerad metod med Composer för GRA-paket och katalogen app/ för varumärkes- eller regionpaket.

Du får inte bara alla fördelar utan även alla nackdelar för båda metoderna. Du bör välja det ena eller det andra (Git eller Composer) för att arbeta optimalt.

Lösningar att undvika