haggag / laravel-visitors
Laravel 6+的访问者追踪和统计工具
Requires
- php: >=7.0|^8.1|^8.2
- guzzlehttp/guzzle: ^6.0 | ^7.0 | ^8.0 | ^9.0 | ^10.0 | ^11.0
- illuminate/bus: 5.5.* | 5.6.* | 5.7.* | 6.* | 7.* | 8.* | 9.* | 10.* | 11.*
- illuminate/contracts: 5.5.* | 5.6.* | 5.7.* | 6.* | 7.* | 8.* | 9.* | 10.* | 11.*
- illuminate/database: 5.5.* | 5.6.* | 5.7.* | 6.* | 7.* | 8.* | 9.* | 10.* | 11.*
- illuminate/http: 5.5.* | 5.6.* | 5.7.* | 6.* | 7.* | 8.* | 9.* | 10.* | 11.*
- illuminate/queue: 5.5.* | 5.6.* | 5.7.* | 6.* | 7.* | 8.* | 9.* | 10.* | 11.*
- illuminate/support: 5.5.* | 5.6.* | 5.7.* | 6.* | 7.* | 8.* | 9.* | 10.* | 11.*
- piwik/device-detector: ^3.9
Requires (Dev)
- orchestra/testbench: ^3.5
- phpunit/phpunit: ^6.5 | ^7.0 | ^8.0 | ^9.0 | ^10.0 | ^11.0
README
追踪您的已认证和未认证访问者,登录尝试,AJAX请求等。包括一个控制器和一系列路由和视图来显示统计信息,以及一个助手类来轻松获取统计信息(如果您想自行显示统计信息)。
安装 - 基础
- 使用composer安装包
composer require voerro/laravel-visitor-tracker
- 执行迁移以安装包的表来记录访问,通过执行
php artisan migrate
- 将中间件添加到
app/Http/Kernel.php
protected $middlewareGroups = [ ... 'web' => [ ... \Voerro\Laravel\VisitorTracker\Middleware\RecordVisits::class, ], ... ];
- Laravel 5.5具有包自动发现。如果您使用的是旧版本,请在
config/app.php中注册服务提供者
... 'providers' => [ ... Voerro\Laravel\VisitorTracker\VisitorTrackerServiceProvider::class, ... ], ...
如果您想自行获取和显示访问者统计信息,请在该文件中注册外观
... 'aliases' => [ ... 'VisitStats' => Voerro\Laravel\VisitorTracker\Facades\VisitStats::class, ... ], ...
- 通过运行来发布配置文件,资产和视图
php artisan vendor:publish
在提供的列表中选择Voerro\Laravel\VisitorTracker\VisitorTrackerServiceProvider
安装 - Geoapi
追踪器使用外部API获取地理位置数据。要关闭geoapi,将配置文件中的geoip_on设置设置为false。要更改提供者,更改geoip_driver字段。支持的驱动程序在配置文件中列出。根据您选择的驱动程序,您可能需要填写额外的API密钥。
由于从外部API获取数据需要时间,因此该操作被排队并异步执行。这是使用Laravel Jobs完成的,可能在共享主机上无法工作。支持多个驱动程序。我们将描述如何设置数据库驱动程序。
首先,在您的.env文件中需要设置
QUEUE_DRIVER=database
然后依次运行以下命令
php artisan queue:table php artisan queue:failed-table php artisan migrate
最后,您需要启动一个工作进程来处理队列。运行以下命令并保持运行
php artisan queue:work
有关队列和作业的更多信息,请参阅Laravel文档。此部分描述了在作业进程失败时如何自动重启队列工作进程。
注意:每次您修改包的配置文件时,都需要重新启动工作进程。
配置
查看config/visitortracker.php文件。它有很好的注释,不需要额外的说明。您可以在那里排除某些用户组、单个用户和某些请求等。
测试
在测试环境中禁用了外部API调用以检索地理位置信息。否则,由于追踪器跟踪所有请求,测试将运行得非常慢。
显示统计信息
该包附带一个控制器和一系列路由和视图来显示统计信息。您可以使用VisitStats类自行获取和显示统计信息,但我们将稍后讨论。提供的视图简单明了,并使用标准的Bootstrap类进行样式化。
要安装内置路由,请将此行添加到您的routes.php文件中
VisitStats::routes();
您可以将此行放入一个组中,以通过中间件限制访问或为路由添加前缀。例如,如下所示
Route::middleware('auth')->prefix('admin')->group(function () { VisitStats::routes(); });
您可以将视图集成到现有的布局中。查看配置文件的Views部分。所有路由都命名,您可以轻松添加和样式化链接到所有页面。以下为路由的完整列表。
收集哪些信息
这是追踪器正在收集的数据。
该软件包使用 piwik/device-detector 来解析用户代理。
手动获取和显示统计信息
如果您对提供的视图不满意,可以使用 Voerro\Laravel\VisitorTracker\Facades\VisitStats 类来获取统计数据,然后创建自己的控制器和视图来显示这些数据。
查看位于 src/Controllers/StatisticsController.php 的控制器,了解如何使用该类,它非常简单。原始类位于 src/VisitStats.php,其中的所有方法都有文档说明,以便您需要更多深入了解。
许可证
这是一个开源软件,受 MIT 许可协议 许可。"# laravel-visitors"