Laravel 通用 CRUD 控制器：高效管理多种资源
在 Laravel 应用中，管理多个资源的 CRUD 操作可能变得复杂，尤其当模型数量不断增加时。本文将指导您构建一个通用的 CRUD 控制器，以便在一个控制器中高效处理所有现有的和未来的 CRUD 操作。
为何选择通用控制器？
通用控制器带来以下优势：
- 最大限度减少代码重复： 避免为每个模型编写重复的 CRUD 代码。
- 轻松添加新模型： 只需创建新模型，无需修改控制器代码。
- 保持应用结构一致： 确保所有资源的 CRUD 操作遵循统一的模式。
步骤详解：
步骤一：创建控制器
使用 Artisan 命令创建新的控制器：
<code class="bash">php artisan make:controller GenericController</code>
步骤二：编写控制器逻辑
以下代码展示了 GenericController 的设计，它能够处理任何模型的 CRUD 操作：
<code class="php"><?php
namespace AppHttpControllers;
use IlluminateHttpRequest;
use IlluminateSupportStr;
class GenericController extends Controller
{
protected function getModel($modelName)
{
$modelClass = 'App\Models\' . Str::studly($modelName);
if (!class_exists($modelClass)) {
abort(404, "Model '$modelName' not found.");
}
return new $modelClass;
}
public function index(string $model)
{
$modelInstance = $this->getModel($model);
return response()->json($modelInstance::all());
}
public function show(string $model, int $id)
{
$modelInstance = $this->getModel($model);
return response()->json($modelInstance::findOrFail($id));
}
public function store(Request $request, string $model)
{
$modelInstance = $this->getModel($model);
$data = $request->validate($modelInstance->getFillable());
$created = $modelInstance::create($data);
return response()->json($created, 201);
}
public function update(Request $request, string $model, int $id)
{
$modelInstance = $this->getModel($model);
$item = $modelInstance::findOrFail($id);
$data = $request->validate($modelInstance->getFillable());
$item->update($data);
return response()->json($item);
}
public function destroy(string $model, int $id)
{
$modelInstance = $this->getModel($model);
$item = $modelInstance::findOrFail($id);
$item->delete();
return response()->json(['message' => 'Deleted successfully.']);
}
}</code>
步骤三：定义动态路由
配置路由以使用动态端点：
<code class="php">use AppHttpControllersGenericController;
Route::controller(GenericController::class)->prefix('api/{model}')->group(function () {
Route::get('/', 'index');
Route::get('/{id}', 'show');
Route::post('/', 'store');
Route::put('/{id}', 'update');
Route::delete('/{id}', 'destroy');
});</code>
步骤四：准备模型
确保每个模型都定义了 $fillable 属性，用于指定可批量赋值的字段。例如：
<code class="php"><?php
namespace AppModels;
use IlluminateDatabaseEloquentFactoriesHasFactory;
use IlluminateDatabaseEloquentModel;
class Post extends Model
{
use HasFactory;
protected $fillable = ['title', 'content'];
}</code>
优势总结：
- 可扩展性： 只需添加模型文件即可轻松支持新的模型。
- 代码可重用性： 显著减少冗余代码。
- 简化维护： 专注于业务逻辑，无需处理重复的 CRUD 代码。
适用场景：
此方法非常适合：
- 具有标准 CRUD 逻辑的应用程序。
- 模型共享相同行为的项目。
对于更复杂的业务逻辑，您可能仍然需要单独的控制器。
