简介
Laravel Scout 是针对Eloquent 模型开发的一个简单的,基于驱动的全文检索系统。Scout 使用模型观察者时会自动保持你的检索索引与你的 Eloquent 记录同步。
目前,Scout 带着一个Algolia驱动;然而,扩展 Scout 并不难,你可以通过自定义驱动来自由的扩展 Scout。接下来我们就自定义搜索引擎elasticsearch来扩展Scount。
ElasticSearch是一个基于Lucene的搜索服务器。它提供了一个分布式多用户能力的全文搜索引擎,基于RESTful web接口。Elasticsearch是用Java开发的,并作为Apache许可条款下的开放源码发布,是当前流行的企业级搜索引擎。
下载并安装elasticsearch
(1)使用elasticsearch的前提是你的主机必须安装了java的JDK,而且版本必须是1.8以上。安装JDK,并设置JAVA_HOME环境变量。
(2)解压安装包,使用cmd命令进入到\bin,首先我们可以使用命令elasticsearch-plugin list 查看插件,我们可以看到会列出一串的插件,但是我们只需要其中analysis-ik插件,如果你的主机不够强大,建议可以删除其他不必要的插件,因为会消耗主机的大部分资源,直接删除\plugins中除了analysis-ik的其他插件。
(3)重新cmd键入elasticsearch-plugin list 查看插件
(4)启动,cmd键入elasticsearch -d,在浏览器地址了中输入127.0.0.1:9200,我们可以看到如下图:
安装Scout
(1)首先,使用 composer 包管理器来安装 Scout,如果没有安装 composer 包管理器,要先安装;接着进入laravel项目的根目录使用composer 命令安装
composer require laravel/scout
(2)接下来,你需要将 ScoutServiceProvider 添加到你的 config/app.php 配置文件的 providers 数组中:
Laravel\Scout\ScoutServiceProvider::class,
(3)注册好 Scout 的服务提供者之后,你可以使用 vendor:publish Artisan 命令生成 Scout 的配置文件。这个命令会在你的 config 目录下生成 scout.php 配置文件:
php artisan vendor:publish --provider="Laravel\Scout\ScoutServiceProvider"
(4)使用 composer安装scout的es驱动:
composer require tamayo/laravel-scout-elastic
(5)安装完驱动之后,修改config\scout.php配合文件,将驱动修改为elasticsearch
'driver' => env('SCOUT_DRIVER', 'elasticsearch'),
并在下方添加驱动:
'elasticsearch' => [
//laravel54是项目名,可以自定义
'index' => env('ELASTICSEARCH_INDEX', 'laravel54'),
'hosts' => [
env('ELASTICSEARCH_HOST', 'http://127.0.0.1:9200'),
],
],
创建command命令
(1)使用php artisan创建command命令
php artisan make:command ESInit
(2)执行完命令后会创建app\Console\Command\ESInit.php文件,修改ESInit.php
//使用什么命令启动脚本
protected $signature = 'es:init';
//描述
protected $description = 'init laravel es for post';
(3)在app\Console\Kernel.php中挂载
protected $commands = [
\App\Console\Commands\ESInit::class
];
完成之后使用php artisan命令查看命令是否挂载成功
安装guzzlehttp/guzzle 扩展
composer require guzzlehttp/guzzle
配置
(1)修改app\Console\Command\ESInit.php
public function handle()
{
//创建template
$client=new Client();
$url=config('scout.elasticsearch.hosts')[0]. '/_template/tmp';
//$client->delete($url);
$param = [
'json'=>[
'template' => config('scout.elasticsearch.index'),
'mappings' => [
'_default_' => [
'dynamic_templates' => [
[
'strings' => [
'match_mapping_type' => 'string',
'mapping' => [
'type' => 'text',
'analyzer' => 'ik_smart',
'fields' => [
'keyword' => [
'type' => 'keyword'
]
]
]
]
]
]
]
],
],
];
$client->put($url,$param);
//记录
$this->info("=======创建模板成功=======");
//创建index
$url = config('scout.elasticsearch.hosts')[0] . '/' . config('scout.elasticsearch.index');
//$client->delete($url);
$param=[
'json' => [
'settings' => [
'refresh_interval' => '5s',
'number_of_shards' => 1,
'number_of_replicas' => 0,
],
'mappings' => [
'_default_' => [
'_all' => [
'enabled' => false
]
]
]
]
];
$client->put($url,$param);
//记录
$this->info("=========创建索引成功=========");
}
(2)在我的项目中我使用文章数据表来搜索,因此需要修改post.php,也就是posts数据对于的数据模型
use Searchable;
//定义索引里面的type
public function searchableAs()
{
return "post";
}
//定义有哪些字段需要搜索
public function toSearchableArray()
{
return [
'title'=>$this->title,
'content'=>$this->content,
];
}
导入数据
使用php artisan命令导入数据
php artisan scout:import "\App\Post"
导入成功之后我们在浏览器地址输栏入:127.0.0.1:9200/laravel54/post/23(laravel54是elasticsearch驱动定义的项目名,post对象的是我项目的post数据模型,23是某条数据的ID )