这篇文章主要给大家介绍了利用 Laravel 事件系统如何实现登录日志记录的相关资料,文中介绍的非常详细,对大家具有一定的参考学习价值,需要的朋友们下面来一起看看吧。
本文介绍的是利用 Laravel
事件队列系统,实现使用队列记录用户登录的日志、IP 等相关信息,分享出来给大家参考。下面来看看详细的步骤:
一、明确需求
我们的需要记录一下登录日志,通常需要下列信息:
- 客户端 Agent 详情
- 客户端 IP 详情
- 访问 IP 地理位置
- 登录具体时间
- 登录用户信息
二、明确使用工具
明确完需求任务后,再根据每个需求任务查找对应的工具,工欲善其事必先利其器:
- 需求1
jenssegers/agent
就可以满足记录 Agent 信息 - 需求2 Laravel 下直接使用
Request::getClientIp()
获取 IP - 需求3
zhuzhichao/ip-location-zh
这个包可以满足要求 - 需求4 time()
- 需求5 登录用户模型
三、开工搭建
3.1 引入 composer 扩展
我们需要记录登录用户的 IP 地址,通 IP
地址转换用户的地址等信息,因此需要引入一些扩展包,安装命令如下:
composer require jenssegers/agent
composer require zhuzhichao/ip-location-zh
采用 Laravel 的事件订阅系统来实现,需要实现一个登录事件和一个登录事件监听器。
3.2 生成事件和监听器
Laravel 命令行支持自动生成事件和监听器,在 App\Providers\EventServiceProvider 中添加需要实现的事件:
protected $listen = [
...,
// 添加登录事件及对应监听器,一个事件可绑定多个监听器
'App\Events\LoginEvent' => [
'App\Listeners\LoginListener',
],
];
运行命令:php artisan event:generate
就会自动生成事件和监听器,已存在的事件和监听器不会发生改变。
3.3 登录事件(Event)
回顾下需求,我们的登录事件需要的 5 点信息,在事件中需要记录这些信息,所以事件设计如下:
<?php
namespace App\Events;
use Illuminate\Broadcasting\Channel;
use Illuminate\Queue\SerializesModels;
use Illuminate\Broadcasting\PrivateChannel;
use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Broadcasting\InteractsWithSockets;
use App\Models\User;
use Jenssegers\Agent\Agent;
class LoginEvent
{
use Dispatchable, InteractsWithSockets, SerializesModels;
/**
* @var User 用户模型
*/
protected $user;
/**
* @var Agent Agent对象
*/
protected $agent;
/**
* @var string IP地址
*/
protected $ip;
/**
* @var int 登录时间戳
*/
protected $timestamp;
/**
* 实例化事件时传递这些信息
*
* LoginEvent constructor.
* @param $user
* @param $agent
* @param $ip
* @param $timestamp
*/
public function __construct($user, $agent, $ip, $timestamp)
{
$this->user = $user;
$this->agent = $agent;
$this->ip = $ip;
$this->timestamp = $timestamp;
}
public function getUser()
{
return $this->user;
}
public function getAgent()
{
return $this->agent;
}
public function getIp()
{
return $this->ip;
}
public function getTimestamp()
{
return $this->timestamp;
}
/**
* Get the channels the event should broadcast on.
*
* @return Channel|array
*/
public function broadcastOn()
{
return new PrivateChannel('channel-default');
}
}
在事件中记录所需要的信息,并实现这些信息的 get 方法。
3.4 登录监听器(Listener)
在监听器中,获取到事件传递过来的信息,把这些信息记录到数据库中,实现如下:
<?php
namespace App\Listeners;
use App\Events\LoginEvent;
use Illuminate\Support\Facades\DB;
use Zhuzhichao\IpLocationZh\Ip;
class LoginListener
{
/**
* handle 方法中处理事件
*
* @param LoginEvent $event
*/
public function handle(LoginEvent $event)
{
//获取事件中保存的信息
$user = $event->getUser();
$agent = $event->getAgent();
$ip = $event->getIp();
$timestamp = $event->getTimestamp();
// 登录信息
$login_info = [
'ip' => $ip,
'login_time' => $timestamp,
'user_id' => $user->id
];
// zhuzhichao/ip-location-zh 包含的方法获取 ip 地理位置
$addresses = Ip::find($ip);
$login_info['address'] = implode(' ', $addresses);
// jenssegers/agent 的方法来提取agent信息
$login_info['device'] = $agent->device(); //设备名称
$browser = $agent->browser();
$login_info['browser'] = $browser.' '.$agent->version($browser); //浏览器
$platform = $agent->platform();
$login_info['platform'] = $platform.' '.$agent->version($platform); //操作系统
$login_info['language'] = implode(',', $agent->languages()); //语言
// 设备类型
if ($agent->isTablet()) {
// 平板
$login_info['device_type'] = 'tablet';
} elseif ($agent->isMobile()) {
// 便捷设备
$login_info['device_type'] = 'mobile';
} elseif ($agent->isRobot()) {
// 爬虫机器人
$login_info['device_type'] = 'robot';
$login_info['device'] = $agent->robot(); //机器人名称
} else {
// 桌面设备
$login_info['device_type'] = 'desktop';
}
// 插入到数据库
DB::table('login_log')->insert($login_info);
}
}
这样,监听器就完成了,每次一触发登录事件,就会在数据库中添加一条登录信息。
3.5 触发事件
通过全局的 event()
方法来触发事件,event()
方法的参数为事件实例:
<?php
namespace App\Controllers;
// ...
use App\Events\LoginEvent;
use Jenssegers\Agent\Agent;
class AuthControoler extends Controller
{
public function login(Request $request)
{
// 登录实现
// ...
// 登录成功,触发事件
event(new LoginEvent(auth('api')->user(), new Agent(), \Request::getClientIp(), time()));
// ...
}
}
3.6 队列化监听器
有时监听器会进行一些耗时任务工作,这时我们可以使用 Laravel
的队列系统,将监听器进行队列化,前提是已经配置了队列并开启了队列处理器。
队列化非常简单,只需监听器实现 ShouldQueue 接口即可,即:
<?php
namespace App\Listeners;
...
use Illuminate\Contracts\Queue\ShouldQueue;
class LoginListener implements ShouldQueue
{
/**
* 失败重试次数
*
* @var int
*/
public $tries = 1;
// ...
}
四、总结
Laravel
的事件系统实现起来还是非常优雅的,同一个事件可以很方便的添加各类监听器,且各个监听器之间互不干扰,解耦性非常强。加上队列系统,可以很方便的处理一些后续任务。