问题背景与挑战
在处理来自数据库或外部api的数据时，我们经常会遇到数值型数据以字符串形式存储的情况。例如，库存数量、价格等字段可能包含货币符号、千位分隔符，或仅仅因为数据库设计原因被存储为 varchar 类型。当这些数据通过 laravel eloquent 关系进行关联查询并返回时，它们仍然保持字符串格式。
考虑以下场景：一个 Openorder 对象通过 shipment 关系关联到 Shipment 对象，其中 shipment 对象的 qty 字段存储为 "$1,638" 这样的字符串。直接对这样的字符串进行数学运算（如求和）会导致错误，或需要额外的、分散的数据清洗逻辑。
原始数据结构示例：
"collection": [
{
"id": 983,
"controlNumber": "4498818",
"ItemNumber": "PS2W12077",
"shipment": {
"id": 27,
"Item": "PS2W12077",
"ColorCode": "GRPFR",
"qty": "$1,638" // 需要转换为整数
}
},
// ... 其他对象
]在控制器中，我们可能通过 with() 方法加载关联数据：
$openorder_data = OpenorderImportTemp::
select('id', 'controlNumber', 'ItemNumber')
->with('shipment:id,Item,ColorCode,qty')
->orderby('id', 'desc')
->where('ControlNumber', '!=', '0')
->get();此时，$openorder_data 中每个 OpenorderImportTemp 对象的 shipment 关系下的 qty 属性仍为字符串。
传统尝试的局限性
一些开发者可能会尝试在查询语句中直接使用 DB::raw() 进行聚合或转换，例如：
$openorder_data = OpenorderImportTemp::
select('id', 'controlNumber', 'ItemNumber', DB::raw("SUM(shipment.qty) as qtysum") )
->with('shipment:id,Item,ColorCode,qty')
->orderby('id', 'desc')
->where('ControlNumber', '!=', '0')
->get();然而，这种方法通常无法直接解决问题，因为数据库可能无法直接对包含非数字字符的字符串执行数学聚合，或者在某些数据库方言中需要复杂的字符串清理函数。更重要的是，这并没有改变 qty 字段在模型实例中的实际数据类型，每次访问时仍需手动转换。
优雅的解决方案：使用 Eloquent $casts 属性
Laravel Eloquent 提供了一个强大且简洁的机制来自动处理模型属性的数据类型转换，即 $casts 属性。通过在模型中定义 $casts，我们可以在数据从数据库检索出来后，或在保存到数据库之前，自动进行类型转换。
工作原理
$casts 属性是一个数组，键是模型属性的名称，值是希望转换成的目标数据类型（如 integer, float, boolean, string, datetime, json 等）。当 Eloquent 从数据库获取数据并实例化模型时，它会检查 $casts 属性，并根据定义将相应字段的值转换为指定类型。
实现步骤
确定所属模型: 找到包含需要转换字段 (qty) 的模型。在本例中，qty 字段属于 shipment 关系所对应的模型，我们假设这个模型名为 Shipment 或 ShipmentImportTemp (根据问题中的上下文，OpenorderImportTemp 关联的 shipment 关系可能是指向一个 Shipment 实体，或者是一个类似的临时导入模型)。为了清晰起见，我们假设存在一个 Shipment 模型。
添加 $casts 属性: 在该模型中添加 protected $casts 属性，并指定 qty 字段应被转换为 integer 类型。
示例代码
假设 shipment 关系指向的是一个名为 Shipment 的模型（或者与 OpenorderImportTemp 关联的 shipment 对象所对应的实际模型）：
// app/Models/Shipment.php (或对应的Shipment相关模型)
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
class Shipment extends Model
{
// ... 其他模型属性和方法
/**
* 应进行类型转换的属性。
*
* @var array
*/
protected $casts = [
'qty' => 'integer',
];
// ... 其他关系定义或业务逻辑
}解释:
- 当 Laravel 从数据库中检索 Shipment 模型的实例时，它会读取 qty 字段的值。
- 由于 qty 在 $casts 中被定义为 integer，Laravel 会尝试将 "$1,638" 这样的字符串解析并转换为整数。Laravel 的类型转换机制通常足够智能，可以处理常见的货币符号和千位分隔符。如果字符串是 "$1,638"，它会尝试将其转换为 1638。
数据获取与验证
一旦在 Shipment 模型中设置了 $casts，控制器中的数据获取代码无需任何改动：
$openorder_data = OpenorderImportTemp::
select('id', 'controlNumber', 'ItemNumber')
->with('shipment:id,Item,ColorCode,qty')
->orderby('id', 'desc')
->where('ControlNumber', '!=', '0')
->get();
foreach ($openorder_data as $openorder) {
if ($openorder->shipment) {
// 此时 $openorder->shipment->qty 已经是一个整数类型
echo gettype($openorder->shipment->qty); // 输出: integer
echo $openorder->shipment->qty + 100; // 可以直接进行数学运算
}
}现在，$openorder->shipment->qty 将直接返回一个整数，可以直接用于数学计算、比较或其他需要整数类型值的操作。
注意事项
-
数据清洁度: 尽管 Laravel 的 $casts 能够处理一些非数字字符，但最佳实践是确保原始数据尽可能地“干净”。如果字符串包含更复杂的非数字字符，或者格式不一致，integer 转换可能会失败或产生意外结果。在这种情况下，可能需要：
- 在数据库层面清理数据。
- 使用 Laravel 的 Accessor (Getter) 手动处理复杂的字符串清理逻辑，然后再返回整数。
- 创建自定义的 Eloquent Cast 类来处理更复杂的转换逻辑。
- 模型位置: 确保 $casts 属性添加在拥有该字段的实际模型中。在本例中，qty 字段在 shipment 关系的对象中，所以应该添加到 Shipment 模型（或其对应的模型）中，而不是 OpenorderImportTemp 模型。
- 性能影响: $casts 是在模型实例化时执行的，对于大量数据，其性能开销通常可以忽略不计，且远优于每次手动转换。
总结
通过在 Laravel Eloquent 模型中利用 $casts 属性，我们可以极大地简化对非标准格式数值型字符串的处理。这种方法不仅使代码更简洁、更易读，而且将数据类型转换的逻辑集中到模型层，符合单一职责原则，提高了代码的可维护性。对于需要在 Laravel 应用中处理类似数据类型转换的场景，$casts 提供了一个强大且优雅的解决方案。
