PHP 面向对象设计：内部方法与协变性下的代码复用与类型安全-php教程-PHP中文网

PHP 面向对象设计：内部方法与协变性下的代码复用与类型安全

本文探讨在 php 面向对象编程中，如何平衡严格的类型声明、代码复用和协变性规则。针对继承体系中内部辅助方法返回类型与子类期望类型不一致的问题，我们提出一种解决方案：对内部（protected/private）方法放宽返回类型声明（移除或使用 `mixed`），从而在不牺牲公共 api 类型安全和代码复用性的前提下，解决协变性冲突。该方法确保了代码的整洁与可维护性。

在构建复杂的 PHP 应用程序时，面向对象设计原则如代码复用、类型安全以及Liskov替换原则（LSP）至关重要。然而，在实践中，特别是在处理继承关系和工厂模式时，我们可能会遇到挑战，即如何在保持代码复用性的同时，严格遵守PHP的协变性（Covariance）和逆变性（Contravariance）规则，并确保类型声明的准确性。

理解问题：协变性冲突与代码复用困境

考虑一个常见的场景：我们有一组基类和子类，其中子类需要创建特定类型的对象。例如，BaseFooClass 和多个 ChildFooClassX，以及 BaseBarClass 和多个 ChildBarClassX。每个 ChildBarClassX 负责根据一些输入数据创建对应的 ChildFooClassX 实例。

为了避免在每个 ChildBarClassX 中重复数据获取和完整性检查的逻辑，我们通常会在 BaseBarClass 中定义一个 protected 辅助方法，例如 getFooBase，来封装这些通用逻辑。

原始代码结构可能如下所示：

立即学习“PHP免费学习笔记（深入）”；

class BaseFooClass {
    protected $keys = [];
    private $map = [];
    public function __construct($keyValuePairs) {
        foreach($this->keys as $key => $value) {
            $this->map[$key] = $keyValuePairs[$key] ?? null;
        }
    }
}

class ChildFooClass1 extends BaseFooClass {
    protected $keys = ['foo1_a', 'foo1_b'];
}

class ChildFooClass2 extends BaseFooClass {
    protected $keys = ['foo2_a', 'foo2_b', 'foo2_c'];
}

// ... 存在大量 ChildFooClass 

abstract class BaseBarClass {
    protected $classIndex;
    protected function getFooBase(int $dataIndex) : ?BaseFooClass // 返回类型为 ?BaseFooClass
    {
        // GetRemoteData 和 checkDataIntegrity 是假设的全局函数
        $keyValuePairs = GetRemoteData($this->classIndex, $dataIndex);
        if (checkDataIntegrity($keyValuePairs)) {
            $class = "ChildFooClass" . $this->classIndex;
            return new $class($keyValuePairs); // 实际返回的是 ChildFooClassX
        }
        return null;
    }
}

class ChildBarClass1 extends BaseBarClass {
    protected $classIndex=1;
    public function getFoo(int $dataIndex) : ?ChildFooClass1 // 期望返回 ?ChildFooClass1
    {
        // 这一行代码违反了协变性规则
        return $this->getFooBase($dataIndex); 
    }
}

class ChildBarClass2 extends BaseBarClass {
    protected $classIndex=2;
    public function getFoo($someInput) : ?ChildFooClass2 // 期望返回 ?ChildFooClass2
    {
        $dataIndex = $this->calculateDataIndex($someInput);
        // 这一行代码也违反了协变性规则
        return $this->getFooBase($dataIndex);
    }
}

登录后复制

上述代码中，BaseBarClass::getFooBase 方法被声明为返回 ?BaseFooClass。然而，在 ChildBarClass1::getFoo 中，它期望返回 ?ChildFooClass1，而 getFooBase 在运行时实际返回的也确实是 ChildFooClass1。尽管逻辑上是正确的，但从类型系统角度看，ChildBarClass1::getFoo 的返回类型 ?ChildFooClass1 比 BaseBarClass::getFooBase 的返回类型 ?BaseFooClass 更窄。当子类方法重写父类方法时，其返回类型可以更窄（协变），但在这里，ChildBarClass1::getFoo 并没有重写 getFooBase，而是调用了它。问题在于，如果 getFooBase 返回类型被声明为 ?BaseFooClass，而 getFoo 尝试将其结果直接赋值给一个类型为 ?ChildFooClass1 的变量，PHP的类型检查器会认为这可能是一个类型不匹配的潜在问题，尤其是在严格类型模式下。

更直接的协变性冲突在于，如果 getFoo 方法本身是重写了 BaseBarClass 中的一个抽象或具体方法，那么它的返回类型必须是 BaseBarClass 中对应方法返回类型的子类型。而这里 getFooBase 是一个内部辅助方法，它的类型声明反而成了瓶颈。

我们希望满足以下三点：

严格类型声明：ChildBarClassX::getFoo 必须返回 ChildFooClassX，同时 BaseBarClass::getFooBase 返回的也必须是 BaseFooClass 或其子类。
代码复用：GetRemoteData 和 checkDataIntegrity 等通用逻辑不应在每个 getFoo 方法中重复。
遵守协变性：避免因类型声明而引发的协变性冲突。

解决方案：放宽内部辅助方法的返回类型

解决此问题的关键在于认识到 getFooBase 是一个 protected 辅助方法，它不是 BaseBarClass 公共API的一部分。它的主要作用是封装内部逻辑，并为子类提供一个统一的构建 Foo 对象的方式。因此，我们可以对其返回类型声明采取更灵活的策略。

