Scout Extended: 为 Laravel 应用赋能 Algolia 全功能搜索

Scout Extended:为 Laravel 应用赋能 Algolia 全功能搜索

Laravel 是目前最流行的 PHP Web 应用框架之一,而 Algolia 则是业界领先的搜索即服务(Search-as-a-Service)提供商。Scout Extended 项目巧妙地将这两者结合在一起,为 Laravel 开发者提供了一个强大而易用的搜索解决方案。

Scout Extended 简介

Scout Extended 是一个基于 Laravel Scout 官方包进行扩展的开源项目。它的目标是让 Laravel 开发者能够更加便捷地使用 Algolia 的全部功能,同时保持与 Laravel 生态系统的无缝集成。

Scout Extended Banner

Scout Extended 由 Algolia 官方维护,这保证了它与 Algolia 服务的高度兼容性和持续更新。该项目在 GitHub 上拥有近 400 个星标,显示了开发者社区对其的认可。

主要特性

Scout Extended 在 Laravel Scout 的基础上添加了许多强大的功能:

零停机重新导入: 在生产环境中无缝更新索引数据,不会影响用户体验。
多模型聚合搜索: 通过聚合器(Aggregator)实现跨多个模型的站内搜索。
自动优化搜索相关性: 内置算法自动改善搜索结果的相关性。
应用索引概览: 提供直观的界面查看和管理应用中的所有索引。
实用的宏和门面: 提供了一系列便捷的宏和门面,简化常见操作。

这些特性极大地简化了在 Laravel 应用中实现高质量搜索功能的过程。

安装与使用

要开始使用 Scout Extended,首先需要通过 Composer 安装:

composer require algolia/scout-extended

然后,你需要发布配置文件:

php artisan vendor:publish --provider="Algolia\ScoutExtended\ScoutExtendedServiceProvider"

接下来,在 .env 文件中添加 Algolia 的 API 凭证:

ALGOLIA_APP_ID=your_algolia_app_id
ALGOLIA_SECRET=your_algolia_secret

现在,你就可以开始在模型中使用 Scout Extended 了。只需在模型类中使用 Searchable trait:

use Algolia\ScoutExtended\Searchable;
use Illuminate\Database\Eloquent\Model;

class Post extends Model
{
    use Searchable;
}

高级功能展示

零停机重新导入

Scout Extended 提供了一个优雅的命令来实现零停机重新导入:

php artisan scout:reimport

这个命令会创建一个临时索引,填充数据,然后原子性地切换到新索引,确保搜索功能在整个过程中不会中断。

聚合器实现多模型搜索

通过定义一个聚合器类,你可以轻松实现跨多个模型的搜索:

use Algolia\ScoutExtended\Searchable;
use App\Models\Post;
use App\Models\User;

class ContentAggregator extends Searchable
{
    public function getModels(): array
    {
        return [
            Post::class,
            User::class,
        ];
    }
}

这样,你就可以在一个索引中搜索多种类型的内容。

自定义搜索规则

Scout Extended 允许你轻松自定义搜索规则:

use Algolia\ScoutExtended\Searchable;
use Illuminate\Database\Eloquent\Model;

class Product extends Model
{
    use Searchable;
    
    public function toSearchableArray()
    {
        $array = $this->toArray();
        
        // 自定义排序规则
        $array['_rankingInfo']['customRanking'] = [
            'desc(popularity)',
            'desc(rating)',
        ];
        
        return $array;
    }
}