PHPStan和信条：$id从来不是写的，只读的

PHPStan 是一个用于 PHP 的静态分析工具，它可以帮助开发者在代码运行之前发现潜在的错误和问题。PHPStan 通过分析代码的结构和类型信息，提供了一系列的规则和检查，以确保代码的正确性和质量。

基础概念

信条（Doctrine）：在这里，信条指的是 PHPStan 中的一条规则或原则。信条 $id从来不是写的，只读的 意味着在代码中，变量 $id 应该被视为只读的，不应该被修改。

相关优势

1. 提高代码质量：通过强制变量为只读，可以减少意外的修改，从而降低引入错误的风险。
2. 增强代码可读性：明确的只读变量可以让其他开发者更容易理解代码的意图。
3. 便于维护：只读变量减少了代码的复杂性，使得代码更易于维护和调试。

类型

在 PHPStan 中，可以通过类型系统来声明变量的只读性。例如，可以使用 int、string 等基本类型，或者自定义类型来明确变量的用途和行为。

应用场景

1. 数据库主键：在处理数据库记录时，主键（如 $id）通常是只读的，因为它们是由数据库自动生成的。
2. 配置参数：某些配置参数在初始化后不应该被修改，以确保系统的稳定性。
3. 函数参数：某些函数的参数应该是只读的，以避免在函数内部被意外修改。

遇到问题及解决方法

问题：为什么 $id 被视为只读的？

原因：PHPStan 通过静态分析发现 $id 在代码中被多次赋值，这可能导致不可预期的行为和错误。

解决方法：

1. 检查赋值点：审查代码中所有对 $id 的赋值操作，确保只有必要的地方进行赋值。
2. 使用类型声明：在函数参数或变量声明时，明确指定其类型，并使用 readonly 关键字（如果 PHP 版本支持）。

function processId(int $id): void {
    // $id 在这里被视为只读
    echo $id;
}

// 错误的示例
function updateId(int $id): void {
    $id = 123; // PHPStan 会警告这里不应该修改 $id
}

1. 使用属性：在面向对象的编程中，可以将 $id 定义为类的只读属性。

class User {
    private int $id;

    public function __construct(int $id) {
        $this->id = $id;
    }

    public function getId(): int {
        return $this->id;
    }
}

通过这些方法，可以有效地遵循 PHPStan 的信条，确保 $id 变量的只读性，从而提高代码的可靠性和可维护性。