Yii2依赖注入,配置和继承

问题描述 投票:2回答:1

假设我有这样的配置(来自official guide的片段):

$config = [
    // ...
    'container' => [
        'definitions' => [
            'yii\widgets\LinkPager' => ['maxButtonCount' => 5],
        ],
    ],
    // ...
];

我创建了一个名为FancyLinkPager的类:

class FancyLinkPager extends \yii\widgets\LinkPager
{
    // ...
}

当我像这样创建类FancyLinkPager的对象时(请忽略$ pagination对象,这是为了正确):

$pagination     = \Yii::createObject(Pagination::class);
$linkPager      = \Yii::createObject(['class' => LinkPager::class, 'pagination' => $pagination]);
$fancyLinkPager = \Yii::createObject(['class' => FancyLinkPager::class, 'pagination' => $pagination]);
$linkPager->maxButtonCount; // 5 as configured
$fancyLinkPager->maxButtonCount; // 10 as LinkPager's default

我的问题是我希望$ fancyLinkPager-> maxButtonCount配置为5。我知道我可以在配置中添加另一行或调整它以指定我的自定义类,但它不适合我,因为:

  1. 我想保留代码DRY
  2. 这是我的需求的一个过于简单的例子 - 在现实世界中,你不希望有多个LinkPager的子类,但它很可能是其他对象

我的问题是:是否有任何框架支持的方法来实现这一目标?我想出的解决方案是:

  1. 在FancyLinkPager(或其他中间类或特征)中破解自定义__construct,以便它可以查看App的配置并在实例上调用Yii :: configure,但我找不到以通用方式执行此操作的好方法
  2. 使用“setup”对象向FancyLinkPager注入依赖项,如LinkPagerSettings,并在我的配置的容器部分配置该类,但是使用vanilla LinkPager实例也会遇到一些麻烦

也许唯一真正的解决方案是创建我自己的yii \ di \ Container实现,允许从父类继承配置,但在我深入研究之前,我想知道我是否没有忽略某些东西。

php inheritance dependency-injection yii2
1个回答
0
投票

最后,我想出了自己的DI容器实现,引入了新的可配置属性:

public $inheritableDefinitions = [];

全班代码:

<?php

namespace app\di;

/**
 * @inheritdoc
 */
class Container extends \yii\di\Container
{
    /**
     * @var array inheritable object configurations indexed by class name
     */
    public $inheritableDefinitions = [];

    /**
     * @inheritdoc
     *
     * @param string $class
     * @param array $params
     * @param array $config
     *
     * @return object the newly created instance of the specified class
     */
    protected function build($class, $params, $config) {
        $config = $this->mergeInheritedConfiguration($class, $config);

        return parent::build($class, $params, $config);
    }

    /**
     * Merges configuration arrays of parent classes into configuration of newly created instance of the specified class.
     * Properties defined in child class (via configuration or property declarations) will not get overridden.
     *
     * @param string $class
     * @param array $config
     *
     * @return array
     */
    protected function mergeInheritedConfiguration($class, $config) {
        if (empty($this->inheritableDefinitions)) {
            return $config;
        }

        $inheritedConfig = [];
        /** @var \ReflectionClass $reflection */
        list($reflection) = $this->getDependencies($class);

        foreach ($this->inheritableDefinitions as $parentClass => $parentConfig) {
            if ($class === $parentClass) {
                $inheritedConfig = array_merge($inheritedConfig, $parentConfig);
            } else if (is_subclass_of($class, $parentClass)) {
                /** @var \ReflectionClass $parentReflection */
                list($parentReflection) = $this->getDependencies($parentClass);

                // The "@" is necessary because of possible (and wanted) array to string conversions
                $notInheritableProperties = @array_diff_assoc($reflection->getDefaultProperties(),
                    $parentReflection->getDefaultProperties());

                // We don't want to override properties defined specifically in child class
                $parentConfig    = array_diff_key($parentConfig, $notInheritableProperties);
                $inheritedConfig = array_merge($inheritedConfig, $parentConfig);
            }
        }

        return array_merge($inheritedConfig, $config);
    }
}

这是如何使用它来完成问题中描述的LinkPager的自定义:

'container'  => [
    'inheritableDefinitions' => [
        'yii\widgets\LinkPager'  => ['maxButtonCount' => 5],
    ],
],

现在,如果我创建一个扩展FancyLinkPager的类yii\widgets\LinkPager,DI容器将合并默认配置:

$pagination     = \Yii::createObject(Pagination::class);
$linkPager      = \Yii::createObject(['class' => LinkPager::class, 'pagination' => $pagination]);
$fancyLinkPager = \Yii::createObject(['class' => FancyLinkPager::class, 'pagination' => $pagination]);
$linkPager->maxButtonCount; // 5 as configured
$fancyLinkPager->maxButtonCount; // 5 as configured - hurrah!

我还考虑了qiangxue's comment关于在类定义中显式设置默认属性值的问题,所以如果我们这样声明FancyLinkPager类:

class FancyLinkPager extends LinkPager
{
    public $maxButtonCount = 18;
}

属性设置将得到尊重:

$linkPager->maxButtonCount; // 5 as configured
$fancyLinkPager->maxButtonCount; // 18 as declared

要在应用程序中交换默认DI容器,您必须在条目脚本中的某处显式设置Yii::$container

Yii::$container = new \app\di\Container();
© www.soinside.com 2019 - 2024. All rights reserved.