Hyperf3.1 模型枚举 Cast 转换,数据库字段映射枚举使用方法

阿强酱_2125

阿强酱_2125

2026-10-05

243人浏览

原创

推荐用自定义 cast 实现模型字段枚举映射,数据库存原始值(int/string),模型属性表现为可读可验证的枚举实例;需定义 backedenum 枚举类并实现 castsattributes 接口的 get/set 方法,支持 null 和非法值兜底处理,最后在模型中通过 $casts 绑定。

hyperf3.1 模型枚举 cast 转换,数据库字段映射枚举使用方法

Hyperf 3.1 中模型字段映射枚举,推荐用自定义 Cast 实现类型安全的双向转换,而不是直接存取整数或字符串。核心是让数据库只存原始值(如 int 或 string),而模型属性始终表现为可读、可验证的枚举实例。

定义枚举类(支持自动获取描述与校验)

先创建一个标准 PHP 枚举(PHP 8.1+),建议使用 BackedEnum,便于与数据库值对齐:

```php
#[\Hyperf\Constants\Annotation\Constants]
enum UserStatus: int
{
  case INACTIVE = 0;
  case ACTIVE = 1;
  case LOCKED = 2;

  public function label(): string
  {
    return match($this) {
      self::INACTIVE => '已停用',
      self::ACTIVE => '已启用',
      self::LOCKED => '已锁定',
    };
  }
}

注意:不需要额外安装 hyperf/constants 来支持枚举,PHP 原生 BackedEnum 即可满足 Cast 需求;若需国际化或错误码管理,再叠加 Constants 注解。

编写枚举 Cast 类(实现 CastsAttributes)

新建 App\Casts\UserStatusCast,严格处理 null 和非法值:

```php
namespace App\Casts;

use App\Enums\UserStatus;
use Hyperf\Contract\CastsAttributes;

class UserStatusCast implements CastsAttributes
{
  public function get($model, string $key, $value, array $attributes)
  {
    if ($value === null) {
      return null;
    }
    return UserStatus::from((int)$value) ?? UserStatus::INACTIVE;
  }

  public function set($model, string $key, $value, array $attributes)
  {
    if ($value === null) {
      return ['status' => null];
    }
    if ($value instanceof UserStatus) {
      return ['status' => $value->value];
    }
    return ['status' => UserStatus::tryFrom((int)$value)?->value ?? UserStatus::INACTIVE->value];
  }
}

关键点:
• get() 返回枚举实例,不是原始值;
• set() 接受枚举实例、整数或 null,统一转为数据库存储值;
• 使用 tryFrom() 避免非法值抛异常,兜底用默认状态。

在模型中声明 cast 并使用

在模型中用 $casts 数组绑定字段和 Cast:

```php
use App\Casts\UserStatusCast;

class User extends Model
{
  protected $casts = [
    'status' => UserStatusCast::class,
  ];
}

DrugBank 数据库
DrugBank 数据库

访问并分析来自 DrugBank 数据库的全面药物信息,包括药物属性、相互作用、靶点、通路、化学结构和药理学数据。用于药物数据、药物发现研究、药理学研究、药物-

下载

这样即可自然操作:

```php
// 读取 → 得到枚举实例
$user = User::find(1);
if ($user->status === UserStatus::ACTIVE) {
  // …
}
echo $user->status->label(); // “已启用”

// 写入 → 支持多种赋值方式
$user->status = UserStatus::LOCKED;
$user->status = 2;
$user->status = null;
$user->save();

数据库 status 字段保持为 TINYINT 或 SMALLINT,无需改动表结构。

进阶:配合访问器简化 API 输出

若需在 JSON 响应中自动输出标签或代码,可加访问器:

```php
protected $appends = ['status_label'];

protected function getStatusLabelAttribute(): string
{
  return $this->status?->label() ?? '';
}

或统一序列化控制(推荐):

```php
protected function casts(): array
{
  return [
    'status' => UserStatusCast::class,
  ];
}

public function toArray(): array
{
  $data = parent::toArray();
  $data['status'] = $this->status?->value;
  $data['status_label'] = $this->status?->label();
  return $data;
}

这样既保持模型内部强类型,又灵活适配接口需求。

相关专题

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

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

2023.09.01

9944

6

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

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

2023.10.11

5921

5

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

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

2023.10.11

2075

5

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

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

2023.10.23

3708

4

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

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

2023.10.23

4394

6

html怎么上传
html怎么上传

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

2023.11.03

3451

9

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

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

2023.11.09

4917

8

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

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

2023.11.13

3842

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

11802

4

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Buffalo框架新项目生成指南
Buffalo框架新项目生成指南

共0课时 | 0人学习

Buffalo框架官方文档
Buffalo框架官方文档

共0课时 | 0人学习

FastAPI SQL数据库实战文档
FastAPI SQL数据库实战文档

共0课时 | 0人学习