Laravel控制器代码复用实践：Trait与基类优化

// app/Traits/ControllerTrait.php
<?php

namespace App\Traits;

use Illuminate\Database\Eloquent\Model;
use Illuminate\View\View;

trait ControllerTrait
{
    /**
     * 通用数据列表展示方法。
     * 接收模型类名、视图路径和数据键名，返回包含所有数据的视图。
     *
     * @param string $modelClass 模型类的完全限定名
     * @param string $viewPath 视图文件路径
     * @param string $dataKey 视图中数据的键名
     * @return View
     * @throws \InvalidArgumentException 如果提供的模型类无效
     */
    protected function showList(string $modelClass, string $viewPath, string $dataKey): View
    {
        // 确保传入的模型类存在且是Eloquent模型
        if (!class_exists($modelClass) || !is_subclass_of($modelClass, Model::class)) {
            throw new \InvalidArgumentException("Invalid model class provided: {$modelClass}");
        }

        // 实例化模型并获取所有数据
        $data = $modelClass::all();

        // 返回包含数据的视图
        return view($viewPath, [
            $dataKey => $data
        ]);
    }

    // 可以在这里添加更多通用的方法，例如 store, update, delete 等
    // protected function storeData(Request $request, string $modelClass, array $rules = []): RedirectResponse
    // {
    //     // ... 验证、保存逻辑
    // }
}

// app/Http/Controllers/GalleryController.php
<?php

namespace App\Http\Controllers;

use App\Models\GalleryModel; // 假设你的模型名为GalleryModel
use App\Traits\ControllerTrait;
use Illuminate\Http\Request;

class GalleryController extends Controller
{
    use ControllerTrait; // 引入通用Trait

    public function create() // 示例方法名，对应原始问题中的create
    {
        // 调用Trait中定义的通用方法
        return $this->showList(GalleryModel::class, 'admin.gallery', 'Gallery');
    }

    // 其他Gallery相关的特定方法...
}

// app/Http/Controllers/VideoController.php
<?php

namespace App\Http\Controllers;

use App\Models\VideoModel; // 假设你的模型名为VideoModel
use App\Traits\ControllerTrait;
use Illuminate\Http\Request;

class VideoController extends Controller
{
    use ControllerTrait; // 引入通用Trait

    public function video() // 示例方法名，对应原始问题中的video
    {
        return $this->showList(VideoModel::class, 'admin.video', 'Video');
    }
}

// app/Http/Controllers/BaseController.php
<?php

namespace App\Http\Controllers;

use App\Traits\ControllerTrait; // 引入Trait
use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
use Illuminate\Foundation\Bus\DispatchesJobs;
use Illuminate\Foundation\Validation\ValidatesRequests;
use Illuminate\Routing\Controller as LaravelBaseController;

class BaseController extends LaravelBaseController
{
    use AuthorizesRequests, DispatchesJobs, ValidatesRequests;
    use ControllerTrait; // 可以在基类中使用Trait，使得所有子类都能访问Trait的方法

    // 可以在这里定义所有控制器都需要的通用属性或方法
    // 例如：日志记录、权限检查、默认视图数据共享等
    protected string $defaultViewPrefix = 'admin.'; // 默认视图前缀

    /**
     * 通用的视图渲染方法。
     *
     * @param string $viewName 视图名称（不含前缀）
     * @param array $data 传递给视图的数据
     * @return \Illuminate\View\View
     */
    protected function renderView(string $viewName, array $data = []): \Illuminate\View\View
    {
        return view($this->defaultViewPrefix . $viewName, $data);
    }

    /**
     * 示例：一个可能需要被子类重写的通用数据处理方法。
     *
     * @param \Illuminate\Http\Request $request
     * @return array
     */
    protected function processData(\Illuminate\Http\Request $request): array
    {
        // 默认的数据处理逻辑
        return $request->all();
    }
}

// app/Http/Controllers/TeamController.php
<?php

namespace App\Http\Controllers;

use App\Models\TeamModel; // 假设你的模型名为TeamModel
use Illuminate\Http\Request;

class TeamController extends BaseController // 继承BaseController
{
    public function team() // 示例方法名，对应原始问题中的team
    {
        // 由于BaseController中引入了ControllerTrait，所以可以直接使用showList方法
        return $this->showList(TeamModel::class, 'admin.team', 'Team');

        // 或者使用BaseController中定义的renderView方法
        // $teams = TeamModel::all();
        // return $this->renderView('team', ['Team' => $teams]);
    }

    /**
     * 示例：重写基类方法以定制行为。
     * 假设BaseController中有一个通用的数据处理方法 `processData`。
     *
     * @param Request $request
     * @return array
     */
    protected function processData(Request $request): array
    {
        // 可以在这里对请求进行预处理或修改，例如移除不必要的字段
        $modifiedRequestData = $request->except(['_token', '_method']);

        // 调用父类的同名方法，执行通用逻辑
        // 注意：这里为了演示，重新构建了一个Request对象，实际情况可能直接传递修改后的数组
        $parentResult = parent::processData(new Request($modifiedRequestData));

        // 可以在父类逻辑执行后，再添加TeamController特有的处理
        $parentResult['extra_info'] = 'Team specific data processed.';

        return $parentResult;
    }
}