文件Commerce實施行動手冊

全球參考架構範例

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

建立對象：

  • 經驗豐富
  • 開發人員

本主題說明組織全域參考架構(GRA)程式碼基底的常見方式。 雖然偏好使用個別套件選項，但某些情況需要其他選項之一，如下所述。

定義

  • 全域參考架構(GRA)：也稱為白色標籤架構或通用程式碼基底。 這是多執行個體設定的模組發佈架構。
  • 多重執行個體設定：相同使用者端針對不同的地區或品牌使用不同的Adobe Commerce安裝。 每個安裝都具有共用模組和獨特模組。
  • 單一執行個體安裝程式：只有一個Adobe Commerce安裝。 不同的測試環境可能會存在原始程式碼的多個副本，但生產程式碼只有一個版本。

選項1：個別套件

請參閱Composer專案結構設定此方法的最佳實務。

說明全域參考架構之個別套件選項的圖表

管理GRA Composer套件的最靈活方式是透過中繼套件。 中繼封裝僅包含composer.json檔案，這會定義其他封裝相依性。 使用Private Packagist存放庫建立中繼套件。

主要專案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"
    }
}

每個模組、語言套件、主題和程式庫都有自己的Git存放庫。 每個Git存放庫都會自動同步至私人Packagist存放庫，並在Git存放庫的根目錄中只要有composer.json檔案就產生套件。

選項2：大量套件

以下是單一Composer套件中多個模組的範例。

大量套件只能包含相同型別的套件。 例如，如果您有Adobe Commerce模組、主題、語言套件和程式庫的多個套件，則必須為每種型別建立個別的大量套件。

廠商目錄內的檔案結構看起來應該像下面的範例。 不過，請檢查您的專案，檢視應包含在您的Git存放庫中的專案)：

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

composer.json檔案應該如下所示：

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

選項3：分割Git

此架構使用四個Git存放庫來儲存程式碼：

  • core：包含Adobe Commerce核心安裝。 用於升級Adobe Commerce版本。
  • GRA：包含GRA程式碼。 所有GRA模組、語言套件、白色標籤主題和程式庫。
  • brand/region：每個品牌或地區都有自己的存放庫，只有品牌或地區特定程式碼。
  • release：以上所有專案已合併至此Git存放庫。 此處只允許合併認可。

說明全域參考架構分割Git選項的圖表

若要設定此選項：

  1. 在Git中建立四種存放庫型別。 僅建立core和GRA存放庫一次。 為每個品牌建立一個brand/region和一個release存放庫。

    建議的存放庫名稱：

    • m2-core
    • m2-gra
    • m2-region-x/m2-brand-x （例如，m2-emea/m2-adobe）
    • m2-release-region-x/m2-release-brand-x （例如，m2-release-emea/m2-release-adobe）

  2. 建立release/目錄並執行下列動作，為所有存放庫建立共用Git記錄。

    code language-bash 
    git init
git remote add origin git@github.com:example-client/m2-release-brand-x.git
git remote add core git@github.com:example-client/m2-core.git
git remote add gra git@github.com:example-client/m2-gra.git
git remote add region-x git@github.com:example-client/m2-region-x.git
touch .gitkeep
git add .gitkeep
git commit -m 'initialize repository'
git push -u origin master
git push core master
git push gra master
git push region-x master

  3. 將每個存放庫（core除外）複製至您電腦的不同目錄中。

    code language-bash 
    git clone git@github.com:example-client/m2-release-brand-x.git
git clone git@github.com:example-client/m2-region-x.git
git clone git@github.com:example-client/m2-gra.git

  4. 安裝Adobe Commerce與撰寫器。 移除.gitignore檔案、新增core遠端、新增並認可程式碼，以及推播。

    code language-bash 
    composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition m2-core
cd m2-core
git init
rm .gitignore
git remote add origin git@github.com:example-client/m2-core.git
git fetch
git checkout .gitkeep
git add --all
git commit -m 'install Adobe Commerce'
git push

  5. 在GRA存放庫中，建立下列目錄：

    • app/code/
    • app/design/
    • app/i18n/
    • lib/

  6. 新增程式碼。 移除.gitignore檔案、新增並認可程式碼、新增遠端及推播。

  7. 在brand/region存放庫中。 執行GRA存放庫中的相同操作，並記住檔案必須是唯一的。 您無法在此存放庫和GRA存放庫中同時包含相同檔案。

  8. 在release存放庫中，套用合併。

    code language-bash 
    git clone git@github.com:example-client/m2-release-brand-x.git
cd m2-release-brand-x
git remote add core git@github.com:example-client/m2-core.git
git remote add gra git@github.com:example-client/m2-gra.git
git remote add region-x git@github.com:example-client/m2-region-x.git
git fetch --all
git merge core/master gra/master brand-a/master
git push

  9. 移除.gitkeep檔案。

  10. 將release存放庫部署到生產、測試、QA和開發伺服器。 升級core、GRA和brand程式碼同樣可以輕鬆執行下列命令：

    code language-bash 
    git fetch --all
git merge core/master gra/master brand-a/master
git push

選項4：Monorepo （建議）

此策略相當模擬Magento Open SourceGit存放庫的運作方式。

所有程式碼都在單一存放庫中開發和測試。 自動化會從此單一存放庫擷取套件，這些套件可以使用Composer安裝在UAT和生產環境中。

說明全域參考架構之monorepo選項的圖表

monorepo選項可讓您在單一存放庫中輕鬆工作，同時提供使用套件構成執行個體的靈活性。

版本設定和封裝蒸餾是使用GitHub動作或GitLab動作透過自動化完成的。

說明全域參考架構之monorepo選項的圖表

如需此自動化的詳細資訊，請參閱下列資源：

TIP
設定monorepo是進階功能，但以最低的間接成本提供最大的彈性。

不要混合策略

不建議針對GRA套件使用Composer，針對品牌或地區套件使用app/目錄。

您不僅取得兩種方法的​ 優點，而且取得兩種方法的​ 缺點。 您應該挑選其中一項（Git或撰寫器），才能以最佳方式運作。

要避免的解決方案

  • 表示GRA或品牌的模組命名慣例

    代表GRA或品牌的命名模組導致缺乏彈性。 請改用Composer中繼資料來判斷模組所屬的群組。 例如，對於客戶VF，套件vf/meta-gra包含所有GRA套件的參考，可以使用composer require vf/meta-gra命令進行安裝。 封裝vf/meta-kipling包含所有Kipling特定封裝和vf/meta-gra封裝的參考。 例如，模組名為vf/module-sales和vf/module-sap。 此命名慣例可讓您在品牌和GRA狀態之間移動套件，且影響較低。

  • 每個執行個體的Adobe Commerce核心升級

    為不同品牌或地區排程Adobe Commerce核心升級（包括修補程式升級），以儘可能緊密地一起執行。 由於相容性限制，針對共用模組支援多個Adobe Commerce版本會導致模組出現分叉現象，並使維護工作增加一倍多。 在繼續定期開發之前，請確定所有執行個體都在相同的Adobe Commerce版本上執行，以防止工作量增加。

recommendation-more-help
754cbbf3-3a3c-4af3-b6ce-9d34390f3a60