laravel怎么创建一个自定义的 Eloquent Cast 类型_laravel自定义Eloquent Cast类型方法-Laravel-PHP中文网

laravel怎么创建一个自定义的 Eloquent Cast 类型_laravel自定义Eloquent Cast类型方法

尼克

发布： 2025-11-01 11:54:02

原创

190人浏览过

在 Laravel 中创建自定义 Eloquent Cast 类需实现 CastsAttributes 接口，定义 get 和 set 方法以处理数据库字段的读取与存储，如将字符串转为首字母大写。

laravel怎么创建一个自定义的 eloquent cast 类型_laravel自定义eloquent cast类型方法

在 Laravel 中，自定义 Eloquent Cast 类型可以让你更灵活地处理数据库字段的存储与读取。比如将 JSON 字符串自动转为对象，或对日期、加密数据等进行特殊处理。Laravel 8+ 支持创建可复用的自定义 Cast 类，下面介绍具体实现方法。

创建自定义 Cast 类

要创建一个自定义的 Eloquent Cast 类，你需要定义一个实现 CastsAttributes 接口的类。这个接口要求实现两个方法：get 和 set，分别用于从数据库获取值和写入数据库前的处理。

例如，我们创建一个将字符串转为首字母大写的 Cast：

<?php
<p>namespace App\Casts;</p><p>use Illuminate\Contracts\Database\Eloquent\CastsAttributes;</p><p>class CapitalizeString implements CastsAttributes
{
/**</p><ul><li>将数据库值转换为模型属性
*/
public function get($model, string $key, $value, array $attributes)
{
return ucfirst($value);
}</li></ul><pre class='brush:php;toolbar:false;'>/**
 * 将模型属性转换为数据库值
 */
public function set($model, string $key, $value, array $attributes)
{
    return strtolower($value);
}

登录后复制

}

在模型中使用自定义 Cast

定义好 Cast 类后，在 Eloquent 模型中通过 $casts 属性注册即可。

<?php
<p>namespace App\Models;</p>
                    <div class="aritcle_card">
                        <a class="aritcle_card_img" href="/ai/1672">
                            <img src="https://img.php.cn/upload/ai_manual/000/000/000/175680338913523.png" alt="BibiGPT-哔哔终结者">
                        </a>
                        <div class="aritcle_card_info">
                            <a href="/ai/1672">BibiGPT-哔哔终结者</a>
                            <p>B站视频总结器-一键总结 音视频内容</p>
                            <div class="">
                                <img src="/static/images/card_xiazai.png" alt="BibiGPT-哔哔终结者">
                                <span>871</span>
                            </div>
                        </div>
                        <a href="/ai/1672" class="aritcle_card_btn">
                            <span>查看详情</span>
                            <img src="/static/images/cardxiayige-3.png" alt="BibiGPT-哔哔终结者">
                        </a>
                    </div>
                <p>use App\Casts\CapitalizeString;
use Illuminate\Database\Eloquent\Model;</p><p>class User extends Model
{
protected $casts = [
'name' => CapitalizeString::class,
];
}</p>

登录后复制

这样，每次访问 $user->name 时，值都会自动首字母大写；保存时则转为小写存入数据库（根据你的逻辑可调整）。

支持数组或复杂类型的 Cast 示例

如果你需要处理 JSON 或数组类型，比如将数据库中的 JSON 字符串转为特定对象：

<?php
<p>namespace App\Casts;</p><p>use Illuminate\Contracts\Database\Eloquent\CastsAttributes;</p><p>class JsonToArrayObject implements CastsAttributes
{
public function get($model, string $key, $value, array $attributes)
{
return json_decode($value, true) ?? [];
}</p><pre class='brush:php;toolbar:false;'>public function set($model, string $key, $value, array $attributes)
{
    return json_encode($value, JSON_UNESCAPED_UNICODE);
}

登录后复制

}

然后在模型中使用：

'settings' => JsonToArrayObject::class