Exemples d’architecture de référence globale

Cette rubrique décrit les méthodes courantes d’organisation d’une base de code architecture de référence globale (GRA). Bien que l’option packages distincts soit préférée, certaines situations nécessitent l’une des autres options décrites ci-dessous.

Définitions

Option 1 : packages distincts

Voir les meilleures pratiques pour configurer cette méthode dans la structure de projet du compositeur.

La méthode la plus souple pour gérer les modules du compositeur d’expérience visuelle passe par les métaphores. Les métaphores contiennent uniquement un fichier composer.json qui définit d’autres dépendances de package. Créez des modules à l’aide des référentiels Private Packagist.

Projet principal 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"
    }
}

Chaque module, module de langue, thème et bibliothèque possède son propre référentiel Git. Chaque référentiel Git se synchronise automatiquement avec le référentiel Packagist privé et y génère un module tant qu’il y a un fichier composer.json à la racine du référentiel Git.

Options 2 : packages en bloc

Vous trouverez ci-dessous un exemple de plusieurs modules dans un seul module de compositeur.

Un module en bloc ne peut inclure que des modules du même type. Par exemple, si vous disposez de plusieurs modules pour les modules, thèmes, modules de langue et bibliothèques Adobe Commerce, vous devez créer des modules en bloc distincts pour chaque type.

La structure de fichiers dans le répertoire du fournisseur doit ressembler à l’exemple suivant. Toutefois, vérifiez votre projet (pour savoir ce qui doit être inclus dans votre référentiel Git) :

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

Le fichier composer.json doit se présenter comme suit :

{
    "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 : Fractionner Git

Cette architecture utilise quatre référentiels Git pour stocker du code :

Pour configurer cette option :

Option 4 : Monorepo (recommandé)

Cette stratégie reproduit fidèlement le fonctionnement du référentiel Git du Magento Open Source.

Tout le code est développé et testé dans un seul référentiel. L’automatisation distribue des modules de ce référentiel unique, qui peuvent être installés sur UAT et dans les environnements de production à l’aide du compositeur.

L’option monorepo vous permet de travailler facilement dans un seul référentiel, tout en offrant la possibilité de composer des instances avec des packages.

Le contrôle de version et la distillation des packages s’effectuent par le biais de l’automatisation, à l’aide des actions GitHub ou des actions GitLab.

Consultez les ressources suivantes pour plus d’informations sur cette automatisation :

Ne pas mélanger de stratégies

Il n’est pas recommandé d’utiliser une approche combinée à l’aide du compositeur pour les packages GRA et du répertoire app/ pour les packages de marque ou de région.

Vous obtenez non seulement tous les avantages mais également tous les inconvénients des deux méthodes. Vous devez choisir l’un ou l’autre (Git ou Compositeur) pour un fonctionnement optimal.

Solutions à éviter