
本文深入探讨laravel observers的高级应用,指导开发者如何通过`withoutevents`方法精细控制`retrieved`事件的触发,避免在批量查询时产生不必要的日志或操作。同时,文章将详细演示如何利用observer、控制器或中间件等不同机制,高效地记录用户ip、user-agent等行为数据至独立的`action`模型,以实现全面的用户活动追踪。
在Laravel应用中,Eloquent模型事件(Model Events)和观察者(Observers)是实现业务逻辑与模型生命周期解耦的强大工具。它们允许我们在模型被创建、更新、删除或检索时执行特定的操作。然而,不恰当的使用也可能导致性能问题或不必要的副作用,特别是对于retrieved事件,它在每次模型实例从数据库中加载时都会触发。本教程将指导您如何精细控制这些事件,并实现用户行为的有效日志记录。
retrieved事件在每次Eloquent模型从数据库中被检索时触发。这意味着,无论您是查询单个模型还是一个模型集合,每个被加载的模型实例都会触发一次retrieved事件。在某些场景下,例如在列表页(index方法)批量查询数据时,我们可能不希望为每个模型都触发此事件,因为它可能导致大量的日志记录或其他不必要的开销。
为了解决这个问题,Laravel提供了withoutEvents()静态方法,允许您在执行特定操作期间暂时禁用模型的所有事件(包括Observer)。
原问题中,DictionaryObserver的retrieved方法会在DictionaryController的index方法中,当加载所有Dictionary模型时,为每个模型触发一次Log::info('xxxxxxxxxx'.$dictionary)。这显然不是我们希望在列表页看到的行为。
解决方案: 使用Model::withoutEvents()方法包裹批量查询逻辑。
<?php
namespace App\Http\Controllers;
use App\Models\Dictionary; // 假设您的模型是 Dictionary
use App\Http\Resources\DictionaryResource;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\DB;
use App\Http\Requests\DictionaryRequest; // 假设有此请求验证
class DictionaryController extends Controller
{
// 假设 $this->model 在构造函数中被初始化为 Dictionary::class
protected $model;
public function __construct(Dictionary $model)
{
$this->model = $model;
}
/**
* 显示字典列表,并避免触发 retrieved 事件。
*
* @param Request $request
* @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection
*/
public function index(Request $request)
{
// 使用 withoutEvents 包裹查询,以防止在批量加载时触发 DictionaryObserver 的 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);
}
// ... 其他方法如 create, store 等保持不变 ...
}通过上述修改,当index方法执行时,Dictionary模型的retrieved事件将不会被触发,从而避免了不必要的日志记录或资源消耗。
原问题中提到“我只需要记录某人打开一条记录进行编辑的时刻,而不是列出所有记录”。虽然withoutEvents解决了批量查询的问题,但对于单个记录的编辑视图(通常由edit或show方法处理),retrieved事件仍会触发。
如果您的retrieved方法中包含需要针对“编辑”操作的特定逻辑,您需要考虑:
示例:在 edit 方法中记录日志
<?php
namespace App\Http\Controllers;
use App\Models\Action; // 假设 Action 模型用于记录用户行为
use App\Models\Dictionary;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Request as FacadesRequest; // 使用别名避免与 Illuminate\Http\Request 冲突
class DictionaryController extends Controller
{
// ... 其他方法 ...
/**
* 显示指定字典的编辑表单。
*
* @param Dictionary $dictionary
* @return \Illuminate\Http\JsonResponse|\Illuminate\View\View
*/
public function edit(Dictionary $dictionary)
{
// 记录用户打开某条记录进行编辑的行为
Action::create([
'user_id' => Auth::id(), // 获取当前登录用户ID
'ip' => FacadesRequest::ip(), // 获取用户IP地址
'user_agent' => FacadesRequest::header('User-Agent'), // 获取用户User-Agent
'description' => 'Opened dictionary for editing: ' . $dictionary->name . ' (ID: ' . $dictionary->id . ')',
// 'company_id' => ... // 如果有公司ID,可以从用户或字典中获取
]);
// 返回用于编辑的数据或视图
return response()->json($dictionary);
}
}记录用户行为(如IP地址、User-Agent、操作描述等)对于审计、安全分析和用户行为分析至关重要。Laravel提供了多种机制来实现这一目标,包括模型观察者(Observers)、控制器(Controllers)和中间件(Middleware)。
当您需要记录与特定模型生命周期事件(创建、更新、删除)相关的用户行为时,Observer是一个非常合适的选择。
Action 模型定义:
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;
class Action extends Model
{
use SoftDeletes; // 如果需要软删除
protected $guarded = ['id']; // 保护 'id' 字段不被批量赋值
protected $fillable = [
'company_id',
'user_id',
'ip',
'user_agent',
'description',
'action_type', // 可以添加一个字段来区分操作类型,例如 'created', 'updated', 'deleted'
'model_type', // 记录是哪个模型的行为
'model_id', // 记录是哪个模型实例的行为
];
protected $dates = [
'deleted_at',
'created_at',
'updated_at'
];
}DictionaryObserver 中记录行为:
<?php
namespace App\Observers;
use App\Models\Dictionary;
use App\Models\Action; // 引入 Action 模型
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Request; // 使用 Request Facade 获取请求信息
use Illuminate\Support\Facades\Log;
class DictionaryObserver
{
/**
* 处理 Dictionary "created" 事件。
*
* @param Dictionary $dictionary
* @return void
*/
public function created(Dictionary $dictionary)
{
Action::create([
'user_id' => Auth::id(), // 获取当前登录用户ID
'ip' => Request::ip(), // 获取用户IP地址
'user_agent' => Request::header('User-Agent'), // 获取用户User-Agent
'description' => 'Created dictionary: ' . $dictionary->name,
'action_type' => 'created',
'model_type' => Dictionary::class,
'model_id' => $dictionary->id,
// 'company_id' => ... // 如果有公司ID,可以从用户或字典中获取
]);
Log::info('Dictionary created: ' . $dictionary->id);
}
/**
* 处理 Dictionary "updated" 事件。
*
* @param Dictionary $dictionary
* @return void
*/
public function updated(Dictionary $dictionary)
{
Action::create([
'user_id' => Auth::id(),
'ip' => Request::ip(),
'user_agent' => Request::header('User-Agent'),
'description' => 'Updated dictionary: ' . $dictionary->name,
'action_type' => 'updated',
'model_type' => Dictionary::class,
'model_id' => $dictionary->id,
]);
Log::info('Dictionary updated: ' . $dictionary->id);
}
/**
* 处理 Dictionary "deleted" 事件。
*
* @param Dictionary $dictionary
* @return void
*/
public function deleted(Dictionary $dictionary)
{
Action::create([
'user_id' => Auth::id(),
'ip' => Request::ip(),
'user_agent' => Request::header('User-Agent'),
'description' => 'Deleted dictionary: ' . $dictionary->name,
'action_type' => 'deleted',
'model_type' => Dictionary::class,
'model_id' => $dictionary->id,
]);
Log::info('Dictionary deleted: ' . $dictionary->id);
}
/**
* 处理 Dictionary "retrieved" 事件。
*
* @param Dictionary $dictionary
* @return void
*/
public function retrieved(Dictionary $dictionary)
{
// 仅在需要记录单个模型被查看时才启用此处的日志
// 由于 index 方法已使用 withoutEvents 排除,此处仅对单个模型加载生效。
// 如果需要更精确地记录“打开编辑”,建议在控制器 edit 方法中处理。
Log::info('Dictionary retrieved: ' . $dictionary->id);
}
}注册 Observer:
确保在 App\Providers\AppServiceProvider 的 boot 方法中注册您的观察者:
<?php
namespace App\Providers;
use App\Models\Dictionary;
use App\Observers\DictionaryObserver;
use Illuminate\Pagination\Paginator;
use Illuminate\Support\ServiceProvider;
class AppServiceProvider extends ServiceProvider
{
/**
* Register any application services.
*
* @return void
*/
public function register()
{
//
}
/**
* Bootstrap any application services.
*
* @return void
*/
public function boot()
{
Paginator::useBootstrap();
Dictionary::observe(DictionaryObserver::class);
}
}如果您的需求是记录所有(或特定路由组)的用户请求行为,而不仅仅是模型操作,那么中间件(Middleware)是更合适的选择。
创建中间件:
php artisan make:middleware LogUserActivity
LogUserActivity 中间件:
<?php
namespace App\Http\Middleware;
use Closure;
use Illuminate\Http\Request;
use App\Models\Action;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Log;
class LogUserActivity
{
/**
* 处理传入请求。
*
* @param \Illuminate\Http\Request $request
* @param \Closure(\Illuminate\Http\Request): (\Illuminate\Http\Response|\Illuminate\Http\RedirectResponse) $next
* @return \Illuminate\Http\Response|\Illuminate\Http\RedirectResponse
*/
public function handle(Request $request, Closure $next)
{
$response = $next($request);
// 记录用户活动,可以在请求处理完成后进行
try {
if (Auth::check()) { // 确保用户已登录
Action::create([
'user_id' => Auth::id(),
'ip' => $request->ip(),
'user_agent' => $request->header('User-Agent'),
'description' => 'Accessed URL: ' . $request->fullUrl(),
'action_以上就是Laravel Observers:精细控制事件触发与用户行为日志实现的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号