vlidaban/laravel-访客统计

Laravel 5 的访客追踪和统计

dev-master 2021-08-30 12:48 UTC

This package is auto-updated.

Last update: 2024-08-29 05:31:40 UTC


README

Packagist Packagist Build Status StyleCI Packagist

追踪您的认证和未认证访客、登录尝试、AJAX 请求等。包括一个控制器和许多路由和视图来显示统计信息,以及一个辅助类,方便您轻松获取统计信息(如果您想自己显示统计信息)。

实时演示

安装 - 基本安装

  1. 使用 composer 安装包
composer require vildanbina/laravel-visitor-statistics
  1. 通过执行以下命令运行迁移以安装包的表,记录访问
php artisan migrate
  1. 将中间件添加到 app/Http/Kernel.php
protected $middlewareGroups = [
    ...
    'web' => [
        ...
        \vildanbina\Laravel\VisitorTracker\Middleware\RecordVisits::class,
    ],
    ...
];
  1. Laravel 5.5 有包自动发现功能。如果您使用的是旧版本,请在 config/app.php 中注册服务提供者
...
'providers' => [
    ...
    vildanbina\Laravel\VisitorTracker\VisitorTrackerServiceProvider::class,
    ...
],
...

如果您想自己获取并显示访客统计信息,请在此文件中注册外观

...
'aliases' => [
    ...
    'VisitStats' => vildanbina\Laravel\VisitorTracker\Facades\VisitStats::class,
    ...
],
...
  1. 通过运行以下命令发布配置文件、资产和视图
php artisan vendor:publish

在提供的列表中选择 vildanbina\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 来解析用户代理。

手动获取和显示统计信息

如果您对提供的视图不满意,可以使用 vildanbina\Laravel\VisitorTracker\Facades\VisitStats 类来获取统计数据,然后创建自己的控制器和视图来显示这些数据。

查看位于 src/Controllers/StatisticsController.php 的控制器,了解如何使用这个类,它非常简单。原始类位于 src/VisitStats.php,里面所有的方法都有文档说明,如果您需要更多信息。

许可证

这是一个开源软件,遵循 MIT 许可协议