snake_case 与 camelCase 在 Lumen Eloquent 中的转换指南

2024-03-06 03:50:30

在 Lumen 应用程序中使用 Eloquent 时，我们经常会遇到数据库字段命名规范与代码中属性命名规范不一致的情况。数据库中通常使用 snake_case（例如 first_name），而 PHP 代码中更倾向于使用 camelCase（例如 firstName）。这种不一致会导致一些麻烦，例如在处理请求和响应数据时需要手动进行字段名转换。

为了解决这个问题，我们可以通过覆写 Eloquent 模型的一些方法来自动完成 snake_case 和 camelCase 之间的转换。

一种常见的方法是覆写 getAttribute() 和 setAttribute() 方法。getAttribute() 方法用于获取模型属性的值，setAttribute() 方法用于设置模型属性的值。通过在这两个方法中添加转换逻辑，我们可以实现自动转换。

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    // ...

    public function getAttribute($key)
    {
        $value = parent::getAttribute($key);
        
        // 将 snake_case 转换为 camelCase
        return camel_case($key) === $key ? $value : studly_case($key);
    }

    public function setAttribute($key, $value)
    {
        // 将 camelCase 转换为 snake_case
        parent::setAttribute(snake_case($key), $value);
    }
}

在上面的代码中，我们在 getAttribute() 方法中使用 camel_case() 函数将数据库字段名转换为 camelCase 格式，然后返回属性值。在 setAttribute() 方法中，我们使用 snake_case() 函数将属性名转换为 snake_case 格式，再调用父类的 setAttribute() 方法设置属性值。

除了 getAttribute() 和 setAttribute() 方法，我们还可以覆写 toArray() 方法来自动转换模型数组的键。toArray() 方法用于将模型转换为数组，例如在 API 接口返回数据时。

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    // ...

    public function toArray()
    {
        $attributes = parent::toArray();

        $convertedAttributes = [];
        foreach ($attributes as $key => $value) {
            $convertedAttributes[camel_case($key)] = $value;
        }

        return $convertedAttributes;
    }
}

在上面的代码中，我们先调用父类的 toArray() 方法获取模型数组，然后遍历数组，将每个键转换为 camelCase 格式，最后返回转换后的数组。

通过覆写这些方法，我们可以实现 snake_case 和 camelCase 之间的自动转换，从而简化代码，提高开发效率。

当然，除了手动覆写 Eloquent 方法外，我们还可以使用一些第三方库来实现类似的功能。例如，eloquence/behaviours 包提供了一个 CamelCasing trait，可以方便地为模型添加自动转换功能。

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Eloquence\Behaviours\CamelCasing;

class User extends Model
{
    use CamelCasing;

    // ...
}