解决 Spatie Model States 属性未正确转换为对象的问题

本文旨在解决使用 Spatie/Laravel-Model-States 时，模型状态属性未自动转换为 `State` 对象，导致调用 `transitionTo()` 方法时报错的问题。核心原因在于模型创建或填充过程中，状态属性被字符串值覆盖。文章将深入分析问题根源，并提供三种有效的解决方案：限制状态字段填充、优化状态流设计以及实现状态属性的自定义 Mutator，以确保状态属性始终是正确的 `State` 对象实例。

问题概述：Spatie Model States 属性类型异常

在使用 Spatie/Laravel-Model-States 库管理模型状态时，开发者可能会遇到一个常见问题：尽管模型已正确配置了状态，但在特定场景下，状态字段（例如 status）并未被 Laravel 自动转换为 Spatie\ModelStates\State 派生对象，而是以字符串形式存在。这通常会导致在尝试调用 transitionTo() 方法时抛出 Call to a member function transitionTo() on string 的异常。

此问题尤其容易在通过 Model::create() 或 Model::fill() 方法批量创建或更新模型时出现，即使在应用程序的其他部分，相同的模型和状态转换逻辑能够正常工作。

模型与状态配置示例

为了更好地理解问题，我们首先回顾一下典型的 Spatie Model States 配置。

1. 基础状态类

所有具体状态类都继承自一个抽象的基础状态类，该类可能定义了所有允许的状态：

<?php

namespace App\States\ShiftPattern;

use Spatie\ModelStates\State;

abstract class ShiftPatternBaseState extends State
{
    public static array $states = [
        Approved::class,
        Draft::class,
        PendingApproval::class,
        Rejected::class,
    ];
}

2. 数据库迁移

模型状态通常对应数据库中的一个字符串字段：

public function up()
{
    Schema::table('shift_patterns', function (Blueprint $table) {
        $table->string('status')->default('draft')->after('booking_pay_rate_id');
    });
}

3. 模型实现

模型需要使用 HasStates Trait 并实现 registerStates() 方法来定义状态字段及其转换规则：

use Spatie\ModelStates\HasStates;
use App\States\ShiftPattern\ShiftPatternBaseState;
use App\States\ShiftPattern\Draft;
use App\States\ShiftPattern\Approved;
use App\States\ShiftPattern\PendingApproval;
use App\States\ShiftPattern\Rejected;
use App\States\ShiftPattern\Transitions\ToPendingApproval;
use App\States\ShiftPattern\Transitions\PendingApprovalToApproved;
use App\States\ShiftPattern\Transitions\ToRejected;

class ShiftPattern extends Model
{
    use HasStates; // ... 其他 Trait

    protected $fillable = ['name', 'status', /* ... 其他可填充字段 */]; // 注意 'status' 字段

    public function registerStates(): void
    {
        $this->addState('status', ShiftPatternBaseState::class)
            ->default(Draft::class)
            ->allowTransition([Draft::class, Rejected::class], PendingApproval::class, ToPendingApproval::class)
            ->allowTransition(PendingApproval::class, Approved::class, PendingApprovalToApproved::class)
            ->allowTransition(PendingApproval::class, Rejected::class, ToRejected::class);
    }
    // ... 其他模型方法
}

在上述配置中，ShiftPattern 模型拥有一个 status 字段，其默认状态为 Draft::class。

问题根源：属性填充与类型覆盖

当使用 ShiftPattern::create($request->attributes()) 这样的语句创建模型时，如果 $request->attributes() 数组中包含了 status 字段（例如 ['status' => 'pending-approval', ...]），就会触发问题。

Laravel 的 create() 方法大致流程如下：

