管理第三方扩展
扩展或自定义Adobe Commerce行为的代码称为扩展。 您可以选择在Commerce Marketplace或其他扩展分发系统上打包和分发扩展。
扩展包括:
- 模块(扩展Adobe Commerce功能)
- 主题(更改店面和管理员的外观)
- 语言包(将店面和管理员本地化)
本主题介绍如何使用命令行界面管理您从Commerce Marketplace为 内部部署 项目购买的第三方扩展。 有关云基础架构项目,请参阅管理扩展。
您可以使用相同的过程安装 any 扩展;您只需要该扩展的编辑器名称和版本。 要找到它,请打开扩展名的composer.json
文件并记下"name"
和"version"
的值。
安装
安装之前,您可能需要:
-
备份数据库。
-
启用维护模式:
code language-bash bin/magento maintenance:enable
要安装扩展,您必须:
-
从Commerce Marketplace或其他扩展开发人员处获取扩展。
-
如果从Commerce Marketplace安装扩展,请确保
composer.json
文件中存在repo.magento.com
存储库:code language-bash "repositories": [ { "type": "composer", "url": "https://repo.magento.com/" } ]
-
获取扩展的编辑器名称和版本。
-
使用扩展名的名称和版本更新项目中的
composer.json
文件。 -
验证扩展是否已正确安装。
-
启用并配置该扩展。
获取扩展信息
如果您已经知道扩展的编辑器名称和版本,请跳过此步骤,继续更新您的composer.json
文件。
要从Commerce Marketplace中获取扩展的编辑器名称和版本,请执行以下操作:
-
使用您购买扩展所用的用户名和密码登录Commerce Marketplace。
-
单击右上角的 您的姓名 > 我的个人资料。
-
单击 我的购买次数。
-
找到要安装的扩展,并记下组件名称和版本。
composer.json
文件中找到_any_扩展的编辑器名称和版本(无论您是在Commerce Marketplace上还是在其他位置购买的)。更新编辑器依赖项
将扩展名的名称和版本添加到您的composer.json
文件:
-
导航到项目目录并更新
composer.json
文件。code language-bash composer require <component-name>:<version>
例如,
code language-bash composer require j2t/module-payplug:2.0.2
-
输入您的身份验证密钥。 您的公钥是您的用户名;您的私钥是您的密码。
-
等待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
选项清除静态视图文件。
-
启用扩展并清除静态视图文件:
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.
-
注册扩展:
code language-bash bin/magento setup:upgrade
-
重新编译项目:在生产模式下,您可能会收到一条消息“请重新运行Magento编译命令”。 应用程序不会提示您以开发人员模式运行compile命令。
code language-bash bin/magento setup:di:compile
-
验证扩展是否已启用:
code language-bash bin/magento module:status J2t_Payplug
您应该会看到验证扩展是否已不再禁用的输出:
code language-none Module is enabled
-
清理缓存:
code language-bash bin/magento cache:clean
-
根据需要在Admin中配置该扩展。
bin/magento cache:flush
。升级
要更新或升级模块或扩展,请执行以下操作:
-
从Marketplace或其他扩展开发人员下载更新的文件。 记下模块名称和版本。
-
将内容导出到应用程序根目录。
-
如果模块存在编辑器包,请运行以下任一操作。
每个模块名称更新:
code language-bash composer update vendor/module-name
每个版本更新:
code language-bash composer require vendor/module-name ^x.x.x
-
运行以下命令以升级、部署和清理缓存。
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
卸载
您应该联系扩展供应商以获取有关删除第三方扩展的说明。 说明应提供以下信息:
- 如何还原数据库表更改
- 如何还原数据库数据更改
- 应删除或还原哪些文件
以下说明提供了有关卸载第三方扩展的常规信息:
-
从您的Adobe Commerce项目存储库中删除该扩展。
-
对于基于编辑器的扩展,请从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>
-
-
如果
config.php
文件在Adobe Commerce项目存储库中受源代码管理,请从config.php
文件中删除该扩展。 -
测试本地数据库,确保供应商提供的说明按预期工作。
-
验证扩展是否已正确禁用,以及您的网站在暂存环境中是否可按预期运行。
-
将更改部署到生产环境。