Sushi实战：如何为Laravel应用创建国家、角色等固定数据模型

Sushi实战：如何为Laravel应用创建国家、角色等固定数据模型

【免费下载链接】sushiEloquent's missing "array" driver.项目地址: https://gitcode.com/gh_mirrors/su/sushi

Sushi是Eloquent缺失的"数组"驱动，为Laravel开发者提供了一种无需数据库即可使用Eloquent模型的终极解决方案。这个简单而强大的PHP包让你能够使用数组数据创建Eloquent模型，非常适合国家列表、用户角色、邮政编码、系统设置等固定数据场景。通过Sushi，你可以轻松管理静态数据集，同时享受Eloquent的所有强大功能，包括关系、验证规则和查询构建器。

🚀 Sushi快速入门指南

一键安装Sushi

安装Sushi非常简单，只需一个Composer命令：

composer require calebporzio/sushi

系统要求：确保你的系统已安装pdo-sqlitePHP扩展，这是Sushi正常运行的必要条件。

创建你的第一个Sushi模型

创建国家模型就像定义一个普通的Eloquent模型一样简单。看看这个完整的国家模型示例：

<?php namespace App\Models; use Illuminate\Database\Eloquent\Model; class Country extends Model { use \Sushi\Sushi; protected $rows = [ ['code' => 'CN', 'name' => '中国', 'population' => 1412600000], ['code' => 'US', 'name' => '美国', 'population' => 331900000], ['code' => 'JP', 'name' => '日本', 'population' => 125800000], ['code' => 'DE', 'name' => '德国', 'population' => 83200000], ['code' => 'FR', 'name' => '法国', 'population' => 67800000], ]; }

就是这么简单！只需要两个步骤：添加Sushitrait和定义$rows属性，你的模型就可以像有数据库表一样使用了。

📊 国家数据模型的完整实现

国际标准国家数据

在实际项目中，你可能需要更完整的国家数据。Sushi包自带了一个完整的国家数据示例，包含ISO 3166-1标准的所有字段：

// 查看完整示例：examples/CountryExample.php class CountryExample extends Model { use \Sushi\Sushi; protected $rows = [ ['code' => 'CN', 'code3' => 'CHN', 'name' => 'China', 'number' => '156'], ['code' => 'US', 'code3' => 'USA', 'name' => 'United States', 'number' => '840'], // ... 包含全球250多个国家和地区 ]; }

这个示例模型包含了：

• ISO 3166-1 alpha-2代码：两字母国家代码（如CN、US）
• ISO 3166-1 alpha-3代码：三字母国家代码（如CHN、USA）
• 完整国家名称：官方英文名称
• 数字代码：三位数国家代码

使用国家模型的5种场景

1. 表单下拉选择：创建国家选择器
2. 地址验证：验证用户输入的国家代码
3. 国际化支持：根据国家代码显示不同语言
4. 数据分析：按国家统计业务数据
5. 地理信息显示：在地图上显示国家信息

👥 用户角色模型的创建方法

基础角色模型实现

用户角色是另一个非常适合使用Sushi的固定数据场景：

class Role extends Model { use \Sushi\Sushi; public $incrementing = false; protected $keyType = 'string'; protected $rows = [ ['id' => 'admin', 'label' => '管理员', 'permissions' => 'all'], ['id' => 'editor', 'label' => '编辑', 'permissions' => 'write'], ['id' => 'viewer', 'label' => '查看者', 'permissions' => 'read'], ['id' => 'guest', 'label' => '访客', 'permissions' => 'none'], ]; }

字符串主键的特殊处理

注意上面的示例中，我们使用了字符串ID作为主键。Sushi需要两个额外的属性来处理字符串主键：

• public $incrementing = false;- 禁用自增ID
• protected $keyType = 'string';- 设置主键类型为字符串

🔗 建立Eloquent关系连接

与用户模型建立关联

Sushi模型可以像普通Eloquent模型一样建立关系：

class User extends Model { public function role() { return $this->belongsTo(Role::class); } }

现在你可以像使用普通模型关系一样使用：

// 获取用户角色 $user->role; // 关联角色 $adminRole = Role::where('id', 'admin')->first(); $user->role()->associate($adminRole); // 预加载角色 User::with('role')->get();

使用验证规则

你甚至可以在表单验证中使用Sushi模型：

$data = request()->validate([ 'country_code' => ['required', 'exists:App\Models\Country,code'], 'role_id' => ['required', 'exists:App\Models\Role,id'], ]);

重要提示：必须使用模型的完整命名空间路径，而不是表名。