1. 实例化模型： Laravel 创建一个新的 ShiftPattern 实例。
2. 默认状态初始化： 在模型实例化的生命周期中，Spatie Model States 库会介入，根据 registerStates() 中定义的默认值，将 status 字段正确地初始化为一个 Draft 状态对象。
3. 属性填充： 随后，Laravel 会使用传入的 $request->attributes() 数组来填充模型的属性。如果该数组中包含 'status' => 'pending-approval'，那么之前已设置为 Draft 对象的 status 属性，就会被字符串 'pending-approval' 覆盖。

此时，模型的 status 属性不再是 State 对象，而是一个简单的字符串。因此，当后续代码尝试调用 $shiftPattern->transitionTo(Approved::class) 时，就会在内部尝试对一个字符串调用方法，从而导致 Call to a member function transitionTo() on string 错误。

尝试通过 $shiftPattern->refresh() 或 $newShiftPattern = ShiftPattern::find($shiftPattern->id) 来重新加载模型，通常也无法解决问题，因为一旦模型被填充为字符串，刷新或重新查找只会从数据库中获取这个字符串值，而不会重新触发 Spatie Model States 的对象转换机制。

解决方案

针对上述问题，有以下几种解决方案：

方案一：限制状态字段的直接填充

最直接的方法是防止状态字段在模型创建或更新时被直接填充为字符串。

实现方式：

1. 从 $fillable 中移除 status 字段： 确保 status 字段不在模型的 $fillable 数组中，或者将其添加到 $guarded 数组中。
2. 手动设置和转换： 允许模型以其默认状态（通常是正确的对象类型）被创建，然后显式地通过 transitionTo() 方法进行状态转换。

示例代码：

class ShiftPattern extends Model
{
    use HasStates;

    // 确保 'status' 不在 $fillable 中，或者在 $guarded 中
    protected $guarded = ['id', 'status']; // 示例：将 'status' 标记为不可填充

    // ... registerStates() 方法不变

    public function createShiftPattern(CreateShiftPatternRequest $request)
    {
        $shiftPattern = $request->record->shiftPatterns()->create(
            // 确保 $request->attributes() 中不包含 'status' 字段
            array_diff_key($request->attributes(), ['status' => null])
        );

        if (!$request->record->booking_must_be_approved) {
            // 模型创建后，status 属性应为默认的 Draft::class 对象
            $shiftPattern->transitionTo(Approved::class);
        }
        return $this->reply()->content($shiftPattern, [], $this->getMeta('bookings.shift-pattern.create'));
    }
}

优点： 确保了状态转换始终通过 transitionTo() 方法进行，调用了所有相关的转换类和事件。 缺点： 创建模型时不能直接指定初始状态，需要额外一步进行转换。

方案二：优化状态流设计与默认状态

如果业务逻辑允许，重新评估并优化状态流设计，确保默认状态与实际需求一致，避免在创建时进行“跳过”默认状态的逻辑。

实现方式：

• 如果某个状态（例如 PendingApproval）是大多数情况下模型创建后的初始状态，那么应该将它设置为模型的默认状态，而不是先设置为 Draft 再立即转换为 PendingApproval。
• 移除不必要的中间状态或简化状态转换路径。

示例： 如果 PendingApproval 应该是默认状态，则修改 registerStates：

public function registerStates(): void
{
    $this->addState('status', ShiftPatternBaseState::class)
        ->default(PendingApproval::class) // 直接设置为 PendingApproval
        // ... 其他转换规则
        ->allowTransition(PendingApproval::class, Approved::class, PendingApprovalToApproved::class)
        ->allowTransition(PendingApproval::class, Rejected::class, ToRejected::class);
}

优点： 简化了业务逻辑和代码，使状态流更加清晰和符合预期。 缺点： 可能需要对现有代码进行较大重构。

方案三：实现状态属性的自定义 Mutator

通过在模型中实现一个 Mutator (setStatusAttribute)，可以在 status 属性被设置时拦截并处理字符串值，将其转换为正确的 State 对象。

实现方式： 在模型中添加一个 setStatusAttribute 方法。当 status 属性被设置为字符串时，Mutator 会使用 Spatie Model States 提供的 resolveStateClass 方法来解析对应的状态类，并实例化一个 State 对象。

