laravel下elasticsearch+analysis-ik实现中文全文搜索

白俊遥
2018-06-10 20:44:55
PHP
Laravel Elasticseach

这篇文章需要建立在 elasticsearch 已经配置完成的前提下；
如果还没安装 elasticsearch ；
请先出门左转 elasticsearch和analysis-ik的安装使用;

新建一个项目演示；

laravel new elasticsearch

创建一个文章表和文章模型；

php artisan make:model Models/Article -m

添加文章标题和内容字段
/database/migrations/2018_06_03_080124_create_articles_table.php

    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('articles', function (Blueprint $table) {
            $table->increments('id');
            $table->string('title')->default('')->comment('标题');
            $table->mediumText('content')->comment('文章内容');
            $table->timestamps();
        });
    }

修改 .env 数据库配置项；

DB_DATABASE=homestead
DB_USERNAME=homestead
DB_PASSWORD=secret

运行迁移生成表;

php artisan migrate

创建填充文件;

php artisan make:seed ArticlesTableSeeder

生成测试数据;

    public function run()
    {
        DB::table('articles')->insert([
            [
                'title' => 'elasticsearch',
                'content' => '一个基于Lucene的企业级搜索引擎'
            ],
            [
                'title' => 'elasticsearch analysis ik',
                'content' => '用于 elasticsearch 的中文分词插件'
            ]
        ]);
    }

运行填充；

php artisan db:seed --class=ArticlesTableSeeder

/routes/web.php

<?php
use App\Models\Article;

Route::get('search', function () {
    // 为查看方便都转成数组
    dump(Article::all()->toArray());
});

准备工作至此结束；
下面开始整合入 laravel ；
有三种方案可供选择；

第一种方案是 laravel-scout-elastic ;
这种基于 scout 的；
好处我们上篇文章已经写了；
增删改操作后自动更新索引；
配置起来也简单方便；
可以非常方便的在各种基于 scout 搜索方案间切换；
但是它并不理解东方神秘的方块字；
不能自定义分词器；
也不能愉快的完成中文搜索功能；

另一种是 Elasticquent ;
这种是独立于 scout 的；
它提供了符合 laravel 风格的操作索引的 api ；
并且和模型结合在了一起可以方便的进行搜索；
可以自定义分词愉快的中文搜索了；
但是结合的不像 scout 那样紧密；
对数据库增删改后还需要手动同步对索引进行相同的操作；
想便捷点也需要自己绑定监听增删改的事件；

那能不能有一个开箱即用还支持中文搜索的方案；
于是有了第三种方案 baijunyao/laravel-scout-elasticsearch 横空出世;
安装 driver ；

composer require baijunyao/laravel-scout-elasticsearch "^3.0"

添加 Provider ；
config/app.php

'providers' => [

    // ...

    /**
     * Elasticsearch全文搜索
     */
    Laravel\Scout\ScoutServiceProvider::class,
    Baijunyao\LaravelScoutElasticsearch\ElasticsearchServiceProvider::class,
],

发布配置项;

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

增加配置项；
/.env ;

SCOUT_DRIVER=elasticsearch

模型中定义全文搜索；
/app/Models/Article.php

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Laravel\Scout\Searchable;

class Article extends Model
{
    use Searchable;

    /**
     * 索引的字段
     *
     * @return array
     */
    public function toSearchableArray()
    {
        return $this->only('id', 'title', 'content');
    }
}

生成索引；

php artisan elasticsearch:import "App\Models\Article"

使用起来也相当简单；
只需要把要搜索的内容传给 search() 方法即可;
/routes/web.php

<?php
use App\Models\Article;

Route::get('search', function () {
    // 为查看方便都转成数组
    dump(Article::all()->toArray());
    dump(Article::search('功能齐全的搜索引擎')->get()->toArray());
});

成功的查出了数据；

最后我们再测下修改数据后的同步索引；

routes/web.php

<?php

use App\Models\Article;