核心思路：移除 getFooBase 的返回类型声明，或者在 PHP 8+ 中使用 mixed。

代码小浣熊

代码小浣熊是基于商汤大语言模型的软件智能研发助手，覆盖软件需求分析、架构设计、代码编写、软件测试等环节

查看详情

修改后的 BaseBarClass 如下：

abstract class BaseBarClass {
    protected $classIndex;

    // 解决方案：移除返回类型声明，或使用 : mixed (PHP 8+)
    protected function getFooBase(int $dataIndex) // 注意：移除了 : ?BaseFooClass
    {
        $keyValuePairs = GetRemoteData($this->classIndex, $dataIndex);
        if (checkDataIntegrity($keyValuePairs)) {
            $class = "ChildFooClass" . $this->classIndex;
            // 运行时，这里会返回正确的 ChildFooClassX 实例
            return new $class($keyValuePairs); 
        }
        return null;
    }
}

class ChildBarClass1 extends BaseBarClass {
    protected $classIndex=1;
    public function getFoo(int $dataIndex) : ?ChildFooClass1 
    {
        // 现在，这里不再违反协变性规则
        // 因为 getFooBase 没有声明具体的返回类型，或者声明为最宽泛的 mixed
        return $this->getFooBase($dataIndex); 
    }
}

class ChildBarClass2 extends BaseBarClass {
    protected $classIndex=2;
    public function getFoo($someInput) : ?ChildFooClass2
    {
        $dataIndex = $this->calculateDataIndex($someInput);
        return $this->getFooBase($dataIndex);
    }
}

登录后复制

解释与原理：

满足类型声明要求 (1)：
- ChildBarClassX::getFoo 仍然严格声明其返回类型为 ?ChildFooClassX。
- BaseBarClass::getFooBase 在运行时依然会返回 BaseFooClass 的一个子类实例。虽然其方法签名不再强制声明为 ?BaseFooClass，但其内部逻辑确保了返回值的兼容性。PHP 的类型系统会在 ChildBarClassX::getFoo 内部进行类型检查。当 getFoo 方法将 getFooBase 的返回值作为其自身的返回值时，PHP 会检查该返回值是否与 getFoo 声明的 ?ChildFooClassX 类型兼容。如果 getFooBase 意外返回了不兼容的类型，将会抛出 TypeError。
满足代码复用要求 (2)：
- GetRemoteData 和 checkDataIntegrity 等共享逻辑仍然封装在 getFooBase 中，避免了重复代码。
遵守协变性规则 (3)：
- 通过移除 getFooBase 的返回类型声明（或使用 mixed），我们避免了 getFooBase 拥有一个比 ChildBarClassX::getFoo 所需类型更宽泛但又具体化的返回类型。
- 当 getFooBase 没有返回类型声明时，PHP 认为它返回的是 mixed（在 PHP 7.x 中），这是一种最宽泛的类型。mixed 类型与任何其他类型都是兼容的，因此将 getFooBase 的结果赋值给 ChildFooClassX 类型的变量不会直接导致协变性冲突。
- 在 PHP 8 及更高版本中，明确使用 : mixed 作为返回类型可以更好地表达这种意图，即该方法可以返回任何类型的值。

优势与注意事项

优势：

保持公共 API 的类型安全：ChildBarClassX::getFoo 方法作为类的公共或受保护接口，其返回类型仍然是严格且具体的，这对于使用这些类的客户端代码来说是清晰和安全的。
增强代码复用性：核心逻辑集中在 getFooBase 中，减少了子类中的重复代码。
遵循 OOP 原则：在内部实现细节上保持灵活性，同时在外部接口上保持严格性，符合封装原则。

注意事项：

仅适用于内部方法：此方法主要适用于 protected 或 private 的辅助方法。对于 public 方法，通常应尽可能保持严格和明确的返回类型，因为它们构成了类的公共契约，对外部使用者有直接影响。
运行时类型检查：虽然移除了 getFooBase 的返回类型声明，但 PHP 仍然会在运行时对 ChildBarClassX::getFoo 的返回值进行类型检查。这意味着如果 getFooBase 真的返回了与 ChildBarClassX::getFoo 声明不兼容的值，程序会在运行时抛出 TypeError。
静态分析工具：对于没有返回类型声明的方法，一些静态分析工具可能无法提供最精确的类型推断。然而，由于 ChildBarClassX::getFoo 仍然有严格的返回类型，静态分析工具仍能在此处进行有效检查。使用 mixed 可以稍微改善静态分析的清晰度。

总结

在 PHP 面向对象设计中，当面临内部辅助方法与子类方法之间因协变性规则而产生的类型声明冲突时，一种实用且有效的方法是放宽内部辅助方法的返回类型声明。通过移除 protected 或 private 方法的返回类型，或明确使用 PHP 8+ 的 mixed 类型，我们可以在不牺牲公共 API 的类型安全性和代码复用性的前提下，解决这一矛盾。这种策略允许我们在内部实现中保持灵活性，同时确保外部接口的清晰和可靠，从而构建出更健壮、更易于维护的 PHP 应用程序。

以上就是PHP 面向对象设计：内部方法与协变性下的代码复用与类型安全的详细内容，更多请关注php中文网其它相关文章！