Laravel Scout 项目教程

Laravel Scout 项目教程

scoutLaravel Scout provides a driver based solution to searching your Eloquent models.项目地址:https://gitcode.com/gh_mirrors/sc/scout

1. 项目的目录结构及介绍

Laravel Scout 是一个用于全文搜索的扩展包，它为 Eloquent 模型添加了简单的、基于驱动程序的搜索功能。以下是 Laravel Scout 项目的基本目录结构及其介绍：

laravel/scout/
├── src/
│   ├── Console/
│   │   ├── ImportCommand.php
│   │   ├── MakeSearchable.php
│   │   ├── RemoveFromSearch.php
│   ├── Engines/
│   │   ├── AlgoliaEngine.php
│   │   ├── CollectionEngine.php
│   │   ├── DatabaseEngine.php
│   │   ├── NullEngine.php
│   │   ├── Engine.php
│   ├── Builder.php
│   ├── Eloquent/
│   │   ├── Searchable.php
│   ├── Jobs/
│   │   ├── MakeSearchable.php
│   │   ├── RemoveFromSearch.php
│   ├── Searchable.php
│   ├── ScoutServiceProvider.php
├── tests/
│   ├── Feature/
│   │   ├── SearchableTest.php
│   │   ├── ImportCommandTest.php
│   ├── Unit/
│   │   ├── BuilderTest.php
│   │   ├── Engines/
│   │   │   ├── AlgoliaEngineTest.php
│   │   │   ├── CollectionEngineTest.php
│   │   │   ├── DatabaseEngineTest.php
│   │   │   ├── NullEngineTest.php
├── composer.json
├── README.md

目录结构介绍

• src/：包含 Scout 扩展包的核心代码。
  • Console/：包含与命令行相关的类，如导入命令、搜索命令等。
  • Engines/：包含不同搜索引擎的实现，如 Algolia、Collection、Database 等。
  • Eloquent/：包含与 Eloquent 模型相关的类，如 Searchable trait。
  • Jobs/：包含与队列任务相关的类，如 MakeSearchable 和 RemoveFromSearch。
  • ScoutServiceProvider.php：Scout 的服务提供者，用于注册 Scout 的服务。
• tests/：包含 Scout 扩展包的测试代码。
  • Feature/：包含功能测试。
  • Unit/：包含单元测试。
• composer.json：Composer 配置文件，定义了依赖关系和其他元数据。
• README.md：项目说明文档。

2. 项目的启动文件介绍

在 Laravel Scout 项目中，主要的启动文件是 ScoutServiceProvider.php。这个文件位于 src/ 目录下，负责注册 Scout 的服务和命令。

ScoutServiceProvider.php

namespace Laravel\Scout;

use Illuminate\Support\ServiceProvider;
use Laravel\Scout\Console\ImportCommand;
use Laravel\Scout\Console\MakeSearchable;
use Laravel\Scout\Console\RemoveFromSearch;

class ScoutServiceProvider extends ServiceProvider
{
    /**
     * Register the service provider.
     *
     * @return void
     */
    public function register()
    {
        $this->app->singleton(EngineManager::class, function ($app) {
            return new EngineManager($app);
        });
    }

    /**
     * Bootstrap any application services.
     *
     * @return void
     */
    public function boot()
    {
        if ($this->app->runningInConsole()) {
            $this->commands([
                ImportCommand::class,
                MakeSearchable::class,
                RemoveFromSearch::class,
            ]);
        }

        $this->publishes([
            __DIR__.'/../config/scout.php' => config_path('scout.php'),
        ]);
    }
}

功能介绍

• register() 方法：注册 Scout 的引擎管理器。
• boot() 方法：在应用启动时注册命令行命令，并发布配置文件。

3. 项目的配置文件介绍

Laravel Scout 的配置文件是 scout.php，它位于项目的 config/ 目录下。这个文件定义了 Scout 的各种配置选项。

scout.php

return [

    /*
    |--------------------------------------------------------------------------
    | Driver
    |--------------------------------------------------------------------------
   

scoutLaravel Scout provides a driver based solution to searching your Eloquent models.项目地址:https://gitcode.com/gh_mirrors/sc/scout