di.xml 文件配置对象管理器注入哪些依赖项。 您还可以使用 di.xml 指定敏感配置设置。
使用区域和应用入口位置
每个模块都可以有一个全局的和特定于区域的 di.xml 文件。 Magento 读取系统中声明的所有 di.xml 配置文件,并通过附加所有节点将它们合并在一起。
作为一般规则,区域特定的 di.xml 文件应配置表示层的依赖项,而模块的全局 di.xml 文件应配置其余的依赖项。
Magento 在以下阶段加载配置:
初始 (app/etc/di.xml)
全局 (<moduleDir>/etc/di.xml)
区域特定 (<moduleDir>/etc/<area>/di.xml)
这些领域是:
- adminhtml
- frontend
- graphql
- webapi_rest
- webapi_soap
- crontab
在引导过程中,每个应用程序入口点都会为请求的区域加载适当的 di.xml 文件。
例子:
在 index.php 中,\Magento\Framework\App\Http 类根据 URL 中提供的前端名称加载区域。
在 static.php 中,\Magento\Framework\App\StaticResource 类也根据请求中的 URL 加载区域。
在 cron.php 中,\Magento\Framework\App\Cron 类总是加载 crontab 区域。
类型配置
类型配置描述了一个对象的生活方式以及如何实例化它。
您可以通过以下方式在 di.xml 配置节点中配置类型:
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
<virtualType name="moduleConfig" type="Magento\Core\Model\Config">
<arguments>
<argument name="type" xsi:type="string">system</argument>
</arguments>
</virtualType>
<type name="Magento\Core\Model\App">
<arguments>
<argument name="config" xsi:type="object">moduleConfig</argument>
</arguments>
</type>
</config>
前面的示例声明了以下类型:
moduleConfig:扩展 Magento\Core\Model\Config 类型的虚拟类型。
Magento\Core\Model\App:此类型的所有实例都接收一个 moduleConfig 实例作为依赖项。
Virtual types
虚拟类型允许您更改特定可注入依赖项的参数并更改特定类的行为。 这允许您使用自定义类,而不会影响依赖于原始类的其他类。
该示例为 Magento\Core\Model\Config 创建了一个虚拟类型,并将 system 指定为 type 的构造函数参数。
构造函数参数
您可以在参数节点的 di.xml 中配置类构造函数参数。 对象管理器在创建过程中将这些参数注入到类中。 XML 文件中配置的参数名称必须与配置类中构造函数中的参数名称相对应。
以下示例创建 Magento\Core\Model\Session 的实例,并将类构造函数参数 $sessionName 设置为 adminhtml 的值:
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
<type name="Magento\Core\Model\Session">
<arguments>
<argument name="sessionName" xsi:type="string">adminhtml</argument>
</arguments>
</type>
</config>
参数类型
节点格式:
<argument xsi:type="object">{typeName}</argument>
<argument xsi:type="object" shared="{shared}">{typeName}</argument>
创建 typeName 类型的实例并将其作为参数传入。 您可以将任何类名、接口名或虚拟类型作为 typeName 传递。
设置共享属性定义了创建的实例的生活方式。 请参阅对象生活方式配置。
string
节点格式:
<argument xsi:type="string">{strValue}</argument>
<argument xsi:type="string" translate="true">{strValue}</argument>
Magento 将此参数节点的任何值解释为字符串。
boolean
节点格式:
<argument xsi:type="boolean">{boolValue}</argument>
number
节点格式:
<argument xsi:type="number">{numericValue}</argument>
此类型的可接受值包括:整数、浮点数或数字字符串。
init_parameter
节点格式:
<argument xsi:type="init_parameter">{Constant::NAME}</argument>
这是由 Constant::NAME 表示的全局应用程序初始化参数。
const
节点格式:
<argument xsi:type="const">{Constant::NAME}</argument>
这是由 Constant::NAME 表示的常量值。
null
节点格式:
<argument xsi:type="null"/>
这表示空值。
array
节点格式:
节点格式如下:
<argument xsi:type="array">
<item name="someKey" xsi:type="<type>">someVal</item>
</argument>
Magento 使用与项目对应的元素构建一个数组,并将其作为参数传递。 数组可以包含无限数量的项,每个数组项可以是任何对象类型,包括数组本身。
当 Magento 合并给定范围的配置文件时,具有相同名称的数组参数会合并到一个新数组中。
当 Magento 稍后通过更具体的范围或通过代码加载新配置时,新配置中的任何数组定义将替换加载的配置而不是合并。
参数示例
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
<type name="Magento\Example\Type">
<arguments>
<!-- Pass simple string -->
<argument name="stringParam" xsi:type="string">someStringValue</argument>
<!-- Pass instance of Magento\Some\Type -->
<argument name="instanceParam" xsi:type="object">Magento\Some\Type</argument>
<!-- Pass true -->
<argument name="boolParam" xsi:type="boolean">1</argument>
<!-- Pass 1 -->
<argument name="intParam" xsi:type="number">1</argument>
<!-- Pass application init argument, named by constant value -->
<argument name="globalInitParam" xsi:type="init_parameter">Magento\Some\Class::SOME_CONSTANT</argument>
<!-- Pass constant value -->
<argument name="constantParam" xsi:type="const">Magento\Some\Class::SOME_CONSTANT</argument>
<!-- Pass null value -->
<argument name="optionalParam" xsi:type="null"/>
<!-- Pass array -->
<argument name="arrayParam" xsi:type="array">
<!-- First element is value of constant -->
<item name="firstElem" xsi:type="const">Magento\Some\Class::SOME_CONSTANT</item>
<!-- Second element is null -->
<item name="secondElem" xsi:type="null"/>
<!-- Third element is a subarray -->
<item name="thirdElem" xsi:type="array">
<!-- Subarray contains scalar value -->
<item name="scalarValue" xsi:type="string">ScalarValue</item>
<!-- and application init argument -->
<item name="globalArgument " xsi:type="init_parameter">Magento\Some\Class::SOME_CONSTANT</item>
</item>
</argument>
</arguments>
</type>
</config>
更多magento教程参考:
Magento2.x企业级开发实战
网友评论