⚙️ 高级配置与优化技巧

自定义数据源方法

除了静态数组，你还可以动态生成数据：

class Currency extends Model { use \Sushi\Sushi; public function getRows() { // 从API、CSV文件或其他数据源获取数据 return [ ['code' => 'USD', 'name' => '美元', 'symbol' => '$'], ['code' => 'CNY', 'name' => '人民币', 'symbol' => '¥'], ['code' => 'EUR', 'name' => '欧元', 'symbol' => '€'], ]; } protected function sushiShouldCache() { return true; // 启用缓存 } }

缓存策略优化

对于动态数据源，Sushi提供了灵活的缓存控制：

class ExternalData extends Model { use \Sushi\Sushi; public function getRows() { return CSV::fromFile(__DIR__.'/data.csv')->toArray(); } protected function sushiShouldCache() { return true; } protected function sushiCacheReferencePath() { return __DIR__.'/data.csv'; // 基于CSV文件变化更新缓存 } }

自定义表结构

如果需要特定的数据类型或索引：

class Product extends Model { use \Sushi\Sushi; protected $rows = [ ['name' => '产品A', 'price' => '199.99', 'stock' => '100'], ['name' => '产品B', 'price' => '299.99', 'stock' => '50'], ]; protected $schema = [ 'price' => 'float', 'stock' => 'integer', ]; protected function afterMigrate(Blueprint $table) { $table->index('name'); // 添加索引优化查询 } }

🛠️ 实际应用场景示例

场景1：多语言支持的国家选择器

// 在控制器中 public function getCountries() { $countries = Country::orderBy('name')->get(); return view('user.form', [ 'countries' => $countries->map(function($country) { return [ 'value' => $country->code, 'label' => $country->name, 'native_name' => $this->getNativeName($country->code) ]; }) ]); }

场景2：权限检查中间件

class CheckRole { public function handle($request, Closure $next, $role) { $userRole = auth()->user()->role; $requiredRole = Role::find($role); if (!$userRole || !$this->hasPermission($userRole, $requiredRole)) { abort(403, '权限不足'); } return $next($request); } }

场景3：系统配置管理

class SystemSetting extends Model { use \Sushi\Sushi; protected $rows = [ ['key' => 'site_name', 'value' => '我的应用', 'type' => 'string'], ['key' => 'maintenance_mode', 'value' => 'false', 'type' => 'boolean'], ['key' => 'max_users', 'value' => '1000', 'type' => 'integer'], ['key' => 'currency', 'value' => 'CNY', 'type' => 'string'], ]; public static function getValue($key, $default = null) { $setting = static::where('key', $key)->first(); return $setting ? $setting->value : $default; } }

📈 性能优化与最佳实践

1. 数据量控制

Sushi适合中小型数据集（通常不超过几千条记录）。对于大型数据集，建议使用传统数据库。

2. 缓存策略

• 静态数据：使用$rows属性，Sushi会自动缓存
• 动态数据：实现sushiShouldCache()返回true
• 外部文件：使用sushiCacheReferencePath()监控文件变化

3. 批量操作优化

// 设置合适的插入块大小 public $sushiInsertChunkSize = 50; // 默认100，可根据需要调整

4. 避免的陷阱

• ❌ 不要在Sushi模型上使用whereHas（跨数据库限制）
• ✅ 使用whereIn代替复杂的关系查询
• ✅ 充分利用Eloquent的作用域和本地作用域

🔍 调试与问题排查

常见错误及解决方案

错误：SQLSTATE[HY000]: General error: 1 too many SQL variables

解决方案：调整插入块大小

public $sushiInsertChunkSize = 50; // 减少默认的100

错误：Schema检测失败

解决方案：明确定义schema

protected $schema = [ 'id' => 'integer', 'name' => 'string', 'created_at' => 'datetime', ];

🎯 总结

Sushi为Laravel开发者提供了一种优雅的方式来处理固定数据模型。通过本文的实战指南，你已经学会了：

✅快速创建国家、角色等固定数据模型
✅建立完整的Eloquent关系
✅使用验证规则确保数据完整性
✅实现高级缓存和性能优化
✅避免常见陷阱和错误

无论你是需要国家列表、用户角色、系统设置还是其他类型的固定数据，Sushi都能让你的开发工作更加高效。它的简单性和强大功能使其成为每个Laravel开发者工具箱中的必备工具。

现在就开始使用Sushi，享受无数据库Eloquent模型的便利吧！🍣

【免费下载链接】sushiEloquent's missing "array" driver.项目地址: https://gitcode.com/gh_mirrors/su/sushi