Detailed explanation of Laravel8 ES packaging and how to use it

This article will introduce you to the relevant knowledge about Laravel8, including explaining Laravel8 ES packaging and how to use it. I hope it will be helpful to everyone!

[Related recommendations: laravel video tutorial】

composer installation

composer require elasticsearch/elasticsearch

ES encapsulation

<?php
namespace App\Es;
use Elasticsearch\ClientBuilder;
class MyEs
{
    //ES客户端链接
    private $client;
    /**
     * 构造函数
     * MyElasticsearch constructor.
     */
    public function __construct()
    {
        $this->client = ClientBuilder::create()->setHosts([&#39;127.0.0.1:9200&#39;])->build();
    }
    /**
     * 判断索引是否存在
     * @param string $index_name
     * @return bool|mixed|string
     */
    public function exists_index($index_name = &#39;test_ik&#39;)
    {
        $params = [
            &#39;index&#39; => $index_name
        ];
        try {
            return $this->client->indices()->exists($params);
        } catch (\Elasticsearch\Common\Exceptions\BadRequest400Exception $e) {
            $msg = $e->getMessage();
            $msg = json_decode($msg,true);
            return $msg;
        }
    }
    /**
     * 创建索引
     * @param string $index_name
     * @return array|mixed|string
     */
    public function create_index($index_name = &#39;test_ik&#39;) { // 只能创建一次
        $params = [
            &#39;index&#39; => $index_name,
            &#39;body&#39; => [
                &#39;settings&#39; => [
                    &#39;number_of_shards&#39; => 5,
                    &#39;number_of_replicas&#39; => 1
                ]
            ]
        ];
        try {
            return $this->client->indices()->create($params);
        } catch (\Elasticsearch\Common\Exceptions\BadRequest400Exception $e) {
            $msg = $e->getMessage();
            $msg = json_decode($msg,true);
            return $msg;
        }
    }
    /**
     * 删除索引
     * @param string $index_name
     * @return array
     */
    public function delete_index($index_name = &#39;test_ik&#39;) {
        $params = [&#39;index&#39; => $index_name];
        $response = $this->client->indices()->delete($params);
        return $response;
    }
    /**
     * 添加文档
     * @param $id
     * @param $doc [&#39;id&#39;=>100, &#39;title&#39;=>&#39;phone&#39;]
     * @param string $index_name
     * @param string $type_name
     * @return array
     */
    public function add_doc($id,$doc,$index_name = &#39;test_ik&#39;,$type_name = &#39;goods&#39;) {
        $params = [
            &#39;index&#39; => $index_name,
            &#39;type&#39; => $type_name,
            &#39;id&#39; => $id,
            &#39;body&#39; => $doc
        ];
        $response = $this->client->index($params);
        return $response;
    }
    /**
     * 判断文档存在
     * @param int $id
     * @param string $index_name
     * @param string $type_name
     * @return array|bool
     */
    public function exists_doc($id = 1,$index_name = &#39;test_ik&#39;,$type_name = &#39;goods&#39;) {
        $params = [
            &#39;index&#39; => $index_name,
            &#39;type&#39; => $type_name,
            &#39;id&#39; => $id
        ];
        $response = $this->client->exists($params);
        return $response;
    }
    /**
     * 获取文档
     * @param int $id
     * @param string $index_name
     * @param string $type_name
     * @return array
     */
    public function get_doc($id = 1,$index_name = &#39;test_ik&#39;,$type_name = &#39;goods&#39;) {
        $params = [
            &#39;index&#39; => $index_name,
            &#39;type&#39; => $type_name,
            &#39;id&#39; => $id
        ];
        $response = $this->client->get($params);
        return $response;
    }
    /**
     * 更新文档
     * @param int $id
     * @param string $index_name
     * @param string $type_name
     * @param array $body [&#39;doc&#39; => [&#39;title&#39; => &#39;苹果手机iPhoneX&#39;]]
     * @return array
     */
    public function update_doc($id = 1,$index_name = &#39;test_ik&#39;,$type_name = &#39;goods&#39;, $body=[]) {
        // 可以灵活添加新字段,最好不要乱添加
        $params = [
            &#39;index&#39; => $index_name,
            &#39;type&#39; => $type_name,
            &#39;id&#39; => $id,
            &#39;body&#39; => $body
        ];
        $response = $this->client->update($params);
        return $response;
    }
    /**
     * 删除文档
     * @param int $id
     * @param string $index_name
     * @param string $type_name
     * @return array
     */
    public function delete_doc($id = 1,$index_name = &#39;test_ik&#39;,$type_name = &#39;goods&#39;) {
        $params = [
            &#39;index&#39; => $index_name,
            &#39;type&#39; => $type_name,
            &#39;id&#39; => $id
        ];
        $response = $this->client->delete($params);
        return $response;
    }
    /**
     * 搜索文档 (分页，排序，权重，过滤)
     * @param string $index_name
     * @param string $type_name
     * @param array $body
     * $body = [
                &#39;query&#39; => [
                    &#39;match&#39; => [
                        &#39;fang_name&#39; => [
                            &#39;query&#39; => $fangName
                        ]
                    ]
                ],
                &#39;highlight&#39;=>[
                    &#39;fields&#39;=>[
                        &#39;fang_name&#39;=>[
                            &#39;pre_tags&#39;=>[
                                &#39;<span style="color: red">&#39;
                            ],
                            &#39;post_tags&#39;=>[
                                &#39;</span>&#39;
                            ]
                        ]
                    ]
                ]
            ];
     * @return array
     */
    public function search_doc($index_name = "test_ik",$type_name = "goods",$body=[]) {
        $params = [
            &#39;index&#39; => $index_name,
            &#39;type&#39; => $type_name,
            &#39;body&#39; => $body
        ];
        $results = $this->client->search($params);
        return $results;
    }
}

Add all the data in the data table to ES

public function esAdd()
    {
        $data = Good::get()->toArray();
        $es = new MyEs();
        if (!$es->exists_index('goods')) {
            //创建es索引，es的索引相当于MySQL的数据库
            $es->create_index('goods');
        }
        foreach ($data as $model) {
            $es->add_doc($model['id'], $model, 'goods', '_doc');
        }
    }

Every time a piece of data is added to MySQL, a piece of data is also added to es

Directly add the code to the logical method of adding MySQL to the database

        //添加至MySQL
        $res=Good::insertGetId($arr);
        $es = new MyEs();
        if (!$es->exists_index('goods')) {
            $es->create_index('goods');
        }
        //添加至es
        $es->add_doc($res, $arr, 'goods', '_doc');
        return $res;

When modifying the MySQL data, the es data is also updated

Directly add the code to the logic of MySQL modifying the data In the method

      //修改MySQL的数据
        $res=Good::where('id',$id)->update($arr);
        $es = new MyEs();
        if (!$es->exists_index('goods')) {
            $es->create_index('goods');
        }
        //修改es的数据
        $es->update_doc($id, 'goods', '_doc',['doc'=>$arr]);
        return $res;

implement the search function through ES

public function search()
    {
        //获取搜索值
        $search = \request()->get('search');
        if (!empty($search)) {
            $es = new MyEs();
            $body = [
                'query' => [
                    'match' => [
                        'title' => [
                            'query' => $search
                        ]
                    ]
                ],
                'highlight'=>[
                    'fields'=>[
                        'title'=>[
                            'pre_tags'=>[
                                &#39;<span style="color: red">&#39;
                            ],
                            &#39;post_tags&#39;=>[
                                &#39;</span>&#39;
                            ]
                        ]
                    ]
                ]
            ];
            $res = $es->search_doc(&#39;goods&#39;, &#39;_doc&#39;, $body);
            $data = array_column($res[&#39;hits&#39;][&#39;hits&#39;], &#39;_source&#39;);
            foreach ($data as $key=>&$v){
                 $v[&#39;title&#39;] = $res[&#39;hits&#39;][&#39;hits&#39;][$key][&#39;highlight&#39;][&#39;title&#39;][0];
            }
            unset($v);
            return $data;
        }
        $data = Good::get();
        return $data;
    }

In addition, add es paging search

If it is used in the WeChat applet, use the pull-up to bottom Events

This function is implemented by adding code on top of the above search function

1. Receive the current page passed by the front-end applet

2. Call the es package When searching the method of the class, pass two more parameters

3. Add two formal parameters to the search method of the es package class

The search value will be highlighted after the search

If used in a WeChat applet, the label and value will be output directly to the page. Adding a label that parses rich text can convert the label into a format and achieve a highlighting effect

<rich-text nodes="{{item.title}}"></rich-text>

Original text Author: amateur

Reposted from the link: https://learnku.com/articles/66177

The above is the detailed content of Detailed explanation of Laravel8 ES packaging and how to use it. For more information, please follow other related articles on the PHP Chinese website!