Elastic Scout Driver Plus 使用教程

Elastic Scout Driver Plus 使用教程

elastic-scout-driver-plusExtension for Elastic Scout Driver项目地址:https://gitcode.com/gh_mirrors/el/elastic-scout-driver-plus

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

Elastic Scout Driver Plus 是一个用于 Laravel Scout 的 Elasticsearch 驱动扩展。项目的目录结构如下：

elastic-scout-driver-plus/
├── src/
│   ├── Contracts/
│   ├── Decorators/
│   ├── Engines/
│   ├──Factories/
│   ├── Query/
│   ├── Support/
│   ├── Traits/
│   ├── Searchable.php
│   ├── ScoutServiceProvider.php
│   └── ...
├── tests/
│   ├── Integration/
│   ├── Unit/
│   └── ...
├── composer.json
├── README.md
└── ...

目录介绍

• src/：包含项目的所有源代码。
  • Contracts/：定义接口。
  • Decorators/：包含装饰器类。
  • Engines/：包含搜索引擎类。
  • Factories/：包含工厂类。
  • Query/：包含查询构建器类。
  • Support/：包含支持类。
  • Traits/：包含特性类。
  • Searchable.php：定义可搜索特性。
  • ScoutServiceProvider.php：Scout 服务提供者。
• tests/：包含项目的测试代码。
  • Integration/：集成测试。
  • Unit/：单元测试。
• composer.json：Composer 配置文件。
• README.md：项目说明文档。

2. 项目的启动文件介绍

项目的启动文件主要是 ScoutServiceProvider.php，它位于 src/ 目录下。这个文件负责注册和启动 Elastic Scout Driver Plus 服务。

namespace Elastic\ScoutDriverPlus;

use Elastic\ScoutDriverPlus\Decorators\EngineDecorator;
use Elastic\ScoutDriverPlus\Engines\DecoratedEngine;
use Elastic\ScoutDriverPlus\Factories\DocumentFactoryInterface;
use Elastic\ScoutDriverPlus\Factories\RoutingFactoryInterface;
use Elastic\ScoutDriverPlus\Support\Query;
use Illuminate\Support\ServiceProvider;
use Laravel\Scout\EngineManager;

class ScoutServiceProvider extends ServiceProvider
{
    public function boot()
    {
        $this->app->make(EngineManager::class)->extend('elastic', function () {
            return new EngineDecorator(
                new DecoratedEngine(
                    $this->app->make(DocumentFactoryInterface::class),
                    $this->app->make(RoutingFactoryInterface::class)
                )
            );
        });
    }
}

启动文件介绍

• ScoutServiceProvider.php：注册和启动 Elastic Scout Driver Plus 服务。
  • boot() 方法：扩展 Scout 引擎，使用 EngineDecorator 和 DecoratedEngine。

3. 项目的配置文件介绍

项目的配置文件主要是 config/elastic-scout-driver.php，它需要在安装后通过 Artisan 命令发布。

发布配置文件

php artisan vendor:publish --provider="Elastic\ScoutDriverPlus\ScoutServiceProvider"

配置文件内容

return [
    'refresh_documents' => env('ELASTIC_SCOUT_REFRESH_DOCUMENTS', false),
];

配置文件介绍

• refresh_documents：是否立即刷新文档，默认为 false。在测试环境中可以设置为 true。

通过以上步骤，您可以了解 Elastic Scout Driver Plus 的目录结构、启动文件和配置文件，从而更好地使用和配置该项目。

elastic-scout-driver-plusExtension for Elastic Scout Driver项目地址:https://gitcode.com/gh_mirrors/el/elastic-scout-driver-plus