包简介

A Laravel package as streamlined solution to utilize the speculation rules api.

README 文档

README

This Laravel package provides a streamlined solution to utilize the Speculation Rules API, allowing you to speed up your website performance significantly.

Note

The Speculation Rules API is an experimental technology.
Further information can be found at the MDN Web Docs.

Installation

You can install the package via composer:

composer require innoge/laravel-speculation-rules-api

You can publish the config file with:

php artisan vendor:publish --tag="laravel-speculation-rules-api-config"

This is the contents of the published config file:

<?php

return [
    /*
    |--------------------------------------------------------------------------
    | Default Eagerness
    |--------------------------------------------------------------------------
    |
    | This value is the default eagerness for the prerender and prefetch rules.
    | You can set it to 'eager', 'moderate' or 'conservative'.
    |
    */

    'default_eagerness' => 'moderate',

    /*
    |--------------------------------------------------------------------------
    | Prerender Rules
    |--------------------------------------------------------------------------
    |
    | Here you may specify custom prerender rules for the application.
    |
    */

    'prerender' => [
//        [
//            'source' => 'list',
//            'urls' => ['page-1', 'page-2'],
//            'eagerness' => 'moderate',
//        ],
//        // parameter usage example
//        [
//            ['href_matches' => '/page-3/*'],
//            ['not' => ['href_matches' => '/page-3/*/*']],
//        ],
    ],

    /*
    |--------------------------------------------------------------------------
    | Prefetch Rules
    |--------------------------------------------------------------------------
    |
    | Here you may specify custom prefetch rules for the application.
    |
    */

    'prefetch' => [
//        [
//            'urls' => ['page-4'],
//            'referrer_policy' => 'no-referrer',
//            'eagerness' => 'moderate',
//        ],
    ],

];

Add the following Blade directive inside the head tag.

<html>
<head>
<!-- ... -->
@speculationRulesApi
</head>
...
</html>

Usage

To prerender or prefetch a route, simply add the prerender or prefetch method to the route definition.

// prerender
Route::get('/page-1', function () {
    return view('...');
})->prerender();

// prefetch
Route::get('/page-1', function () {
    return view('...');
})->prefetch();

The level of eagerness can be passed as a parameter to the prerender and prefetch method, e.g.:

// prerender
Route::get('/page-1', function () {
    return view('...');
})->prerender('eager');

// prefetch
Route::get('/page-1', function () {
    return view('...');
})->prefetch('eager');

Prerender/Prefetch

If you prerender an url, all resources will be fetched and the DOM will be rendered in the background. This will avoid most of the layout shifts you had before. If you prefetch a page, only the resources will be fetched. This can lead to a much faster page load.

For more information refer to the following pages:

Eagerness Levels (available as of Chrome 122)

eager Immediately prerender/prefetch the URL.
moderate Prerender/prefetch on link hover.
conservative Prerender/prefetch only on link click.

Alternatively you can utilize the Speculation Rules API through the package configuration, e.g.:

return [

    // ...

    'prerender' => [
        [
            'source' => 'list',
            'urls' => ['page-1'],
            'eagerness' => 'moderate',
        ],
    ],
    
    'prefetch' => [
        [
            'urls' => ['page-2'],
            'referrer_policy' => 'no-referrer',
            'eagerness' => 'moderate',
        ],
    ],
    
];

For further information on the available options, please refer to the MDN Web Docs.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

innoge/laravel-speculation-rules-api 适用场景与选型建议

innoge/laravel-speculation-rules-api 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 154 次下载、GitHub Stars 达 14，最近一次更新时间为 2024 年 08 月 09 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「laravel」「innoge」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 innoge/laravel-speculation-rules-api 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 innoge/laravel-speculation-rules-api 我们能提供哪些服务？

定制开发 / 二次开发

基于 innoge/laravel-speculation-rules-api 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 innoge/laravel-speculation-rules-api 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

innoge/laravel-msgraph-mail 77

Laravel Mail driver for Microsoft Office 365 using the MSGraph API

innoge/laravel-policy-soft-cache 25

This package helps prevent performance problems with frequent Policy calls within your application lifecycle.

innoge/filament-form-faker 16

A package to generate fake input data for Filament forms.

innoge/laravel-mcp 17

A package for developing MCP Servers with Laravel.

foxtes/alfabank-rest 1

Alfabank REST API integration

victord11/laravel-msgraph-mail 0