Laravel中使用ElasticSearch

williamQian4年前 (2021-04-13)Laravel29680

对于查询业务，如果用的是mysql，在遇到高并发查询，尤其是全文检索的场景时，容易出现性能瓶颈，这时候我们可以使用ElasticSearch，来增强我们后端的检索处理能力。关于ElasticSearch的安装，可以参考这篇文章：[Linux环境安装ElasticSearch以及中文分词器](http://blog.bigfoot.xin/post/3.html "Linux环境安装ElasticSearch以及中文分词器")。

现在我们系统中已经有一个模型Shop，以这个Shop模型为例，来说明下在Larave中如何使用ElasticSearch根据经纬度查询附近2公里以内的店铺，以及根据店铺名称进行查询（中文分词的使用）。

```
Schema::create('shops', function (Blueprint $table) {
	$table->id();
	$table->string('name')->comment('店铺名称');
	$table->decimal('lng', 10, 6)->comment('店铺经度');
	$table->decimal('lat', 10, 6)->comment('店铺纬度');
});
```
<br/>

```
namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

class Shop extends Model
{
    use HasFactory;

protected $casts = [
        'lng' => 'decimal:6',
        'lat' => 'decimal:6'
    ];

/*
	location如果不加进$appends，那么模型的toArray方法不会包含location字段。
	*/
    protected $appends = ['location'];

public function getLocationAttribute()
    {
        return [
            'lat' => (float)$this->lat,
			/*
			这里写成lon，是因为elasticsearch对geo-point field type有格式要求
			详见：https://www.elastic.co/guide/en/elasticsearch/reference/7.12/geo-point.html
			*/
            'lon' => (float)$this->lng,
        ];
    }
}
```
<br/>

## 一、扩展包的安装和使用
为了能够在laravel中方便使用elasticsearch，我们需要用到下面几个扩展包。
1. `laravel/scout`（[https://github.com/laravel/scout ](https://github.com/laravel/scout  "https://github.com/laravel/scout ")）
Laravel Scout 为 Eloquent 模型 的全文搜索提供了基于驱动的简单的解决方案。通过使用模型观察者， Scout 会自动同步 Eloquent 记录的搜索索引。详细的安装和配置步骤请参考[Scout 全文搜索](https://learnku.com/docs/laravel/8.x/scout/9422 "Scout 全文搜索")

2. `tamayo/laravel-scout-elastic`（[https://github.com/ErickTamayo/laravel-scout-elastic](https://github.com/ErickTamayo/laravel-scout-elastic "https://github.com/ErickTamayo/laravel-scout-elastic")）
laravel-scout-elastic是scout的elasticsearch驱动，装了这个驱动scout才能和elasticsearch交互。

3. `elasticsearch/elasticsearch`（[https://github.com/elastic/elasticsearch-php](https://github.com/elastic/elasticsearch-php "https://github.com/elastic/elasticsearch-php")）
这个包是ElasticSearch的官方php扩展包，我们知道elasticsearch的各种操作可以通过restful api去调用，这个包主要就是elasticsearch各种操作api的一个php版本的封装，方便我们在php里和ElasticSearch直接交互。

> 需要搞清楚上面三个包的关系，scout是用来自动同步Laravel模型和ElasticSearch索引的，但是scout默认没有elasticsearch的驱动，所以需要laravel-scout-elastic。而最终和ElasticSearch服务直接交互的是elasticsearch扩展包。

## 二、Artisan命令
安装和配置好扩展包以后，我们可以写一个Artisan命令，执行索引的清空、建立、mapping建立、数据导入等工作。
```
namespace App\Console\Commands;

use Illuminate\Console\Command;
use Elasticsearch\ClientBuilder;
use Illuminate\Support\Facades\Artisan;
use App\Models\Shop;

class FreshShop extends Command
{
    protected $signature = 'shop:fresh';

protected $description = 'fresh shop index in elasticsearch';

public function __construct()
    {
        parent::__construct();
    }

public function handle()
    {
        $client = ClientBuilder::create()
            ->setHosts(config('scout.elasticsearch.hosts'))
            ->build();
        $this->info('正在删除索引shops...');
        try {
            $client->indices()->delete(['index' => 'shops']);
        } catch (\Exception $err) {
        }
        $this->info('正在创建索引shops...');
        $response = $client->indices()->create([
            'index' => 'shops',
        ]);
        $this->info(json_encode($response));
        $this->info('正在创建mapping');
        $response = $client->indices()->putMapping([
            'index' => 'shops',
            'type' => Shop::class,
            'include_type_name' => true,
            'body' => [
                'properties' => [
                    'location' => [
                        'type' => 'geo_point',
                    ],
					'name' => [
						'type' => 'text',
						'analyzer' => 'ik_max_words',
						'search_analyzer' => 'ik_smart'
					],
                ]
            ],
        ]);
        $this->info(json_encode($response));
        $this->info('正在导入模型数据...');
        Artisan::call('scout:import', [
            'model' => Shop::class
        ]);
    }
}
```
命令行执行`php artisan shop:fresh`，shops表的所有记录会被导入ElasticSearch

## 三、geo查询示例
查询控制器代码，这里是根据前端传过来的经纬度（高德地图），去查询周边2公里内的店铺并按照距离由近到远排序。
```
<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use App\Http\Controllers\Controller;
use Elasticsearch\ClientBuilder;

class ShopController extends Controller
{
    public function searchByLocation(Request $request)
    {
        $client = ClientBuilder::create()
            ->setHosts(config('scout.elasticsearch.hosts'))
            ->build();
        $res = $client->search([
            'index' => 'shops',
            'body' => [
                'query' => [
                    'bool' => [
                        'must' => [
                            'match_all' => (object)[]
                        ],
                        'filter' => [
                            'geo_distance' => [
                                'distance' => '2km',
                                'location' => [
                                    'lat' => $request->lat,
                                    'lon' => $request->lng,
                                ]
                            ]
                        ]
                    ]
                ],
                "sort" => [
                    [
                        "_geo_distance" => [
                            "location" => [
                                "lat" => $request->lat,
                                "lon" => $request->lng
                            ],
                            "order" => "asc"
                        ]
                    ]
                ],
				//最多返回50条
                'size' => 50
            ]
        ]);
        $data = array_column($res['hits']['hits'], '_source');
        dd($data);
    }
}

```

## 四、中文查询示例

如果需要中文查询的话，除了ES还得安装ik分词器，ES和ik分词器的安装请看这篇文章：[Linux环境安装ElasticSearch以及中文分词器](http://blog.bigfoot.xin/post/3.html "Linux环境安装ElasticSearch以及中文分词器")。

查询控制器示例代码：
```php
namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Elasticsearch\ClientBuilder;
use App\Http\Controllers\Controller;

class ShopController extends Controller{

public function searchByName(Request $request){
		$client = ClientBuilder::create()
            ->setHosts(config('scout.elasticsearch.hosts'))
            ->build();
		return $client->search([
            'index' => 'shops',
            'body' => [
                'query' => [
                    'bool' => [
                        'must' => [
                            ['match' => ['name' => $request->name]],
                        ]
                    ]
                ],
                'size' => 50
            ]
        ]);
	}
	
}
```