0

0

Laravel中的Enum(枚举)类型如何与数据库交互? (属性转换Casting)

尼克

尼克

发布时间:2026-01-23 15:00:41

|

938人浏览过

|

来源于php中文网

原创

Laravel 原生 enum 需配合 Castable 实现自动转换:必须自定义 Cast 类处理序列化/反序列化,容错处理非法值,数据库字段类型须与枚举底层类型严格一致,并通过 __toString() 或 scope 封装支持查询。

laravel中的enum(枚举)类型如何与数据库交互? (属性转换casting)

Enum 类型必须实现 Castable 接口才能被 Laravel 自动转换

Laravel 不会自动识别 PHP 8.1+ 的原生 enum,直接在 Eloquent 模型中声明 public enum Status: string 字段,数据库读写时仍为原始字符串或 int,不会触发任何类型约束或验证。必须显式提供一个 Cast 类,让框架知道“这个字段存的是枚举,该怎么序列化/反序列化”。

实操建议:

  • 创建 Cast 类:运行 php artisan make:cast StatusCast
  • 让该类实现 Castable 接口,并在 get / set 方法中手动处理枚举实例与数据库值的转换
  • 在模型中通过 $casts 数组注册:
    protected $casts = [
        'status' => StatusCast::class,
    ];
  • 若使用 Laravel 11+,可改用更简洁的匿名 Cast 写法(但调试性稍弱)

getset 方法里必须做容错处理,否则查不到枚举值会抛出 ValueError

PHP 原生枚举的 from() 方法在找不到匹配值时直接抛异常,而数据库可能存了旧数据、空字符串或非法值。不加防护会导致整个查询失败。

常见错误现象:页面报错 Unhandled match expression valueCannot instantiate enum with invalid value,尤其在迁移老项目或允许 NULL 的字段上。

实操建议:

  • get 方法中用 try/catch 捕获 ValueError,返回 null 或默认枚举项
  • set 方法中对 null、空字符串、非枚举实例做预处理,避免写入非法值
  • 示例片段(StatusCast):
    public function get($model, string $key, $value, array $attributes)
    {
        if ($value === null) {
            return null;
        }
    
        try {
            return Status::from($value);
        } catch (ValueError $e) {
            return null; // 或 Status::Draft
        }
    }
    
    public function set($model, string $key, $value, array $attributes)
    {
        if ($value instanceof Status) {
            return $value->value;
        }
    
        if (is_string($value) && Status::tryFrom($value) !== null) {
            return $value;
        }
    
        return null;
    }

数据库字段类型要和枚举底层类型严格一致,否则隐式转换会出问题

PHP 枚举可以是 stringint 底层类型,但数据库字段类型不匹配时,MySQL 可能静默截断、强制转 0 或报错(取决于 strict mode)。

Asksia
Asksia

Asksia AI - 最好的AI老师,可靠的作业助手

下载

使用场景举例:定义 enum Priority: int,但数据库字段是 VARCHAR(20),写入 Priority::High->value(即 3)时,MySQL 会把它当字符串存成 "3";下次读取再调 from("3") 就失败——因为期望的是整数 3,不是字符串 "3"

实操建议:

  • 字符串枚举 → 数据库用 VARCHARENUM(不推荐 MySQL ENUM,迁移和 ORM 兼容差)
  • 整数枚举 → 数据库用 TINYINTSMALLINT 等整型,且确保 NOT NULL 或显式处理 NULL
  • 迁移中明确指定长度和约束:
    $table->enum('status', ['draft', 'published', 'archived'])->default('draft'); // ❌ 不推荐
    $table->string('status', 20)->nullable(); // ✅ 更可控

想支持搜索和查询构造器中的枚举比较,得重载 where 条件逻辑

Eloquent 的 where('status', Status::Published) 默认会把枚举对象传给 Query Builder,最终生成 SQL 时调用 (string) $enum —— 如果没定义 __toString(),就会报错或写入空字符串。

性能影响:每次 where 都触发对象到值的转换,若没缓存或优化,高频查询下有微小开销。

实操建议:

  • 在枚举类中添加 __toString() 方法(仅适用于 string 枚举):
    public function __toString(): string
    {
        return $this->value;
    }
  • 整数枚举可加 __toInt() 并配合访问器使用,但 Query Builder 不自动识别,需手动写 where('priority', Priority::Urgent->value)
  • 更健壮的做法是封装查询 scope:
    public function scopeWhereStatus($query, Status $status): Builder
    {
        return $query->where('status', $status->value);
    }
    然后调用 Model::whereStatus(Status::Published)
实际项目中最容易被忽略的是迁移历史数据时的兼容性——旧记录字段为空或非法值,Cast 类里没兜底就崩。别假设数据库永远干净。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2816

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1692

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1549

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

1036

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1485

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1256

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1589

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1307

2023.11.13

c++空格相关教程合集
c++空格相关教程合集

本专题整合了c++空格相关教程,阅读专题下面的文章了解更多详细内容。

0

2026.01.23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
MySQL 教程
MySQL 教程

共48课时 | 1.9万人学习

MySQL 初学入门(mosh老师)
MySQL 初学入门(mosh老师)

共3课时 | 0.3万人学习

简单聊聊mysql8与网络通信
简单聊聊mysql8与网络通信

共1课时 | 805人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号