Laravel 模型观察器深度指南：事件管理与用户行为日志

// App\Providers\EventServiceProvider.php
use App\Models\Dictionary;
use App\Observers\DictionaryObserver;
use Illuminate\Pagination\Paginator;

public function boot()
{
    Paginator::useBootstrap();
    Dictionary::observe(DictionaryObserver::class);
}

// Controller
public function index(Request $request)
{
    $query = $this->model->orderBy($request->column ?? 'created_at', $request->order ?? 'desc');
    // ... 其他查询条件
    return DictionaryResource::collection($query->paginate($request->per_page));
}

// App\Http\Controllers\DictionaryController.php
<?php

namespace App\Http\Controllers;

use App\Models\Dictionary; // 确保引入 Dictionary 模型
use Illuminate\Http\Request;
use App\Http\Resources\DictionaryResource;

class DictionaryController extends Controller
{
    protected $model;

    public function __construct(Dictionary $model)
    {
        $this->model = $model;
    }

    public function index(Request $request)
    {
        // 在不触发 Dictionary 模型事件（包括 retrieved）的情况下检索数据
        $dictionaries = Dictionary::withoutEvents(function () use ($request) {
            $query = $this->model
                        ->orderBy($request->column ?? 'created_at', $request->order ?? 'desc');

            if ($request->search) {
                $query->where(function ($query) use ($request) {
                    $query->where('name', 'like', '%' . $request->search . '%')
                        ->orWhere('id', 'like', '%' . $request->search . '%');
                });
            }
            return $query->paginate($request->per_page);
        });

        return DictionaryResource::collection($dictionaries);
    }

    // ... 其他方法
}

// App\Http\Controllers\DictionaryController.php
<?php

namespace App\Http\Controllers;

use App\Models\Dictionary;
use App\Models\Action; // 假设您有 Action 模型用于记录行为
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth; // 引入 Auth Facade
use App\Http\Resources\DictionaryResource;

class DictionaryController extends Controller
{
    // ... 构造函数及 index 方法

    public function show(Dictionary $dictionary)
    {
        // 记录用户查看单个字典项的行为
        if (Auth::check()) {
            Action::create([
                'user_id' => Auth::id(),
                'ip' => request()->ip(), // 获取用户IP
                'user_agent' => request()->userAgent(), // 获取User Agent
                'description' => 'Viewed Dictionary ID: ' . $dictionary->id . ' Name: ' . $dictionary->name,
                // 根据 Action 模型的 fillable 字段添加其他信息
            ]);
        }
        return new DictionaryResource($dictionary);
    }

    public function edit(Dictionary $dictionary)
    {
        // 记录用户打开编辑页面
        if (Auth::check()) {
            Action::create([
                'user_id' => Auth::id(),
                'ip' => request()->ip(),
                'user_agent' => request()->userAgent(),
                'description' => 'Opened Dictionary ID: ' . $dictionary->id . ' for editing Name: ' . $dictionary->name,
            ]);
        }
        // 返回编辑所需的数据，例如：
        return response()->json($dictionary);
    }
}

// App\Models\Action.php
<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;

class Action extends Model
{
    use SoftDeletes; // 如果需要软删除

    protected $guarded = ['id']; // 或者使用 $fillable 明确指定可填充字段

    protected $fillable = [
        'company_id', // 如果适用
        'user_id',
        'ip',
        'user_agent',
        'description',
        // 其他您想记录的字段
    ];

    protected $dates = [
        'deleted_at',
        'created_at',
        'updated_at',
    ];
}

// App\Observers\DictionaryObserver.php
<?php

namespace App\Observers;

use App\Models\Dictionary;
use App\Models\Action; // 确保引入 Action 模型
use Illuminate\Support\Facades\Auth; // 引入 Auth Facade
use Illuminate\Support\Facades\Request; // 引入 Request Facade

class DictionaryObserver
{
    /**
     * 辅助方法，用于记录通用的行为日志
     */
    protected function recordAction(Dictionary $dictionary, string $type)
    {
        // 只有当用户已登录时才记录行为
        if (Auth::check()) {
            Action::create([
                // 'company_id' => Auth::user()->company_id ?? null, // 如果用户模型有 company_id 字段
                'user_id' => Auth::id(), // 当前登录用户的ID
                'ip' => Request::ip(), // 获取客户端IP地址
                'user_agent' => Request::userAgent(), // 获取客户端User Agent
                'description' => sprintf('%s Dictionary ID: %s, Name: %s', $type, $dictionary->id, $dictionary->name),
            ]);
        }
    }

    /**
     * Handle the Dictionary "created" event.
     *
     * @param  \App\Models\Dictionary  $dictionary
     * @return void
     */
    public function created(Dictionary $dictionary)
    {
        $this->recordAction($dictionary, 'Created');
    }

    /**
     * Handle the Dictionary "updated" event.
     *
     * @param  \App\Models\Dictionary  $dictionary
     * @return void
     */
    public function updated(Dictionary $dictionary)
    {
        $this->recordAction($dictionary, 'Updated');
    }

    /**
     * Handle the Dictionary "deleted" event.
     *
     * @param  \App\Models\Dictionary  $dictionary
     * @return void
     */
    public function deleted(Dictionary $dictionary)
    {
        $this->recordAction($dictionary, 'Deleted');
    }

    /**
     * Handle the Dictionary "retrieved" event.
     *
     * 注意：此方法在模型被检索时触发。
     * 如果您在控制器中使用了 withoutEvents()，此方法可能不会触发。
     * 谨慎在此处记录行为日志，以免产生大量不必要的记录。
     *
     * @param  \App\Models\Dictionary  $dictionary
     * @return void
     */
    public function retrieved(Dictionary $dictionary)
    {
        // Log::info('Retrieved Dictionary: ' . $dictionary->id);
        // 通常不在此处记录用户行为，除非有特殊需求且已处理批量加载情况
    }
}