本文深入探讨laravel observers的高级应用，指导开发者如何通过`withoutevents`方法精细控制`retrieved`事件的触发，避免在批量查询时产生不必要的日志或操作。同时，文章将详细演示如何利用observer、控制器或中间件等不同机制，高效地记录用户ip、user-agent等行为数据至独立的`action`模型，以实现全面的用户活动追踪。
在Laravel应用中，Eloquent模型事件（Model Events）和观察者（Observers）是实现业务逻辑与模型生命周期解耦的强大工具。它们允许我们在模型被创建、更新、删除或检索时执行特定的操作。然而，不恰当的使用也可能导致性能问题或不必要的副作用，特别是对于retrieved事件，它在每次模型实例从数据库中加载时都会触发。本教程将指导您如何精细控制这些事件，并实现用户行为的有效日志记录。
1. 精细控制 retrieved 事件的触发
retrieved事件在每次Eloquent模型从数据库中被检索时触发。这意味着，无论您是查询单个模型还是一个模型集合，每个被加载的模型实例都会触发一次retrieved事件。在某些场景下，例如在列表页（index方法）批量查询数据时，我们可能不希望为每个模型都触发此事件，因为它可能导致大量的日志记录或其他不必要的开销。
为了解决这个问题，Laravel提供了withoutEvents()静态方法，允许您在执行特定操作期间暂时禁用模型的所有事件（包括Observer）。
1.1 问题分析与解决方案
原问题中，DictionaryObserver的retrieved方法会在DictionaryController的index方法中，当加载所有Dictionary模型时，为每个模型触发一次Log::info(‘xxxxxxxxxx’.$dictionary)。这显然不是我们希望在列表页看到的行为。
解决方案： 使用Model::withoutEvents()方法包裹批量查询逻辑。
model 在构造函数中被初始化为 Dictionary::class protected $model; public function __construct(Dictionary $model) { $this->model = $model; } /** * 显示字典列表，并避免触发 retrieved 事件。 * * @param Request $request * @return IlluminateHttpResourcesJsonAnonymousResourceCollection */ 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事件将不会被触发，从而避免了不必要的日志记录或资源消耗。
1.2 处理单个记录的编辑视图
原问题中提到“我只需要记录某人打开一条记录进行编辑的时刻，而不是列出所有记录”。虽然withoutEvents解决了批量查询的问题，但对于单个记录的编辑视图（通常由edit或show方法处理），retrieved事件仍会触发。
如果您的retrieved方法中包含需要针对“编辑”操作的特定逻辑，您需要考虑：
接受retrieved事件在单个模型加载时触发： 如果retrieved中的逻辑是通用的“模型被查看”操作，那么让它在edit或show方法中触发是合理的。更精确地记录“编辑”行为： 如果您只想记录用户明确“打开编辑页面”这一行为，那么将日志逻辑直接放置在DictionaryController的edit方法中会更精确。
示例：在 edit 方法中记录日志
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); }}
2. 实现用户行为日志记录
记录用户行为（如IP地址、User-Agent、操作描述等）对于审计、安全分析和用户行为分析至关重要。Laravel提供了多种机制来实现这一目标，包括模型观察者（Observers）、控制器（Controllers）和中间件（Middleware）。
2.1 使用 Observer 记录模型特定操作
当您需要记录与特定模型生命周期事件（创建、更新、删除）相关的用户行为时，Observer是一个非常合适的选择。
Action 模型定义：
<?phpnamespace AppModels;use IlluminateDatabaseEloquentModel;use IlluminateDatabaseEloquentSoftDeletes;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 中记录行为：
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：
确保在 AppProvidersAppServiceProvider 的 boot 方法中注册您的观察者：
<?phpnamespace AppProviders;use AppModelsDictionary;use AppObserversDictionaryObserver;use IlluminatePaginationPaginator;use IlluminateSupportServiceProvider;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); }}
2.2 使用 Middleware 记录全局请求行为
如果您的需求是记录所有（或特定路由组）的用户请求行为，而不仅仅是模型操作，那么中间件（Middleware）是更合适的选择。
创建中间件：
php artisan make:middleware LogUserActivity
LogUserActivity 中间件：
Auth::id(), 'ip' => $request->ip(), 'user_agent' => $request->header('User-Agent'), 'description' => 'Accessed URL: ' . $request->fullUrl(), 'action_
以上就是Laravel Observers：精细控制事件触发与用户行为日志实现的详细内容，更多请关注php中文网其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/1342410.html
微信扫一扫 
支付宝扫一扫 
