ben182 / laravel-ab
Laravel A/B 测试工具
Requires
- php: ^7.2 | ^8.0
- illuminate/support: ^6.0 | ^7.0
- jaybizzle/crawler-detect: ^1.2
Requires (Dev)
- mockery/mockery: ^1.0
- orchestra/testbench: 3.9.*
- phpunit/phpunit: ^8.0 | ^9.0
README
此包可以帮助您找到在您的网站上哪些内容有效,哪些无效。
它允许您创建实验和目标。访客将随机收到下一个实验,您可以自定义您的网站以适应该实验。视图和目标转换将被跟踪,您可以在报告中查看结果。
安装
此包可以在 Laravel 5.6 或更高版本中使用。
您可以通过 composer 安装此包
composer require ben182/laravel-ab
配置
安装后发布配置文件
php artisan vendor:publish --provider="Ben182\AbTesting\AbTestingServiceProvider"
您可以在其中定义您的实验和目标。
最后,运行新添加的迁移
php artisan migrate
应该添加两个新的迁移。
用法
实验
@if (AbTesting::isExperiment('logo-big')) <div class="logo-big"></div> @elseif (AbTesting::isExperiment('logo-grayscale')) <div class="logo-greyscale"></div> @elseif (AbTesting::isExperiment('brand-name')) <h1>Brand name</h1> @endif
这是包最基本的使用方法。您不需要初始化任何东西。如果调用 isExperiment
,则包会为您处理所有事情。
或者,您可以使用自定义的 blade if 语句
@ab('logo-big') <div class="logo-big"></div> @elseab('logo-grayscale') <div class="logo-greyscale"></div> @elseab('brand-name') <h1>Brand name</h1> @endab
这将完全一样地工作。
如果您不想进行任何持续的渲染,您可以调用
AbTesting::pageView()
直接触发一个新页面视图和一个随机实验。此函数也将从 isExperiment
中调用。
在底层,一个新会话项将跟踪当前实验。会话只会获得一个实验,并且只会触发一个页面视图。
您可以使用以下方式获取当前实验
// get the underlying model AbTesting::getExperiment() // get the experiment name AbTesting::getExperiment()->name // get the visitor count AbTesting::getExperiment()->visitors
或者,您有一个请求助手供您使用
public function index(Request $request) { // the same as 'AbTesting::getExperiment()' $request->abExperiment() }
目标
要完成目标,只需调用
AbTesting::completeGoal('signup')
此函数将增加分配给活动实验的目标的转换率。如果没有为会话运行活动实验,则会创建一个。您只能在每个会话中触发目标转换一次。这将通过另一个会话项来防止。函数返回基础目标模型。
要获取当前会话中所有完成的目标
AbTesting::getCompletedGoals()
爬虫和机器人
此包可以尝试忽略爬虫和机器人注册页面视图。只需在配置中启用 ignore_crawlers
选项即可。
报告
要获取页面视图、完成的目标和转换的报告,请调用报告命令
php artisan ab:report
这将打印类似以下内容
+---------------+----------+-------------+
| Experiment | Visitors | Goal signup |
+---------------+----------+-------------+
| big-logo | 2 | 1 (50%) |
| small-buttons | 1 | 0 (0%) |
+---------------+----------+-------------+
重置
要重置所有访客和目标完成情况,请调用重置命令
php artisan ab:reset
事件
除了这些,您还可以挂钩到两个事件
ExperimentNewVisitor
在将实验分配给新访客时触发一次。您可以获取实验作为事件的一个属性。GoalCompleted
在目标完成时触发一次。您可以获取目标作为事件的一个属性。
测试
composer test
变更日志
有关最近更改的更多信息,请参阅 CHANGELOG
贡献
有关详细信息,请参阅 CONTRIBUTING
安全
如果您发现任何安全问题,请通过电子邮件 moin@benjaminbortels.de 而不是使用问题跟踪器。
鸣谢
许可
MIT许可证(MIT)。有关更多信息,请参阅许可证文件。
Laravel包模板
本包使用Laravel包模板生成。