Laravel Scout Elasticsearch 驱动项目教程

1. 项目目录结构及介绍

laravel-scout-elastic/
├── src/
│   ├── Scout/
│   │   ├── ElasticsearchEngine.php
│   │   ├── ElasticsearchServiceProvider.php
│   │   └── ...
│   └── ...
├── tests/
│   ├── Feature/
│   │   └── ElasticsearchEngineTest.php
│   └── ...
├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
├── composer.json
├── phpunit.xml.dist
└── ...

目录结构介绍

• src/: 包含项目的核心代码，主要用于实现 Elasticsearch 驱动的功能。
  • Scout/: 包含与 Laravel Scout 集成的核心文件，如 ElasticsearchEngine.php 和 ElasticsearchServiceProvider.php。
• tests/: 包含项目的测试代码，确保功能的正确性和稳定性。
  • Feature/: 包含功能测试文件，如 ElasticsearchEngineTest.php。
• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
• .travis.yml: Travis CI 的配置文件，用于自动化测试。
• LICENSE: 项目的开源许可证文件，本项目使用 MIT 许可证。
• README.md: 项目的说明文档，包含安装、配置和使用说明。
• composer.json: Composer 的配置文件，定义项目的依赖关系。
• phpunit.xml.dist: PHPUnit 的配置文件，用于单元测试。

2. 项目启动文件介绍

ElasticsearchServiceProvider.php

namespace Tamayo\LaravelScoutElastic;

use Illuminate\Support\ServiceProvider;
use Laravel\Scout\EngineManager;
use Tamayo\LaravelScoutElastic\Engines\ElasticsearchEngine;

class ElasticsearchServiceProvider extends ServiceProvider
{
    public function boot()
    {
        resolve(EngineManager::class)->extend('elasticsearch', function () {
            return new ElasticsearchEngine;
        });
    }
}

启动文件介绍

• ElasticsearchServiceProvider.php: 该文件是 Laravel 服务提供者，用于注册 Elasticsearch 引擎到 Laravel Scout 中。通过 boot 方法，将 ElasticsearchEngine 注册为 Scout 的驱动。

3. 项目配置文件介绍

config/scout.php

return [
    'driver' => env('SCOUT_DRIVER', 'elasticsearch'),

    'elasticsearch' => [
        'hosts' => [
            env('ELASTICSEARCH_HOST', 'localhost'),
            // 其他配置项...
        ],
    ],
];

配置文件介绍

• config/scout.php: 该文件是 Laravel Scout 的配置文件，用于配置 Elasticsearch 驱动的相关参数。
  • driver: 指定 Scout 使用的驱动，这里设置为 elasticsearch。
  • elasticsearch: 包含 Elasticsearch 的配置项，如 hosts，用于指定 Elasticsearch 服务器的地址。

通过以上配置，项目可以成功集成 Elasticsearch 驱动，并使用 Laravel Scout 进行全文搜索。