管理協力廠商擴充功能

擴充或自訂Adobe Commerce行為的程式碼稱為擴充功能。 您可以選擇在Commerce Marketplace或其他擴充功能散發系統上封裝和散發擴充功能。

擴充功能包括:

  • 模組(擴充Adobe Commerce功能)
  • 佈景主題(變更店面外觀和風格,以及管理員)
  • 語言套件(將店面和管理員本地化)

本主題說明如何使用命令列介面來管理您從Commerce Marketplace為​ 內部部署 ​專案購買的協力廠商擴充功能。 若為雲端基礎結構專案,請參閱管理擴充功能

您可以使用相同的程式來安裝​ any ​擴充功能;您只需要該擴充功能的撰寫器名稱和版本。 若要尋找它,請開啟擴充功能的composer.json檔案,並記下"name""version"的值。

安裝

安裝之前,您可能需要:

  1. 備份您的資料庫。

  2. 啟用維護模式:

    code language-bash
    bin/magento maintenance:enable
    

若要安裝擴充功能,您必須:

  1. 從Commerce Marketplace或其他擴充功能開發人員取得擴充功能。

  2. 如果您從Commerce Marketplace安裝擴充功能,請確定composer.json檔案中有repo.magento.com存放庫:

    code language-bash
    "repositories": [
        {
            "type": "composer",
            "url": "https://repo.magento.com/"
        }
    ]
    
  3. 取得擴充功能的撰寫器名稱和版本。

  4. 以副檔名的名稱和版本更新專案中的composer.json檔案。

  5. 確認擴充功能已正確安裝。

  6. 啟用並設定擴充功能。

取得擴充功能資訊

如果您已經知道擴充功能的撰寫器名稱和版本,請略過此步驟,然後繼續更新您的composer.json檔案

若要從Commerce Marketplace取得擴充功能的撰寫器名稱和版本:

  1. 以您購買擴充功能所用的使用者名稱和密碼登入Commerce Marketplace

  2. 在右上角,按一下​ 您的姓名 > 我的設定檔

    存取您的Marketplace帳戶

  3. 按一下​ 我的購買

    市集購買記錄

  4. 尋找您要安裝的擴充功能,並記下元件名稱和版本。

    技術詳細資料顯示擴充功能的撰寫器名稱

TIP
或者,您可以在擴充功能的composer.json檔案中找到​_any_​擴充功能的撰寫器名稱和版本(無論您是透過Commerce Marketplace或其他方式購買)。

更新撰寫器相依性

新增擴充功能的名稱和版本至composer.json檔案:

  1. 導覽至您的專案目錄並更新您的composer.json檔案。

    code language-bash
    composer require <component-name>:<version>
    

    例如,

    code language-bash
    composer require j2t/module-payplug:2.0.2
    
  2. 輸入您的驗證金鑰。 您的公開金鑰是您的使用者名稱;您的私密金鑰是您的密碼。

  3. 請等待Composer完成更新您的專案相依性,並確認沒有任何錯誤:

    code language-none
    Updating dependencies (including require-dev)
    Package operations: 1 install, 0 updates, 0 removals
      - Installing j2t/module-payplug (2.0.2): Downloading (100%)
    Writing lock file
    Generating autoload files
    

驗證安裝

若要確認擴充功能是否已正確安裝,請執行以下命令:

bin/magento module:status J2t_Payplug

依預設,擴充功能可能已停用:

Module is disabled

副檔名格式為<VendorName>_<ComponentName>;此格式與撰寫器名稱不同。 使用此格式來啟用擴充功能。 如果您不確定擴充功能名稱,請執行:

bin/magento module:status

檢視「已停用模組清單」下的擴充功能。

啟用

除非您先清除產生的靜態檢視檔案,否則有些副檔名無法正常運作。 啟用副檔名時,請使用--clear-static-content選項清除靜態檢視檔案。

  1. 啟用擴充功能並清除靜態檢視檔案:

    code language-bash
    bin/magento module:enable J2t_Payplug --clear-static-content
    

    您應該會看到下列輸出:

    code language-none
    The following modules have been enabled:
    - J2t_Payplug
    
    To make sure that the enabled modules are properly registered, run 'setup:upgrade'.
    Cache cleared successfully.
    Generated classes cleared successfully. Please run the 'setup:di:compile' command to generate classes.
    Generated static view files cleared successfully.
    
  2. 註冊擴充功能:

    code language-bash
    bin/magento setup:upgrade
    
  3. 重新編譯專案:在生產模式中,您可能會收到「請重新執行Magento編譯命令」的訊息。 應用程式不會提示您以開發人員模式執行compile指令。

    code language-bash
    bin/magento setup:di:compile
    
  4. 確認擴充功能已啟用:

    code language-bash
    bin/magento module:status J2t_Payplug
    

    您應該會看到驗證擴充功能是否已不再停用的輸出:

    code language-none
    Module is enabled
    
  5. 清除快取:

    code language-bash
    bin/magento cache:clean
    
  6. 視需要在Admin中設定擴充功能。

TIP
如果您在瀏覽器中載入店面時發生錯誤,請使用下列命令清除快取: bin/magento cache:flush

升級

若要更新或升級模組或擴充功能:

  1. 從Marketplace或其他擴充功能開發人員下載更新的檔案。 記下模組名稱和版本。

  2. 將內容匯出至應用程式根目錄。

  3. 如果模組存在撰寫器套件,請執行以下其中一項作業。

    每個模組名稱更新:

    code language-bash
    composer update vendor/module-name
    

    每個版本更新:

    code language-bash
    composer require vendor/module-name ^x.x.x
    
  4. 執行以下命令以升級、部署和清除快取。

    code language-bash
    bin/magento setup:upgrade --keep-generated
    
    code language-bash
    bin/magento setup:static-content:deploy
    
    code language-bash
    bin/magento cache:clean
    

解除安裝

請聯絡擴充功能供應商,取得移除協力廠商擴充功能的指示。 指示應提供下列資訊:

  • 如何還原資料庫表格變更
  • 如何還原資料庫資料變更
  • 應該移除或還原哪些檔案
CAUTION
在非生產環境​_上執行解除安裝步驟_,並在部署到生產環境之前進行完整測試。

下列指示提供解除安裝協力廠商擴充功能的一般資訊:

  1. 從您的Adobe Commerce專案存放庫移除擴充功能。

    • 對於以Composer為基礎的副檔名,請從您的Adobe Commerce composer.json檔案中移除該副檔名。

      code language-bash
      composer remove <component-name>
      
    • 對於非Composer型副檔名,請從您的Adobe Commerce專案存放庫中移除實體檔案。

      code language-bash
      rm -rf app/code/<vendor-name>/<component-name>
      
  2. 如果config.php檔案是在您的Adobe Commerce專案存放庫中的原始檔控制之下,請從config.php檔案中移除副檔名。

  3. 測試您的本機資料庫,確保廠商提供的指示如預期般運作。

  4. 確認擴充功能已正確停用,且您的網站在中繼環境中可如預期般運作。

  5. 將變更部署到您的生產環境。

recommendation-more-help
0f8e7db5-0e9c-4002-a5b8-a0088077d995