以下由Laravel教學專欄為大家介紹如何輕鬆整合新版Elasticsearch7.9中文搜尋到Laravel7項目，希望對需要的朋友有幫助！
只需五個步驟：
1、啟動整合ik中文分詞外掛程式的Elasticsearch7.9 Docker映像
課程推薦→：《elasticsearch全文搜尋實戰》（實戰影片）
來自課程《千萬級資料並發解決方案（理論實戰）》
2、Laravel7 配置Scout
3、配置Model模型
4、導入資料
5、搜尋
#示範位址
www.ar414. com/search?query=php�%...
搜尋範圍
#結果權重
- 出現關鍵字數量
- 出現關鍵字次數
搜尋頁面
#前言
主要是部落格剛好想做個搜尋,順便就整理成文章
Laravel Elasticsearch 很多前輩都寫過教程和案例,但是隨著Elasticsearch和laravel的版本升級以前的文章很多都不適用新版本的,建議大家使用任何開源專案時應該過一遍文件以目前使用的版本文件為主,教程為輔
- Elasticsearch 7.9
- Laravel 7
- elasticsearch-analysis-ik v7.9
參考
- ik 中文分詞外掛程式
- elasticsearch 官方文件
使用整合ik中文分詞外掛程式的Elasticsearch
#拉取docker
$ docker pull ar414/elasticsearch-7.9-ik-plugin
登入後複製
建立日誌和資料儲存目錄
本地映射到docker容器內，防止docker重新啟動資料遺失
$ mkdir -p /data/elasticsearch/data
$ mkdir -p /data/elasticsearch/log
$ chmod -R 777 /data/elasticsearch/data
$ chmod -R 777 /data/elasticsearch/log
登入後複製
docker run -d -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" -v /data/elasticsearch/data:/var/lib/elasticsearch -v /data/elasticsearch/log:/var/log/elasticsearch ar414/elasticsearch-7.9-ik-plugin
登入後複製
驗證<div class="code" style="position:relative; padding:0px; margin:0px;"><pre class="brush:php;toolbar:false">$ curl http://localhost:9200{
"name" : "01ac21393985", "cluster_name" : "docker-cluster", "cluster_uuid" : "h8L336qcRb2i1aydOv04Og", "version" : {
"number" : "7.9.0", "build_flavor" : "default", "build_type" : "docker", "build_hash" : "a479a2a7fce0389512d6a9361301708b92dff667", "build_date" : "2020-08-11T21:36:48.204330Z", "build_snapshot" : false, "lucene_version" : "8.6.0", "minimum_wire_compatibility_version" : "6.8.0", "minimum_index_compatibility_version" : "6.0.0-beta1"
}, "tagline" : "You Know, for Search"}</pre><div class="contentsignin">登入後複製</div></div><div class="code" style="position:relative; padding:0px; margin:0px;"><pre class="brush:php;toolbar:false">curl -X POST "http://localhost:9200/_analyze?pretty" -H 'Content-Type: application/json' -d'
{
"analyzer": "ik_max_word",
"text": "laravel天下无敌"
}
'{
"tokens" : [
{
"token" : "laravel", "start_offset" : 0, "end_offset" : 7, "type" : "ENGLISH", "position" : 0 }, {
"token" : "天下无敌", "start_offset" : 7, "end_offset" : 11, "type" : "CN_WORD", "position" : 1 }, {
"token" : "天下", "start_offset" : 7, "end_offset" : 9, "type" : "CN_WORD", "position" : 2 }, {
"token" : "无敌", "start_offset" : 9, "end_offset" : 11, "type" : "CN_WORD", "position" : 3 }
]}</pre><div class="contentsignin">登入後複製</div></div>
Laravel 專案中使用Elasticsearch
- #Elasticsearch
官方有提供SDK，在Laravel 專案中可以更加- 優雅
快速的接入Elasticsearch，Laravel 本身有提供Scout全文搜尋的解決方案，我們只需將預設的Algolia 驅動程式替換成
ElasticSearch驅動程式
。
安裝-
laravel/scout
- #輕鬆整合新版Elasticsearch7.9中文搜尋到Laravel7項目
$ composer require laravel/scout
$ composer require 輕鬆整合新版Elasticsearch7.9中文搜尋到Laravel7項目
登入後複製
#設定-
$ php artisan vendor:publish --provider="Laravel\Scout\ScoutServiceProvider"Copied File [\vendor\laravel\scout\config\scout.php] To [\config\scout.php]Publishing complete.
登入後複製
指定Scout 驅動程式
-
-
##第一種：在.env
檔案中指定（建議）SCOUT_DRIVER=Matchish\ScoutElasticSearch\Engines\ElasticSearchEngine
登入後複製
- 第二種：在
config/scout.php
直接修改預設驅動'driver' => env('SCOUT_DRIVER', 'algolia')改为'driver' => env('SCOUT_DRIVER', 'Matchish\ScoutElasticSearch\Engines\ElasticSearchEngine')登入後複製
###指定Elasticsearch服務IP埠#########如果使用docker部署則使用###docker0###的IP， Linux透過ifconfig查看#########在###.env####中設定###
ELASTICSEARCH_HOST=172.17.0.1:9200
登入後複製
#########註冊服務######config/app.php ######
'providers' => [
// Other Service Providers
\Matchish\ScoutElasticSearch\ElasticSearchServiceProvider::class],
登入後複製
#########清除設定快取###
$ php artisan config:clear
登入後複製
##########至此laravel 已經存取Elasticsearch####
实际业务中使用
需求
通过博客右上角的搜索框可以搜索到与关键词相关的文章，从以下几点匹配
涉及到2张 Mysql表 以及字段
为文章配置 Elasticsearch 索引
-
创建索引配置文件（config/elasticsearch.php）
$ touch config/elasticsearch.php
登入後複製
-
elasticsearch.php 配置字段映射
<?phpreturn [
'indices' => [
'mappings' => [
'blog-articles' => [
"properties"=> [
"content"=> [
"type"=> "text",
"analyzer"=> "ik_max_word",
"search_analyzer"=> "ik_smart"
],
"tags"=> [
"type"=> "text",
"analyzer"=> "ik_max_word",
"search_analyzer"=> "ik_smart"
],
"title"=> [
"type"=> "text",
"analyzer"=> "ik_max_word",
"search_analyzer"=> "ik_smart"
]
]
]
]
],];
登入後複製
- analyzer：字段文本的分词器
- search_analyzer：搜索词的分词器
- 根据具体业务场景选择(颗粒小占用资源多,一般场景analyzer使用ik_max_word,search_analyzer使用ik_smart):
- ik_max_word：ik中文分词插件提供,对文本进行最大数量分词
laravel天下无敌 -> laravel，天下无敌,天下,无敌
- ik_smart: ik中文分词插件提供,对文本进行最小数量分词
laravel天下无敌 -> laravel，天下无敌
配置文章模型
建议先看一遍 Laravel Scout 使用文档
-
引入Laravel Scout
namespace App\Models\Blog;
use Laravel\Scout\Searchable;
class Article extends BlogBaseModel
{
use Searchable;
}登入後複製
-
指定索引(刚刚配置文件中的elasticsearch.indices.mappings.blog-articles)
/**
* 指定索引
* @return string
*/
public function searchableAs()
{
return 'blog-articles';
}登入後複製
-
设置导入索引的数据字段
/**
* 设置导入索引的数据字段
* @return array
*/
public function toSearchableArray()
{
return [
'content' => ArticleContent::query()
->where('article_id',$this->id)
->value('content'),
'tags' => implode(',',$this->tags),
'title' => $this->title
];
}登入後複製
-
指定 搜索索引中存储的唯一ID
/**
* 指定 搜索索引中存储的唯一ID
* @return mixed
*/
public function getScoutKey()
{
return $this->id;
}
/**
* 指定 搜索索引中存储的唯一ID的键名
* @return string
*/
public function getScoutKeyName()
{
return 'id';
}登入後複製
数据导入
其实是将数据表中的数据通过Elasticsearch导入到Lucene
Elasticsearch 是 Lucene 的封装，提供了 REST API 的操作接口
- 一键自动导入:
php artisan scout:import
- 导入指定模型:
php artisan scout:import ${model}
$ php artisan scout:import "App\Models\Blog\Article"Importing [App\Models\Blog\Article]Switching to the new index
5/5 [⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬⚬] 100%[OK] All [App\Models\Blog\Article] records have been imported.
登入後複製
导入失败,常见原因:
- Unresolvable dependency resolving [Parameter #0 [ integer $retries ]] in class Elasticsearch\Transport
- invalid_index_name_exception
- 解决: searchableAs配置错误,为索引创建别名后,指定别名
检查索引是否正确
$ curl -XGET http://localhost:9200/blog-articles/_mapping?pretty{
"blog-articles_1598362919" : {
"mappings" : {
"properties" : {
"__class_name" : {
"type" : "text", "fields" : {
"keyword" : {
"type" : "keyword", "ignore_above" : 256 }
}
}, "content" : {
"type" : "text", "analyzer" : "ik_max_word", "search_analyzer" : "ik_smart"
}, "tags" : {
"type" : "text", "analyzer" : "ik_max_word", "search_analyzer" : "ik_smart"
}, "title" : {
"type" : "text", "analyzer" : "ik_max_word", "search_analyzer" : "ik_smart"
}
}
}
}}登入後複製
测试
-
创建一个测试命令行
$ php artisan make:command ElasticTest
登入後複製
代码
<?phpnamespace App\Console\Commands;use App\Models\Blog\Article;use App\Models\Blog\ArticleContent;use Illuminate\Console\Command;use Illuminate\Support\Carbon;class ElasticTest extends Command{
/**
* The name and signature of the console command.
*
* @var string
*/
protected $signature = 'elasticsearch {query}';
/**
* The console command description.
*
* @var string
*/
protected $description = 'elasticsearch test';
/**
* Create a new command instance.
*
* @return void
*/
public function __construct()
{
parent::__construct();
}
/**
* Execute the console command.
*
* @return mixed
*/
public function handle()
{
//
$startTime = Carbon::now()->getPreciseTimestamp(3);
$articles = Article::search($this->argument('query'))->get()->toArray();
$userTime = Carbon::now()->getPreciseTimestamp(3) - $startTime;
echo "耗时(毫秒)：{$userTime} \n";
//content在另外一张表中，方便观察测试 这里输出
if(!empty($articles)) {
foreach($articles as &$article) {
$article = ArticleContent::query()->where('article_id',$article['id'])->value('content');
}
}
var_dump($articles);
}}登入後複製
- 测试
$ php artisan elasticsearch 周杰伦
登入後複製
- 复杂查询
例如：自定义高亮显示//ONGR\ElasticsearchDSL\Highlight\Highlight ArticleModel::search($query,function($client,$body) {
$higlight = new Highlight();
$higlight->addField('content',['type' => 'plain']);
$higlight->addField('title');
$higlight->addField('tags');
$body->addHighlight($higlight);
$body->setSource(['title','tags']);
return $client->search(['index' => (new ArticleModel())->searchableAs(), 'body' => $body->toArray()]);
})->raw();登入後複製
复杂自定义查询回调中的$client和$body，可根据这两个包进行灵活操作
$client 官方 elasticsearch/elasticsearch package（https://packagist.org/packages/elasticsearch/elasticsearch）
$body ongr/elasticsearch-dsl package（https://packagist.org/packages/ongr/elasticsearch-dsl）
以上是輕鬆整合新版Elasticsearch7.9中文搜尋到Laravel7項目的詳細內容。更多資訊請關注PHP中文網其他相關文章！
