0

0

Laravel中驼峰命名请求数据到下划线命名模型字段的自动映射教程

聖光之護

聖光之護

发布时间:2025-09-15 10:18:19

|

389人浏览过

|

来源于php中文网

原创

Laravel中驼峰命名请求数据到下划线命名模型字段的自动映射教程

本教程详细介绍了在Laravel应用中如何高效处理前端或API传入的驼峰命名(camelCase)请求数据,并将其自动转换为数据库或模型期望的下划线命名(snake_case)格式。通过利用Laravel的Str::snake()辅助函数,文章提供了一种简洁且可维护的方法来避免手动逐一映射大量字段,同时强调了批量赋值的安全性和数据验证的重要性,确保数据处理的准确性和安全性。

laravel开发中,我们经常会遇到这样的场景:前端或外部api发送过来的请求数据字段采用驼峰命名(例如lifetimesales),而我们的数据库表字段和eloquent模型属性通常遵循下划线命名(例如lifetime_sales)。当模型包含大量字段时(如30个或更多),手动逐一进行属性赋值会变得异常繁琐且容易出错。本文将指导您如何利用laravel的内置功能,优雅地解决这一数据格式转换和映射的问题。

核心问题:驼峰命名与下划线命名转换

Laravel的Eloquent模型通常与数据库表结构紧密耦合,其属性名默认对应数据库表的下划线命名列名。然而,现代前端框架(如Vue、React)或某些API规范倾向于使用驼峰命名来表示数据字段。这就导致了数据接收与模型赋值之间的命名不一致问题。

例如,您可能收到如下请求数据:

{
    "lifetimeSales": 100000,
    "lifetimeVolumes": 5000
}

而您的模型字段是:

// app/Models/ScopeCommercial.php
class ScopeCommercial extends Model
{
    protected $fillable = [
        'lifetime_sales',
        'lifetime_volumes',
        // ... 其他字段
    ];
}

传统的做法是逐一映射:

$scopeCommercial = new ScopeCommercial();
$scopeCommercial->lifetime_sales = $request->lifetimeSales;
$scopeCommercial->lifetime_volumes = $request->lifetimeVolumes;
// ... 针对30个字段重复此操作

显然,这种方法效率低下且难以维护。

使用 Str::snake() 自动映射数据

Laravel提供了一个强大的字符串辅助函数Str::snake(),它可以将驼峰命名字符串转换为下划线命名。这正是我们解决上述问题的关键。

Str::snake() 函数介绍

Str::snake() 函数可以将给定的字符串从驼峰命名转换为下划线命名。

use Illuminate\Support\Str;

$camelCaseString = 'fooBar';
$snakeCaseString = Str::snake($camelCaseString); // 结果: 'foo_bar'

$anotherCamelCase = 'lifetimeSales';
$anotherSnakeCase = Str::snake($anotherCamelCase); // 结果: 'lifetime_sales'

这个函数正是我们批量转换请求数据键名所需的工具

批量转换并赋值到模型

我们可以结合$request->all()获取所有请求数据,然后遍历这些数据,将每个键名从驼峰命名转换为下划线命名,最后将转换后的数据数组用于模型的批量赋值。

示例代码:控制器中的实现

Fotor AI Face Generator
Fotor AI Face Generator

Fotor 平台的在线 AI 头像生成器

下载
validate([
            'lifetimeSales' => 'required|numeric',
            'lifetimeVolumes' => 'required|numeric',
            // ... 其他验证规则
        ]);

        // 2. 获取所有请求数据(或验证后的数据)
        $input = $validatedData; // 使用验证后的数据更安全

        // 3. 转换键名:将驼峰命名转换为下划线命名
        $convertedData = [];
        foreach ($input as $key => $value) {
            $snakeCaseKey = Str::snake($key);
            $convertedData[$snakeCaseKey] = $value;
        }

        // 4. 批量赋值到模型
        // 确保您的模型中正确设置了 $fillable 属性,以允许批量赋值。
        try {
            $scopeCommercial = ScopeCommercial::create($convertedData);
            // 或者:
            // $scopeCommercial = new ScopeCommercial();
            // $scopeCommercial->fill($convertedData);
            // $scopeCommercial->save();

            return response()->json([
                'message' => '数据存储成功',
                'data' => $scopeCommercial
            ], 201);

        } catch (\Exception $e) {
            return response()->json([
                'message' => '数据存储失败',
                'error' => $e->getMessage()
            ], 500);
        }
    }
}

在上述代码中,我们首先通过$request->validate()对传入数据进行验证,这是任何Web应用中不可或缺的安全步骤。然后,我们遍历验证后的数据数组,使用Str::snake()将每个键名从驼峰命名转换为下划线命名,并将转换后的键值对存储到$convertedData数组中。最后,我们利用Eloquent模型的create()或fill()方法进行批量赋值,极大地简化了代码。

注意事项

1. 安全隐患:批量赋值(Mass Assignment)

当使用create()或fill()方法进行批量赋值时,Laravel默认会阻止将所有传入的数组键值对直接赋值给模型,以防止“批量赋值漏洞”。您必须在模型中明确指定哪些属性是“可填充的”($fillable)或“受保护的”($guarded)。

模型示例:

// app/Models/ScopeCommercial.php
class ScopeCommercial extends Model
{
    // 明确指定允许批量赋值的字段
    protected $fillable = [
        'lifetime_sales',
        'lifetime_volumes',
        'other_field_one',
        'another_field',
        // ... 所有允许通过批量赋值写入的字段
    ];

    // 或者,指定不应批量赋值的字段(通常为空数组或id)
    // protected $guarded = ['id'];
    // protected $guarded = []; // 如果为空数组,则所有字段都可批量赋值,需谨慎!
}

确保$fillable数组中包含所有通过Str::snake()转换后对应的数据库字段名。

2. 数据验证(Data Validation)

在将请求数据赋值给模型之前,始终进行严格的数据验证是至关重要的。这可以防止无效或恶意数据进入您的应用程序。如示例代码所示,应在转换键名之前完成验证。

3. 非模型字段处理

如果$request->all()中包含一些不对应模型属性的字段(例如,仅用于前端逻辑的字段),使用fill()或create()方法时,这些字段会被Eloquent模型自动忽略,不会导致错误,这通常是期望的行为。

4. 性能考量

对于几十个字段的映射,上述循环转换的方法性能开销可以忽略不计。即使字段数量更多,PHP的循环效率也足以应对大多数应用场景。

总结

通过利用Laravel的Str::snake()辅助函数,我们可以优雅且高效地解决驼峰命名请求数据与下划线命名模型字段之间的映射问题。这种方法不仅减少了手动编码的工作量,提高了代码的可维护性,还通过结合数据验证和批量赋值的安全机制,确保了应用程序的健壮性。在处理大量字段的数据交互时,掌握这种技巧将极大地提升您的开发效率。

相关专题

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

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

2044

2023.09.01

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

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

1373

2023.10.11

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

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

1285

2023.10.11

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

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

951

2023.10.23

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

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

1406

2023.10.23

html怎么上传
html怎么上传

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

1231

2023.11.03

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

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

1440

2023.11.09

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

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

1303

2023.11.13

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

150

2025.12.31

热门下载

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

精品课程

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

共137课时 | 8.2万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 6.9万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.8万人学习

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

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