0

0

Laravel 中处理驼峰命名输入并自动映射到蛇形命名数据库字段的教程

DDD

DDD

发布时间:2025-09-15 12:15:01

|

887人浏览过

|

来源于php中文网

原创

Laravel 中处理驼峰命名输入并自动映射到蛇形命名数据库字段的教程

在Laravel应用中,处理来自API或其他前端的驼峰命名(camelCase)输入,并将其高效地映射到数据库中常用的蛇形命名(snake_case)字段,是一个常见需求。本教程将详细介绍如何利用Laravel的Str::snake()辅助函数,实现数据字段的自动转换与模型赋值,从而避免手动逐一映射,提高开发效率和代码可维护性。

1. 问题背景与手动映射的局限性

在构建web应用时,前后端数据交互通常会遵循不同的命名约定。例如,前端javascriptjson api数据习惯使用驼峰命名(如lifetimesales),而后端数据库字段和laravel模型属性则倾向于使用蛇形命名(如lifetime_sales)。当模型属性较少时,我们可以手动进行映射:

use App\Models\ScopeCommercial;
use Illuminate\Http\Request;

class SomeController extends Controller
{
    public function store(Request $request)
    {
        $scopeCommercial = new ScopeCommercial();
        $scopeCommercial->lifetime_sales = $request->lifetimeSales;
        $scopeCommercial->lifetime_volumes = $request->lifetimeVolumes;
        // ... 更多属性
        $scopeCommercial->save();

        return response()->json(['message' => '数据保存成功']);
    }
}

然而,当模型包含大量属性(例如30个或更多)时,这种逐一手动映射的方式将变得非常繁琐、易出错,并且难以维护。我们需要一种更自动化、更优雅的解决方案。

2. 利用 Str::snake() 实现驼峰到蛇形的转换

Laravel提供了一个强大的Str辅助类,其中的snake()方法正是解决此问题的关键。Str::snake()函数能够将驼峰命名或烤串命名(kebab-case)的字符串转换为蛇形命名。

基本用法:

use Illuminate\Support\Str;

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

$anotherCamelCase = 'userNameId';
$anotherSnakeCase = Str::snake($anotherCamelCase); // 结果: 'user_name_id'

// 默认分隔符是下划线 '_',也可以指定其他分隔符
$snakeWithHyphen = Str::snake('fooBar', '-'); // 结果: 'foo-bar'

通过这个函数,我们可以将请求中接收到的驼峰命名键转换为模型或数据库所需的蛇形命名键。

3. 自动化数据转换与模型填充

结合Str::snake()和$request->all()方法,我们可以轻松地批量转换请求数据,并使用Laravel模型的fill()方法进行填充。

3.1 基础转换与填充

首先,获取所有请求数据,然后遍历这些数据,将每个键从驼峰命名转换为蛇形命名,构建一个新的数组,最后用于模型填充。

use App\Models\ScopeCommercial;
use Illuminate\Http\Request;
use Illuminate\Support\Str;

class ScopeCommercialController extends Controller
{
    public function store(Request $request)
    {
        // 假设 $request->all() 返回的数据如下:
        // [
        //     'lifetimeSales' => 100000,
        //     'lifetimeVolumes' => 5000,
        //     'lastPurchaseDate' => '2023-01-15',
        //     'customerRating' => 4.5
        // ]

        $camelCaseData = $request->all();
        $snakeCaseData = [];

        foreach ($camelCaseData as $key => $value) {
            $snakeCaseData[Str::snake($key)] = $value;
        }

        // $snakeCaseData 现在将是:
        // [
        //     'lifetime_sales' => 100000,
        //     'lifetime_volumes' => 5000,
        //     'last_purchase_date' => '2023-01-15',
        //     'customer_rating' => 4.5
        // ]

        $scopeCommercial = new ScopeCommercial();
        $scopeCommercial->fill($snakeCaseData); // 使用转换后的数据填充模型
        $scopeCommercial->save();

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

3.2 更简洁的转换方式(使用集合)

Laravel的集合(Collection)提供了一种更具函数式编程风格的方式来处理数组转换,使代码更简洁。

use App\Models\ScopeCommercial;
use Illuminate\Http\Request;
use Illuminate\Support\Str;

class ScopeCommercialController extends Controller
{
    public function store(Request $request)
    {
        $snakeCaseData = collect($request->all())
            ->mapWithKeys(function ($value, $key) {
                return [Str::snake($key) => $value];
            })
            ->toArray(); // 将集合转回数组

        $scopeCommercial = new ScopeCommercial();
        $scopeCommercial->fill($snakeCaseData);
        $scopeCommercial->save();

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

这种方法尤其适用于处理大量数据字段的场景,代码可读性更强。

4. 注意事项与最佳实践

  • 模型批量赋值保护 ($fillable 或 $guarded): 在使用fill()方法进行批量赋值时,务必在模型中定义$fillable属性来指定哪些字段可以被批量赋值,或者使用$guarded来指定哪些字段不能被批量赋值。这是Laravel防止恶意批量赋值的安全机制。

    // App/Models/ScopeCommercial.php
    class ScopeCommercial extends Model
    {
        protected $fillable = [
            'lifetime_sales',
            'lifetime_volumes',
            'last_purchase_date',
            'customer_rating',
            // ... 所有允许批量赋值的蛇形命名字段
        ];
    }
  • 数据验证: 在进行数据转换和模型填充之前,强烈建议对传入的$request数据进行验证。这确保了数据的完整性和安全性。

    public function store(Request $request)
    {
        $request->validate([
            'lifetimeSales' => 'required|numeric',
            'lifetimeVolumes' => 'required|numeric',
            'lastPurchaseDate' => 'nullable|date',
            'customerRating' => 'nullable|numeric|min:0|max:5',
            // ... 其他验证规则
        ]);
    
        // ... 转换和填充逻辑
    }
  • 特定字段的排除或特殊处理: 如果某些请求字段不应该被转换,或者需要进行特殊处理,可以在转换循环中添加条件判断,或者在mapWithKeys回调中进行过滤。

    $snakeCaseData = collect($request->all())
        ->mapWithKeys(function ($value, $key) {
            // 假设 'id' 字段不需要转换
            if ($key === 'id') {
                return [$key => $value];
            }
            return [Str::snake($key) => $value];
        })
        ->toArray();
  • 性能考量: 对于极大量的数据(例如几十万条记录的批量导入),这种逐键转换的方式可能会有轻微的性能开销。但在典型的Web请求处理中,这种开销通常可以忽略不计。

5. 总结

通过本教程,我们学习了如何在Laravel应用中高效地处理驼峰命名输入并将其映射到蛇形命名数据库字段。利用Str::snake()辅助函数结合$request->all()和集合操作,可以显著简化代码,提高开发效率,并确保数据命名规范的一致性。同时,结合Laravel的模型批量赋值保护和数据验证机制,可以构建出既灵活又安全的数据处理流程。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

541

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

372

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

727

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

470

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

391

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

990

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

653

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

544

2023.09.20

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

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

7

2025.12.31

热门下载

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

精品课程

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

共137课时 | 8.1万人学习

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号