Laravel ElasticSearch Scout

发表于 | 分类于

Laravel 中使用Elasticsearch 结合Scout,实现全文搜索

参考:

安装composer依赖

1
2
composer require tamayo/laravel-scout-elastic
composer require laravel/scout

config/app.php

1
2
3
4
5
6
'providers' => [
    ...
    Laravel\Scout\ScoutServiceProvider::class,
    ...
    ScoutEngines\Elasticsearch\ElasticsearchProvider::class,
],

配置ElasticSearch

1
php artisan vendor:publish --provider="Laravel\Scout\ScoutServiceProvider

config\scout.php配置文件，

1
'driver' => env('SCOUT_DRIVER', 'elasticsearch')

.env

1
2
ELASTICSEARCH_INDEX=laravel_index
ELASTICSEARCH_HOST=http://localhost

config/scout.php

1
2
3
4
5
6
7
//添加elasticsearch配置
'elasticsearch' => [
        'index' => env('ELASTICSEARCH_INDEX', 'laravel'),
        'hosts' => [
            env('ELASTICSEARCH_HOST', ''),
        ],
    ],

Note: ‘queue’ => env(‘SCOUT_QUEUE’, false),
不使用queue,php artisan scout:import xxx 能直接看到效果。

App\Models\Topic.php

1
2
3
4
5
6
7
8
9
10
11
...
//增加Searchable
use Searchable;
...
public function toSearchableArray()
{
   return [
      'title' => $this->title,
      'content' => $this->content,
   ];
}

创建command 命令

1
php artisan make:command EsInit

app\Console\Command\ESInit.php

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
<?php
namespace App\Console\Commands;

use GuzzleHttp\Client;
use Illuminate\Console\Command;

class ESInit extends Command
{
  /**
   * The name and signature of the console command.
   *
   * @var string
   */
  protected $signature = 'es:init';

  /**
   * The console command description.
   *
   * @var string
   */
  protected $description = 'init laravel es for article';

  /**
   * Create a new command instance.
   *
   * @return void
   */
  public function __construct()
  {
      parent::__construct();
  }

  /**
   * Execute the console command.
   *
   * @return mixed
   */
  public function handle(Client $client)
  {
      $this->createTemplate($client);
      $this->createIndex($client);
  }

  /**
   * 创建模板 see https://www.elastic.co/guide/en/elasticsearch/reference/current/dynamic-templates.html
   * @param Client $client
   */
  private function createTemplate(Client $client)
  {
      $url = config('scout.elasticsearch.hosts')[0] . '/_template/template_1';
      $client->put($url, [
          'json' => [
              'template' => config('scout.elasticsearch.index'),
              'settings' => [
                  'number_of_shards' => 1,
              ],
              'mappings' => [
                  '_default_' => [
                      'dynamic_templates' => [ // 动态映射模板
                          [
                              'string_fields' => [ // 字段映射模板的名称，一般为"类型_fields"的命名方式
                                  'match' => '*', // 匹配的字段名为所有
                                  'match_mapping_type' => 'string', // 限制匹配的字段类型，只能是 string 类型
                                  'mapping' => [ // 字段的处理方式
                                      'type' => 'text', // 字段类型限定为 string
                                      'analyzer' => 'ik_smart', // 字段采用的分析器名，默认值为 standard 分析器
                                      'fields' => [
                                          'raw' => [
                                              'type' => 'keyword',
                                              'ignore_above' => 256, // 字段是索引时忽略长度超过定义值的字段。
                                          ]
                                      ],
                                  ],
                              ],
                          ],
                      ],
                  ],
              ],
          ],
      ]);

      $this->info("=======创建模板成功=======");
  }

  private function createIndex(Client $client)
  {
      $url = config('scout.elasticsearch.hosts')[0] . '/' . config('scout.elasticsearch.index');

      $client->put($url, [
          'json' => [
              'settings' => [
                  'refresh_interval' => '5s',
                  'number_of_shards' => 1, // 分片为
                  'number_of_replicas' => 0, // 副本数
              ],
              'mappings' => [
                  '_default_' => [
                      '_all' => [
                          'enabled' => false, // 是否开启所有字段的检索
                      ],
                  ],
              ],
          ],
      ]);

      $this->info("=========创建索引成功=========");
  }
}

执行command导入数据

1
2
3
4
php artisan es:init

//导入数据
php artisan scout:import "App\Models\Topic"

验证template

1
2
3
4
curl localhost:9200/_template/template_1`

验证导入的数据
curl localhost:9200/laravel_index/_search?pretty