查看: 2440|回复: 0

[PHP学习] 利用Laravel事件系统如何实现登录日志的记录详解

发表于 2018-4-1 10:54:03

本文介绍的是利用Laravel事件系统实现登录日志记录的相关内容,分享出来给大家参考,下面来看看详细的介绍:

明确需求

记录一个登录日志,通常需要下列信息:

  • 客户端Agent信息
  • 客户端IP地址
  • 访问IP地点
  • 登录时间
  • 登录用户信息

确立工具

明确完需求后,根据每个需求查找自己所需的工具吧。

  • 需求1 jenssegers/agent就可以满足我们要求
  • 需求2 Laravel下直接Request::getClientIp()
  • 需求3 zhuzhichao/ip-location-zh这个包可以满足要求
  • 需求4 time()
  • 需求5 登录用户模型

开工

采用Laravel的事件订阅系统来实现,需要实现一个登录事件和一个登录事件监听器。

生成事件和监听器

Laravel命令行支持自动生成事件和监听器,在App\Providers\EventServiceProvider中添加需要实现的事件:

  1. protected $listen = [
  2. ...,
  3. //添加登录事件及对应监听器,一个事件可绑定多个监听器
  4. 'App\Events\LoginEvent' => [
  5. 'App\Listeners\LoginListener',
  6. ],
  7. ];
复制代码

运行命令:php artisan event:generate就会自动生成事件和监听器,已存在的事件和监听器不会发生改变。

登录事件(Event)

回顾下需求,我们的登录事件需要的5点信息,在事件中需要记录这些信息,所以事件设计如下:

  1. namespace App\Events;
  2. use Illuminate\Broadcasting\Channel;
  3. use Illuminate\Queue\SerializesModels;
  4. use Illuminate\Broadcasting\PrivateChannel;
  5. use Illuminate\Foundation\Events\Dispatchable;
  6. use Illuminate\Broadcasting\InteractsWithSockets;
  7. use App\Models\User;
  8. use Jenssegers\Agent\Agent;
  9. class LoginEvent
  10. {
  11. use Dispatchable, InteractsWithSockets, SerializesModels;
  12. /**
  13. * @var User 用户模型
  14. */
  15. protected $user;
  16. /**
  17. * @var Agent Agent对象
  18. */
  19. protected $agent;
  20. /**
  21. * @var string IP地址
  22. */
  23. protected $ip;
  24. /**
  25. * @var int 登录时间戳
  26. */
  27. protected $timestamp;
  28. /**
  29. * 实例化事件时传递这些信息
  30. */
  31. public function __construct($user, $agent, $ip, $timestamp)
  32. {
  33. $this->user = $user;
  34. $this->agent = $agent;
  35. $this->ip = $ip;
  36. $this->timestamp = $timestamp;
  37. }
  38. public function getUser()
  39. {
  40. return $this->user;
  41. }
  42. public function getAgent()
  43. {
  44. return $this->agent;
  45. }
  46. public function getIp()
  47. {
  48. return $this->ip;
  49. }
  50. public function getTimestamp()
  51. {
  52. return $this->timestamp;
  53. }
  54. /**
  55. * Get the channels the event should broadcast on.
  56. *
  57. * @return Channel|array
  58. */
  59. public function broadcastOn()
  60. {
  61. return new PrivateChannel('channel-default');
  62. }
  63. }
复制代码

在事件中记录所需要的信息,并实现这些信息的get方法。

登录监听器(Listener)

在监听器中,获取到事件传递过来的信息,把这些信息记录到数据库中,实现如下:

  1. namespace App\Listeners;
  2. use App\Events\LoginEvent;
  3. class LoginListener
  4. {
  5. // handle方法中处理事件
  6. public function handle(LoginEvent $event)
  7. {
  8. //获取事件中保存的信息
  9. $user = $event->getUser();
  10. $agent = $event->getAgent();
  11. $ip = $event->getIp();
  12. $timestamp = $event->getTimestamp();
  13. //登录信息
  14. $login_info = [
  15. 'ip' => $ip,
  16. 'login_time' => $timestamp,
  17. 'user_id' => $user->id
  18. ];
  19. // zhuzhichao/ip-location-zh 包含的方法获取ip地理位置
  20. $addresses = \Ip::find($ip);
  21. $login_info['address'] = implode(' ', $addresses);
  22. // jenssegers/agent 的方法来提取agent信息
  23. $login_info['device'] = $agent->device(); //设备名称
  24. $browser = $agent->browser();
  25. $login_info['browser'] = $browser . ' ' . $agent->version($browser); //浏览器
  26. $platform = $agent->platform();
  27. $login_info['platform'] = $platform . ' ' . $agent->version($platform); //操作系统
  28. $login_info['language'] = implode(',', $agent->languages()); //语言
  29. //设备类型
  30. if ($agent->isTablet()) {
  31. // 平板
  32. $login_info['device_type'] = 'tablet';
  33. } else if ($agent->isMobile()) {
  34. // 便捷设备
  35. $login_info['device_type'] = 'mobile';
  36. } else if ($agent->isRobot()) {
  37. // 爬虫机器人
  38. $login_info['device_type'] = 'robot';
  39. $login_info['device'] = $agent->robot(); //机器人名称
  40. } else {
  41. // 桌面设备
  42. $login_info['device_type'] = 'desktop';
  43. }
  44. //插入到数据库
  45. DB::table('login_log')->insert($login_info);
  46. }
  47. }
复制代码

这样,监听器就完成了,每次一触发登录事件,就会在数据库中添加一条登录信息。

触发事件

通过全局的event()方法来触发事件,event()方法的参数为事件实例:

  1. namespace App\Controllers;
  2. ...
  3. use App\Events\LoginEvent;
  4. use Jenssegers\Agent\Agent;
  5. class AuthControoler extends Controller
  6. {
  7. ...
  8. public function login(Request $request)
  9. {
  10. //登录实现
  11. ...
  12. //登录成功,触发事件
  13. event(new LoginEvent($this->guard()->user(), new Agent(), \Request::getClientIp(), time()));
  14. ...
  15. }
  16. }
复制代码

队列化监听器

有时监听器会进行一些耗时操作,这时应该结合Laravel的队列系统将监听器进行队列化,前提是已经配置了队列并开启了队列处理器。

队列化非常简单,只需监听器实现ShouldQueue接口即可,即:

  1. namespace App\Listeners;
  2. ...
  3. use Illuminate\Contracts\Queue\ShouldQueue;
  4. class LoginListener implements ShouldQueue
  5. {
  6. /**
  7. * 失败重试次数
  8. * @var int
  9. */
  10. public $tries = 1;
  11. ...
  12. }
复制代码

总结

Laravel的事件系统实现起来还是非常优雅的,同一个事件可以很方便的添加各类监听器,且各个监听器之间互不干扰,解耦性非常强。加上队列系统,可以很方便的处理一些后续任务。

好了,以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作能带来一定的帮助,如果有疑问大家可以留言交流,谢谢大家对程序员之家的支持。



回复

使用道具 举报