Computed

#[Computed] 属性允许你创建在请求期间缓存的派生属性，在多次访问昂贵操作时提供性能优势。

基本用法

将 #[Computed] 属性应用到任意方法，即可将其变为缓存属性：

<?php // resources/views/components/user/⚡show.blade.php

use Livewire\Attributes\Computed;
use Livewire\Component;
use App\Models\User;

new class extends Component {
    public $userId;

    #[Computed] // [tl! highlight]
    public function user()
    {
        return User::find($this->userId);
    }

    public function follow()
    {
        Auth::user()->follow($this->user);
    }
};

<div>
    <h1>{{ $this->user->name }}</h1>
    <span>{{ $this->user->email }}</span>

    <button wire:click="follow">Follow</button>
</div>

user() 方法通过 $this->user 像属性一样访问。首次调用时结果会被缓存，并在本请求的剩余时间内复用。

INFO

模板中必须使用 $this

与普通属性不同，计算属性必须在模板中通过 $this 访问。例如使用 $this->posts 而不是 $posts。

性能优势

计算属性会在整个请求期间缓存结果。若多次访问 $this->posts，底层方法只执行一次：

<?php // resources/views/components/post/⚡index.blade.php

use Illuminate\Support\Facades\Auth;
use Livewire\Attributes\Computed;
use Livewire\Component;

new class extends Component {
    #[Computed] // [tl! highlight]
    public function posts()
    {
        return Auth::user()->posts; // Only queries database once
    }
};

这样你可以自由访问派生值，而不必担心性能影响。

清除缓存

若请求期间底层数据发生变化，可用 unset() 清除缓存：

<?php // resources/views/components/post/⚡index.blade.php

use Illuminate\Support\Facades\Auth;
use Livewire\Attributes\Computed;
use Livewire\Component;

new class extends Component {
    #[Computed]
    public function posts()
    {
        return Auth::user()->posts;
    }

    public function createPost()
    {
        if ($this->posts->count() > 10) {
            throw new \Exception('Maximum post count exceeded');
        }

        Auth::user()->posts()->create(...);

        unset($this->posts); // Clear cache [tl! highlight]
    }
};

创建新文章后，unset($this->posts) 会清除缓存，使下次访问获取更新后的数据。

跨请求缓存

默认情况下，计算属性仅在单个请求内缓存。若要跨多个请求缓存，请使用 persist 参数：

#[Computed(persist: true)] // [tl! highlight]
public function user()
{
    return User::find($this->userId);
}

这会将值缓存 3600 秒（1 小时）。你可以自定义时长：

#[Computed(persist: true, seconds: 7200)] // 2 hours [tl! highlight]

跨所有组件缓存

要在应用中所有组件实例间共享缓存值，请使用 cache 参数：

use Livewire\Attributes\Computed;
use App\Models\Post;

#[Computed(cache: true)] // [tl! highlight]
public function posts()
{
    return Post::all();
}

你可以选择设置自定义缓存键：

#[Computed(cache: true, key: 'homepage-posts')] // [tl! highlight]

何时使用

计算属性在以下情况特别有用：

• 有条件地访问昂贵数据 - 仅在模板实际使用该值时才查询数据库
• 使用内联模板 - 无法通过 render() 传递数据
• 省略 render 方法 - 遵循 v4 的单文件组件约定
• 多次访问同一值 - 自动缓存可避免重复查询

限制

WARNING

不支持用于 Form 对象

计算属性不能用于 Livewire\Form 对象。尝试通过 $form->property 访问会导致错误。

了解更多

关于计算属性、缓存策略与高级用法的详细信息，请参阅计算属性文档。

参考

#[Computed(
    bool $persist = false,
    int $seconds = 3600,
    bool $cache = false,
    ?string $key = null,
    mixed $tags = null,
)]

参数	类型	默认值	说明
$persist	bool	false	在同一组件实例的多次请求间缓存该值
$seconds	int	3600	缓存该值的秒数
$cache	bool	false	在所有组件实例间缓存该值
$key	?string	null	自定义缓存键（未提供则自动生成）
$tags	mixed	null	缓存标签（需要支持标签的缓存驱动）