Route::get('search', function () {
    // 为查看方便都转成数组
    dump(Article::all()->toArray());
    dump('下面搜索的是：企业搜索');
    dump(Article::search('企业搜索')->get()->toArray());
    dump('此处把content改为：能胜任上百个服务节点的扩展，并支持 PB 级别的结构化或者非结构化数据');
    // 修改 content 测试索引是否会自动同步
    $first = Article::find(1);
    // $first->content = '一个基于Lucene的企业级搜索引擎';
    $first->content = '能胜任上百个服务节点的扩展，并支持 PB 级别的结构化或者非结构化数据';
    $first->save();
    // 因 Elasticsearch 同步索引需要点时间此处休眠5秒钟
    sleep(5);
    dump('下面搜索的是：企业搜索');
    dump(Article::search('企业搜索')->get()->toArray());
    dump('下面搜索的是：能胜服务');
    dump(Article::search('能胜服务')->get()->toArray());
});

———————————————————— 更新 ———————————————————— 本篇教程是基于 laravel-scout-elasticsearch v3 版本编写；
最新版的 laravel-scout-elasticsearch 已经不适用于本文章；
使用新版请参考文档教程

本文为白俊遥原创文章,转载无需和我联系,但请注明来自白俊遥博客https://baijunyao.com 欢迎捐赠赞赏加入组织创建QQ群及捐赠渠道

上一篇： elasticsearch和analysis-ik的安装使用
下一篇： php设计模式(一)序言

请先登录后发表评论

latest comments
总共29条评论

石石石：如何处理特殊字符比如我想全文检索”6+8=“如何处理+和=？大佬请指教

2020-06-05 18:22:26 回复

ShuiPingYang ：可以试一下phantomjs

2020-04-13 10:53:52 回复

啸沧海：按照这个一步一步，也是出现这个来的，php artisan elasticsearch:import "App\Models\Article"提示 There are no commands defined in the "elasticsearch" namespace.是不是漏了哪里没有配置啊？

2020-02-04 15:57:17 回复

呆萌@ ：Elasticsearch\Common\Exceptions\NoNodesAvailableException : No alive nodes found in your cluster at E:\laravel-test\seo\vendor\elasticsearch\elasticsearch\src\Elasticsearch\ConnectionPool\StaticNoPingConnectionPool.php:53 49| return $connection; 50| } 51| } 52| > 53| throw new NoNodesAvailableException("No alive nodes found in your cluster"); 54| } 55| 56| public function scheduleCheck() 57| { Exception trace: 1 Elasticsearch\ConnectionPool\StaticNoPingConnectionPool::nextConnection() E:\laravel-test\seo\vendor\elasticsearch\elasticsearch\src\Elasticsearch\Transport.php:78 2 Elasticsearch\Transport::getConnection() E:\laravel-test\seo\vendor\elasticsearch\elasticsearch\src\Elasticsearch\Transport.php:96 Please use the argument -v to see more details.

2019-12-04 13:31:58 回复

2019-12-04 13:25:58 回复

呆萌@ ：大佬，在执行 php artisan elasticsearch:import "App\Models\Article"提示 There are no commands defined in the "elasticsearch" namespace.

2019-12-02 10:27:13 回复

新西..!? ：这样的： php artisan scout:import "App\Models\Article"

2019-12-02 19:37:59 回复

呆萌@ ：也不行

2019-12-04 13:24:33 回复

新西..!? ：config\scout.php中这些都配置正确了吗？'elasticsearch' => [ 'index' => env('ELASTICSEARCH_INDEX', 'laravel'), 'hosts' => [ env('ELASTICSEARCH_HOST', 'http://127.0.0.1'), ], 'host'=>env('ELASTICSEARCH_HOST', '127.0.0.1'), 'port'=>env('ELASTICSEARCH_PORT',9200), 'scheme'=>env('ELASTICSEARCH_SCHEME','http')]

2019-12-04 16:49:57 回复