示例代码：

use Spatie\ModelStates\HasStates;
use App\States\ShiftPattern\ShiftPatternBaseState;
use ReflectionClass;

class ShiftPattern extends Model
{
    use HasStates;

    // ... 其他属性和方法

    /**
     * Mutator for the 'status' attribute to ensure it's always a State object.
     *
     * @param string|Spatie\ModelStates\State $status
     * @return void
     */
    public function setStatusAttribute($status)
    {
        // 只有当传入的值是字符串时才进行转换
        if (is_string($status)) {
            // 尝试解析状态字符串为对应的 State 类名
            $stateClass = ShiftPatternBaseState::resolveStateClass($status);

            // 检查解析出的类是否存在，如果存在则实例化该状态对象
            // 否则，回退到模型的默认状态
            $status = class_exists($stateClass)
                        ? new $stateClass($this)
                        : (new ReflectionClass(self::getDefaultStateFor('status')))->newInstance($this);
        }

        // 将处理后的状态对象赋值给模型的 attributes 数组
        $this->attributes['status'] = $status;
    }

    // ... registerStates() 方法不变
}

ShiftPatternBaseState::resolveStateClass($status) 的工作原理： 这个静态方法会尝试将传入的 $status 字符串解析为对应的完全限定状态类名。它可以处理状态的短名称（如 'pending-approval'）或完整的类名字符串。如果匹配到已知状态，它返回对应的类名；如果未匹配，它将返回传入的原始字符串。

Mutator 逻辑说明：

1. 类型检查： if (is_string($status)) 确保只有当 status 被设置为字符串时才触发转换逻辑。
2. 解析状态类： ShiftPatternBaseState::resolveStateClass($status) 尝试将字符串转换为状态类名。
3. 实例化或回退：
   • class_exists($stateClass) 检查解析出的类名是否确实对应一个存在的类。
   • 如果存在，new $stateClass($this) 创建该状态类的一个实例，并传入模型实例作为上下文。
   • 如果不存在（意味着传入的字符串无法解析为有效状态类），则通过 ReflectionClass(self::getDefaultStateFor('status')))->newInstance($this) 回退到模型的默认状态。self::getDefaultStateFor('status') 会获取为 status 字段配置的默认状态类名。
4. 赋值： 最终，将转换后的 State 对象赋值给 $this->attributes['status']。

优点： 允许在创建或更新模型时直接通过字符串设置状态，同时确保 status 属性最终是正确的 State 对象。提供了最大的灵活性。 缺点： 增加了模型的复杂性，需要仔细处理默认状态和未知状态的逻辑。

总结与建议

Spatie/Laravel-Model-States 库的强大之处在于其将状态建模为对象，并提供了丰富的转换机制。当遇到状态属性未正确转换为对象的问题时，通常是由于 Laravel 的属性填充机制与 Spatie 库的初始化逻辑之间存在交互不当。

• 对于新项目或有条件重构的项目： 推荐优先考虑方案一（限制填充）或方案二（优化状态流）。它们能让状态管理更符合 Spatie 库的“通过转换来改变状态”的核心思想，代码也更清晰。
• 作为快速修复或需要高度灵活性的场景： 方案三（Mutator）是一个非常有效的解决方案。它允许在保持现有数据输入方式不变的情况下，解决属性类型不匹配的问题。但请确保 Mutator 逻辑健壮，能处理所有可能的输入情况。

在实际开发中，理解 Laravel 模型生命周期和 Spatie Model States 的工作原理是解决此类问题的关键。通过选择合适的方案，可以确保模型状态始终以正确的对象形式存在，从而充分利用 Spatie/Laravel-Model-States 提供的强大功能。

以上就是解决 Spatie Model States 属性未正确转换为对象的问题的详细内容，更多请关注php中文网其它相关文章！